System Information

Version: -

Appearance

The panel's design for everyone, the login page included.

Games

Every game comes with GHS. Add a game to show it in the menu and when making servers (its files are downloaded when a server of it is made); hide it when you no longer host it.

Security

Admins without it set up are taken to set it up when they next sign in or reload the panel, and can do nothing else until they have. It cannot be turned off while this is on. Server managers can be required to use it one by one on the Users page.

Updates

Install a new GHS version from an update package (ghs-update-….zip, made by the "Build update package" workflow). The package is checked before anything changes. Installing saves the database, restarts the panel on the new version (about a minute) and goes back to the current version if the new one does not start. Game servers keep running; other nodes update their agent automatically afterwards.

Network & Domains

Players connect with subdomain.primary-domain:port (or a game's own domain, below). Add one wildcard DNS record (*.primary-domain → your public IP) and forward both port ranges (TCP and UDP) on your router once; new servers then need no DNS or router changes. Without a domain, set the players' address instead: players then connect with address:port. Servers in a proxy network are only reachable through their proxy.

Player Guard

Firewall rules on this machine in front of every game port (the port ranges above): servers here and the relay to servers on other nodes alike. It turns away addresses that open too many connections or open them too fast (join floods, bots), and keeps banned addresses out of every server. Players banned by name are under Global Bans.

Banned addresses

Game Servers and the Local Network

Firewall rules on every node stop game servers opening connections to this network and other private addresses: routers, NAS boxes, databases, the machines' own services and cloud metadata. A server's plugins and mods can then only reach the internet. Players on the local network still join, and proxies still reach their servers on other nodes.

Addresses Without a Port

A Java server can also be reached as survival.example.com, without its port: GHS keeps an SRV record for it at the DNS host of your domain. Turn it on per server in its Settings. Bedrock players always need the port.

HTTPS for the Panel

Reach the panel at https:// with a free Let's Encrypt certificate, renewed automatically. It keeps working over plain HTTP on this network as before. Servers' BlueMap web maps get HTTPS too, at https:// and the server's address (the wildcard record covers them).

1. A DNS record for the hostname below pointing at your public IP address (or a wildcard record for the primary domain, which already covers it)
2. Ports 80 and 443 (TCP) forwarded on your router to this machine
3. Optionally the ACME email above, for Let's Encrypt's notices

License Information

Controllers

Standby controllers on other machines keep a live copy of this panel's database, ready to take its place. With them, game servers run on nodes only, not on the controllers.

Public API

Let your own website or billing system create and run servers, with its own accounts and payments: it calls this panel's API with a key. API documentation · API tester

Backup Storage

Network storage for backups (SMB shares such as a UniFi UNAS, SFTP or FTP servers). Each server picks where its backups go in its backup settings; servers that don't choose use the default. Backups are zipped on this server, then stored on the target.

Panel Backups

Backs up the panel itself - its database (servers, users, settings, schedules) and its secret key - to a storage target on another machine, so the panel can be restored if this machine fails. A full backup also has the files of the servers on this machine, so everything comes back in one go: a new panel's first screen offers "Restore from a backup".

Email Notifications (SMTP)

Configure SMTP to receive email notifications for server events.

Discord Notifications

Send notifications to a Discord channel via webhook.

CurseForge API Configuration

Configure your CurseForge API key to enable mod and modpack downloads from CurseForge.

Steam Workshop

A Steam Web API key lets the panel search the Steam Workshop: tModLoader servers' Mods tab and Mods & Resources page get a Workshop browser, and adding a mod adds the mods it needs too. Without one, mods are still added by their Workshop ID or link.

How to get a key

1. Open steamcommunity.com/dev/apikey and sign in with your Steam account.
2. Enter a domain (your panel's address, for example panel.example.com) and register. Steam shows your key.
3. Copy the key, paste it below and click Save key. The panel checks it with Steam before saving it.

Notification Events

Choose which events trigger notifications.

Global Ban List

Players on this list are banned from all servers. Only admins can manage global bans.

Activity Logs

View all user actions and system events. Logs are preserved even after users or servers are deleted.

Account Information

Username:

Role:

Email Address

You can sign in with it instead of your username; password resets and alerts go to it.

Change Password

Where You're Signed In

Sign out of a device you no longer use, or everywhere but here if you think someone else has your password (then change it).