Getting Started

Introduction

This docker image provides a Hytale that will automatically download the latest server files, keep them updated, and lets you configure it via environment variables.

Quickstart

To use the lastest version run the following command:

docker run -d -it -p 5520:5520/udp ghcr.io/f-gillmann/hytale-docker

which will start the server on the default Hytale port 5520 using UDP.

Persistent Data

The container will store all data inside the /data directory. You can mount the directory from your host machine or a managed volume.

When using docker run you can simple add the -v option alongside the path:

docker run ... -v /path/to/dir:/data ghcr.io/f-gillmann/hytale-docker

When using docker-compose you can add a volumes section to the service:

docker-compose.yml

services:
  hytale:
    # other configuration ...
    volumes:
      # relative './data' directory mapped to '/data' in the container
      - ./data:/data

Docker Compose

1. Create a new file named docker-compose.yml in a directory of your choice.

2. Add the contents below to the file

   docker-compose.yml

   services:
     hytale:
       image: ghcr.io/f-gillmann/hytale-docker
       container_name: hytale
       restart: unless-stopped
       ports:
         - "5520:5520/udp"

3. Run docker-compose up -d in the same directory

4. The server will start detached in the background

Authentication

You need to authorize the server and hytale-downloader to allow them to download updates and make players able to join your server when using online mode.

For a detailed guide on how to set this up, check out the authentication guide:

Authentication Guide Learn how to authenticate your Hytale server.

Next Steps

Environment Variables Learn about the available environment variables to configure your server.

Data Directory Understand the structure of the data directory and how to manage your server data.