Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbrennand/mc-hetzner
Deploy a Minecraft PaperMC server on Hetzner using Terraform and Ansible.
https://github.com/dbrennand/mc-hetzner
ansible hetzner hetzner-cloud mc-hetzner minecraft minecraft-server papermc terraform
Last synced: 14 days ago
JSON representation
Deploy a Minecraft PaperMC server on Hetzner using Terraform and Ansible.
- Host: GitHub
- URL: https://github.com/dbrennand/mc-hetzner
- Owner: dbrennand
- License: mit
- Created: 2022-09-03T14:37:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-08T07:32:42.000Z (over 1 year ago)
- Last Synced: 2024-11-30T22:47:10.861Z (22 days ago)
- Topics: ansible, hetzner, hetzner-cloud, mc-hetzner, minecraft, minecraft-server, papermc, terraform
- Language: HCL
- Homepage:
- Size: 26.4 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mc-hetzner
Deploy a Minecraft [PaperMC](https://papermc.io/) server on [Hetzner](https://www.hetzner.com/cloud) using [Terraform](https://www.terraform.io/) and [Ansible](https://www.ansible.com/).
The Minecraft server is deployed as a [container](https://github.com/itzg/docker-minecraft-server) and using [GeyserMC](https://geysermc.org/) and [Floodgate](https://github.com/GeyserMC/Floodgate/), Minecraft Bedrock Edition players can also play on the Java edition server. Optionally, you can also deploy a [container](https://github.com/itzg/docker-mc-backup) to backup the Minecraft server world.
The default server deployed is [`cx21`](mc-hetzner.tf#L31). See [Hetzner Cloud](https://www.hetzner.com/cloud) for the full list of available server types.
## Prerequisites
* [Terraform](https://www.terraform.io/downloads)
* [Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-and-upgrading-ansible)
* [Hetzner Account](https://accounts.hetzner.com/signUp)
* [Hetzner API Token](https://docs.hetzner.com/cloud/api/getting-started/generating-api-token/)
## Playbook variables
```yaml
minecraft_image_tag: latest
```
The [itzg/minecraft-server](https://github.com/itzg/docker-minecraft-server) container image tag to use. See [itzg/minecraft-server/tags](https://hub.docker.com/r/itzg/minecraft-server/tags) for more available tags.
```yaml
minecraft_geysermc_download_url: https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/lastSuccessfulBuild/artifact/bootstrap/spigot/target/Geyser-Spigot.jar
minecraft_floodgate_download_url: https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/lastSuccessfulBuild/artifact/spigot/build/libs/floodgate-spigot.jar
```
The download URLs for the [GeyserMC](https://geysermc.org/) and [Floodgate](https://github.com/GeyserMC/Floodgate/) plugins. These plugins allow Minecraft Bedrock Edition players to play on a Java edition server.
```yaml
# All container environment variables can be found at: https://github.com/itzg/docker-minecraft-server#server-configuration
minecraft_options:
# ...
# Modify the below variables
# https://github.com/itzg/docker-minecraft-server#memory-limit
MEMORY: 2500M
# https://github.com/itzg/docker-minecraft-server#versions
VERSION: LATEST
# https://github.com/itzg/docker-minecraft-server#downloadable-world
WORLD: http://www.example.com/worlds/MySave.zip
# https://github.com/itzg/docker-minecraft-server#server-configuration
MOTD: A Minecraft Server created using https://github.com/dbrennand/mc-hetzner
# ...
```
The environment variables passed to the [itzg/minecraft-server](https://github.com/itzg/docker-minecraft-server) container. These environment variables configure the Minecraft server.
```yaml
minecraft_backup: false
```
Whether or not to deploy the [itzg/mc-backup](https://github.com/itzg/docker-mc-backup) container image to backup the Minecraft server world.
```yaml
minecraft_backup_image_tag: latest
```
The [itzg/mc-backup](https://github.com/itzg/docker-mc-backup) container image tag to use. See [itzg/mc-backup/tags](https://hub.docker.com/r/itzg/mc-backup/tags) for more available tags.
```yaml
# All container environment variables can be found at: https://github.com/itzg/docker-mc-backup#common-variables
minecraft_backup_options:
# ...
# Modify the below variables
BACKUP_INTERVAL: 24h
INITIAL_DELAY: 5m
BACKUP_METHOD: restic
RESTIC_REPOSITORY: b2:
# ...
```
The environment variables passed to the [itzg/mc-backup](https://github.com/itzg/docker-mc-backup) container. These environment variables configure backups for the Minecraft server world.
## Usage
1. Install the required Ansible roles:
```bash
ansible-galaxy install -r requirements.yml
```
2. Create the `mc_hetzner` SSH key pair:
```bash
ssh-keygen -f ~/.ssh/mc_hetzner -t rsa -b 4096 -N ""
```
3. Modify the Ansible playbook [vars](vars/main.yml#L24) file to configure the Minecraft server Docker container and backup container.
4. Initialise the [hcloud](https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs) Terraform provider:
```bash
terraform init
```
5. Deploy the server:
```bash
# Using defaults
terraform apply -var="hcloud_token="
# Example: Overriding the default server_type
terraform apply -var="hcloud_token=" -var="server_type=cx31"
```
6. Enjoy ✨
## FAQs
### How do I reconfigure the Minecraft or Backup container?
Later down the line, you may want to modify the Minecraft server container or backup container's environment variables.
To re-run the creation of either without running the entire playbook, use the tags as below:
```bash
ansible-playbook -u mc-hetzner -i "", --private-key ~/.ssh/mc_hetzner --tags "minecraft,backup" mc-hetzner.yml
```
### How do I whitelist a Minecraft Bedrock Edition player using Floodgate?
```bash
ansible all -u mc-hetzner -i "", --private-key ~/.ssh/mc_hetzner -m ansible.builtin.command -a "docker exec minecraft rcon-cli fwhitelist add "
```
## How do Minecraft Bedrock Edition players on console connect to the server?
There are several options for Minecraft Bedrock Edition players on console to connect to the server:
1. Use a CLI application such as [jhead/phantom](https://github.com/jhead/phantom).
2. Use a mobile application such as [MC Server Connector](https://play.google.com/store/apps/details?id=com.smokiem.mcserverconnector&hl=en_GB&gl=US) or [BedrockTogether](https://apps.apple.com/us/app/bedrocktogether/id1534593376)
## Authors & Contributors
* [**dbrennand**](https://github.com/dbrennand) - *Author*
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) for details.