mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2025-12-09 22:59:24 -05:00
Add a warning when using deprecated template_dir settings (#10768)
The deprecation itself happened in #10596 which shipped with Synapse v1.41.0. However, it doesn't seem fair to suddenly drop support for these settings in ~4-6w without being more vocal about said deprecation.
This commit is contained in:
parent
ae3c16318b
commit
8c9e723fe0
4 changed files with 42 additions and 0 deletions
|
|
@ -16,6 +16,7 @@
|
|||
|
||||
# This file can't be called email.py because if it is, we cannot:
|
||||
import email.utils
|
||||
import logging
|
||||
import os
|
||||
from enum import Enum
|
||||
from typing import Optional
|
||||
|
|
@ -24,6 +25,8 @@ import attr
|
|||
|
||||
from ._base import Config, ConfigError
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
MISSING_PASSWORD_RESET_CONFIG_ERROR = """\
|
||||
Password reset emails are enabled on this homeserver due to a partial
|
||||
'email' block. However, the following required keys are missing:
|
||||
|
|
@ -44,6 +47,14 @@ DEFAULT_SUBJECTS = {
|
|||
"email_validation": "[%(server_name)s] Validate your email",
|
||||
}
|
||||
|
||||
LEGACY_TEMPLATE_DIR_WARNING = """
|
||||
This server's configuration file is using the deprecated 'template_dir' setting in the
|
||||
'email' section. Support for this setting has been deprecated and will be removed in a
|
||||
future version of Synapse. Server admins should instead use the new
|
||||
'custom_templates_directory' setting documented here:
|
||||
https://matrix-org.github.io/synapse/latest/templates.html
|
||||
---------------------------------------------------------------------------------------"""
|
||||
|
||||
|
||||
@attr.s(slots=True, frozen=True)
|
||||
class EmailSubjectConfig:
|
||||
|
|
@ -105,6 +116,9 @@ class EmailConfig(Config):
|
|||
|
||||
# A user-configurable template directory
|
||||
template_dir = email_config.get("template_dir")
|
||||
if template_dir is not None:
|
||||
logger.warning(LEGACY_TEMPLATE_DIR_WARNING)
|
||||
|
||||
if isinstance(template_dir, str):
|
||||
# We need an absolute path, because we change directory after starting (and
|
||||
# we don't yet know what auxiliary templates like mail.css we will need).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue