Container Installation

Container installation

Method A: Docker CLI

Run this command in your terminal to start the server immediately:

docker run \
  --name hytale-server \
  -e SERVER_IP="0.0.0.0" \
  -e SERVER_PORT="5520" \
  -e PROD="FALSE" \
  -e DEBUG="FALSE" \
  -e TZ="Europe/Amsterdam" \
  -p 5520:5520/udp \
  -v "hytale-server:/home/container" \
  -v "/etc/machine-id:/etc/machine-id:ro" \
  --restart unless-stopped \
  -it \
  deinfreu/hytale-server:latest

Method B: Docker compose

Prepare a Directory: Create a dedicated folder inside your home directory to keep your project organized:
```
mkdir ~/hytale-server && cd ~/hytale-server
```

Configuration: Create a file named docker-compose.yml inside this new folder.

nano docker-compose.yml

Add this docker-compose.yml information to the file:

services:
  hytale:
    image: deinfreu/hytale-server:latest
    container_name: hytale-server
    environment:
      SERVER_IP: "0.0.0.0"
      SERVER_PORT: "5520"
      PROD: "FALSE"
      DEBUG: "FALSE"
      TZ: "Europe/Amsterdam"
    restart: unless-stopped
    ports:
      - "5520:5520/udp"
    volumes:
      - ./data:/home/container
      - /etc/machine-id:/etc/machine-id:ro
    tty: true
    stdin_open: true

Now get out of the nano text editor and save the file:

Operating System	Step 1: Write Out	Step 2: Confirm Filename	Step 3: Exit Editor
Linux / Windows (WSL)	Press Ctrl + O	Press Enter	Press Ctrl + X
macOS	Press Control + O	Press Return	Press Control + X

This data folder will be created on your host OS in the same directory as your docker-compose.yml file. Your game files, world data, and configurations are stored here and persist even if you stop or delete the Docker container. If you prefer to use volume mounts instead of bind mounts, see the volume mount example.

Run the docker compose file!
```
docker compose up
```
Do not use -d (detached mode). We need to use the terminal to authenticate the server.

Running a special OS like TrueNAS Scale, Unraid or Windows WSL2? Check out the Guide section for specific instructions!

Continue to the next steps →