37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
Matrix-Elementweb
|
|
=========
|
|
|
|
This will setup a [Element Web](https://github.com/vector-im/element-web) instance using the 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 copy the appservice's registration file to your homeserver's directory and enable it in the config for this appservice to work!**
|
|
|
|
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
|