infrastructure/.ansible/skeleton/default/README.md.j2

34 lines
1.1 KiB
Text
Raw Normal View History

2021-02-28 19:39:59 +01:00
{{ role_name }}
=========
This will setup {{ role_name }}.
Requirements
------------
~ADJUST~ You will need to have docker, docker-compose and traefik installed or declared as dependencies with their respective roles.
~ADJUST~ **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:
- ~ADJUST~ `proxy_network`: Defined by the local traefik installation, this is the shared proxy network used by traefik to reach the containers. (optional)
- ~ADJUST~ `proxy_hiddenservice`: Defined by the local traefik installation, this is used to generate the alt-svc header for the alternative Tor domain. (optional)
Dependencies
------------
- None
License
-------
GPL-3.0-only