Make it clear that certain matrix_nginx_proxy_* variables are necessary for now, even with Traefik

Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2480
This commit is contained in:
Slavi Pantaleev 2023-02-15 07:30:36 +02:00
parent 0b9dc56edf
commit b648d4579f

View File

@ -74,7 +74,7 @@ Unless we have some regression, **existing users should be able to update their
#### How do I explicitly switch to Traefik right now?
**Users who want to migrate to Traefik** today, can do so by using configuration like this:
**Users who wish to migrate to Traefik** today, can do so by **adding** this to their configuration:
```yaml
matrix_playbook_reverse_proxy_type: playbook-managed-traefik
@ -82,6 +82,8 @@ matrix_playbook_reverse_proxy_type: playbook-managed-traefik
devture_traefik_ssl_email_address: YOUR_EMAIL_ADDRESS
```
You may still need to keep certain old `matrix_nginx_proxy_*` variables (like `matrix_nginx_proxy_base_domain_serving_enabled`), even when using Traefik. For now, we recommend keeping all `matrix_nginx_proxy_*` variables just in case. In the future, reliance on `matrix-nginx-proxy` will be removed.
Switching to Traefik will obtain new SSL certificates from Let's Encrypt (stored in `/devture-traefik/ssl/acme.json`). **The switch is reversible**. You can always go back to `playbook-managed-nginx` if Traefik is causing you trouble.
**Note**: toggling `matrix_playbook_reverse_proxy_type` between Traefik and nginx will uninstall the Traefik role and all of its data (under `/devture-traefik`), so you may run into a Let's Encrypt rate limit if you do it often.