Getting started
New to Catalyst? What is Catalyst? explains the panel, node, and server, and the terminology guide fixes the vocabulary. Then create your first game server in minutes.
Catalyst Documentation
Run game servers without the guesswork. Create servers, manage files and backups, and automate everything through the API.
Install the panel
Section titled “Install the panel”On a fresh Linux host, run this from a root shell. The installer installs Docker
when needed, writes a configured .env with generated secrets, and leaves the
stack ready to start:
curl -fsSL https://github.com/catalystctl/catalyst/releases/latest/download/install.sh | sudo bashThen bring the stack up and finish setup. Check
system requirements first, and add a
node before you create game servers. To pin a
release, replace latest in the URL with a release tag; the installer can also
verify its own checksum.
Start here
Section titled “Start here”Game server guide
Console, power controls, files, SFTP, backups, databases, tasks, networking, and sharing your server with others. Open the guide.
Administrator guide
Install the panel, register nodes, configure networking and storage, manage users and roles, and keep everything updated. Open the guide.
API & developers
Authenticate, call endpoints, handle errors and pagination, and subscribe to realtime events. Open the API docs.
Something broken?
Section titled “Something broken?”Head straight to troubleshooting for server, node, panel, and networking issues, or look up a specific message in common errors.