Getting Started
This guide walks you through the full setup process. Gameye uses Docker containers to distribute game-server workloads across regions worldwide — you push an image to Docker Hub, and the orchestrator pulls it onto nodes where containers can be started on demand. Most teams are up and running within a few hours.
Prerequisites
Section titled “Prerequisites”Before you begin, make sure you have:
| Requirement | Details |
|---|---|
| Game server binary | A working game-server executable that runs on Linux. |
| Docker installed | A machine with Docker installed (Linux or Windows). |
| Docker Hub account | A Team or Large Docker Hub plan so you can create private repositories and add collaborators. |
| Gameye credentials | An API token or Admin Panel login. Contact [email protected] or request access at gameye.com/get-access. |
Setup steps
Section titled “Setup steps”Follow these four steps in order:
- Set up Docker Hub — Create a repository, grant Gameye read access, and configure the webhook.
- Create and push your Dockerfile — Containerize your game server, choose your networking mode, and push the image.
- Set up the Admin Panel — Sign in to the Gameye Admin panel to create your application and configure its image, networking, resources, and regions. You can also test-start a container here to verify everything is working before going live.
- Start with the API — In production, all session starts happen through the API. This step shows you how to make your first API call to launch a session programmatically.