OmniEdge for Synology NAS

Recommended: Docker Deployment

For Synology NAS, we recommend running OmniEdge v2.x via Docker. This works on all Synology models that support Docker/Container Manager.

Prerequisites

• Synology NAS with Container Manager (DSM 7.2+) or Docker (DSM 6.x)
• SSH access to your NAS

Deploy via Docker

Using Docker CLI (SSH)

# Create config directory
mkdir -p /volume1/docker/omniedge

# Run OmniEdge container
docker run -d \
    --name omniedge \
    --restart unless-stopped \
    --cap-add NET_ADMIN \
    --device /dev/net/tun \
    -v /volume1/docker/omniedge:/data \
    -e OMNIEDGE_SECURITY_KEY=YOUR_SECURITY_KEY \
    -e OMNIEDGE_NETWORK_ID=YOUR_NETWORK_ID \
    omniedge/omniedge:latest

Using Container Manager UI

1. Open Container Manager in DSM
2. Go to Registry and search for omniedge/omniedge
3. Download the latest image
4. Create a new container with these settings:
   • Network: host (recommended) or bridge
   • Capabilities: Add NET_ADMIN
   • Devices: Add /dev/net/tun
   • Volume: Mount /data to your config directory
   • Environment Variables:
     • OMNIEDGE_SECURITY_KEY: Your security key
     • OMNIEDGE_NETWORK_ID: Your network ID

Verify Connection

# Check container logs
docker logs omniedge

# Check OmniEdge status
docker exec omniedge omniedge status

Access NAS via Virtual IP

Once connected, you can access your Synology NAS via its OmniEdge virtual IP from any device in the same virtual network:

# SSH to NAS
ssh admin@10.147.1.10

# Access DSM web interface
https://10.147.1.10:5001

# Mount shared folders (SMB)
mount -t cifs //10.147.1.10/share /mnt/nas -o username=admin

Docker Compose

Create docker-compose.yml:

version: "3.8"
services:
  omniedge:
    image: omniedge/omniedge:latest
    container_name: omniedge
    restart: unless-stopped
    cap_add:
      - NET_ADMIN
    devices:
      - /dev/net/tun
    volumes:
      - ./config:/data
    environment:
      - OMNIEDGE_SECURITY_KEY=${OMNIEDGE_SECURITY_KEY}
      - OMNIEDGE_NETWORK_ID=${OMNIEDGE_NETWORK_ID}

Create .env file:

OMNIEDGE_SECURITY_KEY=your_security_key_here
OMNIEDGE_NETWORK_ID=your_network_id_here

Deploy:

docker-compose up -d

Legacy v1.x SPK Package (Archived)

A native Synology package (SPK) was available for v1.x:

Repository

• omniedge-synology - Archived

Build Steps (Legacy)

git clone https://github.com/omniedgeio/omniedge-synology.git
cd omniedge-synology
make all

The v1.x SPK package may still work but is no longer maintained. Docker deployment is strongly recommended.

Route LAN Devices

To access other devices on your Synology's LAN through OmniEdge:

1. Enable IP forwarding on the Synology:

   echo 1 > /proc/sys/net/ipv4/ip_forward

2. Add NAT rules:

   iptables -t nat -A POSTROUTING -s 10.147.0.0/16 -o eth0 -j MASQUERADE

3. On client devices, add a route:

   # Linux/macOS
   sudo ip route add 192.168.1.0/24 via SYNOLOGY_VIRTUAL_IP
   
   # Windows
   route add 192.168.1.0 mask 255.255.255.0 SYNOLOGY_VIRTUAL_IP

If you have more questions, feel free to discuss.