Matrix-Mirrors/anonymousland-synapse
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse.git synced 2024-12-27 05:19:22 -05:00
Code Issues Packages Projects Releases Wiki Activity

Make it clearer that the template dir is relative to synapse's root dir (#5543)

Browse Source 
Helps address #5444
This commit is contained in:
Andrew Morgan 2019-06-27 18:20:17 +01:00 committed by GitHub
parent e79ec03165
commit c548dbc4b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/5543.misc Normal file
View File

@ -0,0 +1 @@
Make the config clearer in that email.template_dir is relative to the Synapse's root directory, not the `synapse/` folder within it.

10
docs/sample_config.yaml
View File

@ -1070,11 +1070,13 @@ password_config:
# app_name: Matrix # app_name: Matrix
# #
# # Enable email notifications by default # # Enable email notifications by default
# #
# notif_for_new_users: True # notif_for_new_users: True
# #
# # Defining a custom URL for Riot is only needed if email notifications # # Defining a custom URL for Riot is only needed if email notifications
# # should contain links to a self-hosted installation of Riot; when set # # should contain links to a self-hosted installation of Riot; when set
# # the "app_name" setting is ignored # # the "app_name" setting is ignored
# #
# riot_base_url: "http://localhost/riot" # riot_base_url: "http://localhost/riot"
# #
# # Enable sending password reset emails via the configured, trusted # # Enable sending password reset emails via the configured, trusted
@ -1087,16 +1089,22 @@ password_config:
# # # #
# # If this option is set to false and SMTP options have not been # # If this option is set to false and SMTP options have not been
# # configured, resetting user passwords via email will be disabled # # configured, resetting user passwords via email will be disabled
# #
# #trust_identity_server_for_password_resets: false # #trust_identity_server_for_password_resets: false
# #
# # Configure the time that a validation email or text message code # # Configure the time that a validation email or text message code
# # will expire after sending # # will expire after sending
# # # #
# # This is currently used for password resets # # This is currently used for password resets
# #
# #validation_token_lifetime: 1h # #validation_token_lifetime: 1h
# #
# # Template directory. All template files should be stored within this # # Template directory. All template files should be stored within this
# # directory # # directory. If not set, default templates from within the Synapse
# # package will be used
# #
# # For the list of default templates, please see
# # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
# # # #
# #template_dir: res/templates # #template_dir: res/templates
# #

10
synapse/config/emailconfig.py
View File

@ -233,11 +233,13 @@ class EmailConfig(Config):
# app_name: Matrix # app_name: Matrix
# #
# # Enable email notifications by default # # Enable email notifications by default
# #
# notif_for_new_users: True # notif_for_new_users: True
# #
# # Defining a custom URL for Riot is only needed if email notifications # # Defining a custom URL for Riot is only needed if email notifications
# # should contain links to a self-hosted installation of Riot; when set # # should contain links to a self-hosted installation of Riot; when set
# # the "app_name" setting is ignored # # the "app_name" setting is ignored
# #
# riot_base_url: "http://localhost/riot" # riot_base_url: "http://localhost/riot"
# #
# # Enable sending password reset emails via the configured, trusted # # Enable sending password reset emails via the configured, trusted
@ -250,16 +252,22 @@ class EmailConfig(Config):
# # # #
# # If this option is set to false and SMTP options have not been # # If this option is set to false and SMTP options have not been
# # configured, resetting user passwords via email will be disabled # # configured, resetting user passwords via email will be disabled
# #
# #trust_identity_server_for_password_resets: false # #trust_identity_server_for_password_resets: false
# #
# # Configure the time that a validation email or text message code # # Configure the time that a validation email or text message code
# # will expire after sending # # will expire after sending
# # # #
# # This is currently used for password resets # # This is currently used for password resets
# #
# #validation_token_lifetime: 1h # #validation_token_lifetime: 1h
# #
# # Template directory. All template files should be stored within this # # Template directory. All template files should be stored within this
# # directory # # directory. If not set, default templates from within the Synapse
# # package will be used
# #
# # For the list of default templates, please see
# # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
# # # #
# #template_dir: res/templates # #template_dir: res/templates
# #