DOCKERHUB.md

Simply use the docker run command or docker compose, follow the authentication steps in the terminal, and your server will be ready in seconds. Designed by a community of 10+ contributors, this image prioritizes stability, security, and performance, allowing you to focus on managing your world rather than debugging your environment.

Warning

A valid Hytale game license is required for container authorization.

On the first launch, the server will display an authentication URL in your terminal. Open this link in your browser, log in with your Hytale account, and follow the instructions to authorize the server.

Quick start

Docker run

Tip

container image: "alpine-liberica" provides the smallest footprint and fastest startup time.

docker run \
  --name hytale-server \
  -p 5520:5520/udp \
  -v "hytale-server:/home/container" \
  -v "/etc/machine-id:/etc/machine-id:ro" \
  --restart unless-stopped \
  deinfreu/hytale-server:latest

Docker compose

Important

You need to run docker compose up without the "-d" flag for terminal-based authorization.

services:
  hytale:
    image: deinfreu/hytale-server:latest
    container_name: hytale-server
    restart: unless-stopped
    ports:
      - "5520:5520/udp"
    volumes:
      - ./data:/home/container
      - /etc/machine-id:/etc/machine-id:ro
    tty: true
    stdin_open: true

For additional deployment configurations, see our examples or refer to the installation and OS-specific guides.

File structure

Once the initial run is complete, your server-files directory will be populated with the following structure:

data/
├── Server/
│   ├── .cache/
│   ├── Licenses/
│   ├── logs/
│   ├── mods/
│   ├── telemetry/
│   ├── universe/
│   ├── auth.enc
│   ├── auth.key
│   ├── bans.json
│   ├── config.json
│   ├── config.json.bak
│   ├── HytaleServer.aot.config
│   ├── HytaleServer.jar
│   ├── permissions.json
│   └── whitelist.json
├── .hytale-downloader-credentials.json
└── Assets.zip

Support & Resources

Support:

• OS Specific installation guide at hytale-server-container.com/guide.
• Full installation guide available at hytale-server-container.com/installation.
• Enviroment variables and more: hytale-server-container.com/technical.

Troubleshooting:

• For frequently asked questions: hytale-server-container.com/faq
• Join our community and ask your question! Discord Community
• To check what is actively happening to this github repo and what is planned GitHub Issues