Production-ready Docker container for Hytale dedicated servers
GitHub • Documentation • Discord Support • Report Bug • Request Feature
Automated authentication • Auto-updates • CurseForge mods • Secure by default
| Feature | Description |
|---|---|
| 🚀 One-command startup | Just docker compose up, authenticate once, play forever |
| 🔐 OAuth2 Authentication | Device code flow with 30-day persistent tokens |
| 🔄 Auto-updates | Optional automatic server updates on restart |
| 🧩 CurseForge Mods | Auto-sync mods with CF_MODS environment variable |
| 💻 Unified CLI | Single hytale command for auth, updates, mods, and server commands |
| 🔒 Secure by default | Non-root user, dropped capabilities, hardened container |
| ⚡ Fast boot | AOT cache support for quicker server startup |
| 💾 Persistent data | Worlds, tokens, and mods survive restarts |
Create a 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 # Watch for auth prompt
On first run, you'll see a device authorization prompt. Visit the URL, enter the code, and authorize. The server starts automatically.
Connect to your-ip:5520 using the Hytale client.
Note: Hytale uses QUIC over UDP (not TCP). Forward UDP port 5520 on your firewall.
# Auth
docker exec -it hytale-server hytale auth status
docker exec -it hytale-server hytale auth login
# Server commands
docker exec -it hytale-server hytale cmd /help
docker exec -it hytale-server hytale cmd /list
# Updates
docker exec -it hytale-server hytale update check
docker exec -it hytale-server hytale update schedule
# CurseForge mods
docker exec -it hytale-server hytale mods list
Auto-sync mods from CurseForge:
environment:
CF_API_KEY: "${CF_API_KEY}" # From .env file
CF_MODS: "123456,789012"
See CurseForge documentation for setup.
📚 hytale.romarin.dev — Full documentation
| Variable | Default | Description |
|---|---|---|
JAVA_OPTS | -Xms4G -Xmx8G | JVM memory options |
AUTO_UPDATE | false | Auto-update server on restart |
PATCHLINE | release | Release channel |
USE_AOT_CACHE | true | Faster startup |
CF_API_KEY | — | CurseForge API key |
CF_MODS | — | Comma-separated mod IDs |
See Configuration for all options.
# Build the image locally
docker build -t hytale-server:latest .
# Run locally with Bun
bun run src/main.ts
# Run documentation site
cd docs && pnpm install && pnpm dev
Made with ❤️ by romarin.dev
Content type
Image
Digest
sha256:df214c900…
Size
148.8 MB
Last updated
8 months ago
docker pull rxmarin/hytale-docker