Skip to main content

Getting Started with OrbisRouter

OrbisRouter is a lightweight binary that runs on your server and acts as the entry point for all incoming player connections. It listens on port 5520 via QUIC and routes each player to the correct game server in real time — based on the routing rules you define in OrbisManager.

No reverse proxy needed. Players connect directly.

How it works​

Player → play.example.com:5520 → OrbisRouter → Game Server
  1. A player connects to your domain on port 5520.
  2. OrbisRouter reads the SNI from the QUIC handshake.
  3. Your routing rules are evaluated top to bottom.
  4. The player is forwarded to the matching server.

Prerequisites​

  • A server with a public IP address (Linux recommended)
  • A domain managed via DNS (Cloudflare, etc.)
  • An OrbisManager account with an active project
  • At least one server registered in your project

Step 1 — Create a Router in OrbisManager​

  1. Open your project in OrbisManager.
  2. Navigate to Router.
  3. Click + Add Router, enter a name, and confirm.
  4. Download the generated config.json.

Step 2 — Install OrbisRouter​

Download the latest binary for your platform:

# Linux x64
curl -Lo orbisrouter https://releases.orbismanager.net/orbisrouter/latest/linux-x64/orbisrouter
chmod +x orbisrouter

Place config.json in the same directory as the binary:

/opt/orbisrouter/
├── orbisrouter
└── config.json

Step 3 — Set up DNS​

Create an A record for your player-facing domain pointing to this server's public IP.

Hytale does not support SRV records

You must use a plain A record. SRV records are not supported by the Hytale client.

play.example.com.  IN  A  203.0.113.42

See DNS Setup for a detailed walkthrough.

Step 4 — Start OrbisRouter​

./orbisrouter

The router connects to OrbisManager and appears as online in the dashboard within a few seconds.

To run it as a systemd service, see Configuration.

Verifying it works​

Once the router is online:

  • Check the Router page in OrbisManager — the status dot should turn green.
  • Try connecting to play.example.com from Hytale.
  • Player connections will appear in your routing logs.