Get Started

Connect a node

A node is a Linux machine where game servers run. The panel's agent (game-agent) manages Docker containers on it, serves SFTP to your customers and reports load to the panel.

Connect

In the panel open Nodes → Connect node. The window shows one command; run it on the node as root:

curl -fsSL https://panel.example.com/agent/install.sh | sudo bash -s -- \
  --master-url https://panel.example.com --join-token gjt_...

The command downloads the agent build for the node's architecture, checks its checksum, installs Docker and OpenSSH if needed (Debian/Ubuntu), writes the settings to /etc/game-agent/agent.env and starts the game-agent service. On first start the node registers, receives its own TLS certificate and appears in the list within seconds.

Optional parameters, added to the end of the command:

  • --node-id ID — node name; the host name by default.
  • --sftp-host HOST — the address customers see for SFTP, if it differs from the node's address.
  • --node-ip IP — the node's public IP, if it's detected wrongly.

A join token works once. Issue a new token for every node.

Network

  • The node connects to the panel: https://<panel domain> and port 4222. The panel never connects to the node.
  • Open 22/tcp on the node for SFTP and the ports of your games. The port range for game servers is set in the panel.

Limits

A license limits the number of nodes. Nodes count while they are registered, including offline ones. A node over the limit is refused at registration and its join token is kept. To free a place, delete a node you no longer use in the panel (see Managing nodes).

Certificates

The node certificate is valid for a year and the agent renews it on its own about four months before it expires — nothing to do by hand.

Deleting a node in the panel revokes its certificates and drops its connection at once. To bring the machine back, connect it again with a new join token.

Update the agent

Run the install command again on the node, without a token. Settings in /etc/game-agent/agent.env are kept, and the agent version bundled with the panel is installed:

curl -fsSL https://panel.example.com/agent/install.sh | sudo bash

The Nodes page marks nodes whose agent is older than the panel. See Updates.

The node doesn't appear

Check the agent log on the node:

journalctl -u game-agent -n 100

Usual causes: the node can't reach https://<domain> or port 4222 of the panel, the token was already used, or the license limit on nodes has been reached. More in Troubleshooting.