Docker Compose Installation

The recommended way to run your Hytale server.

1. Create Project Directory

mkdir hytale-server
cd hytale-server

2. Create docker-compose.yml

services:
  hytale:
    image: ghcr.io/terkea/hytale-server:latest
    container_name: hytale-server
    ports:
      - "5520:5520/udp"
    environment:
      - SERVER_NAME=My Hytale Server
      - MOTD=Welcome to my server!
      - MAX_PLAYERS=50
      - MEMORY=4G
    volumes:
      - ./hytale-data:/data
    stdin_open: true
    tty: true
    restart: unless-stopped

3. Start the Server

docker compose up -d
docker logs -f hytale-server

4. Complete OAuth

Watch the logs for two OAuth prompts:

Download OAuth - Authorizes downloading game files
Server OAuth - Authenticates server for players

Visit the URLs shown and authorize with your Hytale account.

Tip: Press Ctrl+C to stop following logs. The server keeps running in the background.

Useful Commands

Command	Description
`docker compose up -d`	Start server in background
`docker compose down`	Stop server
`docker compose logs -f`	Follow server logs
`docker compose restart`	Restart server
`docker attach hytale-server`	Access server console