diff options
| author | Brendan Abolivier <babolivier@matrix.org> | 2021-08-17 14:45:24 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-17 14:45:24 +0200 |
| commit | 56397599809e131174daaeb4c6dc18fde9db6c3f (patch) | |
| tree | 89143336c80709dcab3834eeae1af9d6de069254 /docs/upgrade.md | |
| parent | Attempt to pull from the legacy spaces summary API over federation. (#10583) (diff) | |
| download | synapse-56397599809e131174daaeb4c6dc18fde9db6c3f.tar.xz | |
Centralise the custom template directory (#10596)
Several configuration sections are using separate settings for custom template directories, which can be confusing. This PR adds a new top-level configuration for a custom template directory which is then used for every module. The only exception is the consent templates, since the consent template directory require a specific hierarchy, so it's probably better that it stays separate from everything else.
Diffstat (limited to 'docs/upgrade.md')
| -rw-r--r-- | docs/upgrade.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/upgrade.md b/docs/upgrade.md index 8831c9d6cf..1c459d8e2b 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -112,6 +112,17 @@ environment variable. See [using a forward proxy with Synapse documentation](setup/forward_proxy.md) for details. +## Deprecation of `template_dir` + +The `template_dir` settings in the `sso`, `account_validity` and `email` sections of the +configuration file are now deprecated. Server admins should use the new +`templates.custom_template_directory` setting in the configuration file and use one single +custom template directory for all aforementioned features. Template file names remain +unchanged. See [the related documentation](https://matrix-org.github.io/synapse/latest/templates.html) +for more information and examples. + +We plan to remove support for these settings in October 2021. + # Upgrading to v1.39.0 |