🐳 Hytale Docker Server
Welcome to the official documentation for the shotah/hytale-server. This project provides a high-performance, containerized environment for hosting Hytale servers with ease, featuring automated binary management cross-platform and Pterodactyl support.
To get the most performance out of your server, I suggest taking a look at the optimizations page!
✨ Key Features
- 🚀 Fast server startup: Startup your server in 7 seconds with
CACHE=TRUE - ⚡ Easy Deployment: Go to the installation pages to get started
- 🤖 Smart CLI: Includes the
hytale-downloadertool to manage server binaries and check for updates automatically. You can just use “hytale-downloader” in the terminal to accecs it. - 🍓 Multi-Arch Support: Optimized for
x86_64(ARM64coming soon more info). - 🛠️ Diagnostic Suite: Built-in debug mode to audit your network and security settings automatically.
- 📉 Slim Images: Optimized, lightweight image variants for production environments.
🚀 Getting Started
Ready to host your world? Follow our step-by-step guides to get started:
- Requirements: Hytale game license necessary.
- System Requirements: Check if your hardware is ready.
- Container Installation: Deploy your first server using CLI or Compose.
- Running the server: Explanation how to run the setup and run the hytale server.
- Debug: Learn how to debug your installation.
- Support: Is your installation not working?
- Optimizations: Want to go fast? Read here about all the optimizations.
📚 Examples
Ready-to-use Docker Compose configurations for common setups:
| Example | Description |
|---|---|
| Basic Server | Minimal configuration to get started |
| CurseForge Mods | Auto-download mods from CurseForge |
| Pre-release | Run the latest pre-release server |
| Private Server | Password + whitelist protected |
| Full-Featured | All environment variables documented |
Browse all examples in the examples folder.
🆘 Need Help?
If you run into trouble, we have resources available:
- Frequently Asked Questions: Common fixes for connection and time-zone issues.
- GitHub Issues: Report bugs or request new features.
- Discussions: Connect with other Hytale server owners.
🙏 Credits & Acknowledgments
This project is a fork of the excellent work by deinfreu:
| Original Repository | deinfreu/hytale-server-container |
| Original Author | @deinfreu |
| Contributors | View all contributors |
Thank you to deinfreu and the original contributors for building this container’s foundation!
Disclaimer: This project is not affiliated with HYPIXEL STUDIOS CANADA INC. A valid Hytale license is required to download the server binaries.