MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-22 13:24:01 +01:00
Code Issues Projects Releases Wiki Activity

Clarify config template comments (#8891)

Browse source
This commit is contained in:
Richard van der Hoff 2020-12-08 14:03:08 +00:00 committed by GitHub
parent ff1f0ee094
commit 025fa06fc7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 9 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/8891.doc Normal file
View file

@ -0,0 +1 @@
Clarify comments around template directories in `sample_config.yaml`.

12
docs/sample_config.yaml
View file

@ -1879,11 +1879,8 @@ sso:
# - https://my.custom.client/ # - https://my.custom.client/
# Directory in which Synapse will try to find the template files below. # Directory in which Synapse will try to find the template files below.
# If not set, default templates from within the Synapse package will be used. # If not set, or the files named below are not found within the template
# # directory, default templates from within the Synapse package will be used.
# DO NOT UNCOMMENT THIS SETTING unless you want to customise the templates.
# If you *do* uncomment it, you will need to make sure that all the templates
# below are in the directory.
# #
# Synapse will look for the following templates in this directory: # Synapse will look for the following templates in this directory:
# #
@ -2113,9 +2110,8 @@ email:
#validation_token_lifetime: 15m #validation_token_lifetime: 15m
# Directory in which Synapse will try to find the template files below. # Directory in which Synapse will try to find the template files below.
# If not set, default templates from within the Synapse package will be used. # If not set, or the files named below are not found within the template
# # directory, default templates from within the Synapse package will be used.
# Do not uncomment this setting unless you want to customise the templates.
# #
# Synapse will look for the following templates in this directory: # Synapse will look for the following templates in this directory:
# #

5
synapse/config/emailconfig.py
View file

@ -390,9 +390,8 @@ class EmailConfig(Config):
#validation_token_lifetime: 15m #validation_token_lifetime: 15m
# Directory in which Synapse will try to find the template files below. # Directory in which Synapse will try to find the template files below.
# If not set, default templates from within the Synapse package will be used. # If not set, or the files named below are not found within the template
# # directory, default templates from within the Synapse package will be used.
# Do not uncomment this setting unless you want to customise the templates.
# #
# Synapse will look for the following templates in this directory: # Synapse will look for the following templates in this directory:
# #

7
synapse/config/sso.py
View file

@ -93,11 +93,8 @@ class SSOConfig(Config):
# - https://my.custom.client/ # - https://my.custom.client/
# Directory in which Synapse will try to find the template files below. # Directory in which Synapse will try to find the template files below.
# If not set, default templates from within the Synapse package will be used. # If not set, or the files named below are not found within the template
# # directory, default templates from within the Synapse package will be used.
# DO NOT UNCOMMENT THIS SETTING unless you want to customise the templates.
# If you *do* uncomment it, you will need to make sure that all the templates
# below are in the directory.
# #
# Synapse will look for the following templates in this directory: # Synapse will look for the following templates in this directory:
# #