matrix: rebase homeserver.yaml against 1.9.0

This commit is contained in:
Markus 2020-01-27 15:28:49 +01:00
parent 9ff516e089
commit 8a25f21a87

View File

@ -377,17 +377,17 @@ retention:
# #
# The rationale for this per-job configuration is that some rooms might have a # 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 # 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: #purge_jobs:
# - shortest_max_lifetime: 1d # - shortest_max_lifetime: 1d
# longest_max_lifetime: 3d # longest_max_lifetime: 3d
# interval: 5m: # interval: 12h
# - shortest_max_lifetime: 3d # - shortest_max_lifetime: 3d
# longest_max_lifetime: 1y # longest_max_lifetime: 1y
# interval: 24h # interval: 1d
## TLS ## ## TLS ##
@ -868,23 +868,6 @@ enable_registration: false
# 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.
@ -895,21 +878,55 @@ enable_registration: false
# 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:
# enabled: true # The account validity feature is disabled by default. Uncomment the
# period: 6w # following line to enable it.
# renew_at: 1w #
# renew_email_subject: "Renew your %(app)s account" #enabled: true
# # 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 # The period after which an account is valid after its registration. When
# # synapse/res/templates. # renewing the account, its validity period will be extended by this amount
# template_dir: "res/templates" # of time. This parameter is required when using the account validity
# # HTML to be displayed to the user after they successfully renewed their # feature.
# # account. Optional. #
# account_renewed_html_path: "account_renewed.html" #period: 6w
# # HTML to be displayed when the user tries to renew an account with an invalid
# # renewal token. Optional. # The amount of time before an account's expiry date at which Synapse will
# invalid_token_html_path: "invalid_token.html" # 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
# 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"
# 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.
#
#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"
# 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.
# #
@ -1346,107 +1363,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 #
# #smtp_port: 587
# If your SMTP server requires authentication, the optional smtp_user &
# 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_user: "exampleusername"
# smtp_host: "localhost" # smtp_pass: "examplepassword"
# smtp_port: 25 # SSL: 465, STARTTLS: 587
# smtp_user: "exampleusername" # Uncomment the following to require TLS transport security for SMTP.
# smtp_pass: "examplepassword" # By default, Synapse will connect over plain text, and will then switch to
# require_transport_security: false # TLS via STARTTLS *if the SMTP server supports it*. If this option is set,
# # Synapse will refuse to connect unless the server supports STARTTLS.
# # notif_from defines the "From" address to use when sending emails. #
# # It must be set if email sending is enabled. #require_transport_security: true
# #
# # The placeholder '%(app)s' will be replaced by the application name, # Enable sending emails for messages that the user has missed
# # which is normally 'app_name' (below), but may be overridden by the #
# # Matrix client application. #enable_notifs: false
# #
# # Note that the placeholder must be written '%(app)s', including the # notif_from defines the "From" address to use when sending emails.
# # trailing 's'. # It must be set if email sending is enabled.
# # #
# notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>" # The placeholder '%(app)s' will be replaced by the application name,
# # which is normally 'app_name' (below), but may be overridden by the
# # app_name defines the default value for '%(app)s' in notif_from. It # Matrix client application.
# # defaults to 'Matrix'. #
# # # Note that the placeholder must be written '%(app)s', including the
# #app_name: my_branded_matrix_server # trailing 's'.
# #
# # Enable email notifications by default #notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>"
# #
# notif_for_new_users: true # app_name defines the default value for '%(app)s' in notif_from. It
# # defaults to 'Matrix'.
# # Defining a custom URL for Riot is only needed if email notifications #
# # should contain links to a self-hosted installation of Riot; when set #app_name: my_branded_matrix_server
# # the "app_name" setting is ignored
# # # Uncomment the following to disable automatic subscription to email
# riot_base_url: "http://localhost/riot" # notifications for new users. Enabled by default.
# #
# # Configure the time that a validation email or text message code #notif_for_new_users: false
# # will expire after sending
# # # Custom URL for client links within the email notifications. By default
# # This is currently used for password resets # links will be based on "https://matrix.to".
# # #
# #validation_token_lifetime: 1h # (This setting used to be called riot_base_url; the old name is still
# # supported for backwards-compatibility but is now deprecated.)
# # Template directory. All template files should be stored within this #
# # directory. If not set, default templates from within the Synapse #client_base_url: "http://localhost/riot"
# # 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 #
# # #validation_token_lifetime: 15m
# #template_dir: res/templates
# # Directory in which Synapse will try to find the template files below.
# # Templates for email notifications # If not set, default templates from within the Synapse package will be used.
# # #
# notif_template_html: notif_mail.html # DO NOT UNCOMMENT THIS SETTING unless you want to customise the templates.
# notif_template_text: notif_mail.txt # If you *do* uncomment it, you will need to make sure that all the templates
# # below are in the directory.
# # 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 # * The contents of email notifications of missed events: 'notif_mail.html' and
# # 'notif_mail.txt'.
# # Templates for password reset emails sent by the homeserver #
# # # * The contents of account expiry notice emails: 'notice_expiry.html' and
# #password_reset_template_html: password_reset.html # 'notice_expiry.txt'.
# #password_reset_template_text: password_reset.txt #
# # * The contents of password reset emails sent by the homeserver:
# # Templates for registration emails sent by the homeserver # 'password_reset.html' and 'password_reset.txt'
# # #
# #registration_template_html: registration.html # * HTML pages for success and failure that a user will see when they follow
# #registration_template_text: registration.txt # the link in the password reset email: 'password_reset_success.html' and
# # 'password_reset_failure.html'
# # Templates for validation emails sent by the homeserver when adding an email to #
# # your user account # * The contents of address verification emails sent during registration:
# # # 'registration.html' and 'registration.txt'
# #add_threepid_template_html: add_threepid.html #
# #add_threepid_template_text: 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 during registration:
# # Templates for password reset success and failure pages that a user # 'registration_success.html' and 'registration_failure.html'
# # will see after attempting to reset their password #
# # # * The contents of address verification emails sent when an address is added
# #password_reset_template_success_html: password_reset_success.html # to a Matrix account: 'add_threepid.html' and 'add_threepid.txt'
# #password_reset_template_failure_html: password_reset_failure.html #
# # * HTML pages for success and failure that a user will see when they follow
# # Templates for registration success and failure pages that a user # the link in an address verification email sent when an address is added
# # will see after attempting to register using an email or phone # to a Matrix account: 'add_threepid_success.html' and
# # # 'add_threepid_failure.html'
# #registration_template_success_html: registration_success.html #
# #registration_template_failure_html: registration_failure.html # You can see the default templates at:
# # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
# # Templates for success and failure pages that a user will see after attempting #
# # to add an email or phone to their account #template_dir: "res/templates"
# #
# #add_threepid_success_html: add_threepid_success.html
# #add_threepid_failure_html: add_threepid_failure.html
password_providers: password_providers: