infrastructure/roles/minecraft/README.md
2020-08-10 01:37:13 +02:00

37 lines
No EOL
1.3 KiB
Markdown

Minecraft
=========
Setup a Minecraft server container (https://github.com/itzg/docker-minecraft-server) with an optional RCON interface.
Requirements
------------
You will need to have docker, docker-compose and optionally traefik installed or declared as dependencies with their respective roles.
**This role assumes that (if your are using the RCON webinterface) you have setup traefik with an endpoint called `websecure`.**
Role Variables
--------------
**Please look at the [defaults/main.yml](defaults/main.yml) for all available variables and their description.**
**Note: Lines that are commented out via `#` are usually still valid/used variables, but they are not defined by default, so they might enable a feature, when uncommenting/defining them!**
### Global variables, that are used:
**Only when the webinterface is enabled:**
- `proxy_network`: Defined by the local traefik installation, this is the shared proxy network used by traefik to reach the containers. (optional)
- `proxy_hiddenservice`: Defined by the local traefik installation, this is used to generate the alt-svc header for the alternative Tor domain. (optional)
Dependencies
------------
- docker
- docker-compose
- traefik (optional, only when enabling the webinterface)
License
-------
GPL-3.0-only