Synchronize Synapse config with the sample from 0.99.3

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

@@ -1,13 +1,16 @@
 # vim:ft=yaml
+
 ## Server ##
 
 # The domain name of the server, with optional explicit port.
 # This is used by remote servers to connect to this server,
 # e.g. matrix.org, localhost:8080, etc.
 # This is also the last part of your UserID.
+#
 server_name: "{{ matrix_domain }}"
 
 # When running as a daemon, the file to store the pid in
+#
 pid_file: /homeserver.pid
 
 # CPU affinity mask. Setting this restricts the CPUs on which the
@@ -33,30 +36,41 @@ pid_file: /homeserver.pid
 #
 #cpu_affinity: 0xFFFFFFFF
 
+# The path to the web client which will be served at /_matrix/client/
+# if 'webclient' is configured under the 'listeners' configuration.
+#
+#web_client_location: "/path/to/web/root"
+
 # The public-facing base URL that clients use to access this HS
 # (not including _matrix/...). This is the same URL a user would
 # enter into the 'custom HS URL' field on their client. If you
 # use synapse with a reverse proxy, this should be the URL to reach
 # synapse via the proxy.
+#
 public_baseurl: https://{{ matrix_server_fqn_matrix }}/
 
 # Set the soft limit on the number of file descriptors synapse can use
 # Zero is used to indicate synapse should set the soft limit to the
 # hard limit.
-soft_file_limit: 0
+#
+#soft_file_limit: 0
 
 # Set to false to disable presence tracking on this homeserver.
+#
 use_presence: {{ matrix_synapse_use_presence|to_json }}
 
 # The GC threshold parameters to pass to `gc.set_threshold`, if defined
+#
 #gc_thresholds: [700, 10, 10]
 
 # Set the limit on the returned events in the timeline in the get
 # and sync operations. The default value is -1, means no upper limit.
+#
 #filter_timeline_limit: 5000
 
 # Whether room invites to users on this server should be blocked
 # (except those sent by local server admins). The default is False.
+#
 #block_non_admin_invites: True
 
 # Room searching
@@ -139,6 +153,8 @@ federation_domain_whitelist: {{ matrix_synapse_federation_domain_whitelist|to_js
 #   static: static resources under synapse/static (/_matrix/static). (Mostly
 #       useful for 'fallback authentication'.)
 #
+#   webclient: A web client. Requires web_client_location to be set.
+#
 listeners:
 {% if matrix_synapse_metrics_enabled %}
   - type: metrics
@@ -196,14 +212,17 @@ listeners:
 ## Homeserver blocking ##
 
 # How to reach the server admin, used in ResourceLimitError
+#
 #admin_contact: 'mailto:admin@server.com'
 
 # Global blocking
+#
 #hs_disabled: False
 #hs_disabled_message: 'Human readable reason for why the HS is blocked'
 #hs_disabled_limit_type: 'error code(str), to help clients decode reason'
 
 # Monthly Active User Blocking
+#
 #limit_usage_by_mau: False
 #max_mau_value: 50
 #mau_trial_days: 2
@@ -211,6 +230,7 @@ listeners:
 # If enabled, the metrics for the number of monthly active users will
 # be populated, however no one will be limited. If limit_usage_by_mau
 # is true, this is implied to be true.
+#
 #mau_stats_only: False
 
 # Sometimes the server admin will want to ensure certain accounts are
@@ -230,9 +250,15 @@ listeners:
 # See 'ACME support' below to enable auto-provisioning this certificate via
 # Let's Encrypt.
 #
+# If supplying your own, be sure to use a `.pem` file that includes the
+# full certificate chain including any intermediate certificates (for
+# instance, if using certbot, use `fullchain.pem` as your certificate,
+# not `cert.pem`).
+#
 tls_certificate_path: {{ matrix_synapse_tls_certificate_path|to_json }}
 
 # PEM-encoded private key for TLS
+#
 tls_private_key_path: {{ matrix_synapse_tls_private_key_path|to_json }}
 
 # ACME support: This will configure Synapse to request a valid TLS certificate
@@ -283,6 +309,20 @@ acme:
     #
     #reprovision_threshold: 30
 
+    # The domain that the certificate should be for. Normally this
+    # should be the same as your Matrix domain (i.e., 'server_name'), but,
+    # by putting a file at 'https://<server_name>/.well-known/matrix/server',
+    # you can delegate incoming traffic to another server. If you do that,
+    # you should give the target of the delegation here.
+    #
+    # For example: if your 'server_name' is 'example.com', but
+    # 'https://example.com/.well-known/matrix/server' delegates to
+    # 'matrix.example.com', you should put 'matrix.example.com' here.
+    #
+    # If not set, defaults to your 'server_name'.
+    #
+    #domain: matrix.example.com
+
 # List of allowed TLS fingerprints for this server to publish along
 # with the signing keys for this server. Other matrix servers that
 # make HTTPS requests to this server will check that the TLS
@@ -308,7 +348,6 @@ acme:
 #   openssl x509 -outform DER | openssl sha256 -binary | base64 | tr -d '='
 # or by checking matrix.org/federationtester/api/report?server_name=$host
 #
-tls_fingerprints: []
 #tls_fingerprints: [{"sha256": "<base64_encoded_sha256_fingerprint>"}]
 
 
@@ -327,58 +366,102 @@ database:
     cp_max: 10
 
 # Number of events to cache in memory.
+#
 event_cache_size: "{{ matrix_synapse_event_cache_size }}"
 
 
 ## Logging ##
 
 # A yaml python logging config file
+#
 log_config: "/data/{{ matrix_server_fqn_matrix }}.log.config"
 
 
 ## Ratelimiting ##
 
 # Number of messages a client can send per second
+#
 rc_messages_per_second: {{ matrix_synapse_rc_messages_per_second }}
 
 # Number of message a client can send before being throttled
+#
 rc_message_burst_count: {{ matrix_synapse_rc_message_burst_count }}
 
+# Ratelimiting settings for registration and login.
+#
+# Each ratelimiting configuration is made of two parameters:
+#   - per_second: number of requests a client can send per second.
+#   - burst_count: number of requests a client can send before being throttled.
+#
+# Synapse currently uses the following configurations:
+#   - one for registration that ratelimits registration requests based on the
+#     client's IP address.
+#   - one for login that ratelimits login requests based on the client's IP
+#     address.
+#   - one for login that ratelimits login requests based on the account the
+#     client is attempting to log into.
+#   - one for login that ratelimits login requests based on the account the
+#     client is attempting to log into, based on the amount of failed login
+#     attempts for this account.
+#
+# The defaults are as shown below.
+#
+#rc_registration:
+#  per_second: 0.17
+#  burst_count: 3
+#
+#rc_login:
+#  address:
+#    per_second: 0.17
+#    burst_count: 3
+#  account:
+#    per_second: 0.17
+#    burst_count: 3
+#  failed_attempts:
+#    per_second: 0.17
+#    burst_count: 3
+
 # The federation window size in milliseconds
-federation_rc_window_size: 1000
+#
+#federation_rc_window_size: 1000
 
 # The number of federation requests from a single server in a window
 # before the server will delay processing the request.
-federation_rc_sleep_limit: 10
+#
+#federation_rc_sleep_limit: 10
 
 # The duration in milliseconds to delay processing events from
 # remote servers by if they go over the sleep limit.
-federation_rc_sleep_delay: 500
+#
+#federation_rc_sleep_delay: 500
 
 # The maximum number of concurrent federation requests allowed
 # from a single server
-federation_rc_reject_limit: 50
+#
+#federation_rc_reject_limit: 50
 
 # The number of federation requests to concurrently process from a
 # single server
-federation_rc_concurrent: 3
+#
-
+#federation_rc_concurrent: 3
-# Number of registration requests a client can send per second.
-# Defaults to 1/minute (0.17).
-# rc_registration_requests_per_second: 0.17
 
-# Number of registration requests a client can send before being
+# Target outgoing federation transaction frequency for sending read-receipts,
-# throttled.
+# per-room.
-# Defaults to 3.
+#
-# rc_registration_request_burst_count: 3.0
+# If we end up trying to send out more read-receipts, they will get buffered up
+# into fewer transactions.
+#
+#federation_rr_transactions_per_room_per_second: 50
 
 
 
 # Directory where uploaded images and attachments are stored.
+#
 media_store_path: "/matrix-media-store-parent/{{ matrix_synapse_media_store_directory_name }}"
 
 # Media storage providers allow media to be stored in different
 # locations.
+#
 #media_storage_providers:
 #  - module: file_system
 #    # Whether to write new local files.
@@ -392,43 +475,49 @@ media_store_path: "/matrix-media-store-parent/{{ matrix_synapse_media_store_dire
 #       directory: /mnt/some/other/directory
 
 # Directory where in-progress uploads are stored.
+#
 uploads_path: "/matrix-run/uploads"
 
 # The largest allowed upload size in bytes
+#
 max_upload_size: "{{ matrix_synapse_max_upload_size_mb }}M"
 
 # Maximum number of pixels that will be thumbnailed
-max_image_pixels: "32M"
+#
+#max_image_pixels: 32M
 
 # Whether to generate new thumbnails on the fly to precisely match
 # the resolution requested by the client. If true then whenever
 # a new resolution is requested by the client the server will
 # generate a new thumbnail. If false the server will pick a thumbnail
 # from a precalculated list.
-dynamic_thumbnails: false
+#
+#dynamic_thumbnails: false
 
 # List of thumbnails to precalculate when an image is uploaded.
-thumbnail_sizes:
+#
-- width: 32
+#thumbnail_sizes:
-  height: 32
+#  - width: 32
-  method: crop
+#    height: 32
-- width: 96
+#    method: crop
-  height: 96
+#  - width: 96
-  method: crop
+#    height: 96
-- width: 320
+#    method: crop
-  height: 240
+#  - width: 320
-  method: scale
+#    height: 240
-- width: 640
+#    method: scale
-  height: 480
+#  - width: 640
-  method: scale
+#    height: 480
-- width: 800
+#    method: scale
-  height: 600
+#  - width: 800
-  method: scale
+#    height: 600
+#    method: scale
 
 # Is the preview URL API enabled?  If enabled, you *must* specify
 # an explicit url_preview_ip_range_blacklist of IPs that the spider is
 # denied from accessing.
-url_preview_enabled: True
+#
+#url_preview_enabled: false
 
 # List of IP address CIDR ranges that the URL preview spider is denied
 # from accessing.  There are no defaults: you must explicitly
@@ -438,16 +527,16 @@ url_preview_enabled: True
 # synapse to issue arbitrary GET requests to your internal services,
 # causing serious security issues.
 #
-url_preview_ip_range_blacklist:
+#url_preview_ip_range_blacklist:
-- '127.0.0.0/8'
+#  - '127.0.0.0/8'
-- '10.0.0.0/8'
+#  - '10.0.0.0/8'
-- '172.16.0.0/12'
+#  - '172.16.0.0/12'
-- '192.168.0.0/16'
+#  - '192.168.0.0/16'
-- '100.64.0.0/10'
+#  - '100.64.0.0/10'
-- '169.254.0.0/16'
+#  - '169.254.0.0/16'
-- '::1/128'
+#  - '::1/128'
-- 'fe80::/64'
+#  - 'fe80::/64'
-- 'fc00::/7'
+#  - 'fc00::/7'
 #
 # List of IP address CIDR ranges that the URL preview spider is allowed
 # to access even if they are specified in url_preview_ip_range_blacklist.
@@ -493,60 +582,72 @@ url_preview_ip_range_blacklist:
 #  - netloc: '^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$'
 
 # The largest allowed URL preview spidering size in bytes
-max_spider_size: "10M"
+#
-
+#max_spider_size: 10M
 
 
 ## Captcha ##
 # See docs/CAPTCHA_SETUP for full details of configuring this.
 
 # This Home Server's ReCAPTCHA public key.
-recaptcha_public_key: "YOUR_PUBLIC_KEY"
+#
+#recaptcha_public_key: "YOUR_PUBLIC_KEY"
 
 # This Home Server's ReCAPTCHA private key.
-recaptcha_private_key: "YOUR_PRIVATE_KEY"
+#
+#recaptcha_private_key: "YOUR_PRIVATE_KEY"
 
 # Enables ReCaptcha checks when registering, preventing signup
 # unless a captcha is answered. Requires a valid ReCaptcha
 # public/private key.
-enable_registration_captcha: False
+#
+#enable_registration_captcha: false
 
 # A secret key used to bypass the captcha test entirely.
+#
 #captcha_bypass_secret: "YOUR_SECRET_HERE"
 
 # The API endpoint to use for verifying m.login.recaptcha responses.
-recaptcha_siteverify_api: "https://www.recaptcha.net/recaptcha/api/siteverify"
+#
+#recaptcha_siteverify_api: "https://www.recaptcha.net/recaptcha/api/siteverify"
 
 
 ## TURN ##
 
 # The public URIs of the TURN server to give to clients
+#
 turn_uris: {{ matrix_synapse_turn_uris|to_json }}
 
 # The shared secret used to compute passwords for the TURN server
+#
 turn_shared_secret: {{ matrix_synapse_turn_shared_secret|to_json }}
 
 # The Username and password if the TURN server needs them and
 # does not use a token
+#
 #turn_username: "TURNSERVER_USERNAME"
 #turn_password: "TURNSERVER_PASSWORD"
 
 # How long generated TURN credentials last
-turn_user_lifetime: "1h"
+#
+#turn_user_lifetime: 1h
 
 # Whether guests should be allowed to use the TURN server.
 # This defaults to True, otherwise VoIP will be unreliable for guests.
 # However, it does introduce a slight security risk as it allows users to
 # connect to arbitrary endpoints without having first signed up for a
 # valid account (e.g. by passing a CAPTCHA).
+#
 turn_allow_guests: False
 
 
 ## Registration ##
+#
 # Registration can be rate-limited using the parameters in the "Ratelimiting"
 # section of this file.
 
 # Enable registration for new users.
+#
 enable_registration: {{ matrix_synapse_enable_registration|to_json }}
 
 # The user must provide all of the below types of 3PID when registering.
@@ -558,7 +659,7 @@ enable_registration: {{ matrix_synapse_enable_registration|to_json }}
 # Explicitly disable asking for MSISDNs from the registration
 # flow (overrides registrations_require_3pid if MSISDNs are set as required)
 #
-# disable_msisdn_registration = True
+#disable_msisdn_registration: true
 
 # Mandate that users are only allowed to associate certain formats of
 # 3PIDs with accounts on this server.
@@ -571,8 +672,9 @@ enable_registration: {{ matrix_synapse_enable_registration|to_json }}
 #  - medium: msisdn
 #    pattern: '\+44'
 
-# If set, allows registration by anyone who also has the shared
+# If set, allows registration of standard or admin accounts by anyone who
-# secret, even if registration is otherwise disabled.
+# has the shared secret, even if registration is otherwise disabled.
+#
 registration_shared_secret: {{ matrix_synapse_registration_shared_secret|to_json }}
 
 # Set the number of bcrypt rounds used to generate password hash.
@@ -580,12 +682,14 @@ registration_shared_secret: {{ matrix_synapse_registration_shared_secret|to_json
 # The default number is 12 (which equates to 2^12 rounds).
 # N.B. that increasing this will exponentially increase the time required
 # to register or login - e.g. 24 => 2^24 rounds which will take >20 mins.
-bcrypt_rounds: 12
+#
+#bcrypt_rounds: 12
 
 # Allows users to register as guests without a password/email/etc, and
 # participate in rooms hosted on this server which have been made
 # accessible to anonymous users.
-allow_guest_access: False
+#
+#allow_guest_access: false
 
 # The identity server which we suggest that clients should use when users log
 # in on this server.
@@ -600,6 +704,7 @@ allow_guest_access: False
 #
 # Also defines the ID server which will be called when an account is
 # deactivated (one will be picked arbitrarily).
+#
 {% if matrix_synapse_trusted_third_party_id_servers|length > 0 %}
 trusted_third_party_id_servers:
 {{ matrix_synapse_trusted_third_party_id_servers|to_nice_yaml }}
@@ -607,6 +712,9 @@ trusted_third_party_id_servers:
 
 # Users who register on this homeserver will automatically be joined
 # to these rooms
+#
+#auto_join_rooms:
+#  - "#example:example.com"
 {% if matrix_synapse_auto_join_rooms|length > 0 %}
 auto_join_rooms:
 {{ matrix_synapse_auto_join_rooms|to_nice_yaml }}
@@ -617,14 +725,16 @@ auto_join_rooms:
 # homeserver registers.
 # Setting to false means that if the rooms are not manually created,
 # users cannot be auto-joined since they do not exist.
-autocreate_auto_join_rooms: {{ matrix_synapse_autocreate_auto_join_rooms }}
+#
+autocreate_auto_join_rooms: {{ matrix_synapse_autocreate_auto_join_rooms|to_json }}
 
 
 ## Metrics ###
 
 # Enable collection and rendering of performance metrics
-enable_metrics: {{ matrix_synapse_metrics_enabled }}
+#
-report_stats: {{ matrix_synapse_report_stats|to_json }}
+enable_metrics: {{ matrix_synapse_metrics_enabled|to_json  }}
+
 
 # Enable sentry integration
 # NOTE: While attempts are made to ensure that the logs don't contain
@@ -636,47 +746,58 @@ report_stats: {{ matrix_synapse_report_stats|to_json }}
 #sentry:
 #    dsn: "..."
 
+# Whether or not to report anonymized homeserver usage statistics.
+report_stats: {{ matrix_synapse_report_stats|to_json }}
+
 
 ## API Configuration ##
 
 # A list of event types that will be included in the room_invite_state
-room_invite_state_types:
+#
-    - "m.room.join_rules"
+#room_invite_state_types:
-    - "m.room.canonical_alias"
+#  - "m.room.join_rules"
-    - "m.room.avatar"
+#  - "m.room.canonical_alias"
-    - "m.room.encryption"
+#  - "m.room.avatar"
-    - "m.room.name"
+#  - "m.room.encryption"
+#  - "m.room.name"
 
 
-# A list of application service config file to use
+# A list of application service config files to use
+#
 app_service_config_files: {{ matrix_synapse_app_service_config_files }}
 
-# Whether or not to track application service IP addresses. Implicitly
+# Uncomment to enable tracking of application service IP addresses. Implicitly
 # enables MAU tracking for application service users.
-track_appservice_user_ips: False
+#
+#track_appservice_user_ips: True
 
 
 # a secret which is used to sign access tokens. If none is specified,
 # the registration_shared_secret is used, if one is given; otherwise,
 # a secret key is derived from the signing key.
+#
 macaroon_secret_key: {{ matrix_synapse_macaroon_secret_key|to_json }}
 
 # Used to enable access token expiration.
-expire_access_token: False
+#
+#expire_access_token: False
 
 # a secret which is used to calculate HMACs for form values, to stop
 # falsification of values. Must be specified for the User Consent
 # forms to work.
+#
 form_secret: {{ matrix_synapse_form_secret|to_json }}
 
 ## Signing Keys ##
 
 # Path to the signing key to sign messages with
+#
 signing_key_path: "/data/{{ matrix_server_fqn_matrix }}.signing.key"
 
 # The keys that the server used to sign messages with but won't use
 # to sign new messages. E.g. it has lost its private key
-old_signing_keys: {}
+#
+#old_signing_keys:
 #  "ed25519:auto":
 #    # Base64 encoded public key
 #    key: "The public part of your old signing key."
@@ -687,16 +808,17 @@ old_signing_keys: {}
 # Used to set the valid_until_ts in /key/v2 APIs.
 # Determines how quickly servers will query to check which keys
 # are still valid.
-key_refresh_interval: "1d" # 1 Day.
+#
+#key_refresh_interval: 1d
 
 # The trusted servers to download signing keys from.
-perspectives:
+#
-  servers:
+#perspectives:
-    "matrix.org":
+#  servers:
-      verify_keys:
+#    "matrix.org":
-        "ed25519:auto":
+#      verify_keys:
-          key: "Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw"
+#        "ed25519:auto":
-
+#          key: "Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw"
 
 
 # Enable SAML2 for registration and login. Uses pysaml2.
@@ -704,13 +826,11 @@ perspectives:
 # `sp_config` is the configuration for the pysaml2 Service Provider.
 # See pysaml2 docs for format of config.
 #
-#   # The following is the configuration for the pysaml2 Service Provider.
+# Default values will be used for the 'entityid' and 'service' settings,
-#   # See pysaml2 docs for format of config.
+# so it is not normally necessary to specify them unless you need to
-#   #
+# override them.
-#   # Default values will be used for the 'entityid' and 'service' settings,
-#   # so it is not normally necessary to specify them unless you need to
-#   # override them.
 #
+#saml2_config:
 #  sp_config:
 #    # point this to the IdP's metadata. You can use either a local file or
 #    # (preferably) a URL.
@@ -719,7 +839,7 @@ perspectives:
 #      remote:
 #        - url: https://our_idp/metadata.xml
 #
-#     # The following is just used to generate our metadata xml, and you
+#    # The rest of sp_config is just used to generate our metadata xml, and you
 #    # may well not need it, depending on your setup. Alternatively you
 #    # may need a whole lot more detail - see the pysaml2 docs!
 #
@@ -741,11 +861,12 @@ perspectives:
 #  # Instead of putting the config inline as above, you can specify a
 #  # separate pysaml2 configuration file:
 #  #
-#   # config_path: "/data/sp_conf.py"
+#  config_path: "/data/sp_conf.py"
 
 
 
 # Enable CAS for registration and login.
+#
 #cas_config:
 #   enabled: true
 #   server_url: "https://cas-server.com"
@@ -762,12 +883,14 @@ perspectives:
 #   algorithm: "HS256"
 
 
-
-# Enable password for login.
 password_config:
-   enabled: true
+   # Uncomment to disable password login
+   #
+   #enabled: false
+
    # Uncomment and change to a secret random string for extra security.
    # DO NOT CHANGE THIS AFTER INITIAL SETUP!
+   #
    pepper: {{ matrix_synapse_password_config_pepper|to_json }}
 
 
@@ -856,11 +979,11 @@ password_providers:
 # notification request includes the content of the event (other details
 # like the sender are still included). For `event_id_only` push, it
 # has no effect.
-
+#
 # For modern android devices the notification content will still appear
 # because it is loaded by the app. iPhone, however will send a
 # notification saying only that a message arrived and who it came from.
-
+#
 push:
    include_content: {{ matrix_synapse_push_include_content|to_json }}
 
@@ -871,17 +994,23 @@ push:
 #    example_option: 'things'
 
 
-# Whether to allow non server admins to create groups on this server
+# Uncomment to allow non-server-admin users to create groups on this server
-enable_group_creation: false
+#
+#enable_group_creation: true
 
 # If enabled, non server admins can only create groups with local parts
 # starting with this prefix
+#
 #group_creation_prefix: "unofficial/"
 
 
 
 # User Directory configuration
 #
+# 'enabled' defines whether users can search the user directory. If
+# false then empty responses are returned to all queries. Defaults to
+# true.
+#
 # 'search_all_users' defines whether to search all users visible to your HS
 # when searching the user directory, rather than limiting to users visible
 # in public rooms.  Defaults to false.  If you set it True, you'll have to run
@@ -889,6 +1018,7 @@ enable_group_creation: false
 # on your database to tell it to rebuild the user_directory search indexes.
 #
 #user_directory:
+#  enabled: true
 #  search_all_users: false
 
 
@@ -964,6 +1094,12 @@ enable_group_creation: false
 
 
 
+# Uncomment to disable searching the public room list. When disabled
+# blocks searching local and remote room lists for local and remote
+# users by always returning an empty list for all queries.
+#
+#enable_room_list_search: false
+
 # The `alias_creation` option controls who's allowed to create aliases
 # on this server.
 #
@@ -1007,7 +1143,7 @@ enable_group_creation: false
 #
 # Options for the rules include:
 #
-#   user_id: Matches against the creator of the alias
+#   user_id: Matches agaisnt the creator of the alias
 #   room_id: Matches against the room ID being published
 #   alias: Matches against any current local or canonical aliases
 #            associated with the room