zacheri/hytale-server repository overview

⁠

Docker Hytale Server

Docker image that provides a Hytale Server.

⁠Features

• Automatically downloads server files
• Extensive configuration of config.json via environment variables
• More to come!

⁠📖 Quick Start Guide

⁠Quick Start with Docker Compose

This example docker-compose.yml will create a server on the default port 5520 with 8GB of RAM.

1. Create a new folder and open it
2. Paste the following into new file named docker-compose.yml:

services:
  hytale:
    network_mode: "host"
    image: zacheri/hytale-server
    tty: true
    stdin_open: true
    ports:
      - "5520:5520"
    environment:
      - MEMORY=8G
      - PORT=5520
    volumes:
      - ./:/data
    restart: unless-stopped

1. First time setup requires some configuration. Run with docker compose up
2. Click the link in the terminal to authenticate via the Hytale website to complete the server file download
3. When the server is started as shown below, press Ctrl + C to stop it
4. Run docker compose up -d
5. Run docker ps and find the container ID
6. Run docker attach [container-id] as shown below
7. You're now in the server console. Run /auth login device and follow the authentication prompt similar to step 4.
8. OPTIONAL (but recommended): Run /auth persistence Encrypted. This will save your authentication so you don't have to run it every time the server starts.
9. You can now run Ctrl P, Q to detach from the Docker container.
10. You're done. Connect with your server's IP address on port 5520. You can stop the server with docker stop [container-id] and start it with docker compose up -d.

⁠Environment Variable Options

⁠🛠️ Troubleshooting

⁠⚠️ Disclaimer

Hytale is still in early access. Expect bugs and changes. This project is in no way affiliated with the Hytale team or Hypixel Studios Canada Inc.