Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit c548dbc

Browse files
Make it clearer that the template dir is relative to synapse's root dir (#5543)
Helps address #5444
1 parent e79ec03 commit c548dbc

File tree

3 files changed

+19
-2
lines changed

3 files changed

+19
-2
lines changed

changelog.d/5543.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Make the config clearer in that email.template_dir is relative to the Synapse's root directory, not the `synapse/` folder within it.

docs/sample_config.yaml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1070,11 +1070,13 @@ password_config:
10701070
# app_name: Matrix
10711071
#
10721072
# # Enable email notifications by default
1073+
# #
10731074
# notif_for_new_users: True
10741075
#
10751076
# # Defining a custom URL for Riot is only needed if email notifications
10761077
# # should contain links to a self-hosted installation of Riot; when set
10771078
# # the "app_name" setting is ignored
1079+
# #
10781080
# riot_base_url: "http://localhost/riot"
10791081
#
10801082
# # Enable sending password reset emails via the configured, trusted
@@ -1087,16 +1089,22 @@ password_config:
10871089
# #
10881090
# # If this option is set to false and SMTP options have not been
10891091
# # configured, resetting user passwords via email will be disabled
1092+
# #
10901093
# #trust_identity_server_for_password_resets: false
10911094
#
10921095
# # Configure the time that a validation email or text message code
10931096
# # will expire after sending
10941097
# #
10951098
# # This is currently used for password resets
1099+
# #
10961100
# #validation_token_lifetime: 1h
10971101
#
10981102
# # Template directory. All template files should be stored within this
1099-
# # directory
1103+
# # directory. If not set, default templates from within the Synapse
1104+
# # package will be used
1105+
# #
1106+
# # For the list of default templates, please see
1107+
# # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
11001108
# #
11011109
# #template_dir: res/templates
11021110
#

synapse/config/emailconfig.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,11 +233,13 @@ def generate_config_section(self, config_dir_path, server_name, **kwargs):
233233
# app_name: Matrix
234234
#
235235
# # Enable email notifications by default
236+
# #
236237
# notif_for_new_users: True
237238
#
238239
# # Defining a custom URL for Riot is only needed if email notifications
239240
# # should contain links to a self-hosted installation of Riot; when set
240241
# # the "app_name" setting is ignored
242+
# #
241243
# riot_base_url: "http://localhost/riot"
242244
#
243245
# # Enable sending password reset emails via the configured, trusted
@@ -250,16 +252,22 @@ def generate_config_section(self, config_dir_path, server_name, **kwargs):
250252
# #
251253
# # If this option is set to false and SMTP options have not been
252254
# # configured, resetting user passwords via email will be disabled
255+
# #
253256
# #trust_identity_server_for_password_resets: false
254257
#
255258
# # Configure the time that a validation email or text message code
256259
# # will expire after sending
257260
# #
258261
# # This is currently used for password resets
262+
# #
259263
# #validation_token_lifetime: 1h
260264
#
261265
# # Template directory. All template files should be stored within this
262-
# # directory
266+
# # directory. If not set, default templates from within the Synapse
267+
# # package will be used
268+
# #
269+
# # For the list of default templates, please see
270+
# # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
263271
# #
264272
# #template_dir: res/templates
265273
#

0 commit comments

Comments
 (0)