Run OmniEdge in container

Run OmniEdge in container is very easy.

1. Sign up your account
2. Generate Security-key, and get the Virtual Network ID from Dashboard
3. Run the command with your own Security-key and Virtual Network ID:

Quick Start

docker pull omniedge/omniedge:latest

Usage

Edge Mode (VPN Client)

docker run -d --name omniedge \
  --privileged --network host \
  -v /dev/net/tun:/dev/net/tun \
  omniedge/omniedge:latest \
  edge -n <network-id> -s <security-key>

Nucleus Mode (Signaling Server)

docker run -d --name omniedge-nucleus \
  --network host \
  omniedge/omniedge:latest \
  nucleus --secret "YourSecretMin16Chars"

Dual Mode (VPN + Signaling)

docker run -d --name omniedge-dual \
  --privileged --network host \
  -v /dev/net/tun:/dev/net/tun \
  omniedge/omniedge:latest \
  dual -n <network-id> -s <security-key> --secret "YourSecretMin16Chars"

Options

Docker Compose

# Edge mode
OMNIEDGE_NETWORK_ID=<id> OMNIEDGE_SECURITY_KEY=<key> \
  docker compose up omniedge-edge -d

# Nucleus mode
OMNIEDGE_SECRET=YourSecretMin16Chars \
  docker compose up omniedge-nucleus -d

# Dual mode
OMNIEDGE_NETWORK_ID=<id> OMNIEDGE_SECURITY_KEY=<key> OMNIEDGE_SECRET=<secret> \
  docker compose up omniedge-dual -d

Exit Node

# Run as exit node
docker run -d --name omniedge \
  --privileged --network host \
  -v /dev/net/tun:/dev/net/tun \
  omniedge/omniedge:latest \
  edge -n <network-id> -s <security-key> --as-exit-node

# Use exit node
docker run -d --name omniedge \
  --privileged --network host \
  -v /dev/net/tun:/dev/net/tun \
  omniedge/omniedge:latest \
  edge -n <network-id> -s <security-key> --exit-node 10.0.0.1

Commands

# View logs
docker logs omniedge

# Check status
docker exec omniedge omniedge status

# Stop
docker stop omniedge

Build from Source

docker build -t omniedge/omniedge:latest .

# Multi-arch
docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 \
  -t omniedge/omniedge:latest --push .

Architectures

• linux/amd64
• linux/arm64
• linux/arm/v7

Links

• Docker Hub
• GitHub

If you have more questions, feel free to discuss.