The hub server
The hub is a small server that keeps the list of game servers. Game servers announce themselves to it, and the game client and the RC tool read the list from it, so nobody types a server address. There is no global account: every game server keeps its own accounts and the hub never sees a login.
The hub is a separate program (borne-hub). A game server runs without it; the hub only matters when you want to be listed.
Running a hub
Section titled “Running a hub”Everything is an environment variable, so the Docker .env file is the whole configuration.
| Variable | Meaning | Default |
|---|---|---|
BORNE_HUB_LISTEN |
Listen address | 0.0.0.0:14950 |
BORNE_HUB_PASSWORD or BORNE_HUB_PASSWORD_FILE |
The password servers announce with, 16 to 256 bytes | required |
BORNE_HUB_TLS_CERT, BORNE_HUB_TLS_KEY |
PEM certificate chain and key (set both) | A self-signed pair under the data folder; the fingerprint is printed at start |
BORNE_HUB_DATA_DIR |
Folder of the generated certificate and of hub-state.json |
/var/lib/borne-hub |
BORNE_HUB_APPROVAL |
A server is listed only after you approve it | true |
BORNE_HUB_ADMIN_PASSWORD or BORNE_HUB_ADMIN_PASSWORD_FILE |
Password of the web panel, 12 to 256 bytes. The panel runs only with it, and approval needs it | none |
BORNE_HUB_ADMIN_USER |
User name of the panel | admin |
BORNE_HUB_ADMIN_LISTEN |
Listen address of the panel | 0.0.0.0:14951 |
BORNE_HUB_ALLOW_INSECURE_LOCALHOST |
Plain ws:// from the same computer. Development only |
off |
Five wrong passwords from one address in five minutes ban that address for ten minutes. The hub keeps no history: a server is listed while its connection is alive and disappears when the connection closes or after 90 seconds without a message. At most 64 servers are listed.
The admin panel
Section titled “The admin panel”When BORNE_HUB_ADMIN_PASSWORD is set, the hub serves a web page on its second port, over the same certificate. It has no JavaScript. It shows:
- servers waiting for approval, with Approve and Reject;
- the servers listed now;
- the approved and rejected servers that are offline, with Reject, Approve, and Forget (forget makes the server pending again);
- the news: a form (a title up to 120 characters, a text up to 4,000), the list, and Delete.
With approval on, a server that announces with the right password stays connected but is not in the list until you approve it. Decisions are saved in hub-state.json, so a restart keeps them. A rejected server is disconnected and retries only every five minutes.
Announcing a game server
Section titled “Announcing a game server”Set these on the game server. Without BORNE_HUB_URL the server does not announce.
| Variable | Meaning | Default |
|---|---|---|
BORNE_HUB_URL |
wss://host[:port] of the hub |
none |
BORNE_HUB_PASSWORD or BORNE_HUB_PASSWORD_FILE |
The hub password | required with the URL |
BORNE_HUB_CERT_SHA256 |
Pins the certificate of a self-signed hub | the system trust store |
BORNE_HUB_PUBLIC_HOST |
Host that clients connect to | the address the hub sees |
BORNE_HUB_PUBLIC_PORT |
Port that clients connect to | network.port |
BORNE_HUB_DESCRIPTION |
Description, up to 512 characters | the Server Option description |
BORNE_HUB_ICON |
PNG icon file, at most 64 by 64 pixels and 1 MiB | <data_dir>/server-icon.png when it exists |
The name comes from the Server Option name, and the player count from the players online. A change reaches the hub within 30 seconds. A server without an icon gets a generated one. The server reconnects by itself after a failure.
Clients
Section titled “Clients”The server screen of the client lists the servers of the hub with icon, name, players online, and the first line of the description. In a wide window (720 logical pixels or more) the news of the hub show in a column on the right. The list is read when the screen opens and every 20 seconds; F5 reads it at once. F4 switches to the saved list of direct connections, for development servers.
The hub address is the setting $pref::borne::hub of the client ($pref::borne::hubcert pins a self-signed hub), and hub_url in the settings of the RC tool. Until the project’s hub has an address the built-in default is empty.
The hub does not pass certificate fingerprints. A game server with a self-signed certificate is trusted the same way as without a hub (the first-use prompt, then a pinned entry), so a wrong hub can list a wrong address but cannot make a client trust a certificate.
Engine version 0.1.0. Built 2026-11-18.