Build from source

Build the management panel from source, then connect your game hosts.

1. Prepare the environment

• The management panel requires Node.js 22.13+, npm 10+, and Git.
• Linux hosts also need Python 3, gcc, g++, and make for native dependencies.
• Install and start Docker on game hosts beforehand: Docker Engine on Linux, or Docker Desktop with Linux container support on macOS and Windows.
• Port 3000 must be available on the host running the panel.

2. Download and install

Run with a regular account on the host where you want to install the management panel:

git clone --branch release/v1.2.0 --depth 1 https://github.com/gamex-sh/gamex-panel.git gamex-panel
cd gamex-panel
npm ci --audit=false --fund=false
npm run build

3. Start the panel

Continue in the same terminal:

npm start

For a local installation, open http://localhost:3000/setup; for a remote server, allow port 3000 in the firewall and cloud security group, then open http://SERVER_IP:3000/setup. Follow the guide to create the administrator account and complete setup.

If you prefer to keep the port closed, use SSH forwarding; HTTPS is recommended for public access.

4. Connect a game host

Follow Connect a node on each game host, using a Panel address it can reach. Once the node is online with Running Docker, create a game server on it.

For startup on boot, logs, and stopping services, see Deployment management.