infrastructure/roles/minecraft_blockmap/README.md
saibotk a47fde9c9c
Rename roles to underscore
This patch renames all roles with a `-` to `_`, to comply with the ansible-lint rule 106. As collection roles are now also limited to these symbols and this will make it easier to move them later.
2020-09-26 18:12:59 +02:00

37 lines
No EOL
1.3 KiB
Markdown

Minecraft-Blockmap
=========
This will setup a Blockmap render job using the Blockmap container and automatically render the provided Minecraft world. The render result then is made available with an nginx container and traefik.
Requirements
------------
You will need to have docker, docker-compose and traefik installed or declared as dependencies with their respective roles.
Also currently the container expects you to use LVM with enough space for a snapshot.
**This role assumes that 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:
- `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
License
-------
GPL-3.0-only