# HyOS - Hytale Server

HyOS - Hytale Server is a self-hosted game servers app. Hytale dedicated game server with web management UI, OAuth authentication, auto-updates, mod support, and REST API for server control. It is open source and self-hosted, installable on TrueNAS.

Canonical page: https://ourlocalhost.com/app/4407/hyos-hytale-server

## Description

Hytale dedicated game server with web management UI, OAuth authentication, auto-updates, mod support, and REST API for server control.

## Platform availability

Available on 1 of 10 platforms: TrueNAS.

## Health score

37/100 (Low), based on 4 of 4 factors.
- Maintained: 56 (last commit 191 days ago)
- Popular: 21 (10 GitHub stars)
- Easy to install: 25 (1 install platform, install notes)
- Light to run: 30 (4 GB minimum RAM)

## Links

- GitHub: https://github.com/editmysave/hyOS
- Documentation: https://hyos.io/docs
- TrueNAS: https://apps.truenas.com/catalog/hyos/
- Official website: https://hyos.io

## Common questions

### Which ports should I open for Hytale gameplay and the HyOS dashboard?

Expose UDP port 30380 for game traffic. The web management UI is available on port 30382 over HTTP.

### What dataset and permission settings are needed for HyOS storage on TrueNAS?

Create a dataset for server data and set ACL permissions for user 568 and group 568. Update both services in the YAML to use that dataset path.

### What API password requirements apply to HyOS management?

Set API_CLIENT_SECRET to a secure password with a minimum of 8 characters. API_CLIENT_ID defaults to hyos-manager.

### How much memory should I plan for when running HyOS on TrueNAS?

The TrueNAS install guidance recommends at least 8GB of system memory. The compose example defaults Java to 1G minimum and 3G maximum.

### Does the HyOS compose example enable automatic updates by default?

The example sets AUTO_UPDATE to false by default. HyOS includes automated update functionality.

### How does HyOS handle mods?

HyOS provides mod management and content-only mod patching through its server management features.

---
Source: Our Local Host (https://ourlocalhost.com/app/4407/hyos-hytale-server), the self-hosted and open-source app directory.
