tileradotorg/synapse
1
0
Fork 0
forked from MirrorHub/synapse
Code Pull requests Activity

Clarify the account_validity and email sections of the sample configuration. (#6685)

Browse source 
Generally try to make this more comprehensible, and make it match the
conventions.

I've removed the documentation for all the settings which allow you to change
the names of the template files, because I can't really see why they are
useful.
This commit is contained in:
Richard van der Hoff 2020-01-17 10:04:15 +00:00 committed by GitHub
parent d386f2f339
commit 5ce0b17e38
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 320 additions and 272 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1 @@
Clarify the `account_validity` and `email` sections of the sample configuration.

232
docs/sample_config.yaml
View file

@ -874,23 +874,6 @@ media_store_path: "DATADIR/media_store"
# Optional account validity configuration. This allows for accounts to be denied # Optional account validity configuration. This allows for accounts to be denied
# any request after a given period. # any request after a given period.
# #
# ``enabled`` defines whether the account validity feature is enabled. Defaults
# to False.
#
# ``period`` allows setting the period after which an account is valid
# after its registration. When renewing the account, its validity period
# will be extended by this amount of time. This parameter is required when using
# the account validity feature.
#
# ``renew_at`` is the amount of time before an account's expiry date at which
# Synapse will send an email to the account's email address with a renewal link.
# This needs the ``email`` and ``public_baseurl`` configuration sections to be
# filled.
#
# ``renew_email_subject`` is the subject of the email sent out with the renewal
# link. ``%(app)s`` can be used as a placeholder for the ``app_name`` parameter
# from the ``email`` section.
#
# Once this feature is enabled, Synapse will look for registered users without an # Once this feature is enabled, Synapse will look for registered users without an
# expiration date at startup and will add one to every account it found using the # expiration date at startup and will add one to every account it found using the
# current settings at that time. # current settings at that time.
@ -901,20 +884,54 @@ media_store_path: "DATADIR/media_store"
# date will be randomly selected within a range [now + period - d ; now + period], # date will be randomly selected within a range [now + period - d ; now + period],
# where d is equal to 10% of the validity period. # where d is equal to 10% of the validity period.
# #
#account_validity: account_validity:
# The account validity feature is disabled by default. Uncomment the
# following line to enable it.
#
#enabled: true #enabled: true
# The period after which an account is valid after its registration. When
# renewing the account, its validity period will be extended by this amount
# of time. This parameter is required when using the account validity
# feature.
#
#period: 6w #period: 6w
# The amount of time before an account's expiry date at which Synapse will
# send an email to the account's email address with a renewal link. By
# default, no such emails are sent.
#
# If you enable this setting, you will also need to fill out the 'email' and
# 'public_baseurl' configuration sections.
#
#renew_at: 1w #renew_at: 1w
# The subject of the email sent out with the renewal link. '%(app)s' can be
# used as a placeholder for the 'app_name' parameter from the 'email'
# section.
#
# Note that the placeholder must be written '%(app)s', including the
# trailing 's'.
#
# If this is not set, a default value is used.
#
#renew_email_subject: "Renew your %(app)s account" #renew_email_subject: "Renew your %(app)s account"
# # Directory in which Synapse will try to find the HTML files to serve to the
# # user when trying to renew an account. Optional, defaults to # Directory in which Synapse will try to find templates for the HTML files to
# # synapse/res/templates. # serve to the user when trying to renew an account. If not set, default
# templates from within the Synapse package will be used.
#
#template_dir: "res/templates" #template_dir: "res/templates"
# # HTML to be displayed to the user after they successfully renewed their
# # account. Optional. # File within 'template_dir' giving the HTML to be displayed to the user after
# they successfully renewed their account. If not set, default text is used.
#
#account_renewed_html_path: "account_renewed.html" #account_renewed_html_path: "account_renewed.html"
# # HTML to be displayed when the user tries to renew an account with an invalid
# # renewal token. Optional. # File within 'template_dir' giving the HTML to be displayed when the user
# tries to renew an account with an invalid renewal token. If not set,
# default text is used.
#
#invalid_token_html_path: "invalid_token.html" #invalid_token_html_path: "invalid_token.html"
# Time that a user's session remains valid for, after they log in. # Time that a user's session remains valid for, after they log in.
@ -1353,107 +1370,110 @@ password_config:
#pepper: "EVEN_MORE_SECRET" #pepper: "EVEN_MORE_SECRET"
# Configuration for sending emails from Synapse.
#
email:
# The hostname of the outgoing SMTP server to use. Defaults to 'localhost'.
#
#smtp_host: mail.server
# Enable sending emails for password resets, notification events or # The port on the mail server for outgoing SMTP. Defaults to 25.
# account expiry notices
# #
# If your SMTP server requires authentication, the optional smtp_user & #smtp_port: 587
# smtp_pass variables should be used
# Username/password for authentication to the SMTP server. By default, no
# authentication is attempted.
# #
#email:
# enable_notifs: false
# smtp_host: "localhost"
# smtp_port: 25 # SSL: 465, STARTTLS: 587
# smtp_user: "exampleusername" # smtp_user: "exampleusername"
# smtp_pass: "examplepassword" # smtp_pass: "examplepassword"
# require_transport_security: false
# Uncomment the following to require TLS transport security for SMTP.
# By default, Synapse will connect over plain text, and will then switch to
# TLS via STARTTLS *if the SMTP server supports it*. If this option is set,
# Synapse will refuse to connect unless the server supports STARTTLS.
#
#require_transport_security: true
# Enable sending emails for messages that the user has missed
#
#enable_notifs: false
# notif_from defines the "From" address to use when sending emails.
# It must be set if email sending is enabled.
#
# The placeholder '%(app)s' will be replaced by the application name,
# which is normally 'app_name' (below), but may be overridden by the
# Matrix client application.
#
# Note that the placeholder must be written '%(app)s', including the
# trailing 's'.
# #
# # notif_from defines the "From" address to use when sending emails.
# # It must be set if email sending is enabled.
# #
# # The placeholder '%(app)s' will be replaced by the application name,
# # which is normally 'app_name' (below), but may be overridden by the
# # Matrix client application.
# #
# # Note that the placeholder must be written '%(app)s', including the
# # trailing 's'.
# #
#notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>" #notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>"
# app_name defines the default value for '%(app)s' in notif_from. It
# defaults to 'Matrix'.
# #
# # app_name defines the default value for '%(app)s' in notif_from. It #app_name: my_branded_matrix_server
# # defaults to 'Matrix'.
# # # Uncomment the following to disable automatic subscription to email
# #app_name: my_branded_matrix_server # notifications for new users. Enabled by default.
# #
# # Enable email notifications by default #notif_for_new_users: false
# #
# notif_for_new_users: true # Custom URL for client links within the email notifications. By default
# links will be based on "https://matrix.to".
# #
# # Defining a custom URL for Riot is only needed if email notifications # (This setting used to be called riot_base_url; the old name is still
# # should contain links to a self-hosted installation of Riot; when set # supported for backwards-compatibility but is now deprecated.)
# # the "app_name" setting is ignored
# #
# riot_base_url: "http://localhost/riot"
# #
# # Configure the time that a validation email or text message code #client_base_url: "http://localhost/riot"
# # will expire after sending
# # # Configure the time that a validation email will expire after sending.
# # This is currently used for password resets # Defaults to 1h.
# #
# #validation_token_lifetime: 1h
# #
# # Template directory. All template files should be stored within this #validation_token_lifetime: 15m
# # directory. If not set, default templates from within the Synapse
# # package will be used # 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.
# # For the list of default templates, please see
# # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
# #
# #template_dir: res/templates
# #
# # Templates for email notifications # 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
# notif_template_html: notif_mail.html # below are in the directory.
# notif_template_text: notif_mail.txt
# #
# # Templates for account expiry notices # Synapse will look for the following templates in this directory:
# #
# expiry_template_html: notice_expiry.html
# expiry_template_text: notice_expiry.txt
# #
# # Templates for password reset emails sent by the homeserver # * The contents of email notifications of missed events: 'notif_mail.html' and
# # # 'notif_mail.txt'.
# #password_reset_template_html: password_reset.html
# #password_reset_template_text: password_reset.txt
# #
# # Templates for registration emails sent by the homeserver # * The contents of account expiry notice emails: 'notice_expiry.html' and
# # # 'notice_expiry.txt'.
# #registration_template_html: registration.html
# #registration_template_text: registration.txt
# #
# # Templates for validation emails sent by the homeserver when adding an email to # * The contents of password reset emails sent by the homeserver:
# # your user account # 'password_reset.html' and 'password_reset.txt'
# #
# #add_threepid_template_html: add_threepid.html
# #add_threepid_template_text: add_threepid.txt
# #
# # Templates for password reset success and failure pages that a user # * HTML pages for success and failure that a user will see when they follow
# # will see after attempting to reset their password # the link in the password reset email: 'password_reset_success.html' and
# # # 'password_reset_failure.html'
# #password_reset_template_success_html: password_reset_success.html
# #password_reset_template_failure_html: password_reset_failure.html
# #
# # Templates for registration success and failure pages that a user # * The contents of address verification emails sent during registration:
# # will see after attempting to register using an email or phone # 'registration.html' and 'registration.txt'
# #
# #registration_template_success_html: registration_success.html
# #registration_template_failure_html: registration_failure.html
# #
# # Templates for success and failure pages that a user will see after attempting # * HTML pages for success and failure that a user will see when they follow
# # to add an email or phone to their account # the link in an address verification email sent during registration:
# # # 'registration_success.html' and 'registration_failure.html'
# #add_threepid_success_html: add_threepid_success.html #
# #add_threepid_failure_html: add_threepid_failure.html # * The contents of address verification emails sent when an address is added
# to a Matrix account: 'add_threepid.html' and 'add_threepid.txt'
#
# * HTML pages for success and failure that a user will see when they follow
# the link in an address verification email sent when an address is added
# to a Matrix account: 'add_threepid_success.html' and
# 'add_threepid_failure.html'
#
# You can see the default templates at:
# https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
#
#template_dir: "res/templates"
#password_providers: #password_providers:

186
synapse/config/emailconfig.py
View file

@ -37,10 +37,12 @@ class EmailConfig(Config):
self.email_enable_notifs = False self.email_enable_notifs = False
email_config = config.get("email", {}) email_config = config.get("email")
if email_config is None:
email_config = {}
self.email_smtp_host = email_config.get("smtp_host", None) self.email_smtp_host = email_config.get("smtp_host", "localhost")
self.email_smtp_port = email_config.get("smtp_port", None) self.email_smtp_port = email_config.get("smtp_port", 25)
self.email_smtp_user = email_config.get("smtp_user", None) self.email_smtp_user = email_config.get("smtp_user", None)
self.email_smtp_pass = email_config.get("smtp_pass", None) self.email_smtp_pass = email_config.get("smtp_pass", None)
self.require_transport_security = email_config.get( self.require_transport_security = email_config.get(
@ -74,9 +76,9 @@ class EmailConfig(Config):
self.email_template_dir = os.path.abspath(template_dir) self.email_template_dir = os.path.abspath(template_dir)
self.email_enable_notifs = email_config.get("enable_notifs", False) self.email_enable_notifs = email_config.get("enable_notifs", False)
account_validity_renewal_enabled = config.get("account_validity", {}).get(
"renew_at" account_validity_config = config.get("account_validity") or {}
) account_validity_renewal_enabled = account_validity_config.get("renew_at")
self.threepid_behaviour_email = ( self.threepid_behaviour_email = (
# Have Synapse handle the email sending if account_threepid_delegates.email # Have Synapse handle the email sending if account_threepid_delegates.email
@ -278,7 +280,9 @@ class EmailConfig(Config):
self.email_notif_for_new_users = email_config.get( self.email_notif_for_new_users = email_config.get(
"notif_for_new_users", True "notif_for_new_users", True
) )
self.email_riot_base_url = email_config.get("riot_base_url", None) self.email_riot_base_url = email_config.get(
"client_base_url", email_config.get("riot_base_url", None)
)
if account_validity_renewal_enabled: if account_validity_renewal_enabled:
self.email_expiry_template_html = email_config.get( self.email_expiry_template_html = email_config.get(
@ -294,107 +298,111 @@ class EmailConfig(Config):
raise ConfigError("Unable to find email template file %s" % (p,)) raise ConfigError("Unable to find email template file %s" % (p,))
def generate_config_section(self, config_dir_path, server_name, **kwargs): def generate_config_section(self, config_dir_path, server_name, **kwargs):
return """ return """\
# Enable sending emails for password resets, notification events or # Configuration for sending emails from Synapse.
# account expiry notices
# #
# If your SMTP server requires authentication, the optional smtp_user & email:
# smtp_pass variables should be used # The hostname of the outgoing SMTP server to use. Defaults to 'localhost'.
#
#smtp_host: mail.server
# The port on the mail server for outgoing SMTP. Defaults to 25.
#
#smtp_port: 587
# Username/password for authentication to the SMTP server. By default, no
# authentication is attempted.
# #
#email:
# enable_notifs: false
# smtp_host: "localhost"
# smtp_port: 25 # SSL: 465, STARTTLS: 587
# smtp_user: "exampleusername" # smtp_user: "exampleusername"
# smtp_pass: "examplepassword" # smtp_pass: "examplepassword"
# require_transport_security: false
# Uncomment the following to require TLS transport security for SMTP.
# By default, Synapse will connect over plain text, and will then switch to
# TLS via STARTTLS *if the SMTP server supports it*. If this option is set,
# Synapse will refuse to connect unless the server supports STARTTLS.
#
#require_transport_security: true
# Enable sending emails for messages that the user has missed
#
#enable_notifs: false
# notif_from defines the "From" address to use when sending emails.
# It must be set if email sending is enabled.
#
# The placeholder '%(app)s' will be replaced by the application name,
# which is normally 'app_name' (below), but may be overridden by the
# Matrix client application.
#
# Note that the placeholder must be written '%(app)s', including the
# trailing 's'.
# #
# # notif_from defines the "From" address to use when sending emails.
# # It must be set if email sending is enabled.
# #
# # The placeholder '%(app)s' will be replaced by the application name,
# # which is normally 'app_name' (below), but may be overridden by the
# # Matrix client application.
# #
# # Note that the placeholder must be written '%(app)s', including the
# # trailing 's'.
# #
#notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>" #notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>"
# app_name defines the default value for '%(app)s' in notif_from. It
# defaults to 'Matrix'.
# #
# # app_name defines the default value for '%(app)s' in notif_from. It #app_name: my_branded_matrix_server
# # defaults to 'Matrix'.
# # # Uncomment the following to disable automatic subscription to email
# #app_name: my_branded_matrix_server # notifications for new users. Enabled by default.
# #
# # Enable email notifications by default #notif_for_new_users: false
# #
# notif_for_new_users: true # Custom URL for client links within the email notifications. By default
# links will be based on "https://matrix.to".
# #
# # Defining a custom URL for Riot is only needed if email notifications # (This setting used to be called riot_base_url; the old name is still
# # should contain links to a self-hosted installation of Riot; when set # supported for backwards-compatibility but is now deprecated.)
# # the "app_name" setting is ignored
# #
# riot_base_url: "http://localhost/riot"
# #
# # Configure the time that a validation email or text message code #client_base_url: "http://localhost/riot"
# # will expire after sending
# # # Configure the time that a validation email will expire after sending.
# # This is currently used for password resets # Defaults to 1h.
# #
# #validation_token_lifetime: 1h
# #
# # Template directory. All template files should be stored within this #validation_token_lifetime: 15m
# # directory. If not set, default templates from within the Synapse
# # package will be used # 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.
# # For the list of default templates, please see
# # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
# #
# #template_dir: res/templates
# #
# # Templates for email notifications # 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
# notif_template_html: notif_mail.html # below are in the directory.
# notif_template_text: notif_mail.txt
# #
# # Templates for account expiry notices # Synapse will look for the following templates in this directory:
# #
# expiry_template_html: notice_expiry.html
# expiry_template_text: notice_expiry.txt
# #
# # Templates for password reset emails sent by the homeserver # * The contents of email notifications of missed events: 'notif_mail.html' and
# # # 'notif_mail.txt'.
# #password_reset_template_html: password_reset.html
# #password_reset_template_text: password_reset.txt
# #
# # Templates for registration emails sent by the homeserver # * The contents of account expiry notice emails: 'notice_expiry.html' and
# # # 'notice_expiry.txt'.
# #registration_template_html: registration.html
# #registration_template_text: registration.txt
# #
# # Templates for validation emails sent by the homeserver when adding an email to # * The contents of password reset emails sent by the homeserver:
# # your user account # 'password_reset.html' and 'password_reset.txt'
# #
# #add_threepid_template_html: add_threepid.html
# #add_threepid_template_text: add_threepid.txt
# #
# # Templates for password reset success and failure pages that a user # * HTML pages for success and failure that a user will see when they follow
# # will see after attempting to reset their password # the link in the password reset email: 'password_reset_success.html' and
# # # 'password_reset_failure.html'
# #password_reset_template_success_html: password_reset_success.html
# #password_reset_template_failure_html: password_reset_failure.html
# #
# # Templates for registration success and failure pages that a user # * The contents of address verification emails sent during registration:
# # will see after attempting to register using an email or phone # 'registration.html' and 'registration.txt'
# #
# #registration_template_success_html: registration_success.html
# #registration_template_failure_html: registration_failure.html
# #
# # Templates for success and failure pages that a user will see after attempting # * HTML pages for success and failure that a user will see when they follow
# # to add an email or phone to their account # the link in an address verification email sent during registration:
# # # 'registration_success.html' and 'registration_failure.html'
# #add_threepid_success_html: add_threepid_success.html #
# #add_threepid_failure_html: add_threepid_failure.html # * The contents of address verification emails sent when an address is added
# to a Matrix account: 'add_threepid.html' and 'add_threepid.txt'
#
# * HTML pages for success and failure that a user will see when they follow
# the link in an address verification email sent when an address is added
# to a Matrix account: 'add_threepid_success.html' and
# 'add_threepid_failure.html'
#
# You can see the default templates at:
# https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
#
#template_dir: "res/templates"
""" """

2
synapse/config/push.py
View file

@ -35,7 +35,7 @@ class PushConfig(Config):
# Now check for the one in the 'email' section and honour it, # Now check for the one in the 'email' section and honour it,
# with a warning. # with a warning.
push_config = config.get("email", {}) push_config = config.get("email") or {}
redact_content = push_config.get("redact_content") redact_content = push_config.get("redact_content")
if redact_content is not None: if redact_content is not None:
print( print(

69
synapse/config/registration.py
View file

@ -27,6 +27,8 @@ class AccountValidityConfig(Config):
section = "accountvalidity" section = "accountvalidity"
def __init__(self, config, synapse_config): def __init__(self, config, synapse_config):
if config is None:
return
self.enabled = config.get("enabled", False) self.enabled = config.get("enabled", False)
self.renew_by_email_enabled = "renew_at" in config self.renew_by_email_enabled = "renew_at" in config
@ -159,23 +161,6 @@ class RegistrationConfig(Config):
# Optional account validity configuration. This allows for accounts to be denied # Optional account validity configuration. This allows for accounts to be denied
# any request after a given period. # any request after a given period.
# #
# ``enabled`` defines whether the account validity feature is enabled. Defaults
# to False.
#
# ``period`` allows setting the period after which an account is valid
# after its registration. When renewing the account, its validity period
# will be extended by this amount of time. This parameter is required when using
# the account validity feature.
#
# ``renew_at`` is the amount of time before an account's expiry date at which
# Synapse will send an email to the account's email address with a renewal link.
# This needs the ``email`` and ``public_baseurl`` configuration sections to be
# filled.
#
# ``renew_email_subject`` is the subject of the email sent out with the renewal
# link. ``%%(app)s`` can be used as a placeholder for the ``app_name`` parameter
# from the ``email`` section.
#
# Once this feature is enabled, Synapse will look for registered users without an # Once this feature is enabled, Synapse will look for registered users without an
# expiration date at startup and will add one to every account it found using the # expiration date at startup and will add one to every account it found using the
# current settings at that time. # current settings at that time.
@ -186,20 +171,54 @@ class RegistrationConfig(Config):
# date will be randomly selected within a range [now + period - d ; now + period], # date will be randomly selected within a range [now + period - d ; now + period],
# where d is equal to 10%% of the validity period. # where d is equal to 10%% of the validity period.
# #
#account_validity: account_validity:
# The account validity feature is disabled by default. Uncomment the
# following line to enable it.
#
#enabled: true #enabled: true
# The period after which an account is valid after its registration. When
# renewing the account, its validity period will be extended by this amount
# of time. This parameter is required when using the account validity
# feature.
#
#period: 6w #period: 6w
# The amount of time before an account's expiry date at which Synapse will
# send an email to the account's email address with a renewal link. By
# default, no such emails are sent.
#
# If you enable this setting, you will also need to fill out the 'email' and
# 'public_baseurl' configuration sections.
#
#renew_at: 1w #renew_at: 1w
# The subject of the email sent out with the renewal link. '%%(app)s' can be
# used as a placeholder for the 'app_name' parameter from the 'email'
# section.
#
# Note that the placeholder must be written '%%(app)s', including the
# trailing 's'.
#
# If this is not set, a default value is used.
#
#renew_email_subject: "Renew your %%(app)s account" #renew_email_subject: "Renew your %%(app)s account"
# # Directory in which Synapse will try to find the HTML files to serve to the
# # user when trying to renew an account. Optional, defaults to # Directory in which Synapse will try to find templates for the HTML files to
# # synapse/res/templates. # serve to the user when trying to renew an account. If not set, default
# templates from within the Synapse package will be used.
#
#template_dir: "res/templates" #template_dir: "res/templates"
# # HTML to be displayed to the user after they successfully renewed their
# # account. Optional. # File within 'template_dir' giving the HTML to be displayed to the user after
# they successfully renewed their account. If not set, default text is used.
#
#account_renewed_html_path: "account_renewed.html" #account_renewed_html_path: "account_renewed.html"
# # HTML to be displayed when the user tries to renew an account with an invalid
# # renewal token. Optional. # File within 'template_dir' giving the HTML to be displayed when the user
# tries to renew an account with an invalid renewal token. If not set,
# default text is used.
#
#invalid_token_html_path: "invalid_token.html" #invalid_token_html_path: "invalid_token.html"
# Time that a user's session remains valid for, after they log in. # Time that a user's session remains valid for, after they log in.