diff options
| author | Andrew Morgan <andrew@amorgan.xyz> | 2019-06-05 13:36:56 +0100 |
|---|---|---|
| committer | Andrew Morgan <andrew@amorgan.xyz> | 2019-06-05 13:36:56 +0100 |
| commit | a862f2adc430010ac15d3734412f1b108582e6e4 (patch) | |
| tree | 12561b375af0e75ca9b78755a400936ed5be888f | |
| parent | Update unit test template dir (diff) | |
| download | synapse-a862f2adc430010ac15d3734412f1b108582e6e4.tar.xz | |
gen sample config
| -rw-r--r-- | docs/sample_config.yaml | 57 |
1 files changed, 46 insertions, 11 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 493ea9ee9e..859df5b636 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -1018,33 +1018,68 @@ password_config: -# Enable sending emails for notification events or expiry notices -# Defining a custom URL for Riot is only needed if email notifications -# should contain links to a self-hosted installation of Riot; when set -# the "app_name" setting is ignored. +# Enable sending emails for password resets, notification events or +# account expiry notices # # If your SMTP server requires authentication, the optional smtp_user & # smtp_pass variables should be used # #email: -# enable_notifs: false # smtp_host: "localhost" -# smtp_port: 25 +# smtp_port: 25 # SSL: 465, STARTTLS: 587 # smtp_user: "exampleusername" # smtp_pass: "examplepassword" # require_transport_security: False # notif_from: "Your Friendly %(app)s Home Server <noreply@example.com>" # app_name: Matrix -# # if template_dir is unset, uses the example templates that are part of -# # the Synapse distribution. +# +# # Enable sending email notifications for new chat messages +# # +# enable_notifs: False +# +# # Enable email notifications by default +# notif_for_new_users: True +# +# # Defining a custom URL for Riot is only needed if email notifications +# # should contain links to a self-hosted installation of Riot; when set +# # the "app_name" setting is ignored +# riot_base_url: "http://localhost/riot" +# +# # Disable sending password reset emails via the configured, trusted +# # identity servers +# # +# # IMPORTANT! This will give a malicious or overtaken identity server +# # the ability to reset passwords for your users! Make absolutely sure +# # that you want to do this! It is strongly recommended that password +# # reset emails be sent by the homeserver instead +# # +# #enable_password_reset_from_is: False +# +# # Configure the time in seconds that a validation email or text +# # message code will expire after sending +# # +# # This is currently used for password resets +# #validation_token_lifetime: 900 # 15 minutes +# +# # Template directory. All template files should be stored within this +# # directory +# # # #template_dir: res/templates +# +# # Templates for email notifications +# # # notif_template_html: notif_mail.html # notif_template_text: notif_mail.txt -# # Templates for account expiry notices. +# +# # Templates for account expiry notices +# # # expiry_template_html: notice_expiry.html # expiry_template_text: notice_expiry.txt -# notif_for_new_users: True -# riot_base_url: "http://localhost/riot" +# +# # Templates for password reset emails sent by the homeserver +# # +# #password_reset_template_html: password_reset.html +# #password_reset_template_text: password_reset.txt #password_providers: |