infrastructure/roles/matrix_maubot/README.md
2021-08-26 14:46:31 +02:00

1.2 KiB

Matrix-maubot

This will setup a Matrix Maubot instance using their official docker container and traefik as a reverse proxy.

Requirements

You will need to have docker, docker-compose and traefik installed or declared as dependencies with their respective roles.

This role assumes that you have setup traefik with an endpoint called websecure.

You will also need to manually setup the services configuration file!

Role Variables

Please look at the 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