Synchronize config with the one from Synapse 1.9.0

Related to #355.

group_vars/matrix_servers

@@ -638,7 +638,6 @@ matrix_synapse_email_smtp_host: "matrix-mailer"
 matrix_synapse_email_smtp_port: 8025
 matrix_synapse_email_smtp_require_transport_security: false
 matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
-matrix_synapse_email_riot_base_url: "https://{{ matrix_server_fqn_riot }}"
 
 # Even if TURN doesn't support TLS (it does by default),
 # it doesn't hurt to try a secure connection anyway.

roles/matrix-synapse/defaults/main.yml

@@ -259,7 +259,7 @@ matrix_synapse_email_smtp_host: ""
 matrix_synapse_email_smtp_port: 587
 matrix_synapse_email_smtp_require_transport_security: false
 matrix_synapse_email_notif_from: "Matrix <matrix@{{ matrix_domain }}>"
-matrix_synapse_email_riot_base_url: "https://{{ matrix_server_fqn_riot }}"
+matrix_synapse_email_client_base_url: "https://{{ matrix_server_fqn_riot }}"
 
 
 # Enable this to activate the REST auth password provider module.

roles/matrix-synapse/tasks/validate_config.yml

@@ -15,6 +15,7 @@
       Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).
   when: "item.old in vars"
   with_items:
+    - {'old': 'matrix_synapse_email_riot_base_url', 'new': '<superseded by client_base_url>'}
     - {'old': 'matrix_synapse_container_expose_api_port', 'new': '<superseded by matrix_synapse_container_federation_api_plain_host_bind_port>'}
     - {'old': 'matrix_synapse_no_tls', 'new': '<removed>'}
     - {'old': 'matrix_enable_room_list_search', 'new': 'matrix_synapse_enable_room_list_search'}

roles/matrix-synapse/templates/synapse/homeserver.yaml.j2

@@ -392,17 +392,17 @@ retention:
   #
   # The rationale for this per-job configuration is that some rooms might have a
   # retention policy with a low 'max_lifetime', where history needs to be purged
-  # of outdated messages on a very frequent basis (e.g. every 5min), but not want
+  # of outdated messages on a more frequent basis than for the rest of the rooms
-  # that purge to be performed by a job that's iterating over every room it knows,
+  # (e.g. every 12h), but not want that purge to be performed by a job that's
-  # which would be quite heavy on the server.
+  # iterating over every room it knows, which could be heavy on the server.
   #
   #purge_jobs:
   #  - shortest_max_lifetime: 1d
   #    longest_max_lifetime: 3d
-  #    interval: 5m:
+  #    interval: 12h
   #  - shortest_max_lifetime: 3d
   #    longest_max_lifetime: 1y
-  #    interval: 24h
+  #    interval: 1d
 
 
 ## TLS ##
@@ -891,23 +891,6 @@ enable_registration: {{ matrix_synapse_enable_registration|to_json }}
 # Optional account validity configuration. This allows for accounts to be denied
 # 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
 # expiration date at startup and will add one to every account it found using the
 # current settings at that time.
@@ -918,32 +901,55 @@ enable_registration: {{ matrix_synapse_enable_registration|to_json }}
 # date will be randomly selected within a range [now + period - d ; now + period],
 # where d is equal to 10% of the validity period.
 #
-#account_validity:
+account_validity:
-#  enabled: True
+  # The account validity feature is disabled by default. Uncomment the
+  # following line to enable it.
+  #
+  #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
+
+  # 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_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
-#  # synapse/res/templates.
-#  template_dir: "res/templates"
-#  # HTML to be displayed to the user after they successfully renewed their
-#  # account. Optional.
-#  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.
-#  invalid_token_html_path: "invalid_token.html"
 
-# Time that a user's session remains valid for, after they log in.
+  # 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 this is not currently compatible with guest logins.
+  # Note that the placeholder must be written '%(app)s', including the
+  # trailing 's'.
   #
-# Note also that this is calculated at login time: changes are not applied
+  # If this is not set, a default value is used.
-# retrospectively to users who have already logged in.
   #
-# By default, this is infinite.
+  #renew_email_subject: "Renew your %(app)s account"
+
+  # Directory in which Synapse will try to find templates for the HTML files to
+  # serve to the user when trying to renew an account. If not set, default
+  # templates from within the Synapse package will be used.
   #
-#session_lifetime: 24h
+  #template_dir: "res/templates"
+
+  # 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"
+
+  # 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"
 
 # The user must provide all of the below types of 3PID when registering.
 #
@@ -1378,107 +1384,123 @@ password_config:
    pepper: {{ matrix_synapse_password_config_pepper|string|to_json }}
 
 
+{% if matrix_synapse_email_enabled %}
+# Configuration for sending emails from Synapse.
+#
+email:
+  # The hostname of the outgoing SMTP server to use. Defaults to 'localhost'.
+  #
+  #smtp_host: mail.server
+  smtp_host: {{ matrix_synapse_email_smtp_host|string|to_json }}
 
-# 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
+  smtp_port: {{ matrix_synapse_email_smtp_port|to_json }}
+
+  # 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_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
+  require_transport_security: {{ matrix_synapse_email_smtp_require_transport_security|to_json }}
+
+  # Enable sending emails for messages that the user has missed
+  #
+  #enable_notifs: false
+  enable_notifs: true
+
+  # 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>"
-#   app_name: Matrix
+  notif_from: {{ matrix_synapse_email_notif_from|string|to_json }}
+
+  # app_name defines the default value for '%(app)s' in notif_from. It
+  # defaults to 'Matrix'.
   #
-#   # Enable email notifications by default
+  #app_name: my_branded_matrix_server
-#   #
+  app_name: Matrix
-#   notif_for_new_users: True
+
+  # Uncomment the following to disable automatic subscription to email
+  # notifications for new users. Enabled by default.
   #
-#   # Defining a custom URL for Riot is only needed if email notifications
+  #notif_for_new_users: false
-#   # should contain links to a self-hosted installation of Riot; when set
+  notif_for_new_users: True
-#   # the "app_name" setting is ignored
+
-#   #
+  # Custom URL for client links within the email notifications. By default
-#   riot_base_url: "http://localhost/riot"
+  # links will be based on "https://matrix.to".
   #
-#   # Configure the time that a validation email or text message code
+  # (This setting used to be called riot_base_url; the old name is still
-#   # will expire after sending
+  # supported for backwards-compatibility but is now deprecated.)
-#   #
-#   # This is currently used for password resets
-#   #
-#   #validation_token_lifetime: 1h
   #
-#   # Template directory. All template files should be stored within this
+  #client_base_url: "http://localhost/riot"
-#   # directory. If not set, default templates from within the Synapse
+  client_base_url: {{ matrix_synapse_email_client_base_url|string|to_json }}
-#   # package will be used
+
-#   #
+  # Configure the time that a validation email will expire after sending.
-#   # For the list of default templates, please see
+  # Defaults to 1h.
-#   # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
-#   #
-#   #template_dir: res/templates
   #
-#   # Templates for email notifications
+  #validation_token_lifetime: 15m
-#   #
+
-#   notif_template_html: notif_mail.html
+  # Directory in which Synapse will try to find the template files below.
-#   notif_template_text: notif_mail.txt
+  # If not set, default templates from within the Synapse package will be used.
   #
-#   # Templates for account expiry notices
+  # 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
-#   expiry_template_html: notice_expiry.html
+  # below are in the directory.
-#   expiry_template_text: notice_expiry.txt
   #
-#   # Templates for password reset emails sent by the homeserver
+  # Synapse will look for the following templates in this directory:
-#   #
-#   #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 email notifications of missed events: 'notif_mail.html' and
-#   #
+  #   'notif_mail.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 account expiry notice emails: 'notice_expiry.html' and
-#   # your user account
+  #   'notice_expiry.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
+  # * The contents of password reset emails sent by the homeserver:
-#   # will see after attempting to reset their password
+  #   'password_reset.html' and 'password_reset.txt'
-#   #
-#   #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
+  # * HTML pages for success and failure that a user will see when they follow
-#   # will see after attempting to register using an email or phone
+  #   the link in the password reset email: 'password_reset_success.html' and
-#   #
+  #   'password_reset_failure.html'
-#   #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
+  # * The contents of address verification emails sent during registration:
-#   # to add an email or phone to their account
+  #   'registration.html' and 'registration.txt'
-#   #
+  #
-#   #add_threepid_success_html: add_threepid_success.html
+  # * HTML pages for success and failure that a user will see when they follow
-#   #add_threepid_failure_html: add_threepid_failure.html
+  #   the link in an address verification email sent during registration:
-{% if matrix_synapse_email_enabled %}
+  #   'registration_success.html' and 'registration_failure.html'
-email:
+  #
-   enable_notifs: true
+  # * The contents of address verification emails sent when an address is added
-   smtp_host: {{ matrix_synapse_email_smtp_host|string|to_json }}
+  #   to a Matrix account: 'add_threepid.html' and 'add_threepid.txt'
-   smtp_port: {{ matrix_synapse_email_smtp_port|to_json }}
+  #
-   require_transport_security: {{ matrix_synapse_email_smtp_require_transport_security|to_json }}
+  # * HTML pages for success and failure that a user will see when they follow
-   notif_from: {{ matrix_synapse_email_notif_from|string|to_json }}
+  #   the link in an address verification email sent when an address is added
-   app_name: Matrix
+  #   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"
   notif_template_html: notif_mail.html
   notif_template_text: notif_mail.txt
-   # 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: {{ matrix_synapse_email_riot_base_url|string|to_json }}
 {% endif %}