Skip to content

Commit

Permalink
Make it clear that certain matrix_nginx_proxy_* variables are necessa…
Browse files Browse the repository at this point in the history
…ry for now, even with Traefik

Related to #2480
  • Loading branch information
spantaleev committed Feb 15, 2023
1 parent 0b9dc56 commit b648d45
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Expand Up @@ -74,14 +74,16 @@ 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

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.
Expand Down

0 comments on commit b648d45

Please sign in to comment.