⚠️ The latest release is unstable — use preview builds instead
Skip to content

Server Operations

Management Interfaces

InterfaceAccessBest For
Your Game ClientCo-op → Enter Invite CodePlaying and testing — just connect like any multiplayer game
CLI Consoledocker compose exec server attach-cliServer commands, logs, invite codes
Chat CommandsIn-game chatPlayer management, admin tasks
REST APIHTTP requestsAutomation, external tools
VNC Web InterfaceBrowser at http://server:5800Advanced debugging only (disabled by default)

Common Tasks

Starting and Stopping

sh
# Start the server
docker compose up -d

# Stop the server
docker compose down

# View logs
docker compose logs -f

# Restart
docker compose restart

Server Status

Check if the server is running:

sh
docker compose ps

Get detailed server info via CLI:

sh
docker compose exec server attach-cli
# Then type: info

Save Management

Save files are stored in the saves Docker volume. See Backup & Recovery for backup and restore procedures.

Guides

Released under the MIT License.