Configuration

config.json

OrbisRouter is configured via a single config.json file placed in the same directory as the binary. You can download it directly from the OrbisManager Router page after creating a router.

{
  "api_url": "https://api.orbismanager.net",
  "project_id": "proj_xxxxxxxxxxxxxxxx",
  "api_key": "key_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "router_id": "rtr_xxxxxxxxxxxxxxxx"
}

Field	Description
api_url	OrbisManager API endpoint. Do not change this.
project_id	Your project ID. Found in project settings.
api_key	Project API key. Generated when the router is created. Keep this secret.
router_id	The ID of this specific router instance.

danger

Keep your API key secret Never commit config.json to a public repository. Add it to your .gitignore.

Running as a systemd service

To keep OrbisRouter running after a reboot, create a systemd unit file.

sudo nano /etc/systemd/system/orbisrouter.service

[Unit]
Description=OrbisRouter
After=network.target

[Service]
Type=simple
User=orbisrouter
WorkingDirectory=/opt/orbisrouter
ExecStart=/opt/orbisrouter/orbisrouter
Restart=on-failure
RestartSec=5

[Install]
WantedBy=multi-user.target

Enable and start the service:

sudo systemctl daemon-reload
sudo systemctl enable orbisrouter
sudo systemctl start orbisrouter
sudo systemctl status orbisrouter

Firewall

Make sure port 5520 UDP is open on your server:

# ufw
sudo ufw allow 5520/udp

# iptables
sudo iptables -A INPUT -p udp --dport 5520 -j ACCEPT

Logs

View live logs with:

# systemd
sudo journalctl -u orbisrouter -f

# standalone
./orbisrouter 2>&1 | tee orbisrouter.log

Updating

Stop the service, replace the binary, and restart:

sudo systemctl stop orbisrouter
curl -Lo /opt/orbisrouter/orbisrouter https://releases.orbismanager.net/orbisrouter/latest/linux-x64/orbisrouter
chmod +x /opt/orbisrouter/orbisrouter
sudo systemctl start orbisrouter