Quick Start

Get your Hytale server up and running in just a few minutes.

Prerequisites

Docker installed (version 20.10+)
A Hytale account for authentication
UDP port 5520 available

Requirement	Details
Java	25+ (included in image)
RAM	4GB minimum, 8GB+ recommended
Disk	~2GB for server files
Network	UDP port 5520

Create docker-compose.yml

Create a new directory and add this docker-compose.yml:

services:
  hytale:
    image: rxmarin/hytale-docker:latest
    container_name: hytale-server
    restart: unless-stopped
    stdin_open: true
    tty: true
    ports:
      - "5520:5520/udp"
    environment:
      JAVA_OPTS: "-Xms4G -Xmx8G"
      AUTO_UPDATE: "true"
    volumes:
      - hytale-data:/server

volumes:
  hytale-data:

Start the Server

docker compose up -d
docker compose logs -f

Authenticate

On first run, you'll see a device authorization prompt:

═══════════════════════════════════════════════════════════
  DEVICE AUTHORIZATION REQUIRED
═══════════════════════════════════════════════════════════
  Visit: https://accounts.hytale.com/device
  Code:  XXXX-XXXX
═══════════════════════════════════════════════════════════

Visit the URL in your browser
Log in with your Hytale account
Enter the verification code
Authorize the server

The server starts automatically after authorization.

Connect

Open Hytale and connect to:

your-ip:5520

Hytale uses QUIC over UDP (not TCP). Forward UDP port 5520 on your firewall/router.

Server Management

# View logs
docker compose logs -f

# Stop server
docker compose down

# Restart server
docker compose restart

# Send commands
docker exec -it hytale-server hytale cmd /help
docker exec -it hytale-server hytale cmd /list

# Check auth status
docker exec -it hytale-server hytale auth status

# Check for updates
docker exec -it hytale-server hytale update check

What Happens on Startup

Load tokens — Existing tokens from /server/.hytale/tokens/
Authenticate — Device code flow if no tokens exist
Download server — If new or update available (with AUTO_UPDATE=true)
Sync mods — CurseForge mods if configured
Create session — Game session with selected profile
Start server — Java process with session tokens
Background refresh — Daemon keeps tokens valid

Next Steps

Configuration — All environment variables
CLI Reference — Command-line interface
CurseForge Mods — Auto-sync mods
Troubleshooting — Common issues

Quick Start

On this page