Server setup
A Borne server is one program, borne-server, and a PostgreSQL database. Engine data (accounts, flags, scripts, bans) lives in PostgreSQL 15 or newer. Levels, images, and script databases live in a data folder.
What you need
Section titled “What you need”- PostgreSQL 15 or newer, and a database with a user that can create tables.
- A folder for the data. The sample world in
sample-world/is a ready example. - A signing key and a cache secret for a public server (keys and TLS).
Run the program
Section titled “Run the program”borne-server --config server.toml run--config names the configuration file and defaults to server.toml in the current folder. A relative server.data_dir is resolved against the folder of that file. The environment variable BORNE_DATABASE_URL overrides database.url.
Every key is described in configuration; deploy/server.example.toml is a complete example to copy.
First start
Section titled “First start”On the first start the server:
- connects to the database and applies the migrations in order. It refuses to start when the database has a newer migration than it knows;
- loads the scripts from the data folder when the database has none (weapons, NPCs, classes);
- creates a self-signed TLS certificate under
<data_dir>/tlswhen you did not configure one, and prints its SHA-256 fingerprint. Give the fingerprint to your players; - prints a hint with the
grant-staffcommand when there is no staff account yet (staff bootstrap).
The server stops cleanly on SIGTERM. It stops accepting logins, logs every player out, writes everything to the database, and exits. It waits at most 30 seconds.
Development mode
Section titled “Development mode”--dev allows plain ws:// connections from the same computer, generates a development cache secret, and, when security.signing_key is not set, signs scripts with the public development key that development client builds trust. Use it only on your own machine:
BORNE_DATABASE_URL=postgres://borne:change-me@localhost/borne \ borne-server --config sample-world/server.toml --dev runDocker
Section titled “Docker”deploy/docker-compose.yml starts the server and PostgreSQL, each with a named volume, and checks that they are healthy.
docker compose -f deploy/docker-compose.yml up -d --waitdocker compose -f deploy/docker-compose.yml down- Set
POSTGRES_PASSWORDin the environment. The defaultchange-meis for tests only. - Copy
signing.keyandcache.secretinto theserver-secretsvolume. The volume is mounted read-only at/etc/borne/secrets. - The game port is
14900. PostgreSQL is not published. deploy/docker-compose.sample.ymladds the sample world with generated development keys:
BORNE_UID=$(id -u) BORNE_GID=$(id -g) \ docker compose -f deploy/docker-compose.yml -f deploy/docker-compose.sample.yml up --waitUpdating
Section titled “Updating”Stop the server, back up the database and the data folder (backups), install the new version, and start it. The migrations run by themselves.
Engine version 0.1.0. Built 2026-11-18.