#jinja2: lstrip_blocks: True {{ ansible_managed | comment }} ## Server ## # The domain name of the server, with optional explicit port server_name: "{{ matrix_server_url }}" # When running as a daemon, the file to store the pid in pid_file: /var/run/homeserver.pid # 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 public_baseurl: {{ matrix_client_url }} # 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 # Set to false to disable presence tracking on this homeserver. use_presence: false # Whether to require authentication to retrieve profile data (avatars, # display names) of other users through the client API. require_auth_for_profile_requests: false # If set to 'false', requires authentication to access the server's public rooms # directory through the client API. allow_public_rooms_without_auth: true # If set to 'false', forbids any other homeserver to fetch the server's public # rooms directory via federation. Defaults to 'true'. allow_public_rooms_over_federation: true # The default room version for newly created rooms. # https://matrix.org/docs/spec/#complete-list-of-room-versions default_room_version: "4" # 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 enable_search: true # Restrict federation to the following whitelist of domains. federation_domain_whitelist: [] federation_ip_range_blacklist: - '127.0.0.0/8' - '10.0.0.0/8' - '172.16.0.0/12' - '192.168.0.0/16' - '100.64.0.0/10' - '169.254.0.0/16' - '::1/128' - 'fe80::/64' - 'fc00::/7' # List of ports that Synapse should listen on, their purpose and their # configuration. listeners: # TLS-enabled listener: for when matrix traffic is sent directly to synapse. - port: {{ matrix_https_bind_port }} bind_addresses: {{ matrix_https_bind_ips | to_nice_yaml(indent=2) | indent(4) }} type: http tls: true x_forwarded: false resources: - names: [client, federation] compress: false # Unsecure HTTP listener: for when matrix traffic passes through a reverse proxy # that unwraps TLS. - port: {{ matrix_http_bind_port }} tls: false bind_addresses: {{ matrix_http_bind_ips | to_nice_yaml(indent=2) | indent(4) }} type: http x_forwarded: true resources: - names: [client, federation] compress: false ## 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 # # Used in cases where the admin or server owner wants to limit to the # number of monthly active users. # # 'limit_usage_by_mau' disables/enables monthly active user blocking. When # anabled and a limit is reached the server returns a 'ResourceLimitError' # with error type Codes.RESOURCE_LIMIT_EXCEEDED # # 'max_mau_value' is the hard limit of monthly active users above which # the server will start blocking user actions. # # 'mau_trial_days' is a means to add a grace period for active users. It # means that users must be active for this number of days before they # can be considered active and guards against the case where lots of users # sign up in a short space of time never to return after their initial # session. # #limit_usage_by_mau: False #max_mau_value: 50 #mau_trial_days: 2 # 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 # never blocked by mau checking. These accounts are specified here. # #mau_limit_reserved_threepids: # - medium: 'email' # address: 'reserved_user@example.com' # Used by phonehome stats to group together related servers. #server_context: context # Whether to require a user to be in the room to add an alias to it. # Defaults to 'true'. # #require_membership_for_aliases: false # Whether to allow per-room membership profiles through the send of membership # events with profile information that differ from the target's global profile. # Defaults to 'true'. # #allow_per_room_profiles: false ## TLS ## {% if matrix_tls_enabled %} tls_certificate_path: "{{ matrix_tls_cert_path }}" tls_private_key_path: "{{ matrix_tls_key_path }}" tls_dh_params_path: "{{ matrix_tls_dhparam_path }}" {% endif %} # Whether to verify TLS server certificates for outbound federation requests. federation_verify_certificates: true # The minimum TLS version that will be used for outbound federation requests. federation_client_minimum_tls_version: 1.2 # Skip federation certificate verification on the following whitelist # of domains. federation_certificate_verification_whitelist: [] # List of custom certificate authorities for federation traffic. # # This setting should only normally be used within a private network of # homeservers. # # Note that this list will replace those that are provided by your # operating environment. Certificates must be in PEM format. # #federation_custom_ca_list: # - myCA1.pem # - myCA2.pem # - myCA3.pem # 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 # certificates returned by this server match one of the fingerprints. # # Synapse automatically adds the fingerprint of its own certificate # to the list. So if federation traffic is handled directly by synapse # then no modification to the list is required. # # If synapse is run behind a load balancer that handles the TLS then it # will be necessary to add the fingerprints of the certificates used by # the loadbalancers to this list if they are different to the one # synapse is using. # # Homeservers are permitted to cache the list of TLS fingerprints # returned in the key responses up to the "valid_until_ts" returned in # key. It may be necessary to publish the fingerprints of a new # certificate and wait until the "valid_until_ts" of the previous key # responses have passed before deploying it. # # You can calculate a fingerprint from a given TLS listener via: # openssl s_client -connect $host:$port < /dev/null 2> /dev/null | # openssl x509 -outform DER | openssl sha256 -binary | base64 | tr -d '=' # or by checking matrix.org/federationtester/api/report?server_name=$host # #tls_fingerprints: [{"sha256": ""}] ## Database ## database: {% if matrix_postgres_enabled %} name: psycopg2 args: user: {{ matrix_postgres_user.name }} password: {{ matrix_postgres_user.password }} dbname: {{ matrix_postgres_db.name }} host: {{ matrix_postgres_server }} port: {{ matrix_postgres_port }} sslmode: {{ matrix_postgres_ssl_mode }} sslrootcert: {{ matrix_postgres_ssl_root_cert }} cp_min: 5 cp_max: 10 {% else %} name: "sqlite3" args: database: "{{ matrix_data_dir }}/homeserver.db" {% endif %} # Number of events to cache in memory. event_cache_size: "10K" ## Logging ## # A yaml python logging config file log_config: "{{ matrix_conf_dir }}/logging.config" ## Ratelimiting ## # Ratelimiting settings for client actions (registration, login, messaging). rc_message: per_second: 0.2 burst_count: 10 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 # Ratelimiting settings for incoming federation rc_federation: window_size: 1000 sleep_limit: 10 sleep_delay: 500 reject_limit: 50 concurrent: 3 # Directory where uploaded images and attachments are stored. media_store_path: "{{ matrix_data_dir }}/media_store" # Media storage providers allow media to be stored in different # locations. # #media_storage_providers: # - module: file_system # # Whether to write new local files. # store_local: false # # Whether to write new remote media # store_remote: false # # Whether to block upload requests waiting for write to this # # provider to complete # store_synchronous: false # config: # directory: /mnt/some/other/directory # Directory where in-progress uploads are stored. uploads_path: "{{ matrix_data_dir }}/uploads" # The largest allowed upload size in bytes max_upload_size: 10M # Maximum number of pixels that will be thumbnailed 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 # List of thumbnails to precalculate when an image is uploaded. thumbnail_sizes: - width: 32 height: 32 method: crop - width: 96 height: 96 method: crop - width: 320 height: 240 method: scale - width: 640 height: 480 method: scale - width: 800 height: 600 method: scale # Is the preview URL API enabled? url_preview_enabled: {{ 'true' if matrix_url_preview_enabled else 'false' }} # List of IP address CIDR ranges that the URL preview spider is denied # from accessing. {% if matrix_url_preview_ip_blacklist is defined %} url_preview_ip_range_blacklist: {{ matrix_url_preview_ip_blacklist | to_nice_yaml(indent=2) }} {% endif %} # 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. url_preview_ip_range_whitelist: [] # Optional list of URL matches that the URL preview spider is # denied from accessing. {% if matrix_url_preview_url_blacklist is defined %} url_preview_url_blacklist: {{ matrix_url_preview_url_blacklist | to_nice_yaml(indent=2) }} {% endif %} # The largest allowed URL preview spidering size in bytes max_spider_size: "{{ matrix_url_preview_max_spider_size }}" ## Captcha ## enable_registration_captcha: false ## TURN ## # The public URIs of the TURN server to give to clients # #turn_uris: [] # The shared secret used to compute passwords for the TURN server # #turn_shared_secret: "YOUR_SHARED_SECRET" # 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 # 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: True ## Registration ## # Enable registration for new users. enable_registration: false # 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. # This means that, if a validity period is set, and Synapse is restarted (it will # then derive an expiration date from the current validity period), and some time # after that the validity period changes and Synapse is restarted, the users' # expiration dates won't be updated unless their account is manually renewed. This # 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: # enabled: True # period: 6w # renew_at: 1w # renew_email_subject: "Renew your %(app)s account" # Time that a user's session remains valid for, after they log in. # # Note that this is not currently compatible with guest logins. # # Note also that this is calculated at login time: changes are not applied # retrospectively to users who have already logged in. # # By default, this is infinite. # #session_lifetime: 24h # The user must provide all of the below types of 3PID when registering. # #registrations_require_3pid: # - email # - msisdn # Explicitly disable asking for MSISDNs from the registration # flow (overrides registrations_require_3pid if MSISDNs are set as required) # #disable_msisdn_registration: true # Mandate that users are only allowed to associate certain formats of # 3PIDs with accounts on this server. # #allowed_local_3pids: # - medium: email # pattern: '.*@matrix\.org' # - medium: email # pattern: '.*@vector\.im' # - medium: msisdn # pattern: '\+44' # Enable 3PIDs lookup requests to identity servers from this server. # #enable_3pid_lookup: true # If set, allows registration of standard or admin accounts by anyone who # has the shared secret, even if registration is otherwise disabled. # # registration_shared_secret: "e08G0UAJxITGG+aeHJpQIEp^n7@t_nd#rh-fu:P1=E,lPF:L@n" # Set the number of bcrypt rounds used to generate password hash. # Larger numbers increase the work factor needed to generate the hash. 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 # The identity server which we suggest that clients should use when users log # in on this server. # #default_identity_server: https://matrix.org # The list of identity servers trusted to verify third party # identifiers by this server. # # Also defines the ID server which will be called when an account is # deactivated (one will be picked arbitrarily). # #trusted_third_party_id_servers: # - matrix.org # - vector.im # Users who register on this homeserver will automatically be joined # to these rooms # #auto_join_rooms: # - "#example:example.com" # Where auto_join_rooms are specified, setting this flag ensures that the # the rooms exist by creating them when the first user on the # 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: true ## Metrics ### # Enable collection and rendering of performance metrics enable_metrics: False # Whether or not to report anonymized homeserver usage statistics. report_stats: false ## API Configuration ## # A list of event types that will be included in the room_invite_state # #room_invite_state_types: # - "m.room.join_rules" # - "m.room.canonical_alias" # - "m.room.avatar" # - "m.room.encryption" # - "m.room.name" # A list of application service config files to use # #app_service_config_files: # - app_service_1.yaml # - app_service_2.yaml # Uncomment to enable tracking of application service IP addresses. Implicitly # enables MAU tracking for application service users. # #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: "jr;vhMlW=+U8pwBhVE^=6.,M94Gcyg_07Z-nNAsgj4ZZ:ew:HV" # Used to enable access token expiration. # #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: "oFP3m&,r^wJ=Tr#=Ruww5+h0e;-DZqcuVGXV4XgRZIAt~Gv2YF" ## Signing Keys ## # Path to the signing key to sign messages with signing_key_path: "{{ matrix_conf_dir }}/{{ matrix_server_url }}.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: # "ed25519:auto": # # Base64 encoded public key # key: "The public part of your old signing key." # # Millisecond POSIX timestamp when the key expired. # expired_ts: 123456789123 # How long key response published by this server is valid for. key_refresh_interval: 1d # The trusted servers to download signing keys from. # # When we need to fetch a signing key, each server is tried in parallel. # # Normally, the connection to the key server is validated via TLS certificates. # Additional security can be provided by configuring a `verify key`, which # will make synapse check that the response is signed by that key. # # This setting supercedes an older setting named `perspectives`. The old format # is still supported for backwards-compatibility, but it is deprecated. # # Options for each entry in the list include: # # server_name: the name of the server. required. # # verify_keys: an optional map from key id to base64-encoded public key. # If specified, we will check that the response is signed by at least # one of the given keys. # # accept_keys_insecurely: a boolean. Normally, if `verify_keys` is unset, # and federation_verify_certificates is not `true`, synapse will refuse # to start, because this would allow anyone who can spoof DNS responses # to masquerade as the trusted key server. If you know what you are doing # and are sure that your network environment provides a secure connection # to the key server, you can set this to `true` to override this # behaviour. # # An example configuration might look like: # #trusted_key_servers: # - server_name: "my_trusted_server.example.com" # verify_keys: # "ed25519:auto": "abcdefghijklmnopqrstuvwxyzabcdefghijklmopqr" # - server_name: "my_other_trusted_server.example.com" # # The default configuration is: # #trusted_key_servers: # - server_name: "matrix.org" password_config: enabled: true {% if matrix_ldap_auth_enabled %} password_providers: - module: "ldap_auth_provider.LdapAuthProvider" config: enabled: true uri: "{{ matrix_ldap_auth_server }}" start_tls: "{{ matrix_ldap_auth_use_starttls }}" base: "{{ matrix_ldap_auth_basedn }}" attributes: uid: "{{ matrix_ldap_auth_uid_attr }}" mail: "{{ matrix_ldap_auth_mail_attr }}" name: "{{ matrix_ldap_auth_name_attr }}" {% if matrix_ldap_auth_binddn is defined %} bind_dn: "{{ matrix_ldap_auth_binddn }}" {% endif %} {% if matrix_ldap_auth_bind_password is defined %} bind_password: "{{ matrix_ldap_auth_bind_password }}" {% endif %} {% if matrix_ldap_auth_filter is defined %} filter: "{{ matrix_ldap_auth_filter }}" {% endif %} {% endif %} # 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 # SSL: 465, STARTTLS: 587 # smtp_user: "exampleusername" # smtp_pass: "examplepassword" # require_transport_security: False # notif_from: "Your Friendly %(app)s Home Server " # app_name: Matrix # # # 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" # # # Enable 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 # # # # If this option is set to false and SMTP options have not been # # configured, resetting user passwords via email will be disabled # # # #trust_identity_server_for_password_resets: false # # # Configure the time that a validation email or text message code # # will expire after sending # # # # This is currently used for password resets # # # #validation_token_lifetime: 1h # # # Template directory. All template files should be stored within this # # directory. 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 # # # 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 # # # Templates for password reset emails sent by the homeserver # # # #password_reset_template_html: password_reset.html # #password_reset_template_text: password_reset.txt # # # Templates for password reset success and failure pages that a user # # will see after attempting to reset their password # # # #password_reset_template_success_html: password_reset_success.html # #password_reset_template_failure_html: password_reset_failure.html # Clients requesting push notifications can either have the body of # the message sent in the notification poke along with other details # like the sender, or just the event ID and room ID (`event_id_only`). # If clients choose the former, this option controls whether the # 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: true #spam_checker: # module: "my_custom_project.SuperSpamChecker" # config: # example_option: 'things' # Uncomment to allow non-server-admin users to create groups on this server enable_group_creation: false # 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 # rebuild the user_directory search indexes, see # https://github.com/matrix-org/synapse/blob/master/docs/user_directory.md # #user_directory: # enabled: true # search_all_users: false # User Consent configuration # # for detailed instructions, see # https://github.com/matrix-org/synapse/blob/master/docs/consent_tracking.md # # Parts of this section are required if enabling the 'consent' resource under # 'listeners', in particular 'template_dir' and 'version'. # # 'template_dir' gives the location of the templates for the HTML forms. # This directory should contain one subdirectory per language (eg, 'en', 'fr'), # and each language directory should contain the policy document (named as # '.html') and a success page (success.html). # # 'version' specifies the 'current' version of the policy document. It defines # the version to be served by the consent resource if there is no 'v' # parameter. # # 'server_notice_content', if enabled, will send a user a "Server Notice" # asking them to consent to the privacy policy. The 'server_notices' section # must also be configured for this to work. Notices will *not* be sent to # guest users unless 'send_server_notice_to_guests' is set to true. # # 'block_events_error', if set, will block any attempts to send events # until the user consents to the privacy policy. The value of the setting is # used as the text of the error. # # 'require_at_registration', if enabled, will add a step to the registration # process, similar to how captcha works. Users will be required to accept the # policy before their account is created. # # 'policy_name' is the display name of the policy users will see when registering # for an account. Has no effect unless `require_at_registration` is enabled. # Defaults to "Privacy Policy". # #user_consent: # template_dir: res/templates/privacy # version: 1.0 # server_notice_content: # msgtype: m.text # body: >- # To continue using this homeserver you must review and agree to the # terms and conditions at %(consent_uri)s # send_server_notice_to_guests: True # block_events_error: >- # To continue using this homeserver you must review and agree to the # terms and conditions at %(consent_uri)s # require_at_registration: False # policy_name: Privacy Policy # # Local statistics collection. Used in populating the room directory. # # 'bucket_size' controls how large each statistics timeslice is. It can # be defined in a human readable short form -- e.g. "1d", "1y". # # 'retention' controls how long historical statistics will be kept for. # It can be defined in a human readable short form -- e.g. "1d", "1y". # # #stats: # enabled: true # bucket_size: 1d # retention: 1y # Server Notices room configuration # # Uncomment this section to enable a room which can be used to send notices # from the server to users. It is a special room which cannot be left; notices # come from a special "notices" user id. # # If you uncomment this section, you *must* define the system_mxid_localpart # setting, which defines the id of the user which will be used to send the # notices. # # It's also possible to override the room name, the display name of the # "notices" user, and the avatar for the user. # #server_notices: # system_mxid_localpart: notices # system_mxid_display_name: "Server Notices" # system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ" # room_name: "Server Notices" # 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: true # The `alias_creation` option controls who's allowed to create aliases # on this server. alias_creation_rules: - user_id: "*" alias: "*" room_id: "*" action: allow # The `room_list_publication_rules` option controls who can publish and # which rooms can be published in the public room list. room_list_publication_rules: - user_id: "*" alias: "*" room_id: "*" action: allow ## Opentracing ## # These settings enable opentracing, which implements distributed tracing. opentracing: enabled: false