Docker Compose deployment

Install GameX on one Linux host using a configuration file.

The template uses latest image tags by default. To install a fixed version, change :latest on both Panel and Daemon images to the target tag, such as :1.2.0.

1. Prepare the environment

• Linux amd64 or arm64; this single-host template requires Linux Docker Engine and does not support Docker Desktop.
• Install and start Docker Engine 28+ and install Docker Compose 2.24+ beforehand.
• curl is installed, your account can use Docker, the server can pull GameX images from GHCR, and port 3000 is available.

2. Download the configuration

Create an installation directory on the server and download the configuration:

mkdir -p ~/gamex-compose
cd ~/gamex-compose
curl -fSL https://docs.gamexserver.com/install/compose.yaml -o compose.yaml

3. Start the services

Run from the installation directory:

docker compose config --quiet
docker compose pull
docker compose up -d
docker compose ps

Confirm that both services have started. Daemon waits for Panel setup before pairing; an offline local node before setup is complete does not mean the container failed.

4. Open the management panel

For a local installation, open http://localhost:3000/setup; for a remote server, expose the panel port first, then open http://SERVER_IP:3000/setup. Follow the guide to create the administrator account and sign in.

Panel creates Local Docker and pairs the local Daemon automatically. Confirm that it is online under Nodes and Docker status is Running, then create a game server.

HTTPS is recommended for public access.

SSH forwarding (optional)

On your own computer, replace user@host.example with the server's SSH user and address, then run:

ssh -N -L 3000:127.0.0.1:3000 user@host.example

Keep the connection open and visit http://localhost:3000/setup on your own computer.

Configuration and game data stay on the server, so back up before upgrading; see Deployment management for logs, restarting, and stopping services.