Getting Started

Gameye runs your game server as a Docker container. You push an image to Docker Hub, register it as an application on Gameye, and start sessions (one running container each) through the API. Gameye pulls your image onto nodes in the regions you choose, so a session starts in seconds.

Is your image on GitHub Container Registry (GHCR) instead? Follow Getting started with GHCR in place of step 1, then continue with step 2.

Prerequisites

Requirement	Details
Linux game server	A dedicated-server build of your game that runs headless on Linux (x86-64).
Docker	Docker installed on the machine you build images on.
Docker Hub repository	A Docker Hub repository for your server image. Private repositories need a Docker Hub plan that lets you add collaborators; see Docker pricing.
Gameye account	An Admin Panel login or an API token. Sign up at trial.gameye.com or contact Gameye support.

---

Setup steps

1. Set up Docker Hub: create a repository, give Gameye read access, and add the webhook that tells Gameye about new tags.
2. Create and push your Dockerfile: containerize your server, choose a network mode, and push the image.
3. Set up the Admin Panel: create your application, load an image tag, and test-start a container.
4. Start with the API: start, inspect and stop sessions from your own backend or matchmaker. In production, every session is started through the API.

You can do step 3 through the API instead: see Create an application.