HUB
Sign inSign up

rxmarin/hytale-docker

By rxmarin

•Updated 8 months ago

https://github/romariin/hytale-docker

Image
3

10K+

rxmarin/hytale-docker repository overview

Hytale Docker

⁠Hytale Docker Server

Production-ready Docker container for Hytale dedicated servers

GitHub⁠ • Documentation⁠ • Discord Support⁠ • Report Bug⁠ • Request Feature⁠

Docker Java License Docs

Automated authentication • Auto-updates • CurseForge mods • Secure by default


⁠✨ Features

FeatureDescription
🚀 One-command startupJust docker compose up, authenticate once, play forever
🔐 OAuth2 AuthenticationDevice code flow with 30-day persistent tokens
🔄 Auto-updatesOptional automatic server updates on restart
🧩 CurseForge ModsAuto-sync mods with CF_MODS environment variable
💻 Unified CLISingle hytale command for auth, updates, mods, and server commands
🔒 Secure by defaultNon-root user, dropped capabilities, hardened container
⚡ Fast bootAOT cache support for quicker server startup
💾 Persistent dataWorlds, tokens, and mods survive restarts

⁠🚀 Quick Start

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.


⁠💻 CLI Usage

# 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

⁠🧩 CurseForge Mods

Auto-sync mods from CurseForge:

environment:
  CF_API_KEY: "${CF_API_KEY}"  # From .env file
  CF_MODS: "123456,789012"

See CurseForge documentation⁠ for setup.


⁠📖 Documentation

📚 hytale.romarin.dev⁠ — Full documentation


⁠⚙️ Environment Variables

VariableDefaultDescription
JAVA_OPTS-Xms4G -Xmx8GJVM memory options
AUTO_UPDATEfalseAuto-update server on restart
PATCHLINEreleaseRelease channel
USE_AOT_CACHEtrueFaster startup
CF_API_KEY—CurseForge API key
CF_MODS—Comma-separated mod IDs

See Configuration⁠ for all options.


⁠🏗️ Development

# 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

⁠📚 References


Made with ❤️ by romarin.dev⁠

Tag summary

Content type

Image

Digest

sha256:df214c900…

Size

148.8 MB

Last updated

8 months ago

docker pull rxmarin/hytale-docker