From ff862c8781d1b0f73edb4f5e383a6083000cc36d Mon Sep 17 00:00:00 2001 From: H-Shay Date: Mon, 18 Apr 2022 18:33:06 +0000 Subject: [PATCH] deploy: 3c758d9808ddc00ee96c5426dda3caea356c8745 --- develop/404.html | 2 +- develop/CAPTCHA_SETUP.html | 2 +- develop/admin_api/account_validity.html | 2 +- develop/admin_api/delete_group.html | 2 +- develop/admin_api/event_reports.html | 2 +- develop/admin_api/media_admin_api.html | 2 +- develop/admin_api/purge_history_api.html | 2 +- develop/admin_api/register_api.html | 2 +- develop/admin_api/room_membership.html | 2 +- develop/admin_api/rooms.html | 2 +- develop/admin_api/server_notices.html | 2 +- develop/admin_api/statistics.html | 2 +- develop/admin_api/user_admin_api.html | 2 +- develop/admin_api/version_api.html | 2 +- develop/application_services.html | 2 +- develop/auth_chain_difference_algorithm.html | 2 +- develop/code_style.html | 2 +- develop/consent_tracking.html | 2 +- develop/delegate.html | 2 +- develop/deprecation_policy.html | 2 +- develop/development/cas.html | 2 +- develop/development/contributing_guide.html | 2 +- develop/development/database_schema.html | 2 +- develop/development/demo.html | 2 +- .../development/experimental_features.html | 2 +- develop/development/git.html | 2 +- .../internal_documentation/index.html | 2 +- develop/development/releases.html | 2 +- develop/development/room-dag-concepts.html | 2 +- develop/development/saml.html | 2 +- develop/development/url_previews.html | 2 +- develop/federate.html | 2 +- develop/index.html | 2 +- develop/jwt.html | 2 +- develop/log_contexts.html | 2 +- develop/manhole.html | 2 +- develop/media_repository.html | 2 +- develop/message_retention_policies.html | 2 +- develop/metrics-howto.html | 2 +- develop/modules/account_data_callbacks.html | 2 +- .../modules/account_validity_callbacks.html | 2 +- ...ackground_update_controller_callbacks.html | 2 +- develop/modules/index.html | 2 +- .../password_auth_provider_callbacks.html | 2 +- develop/modules/porting_legacy_module.html | 2 +- .../modules/presence_router_callbacks.html | 2 +- develop/modules/spam_checker_callbacks.html | 2 +- .../modules/third_party_rules_callbacks.html | 2 +- develop/modules/writing_a_module.html | 2 +- develop/openid.html | 2 +- develop/opentracing.html | 2 +- ...ing_synapse_on_single_board_computers.html | 2 +- develop/password_auth_providers.html | 2 +- develop/postgres.html | 2 +- develop/print.html | 2927 +++++++++++++++- develop/replication.html | 2 +- develop/reverse_proxy.html | 2 +- develop/room_and_user_statistics.html | 2 +- develop/searchindex.js | 2 +- develop/searchindex.json | 2 +- develop/server_notices.html | 2 +- develop/setup/forward_proxy.html | 2 +- develop/setup/installation.html | 2 +- develop/sso_mapping_providers.html | 2 +- develop/structured_logging.html | 2 +- develop/synctl_workers.html | 2 +- develop/systemd-with-workers/index.html | 2 +- develop/tcp_replication.html | 2 +- develop/templates.html | 2 +- develop/turn-howto.html | 2 +- develop/upgrade.html | 2 +- .../admin_api/background_updates.html | 2 +- .../administration/admin_api/federation.html | 2 +- .../usage/administration/admin_api/index.html | 2 +- .../admin_api/registration_tokens.html | 2 +- develop/usage/administration/admin_faq.html | 2 +- .../database_maintenance_tools.html | 2 +- develop/usage/administration/index.html | 2 +- develop/usage/administration/request_log.html | 2 +- .../usage/administration/state_groups.html | 2 +- ...anding_synapse_through_grafana_graphs.html | 2 +- .../administration/useful_sql_for_admins.html | 2 +- .../configuration/config_documentation.html | 3108 +++++++++++++++++ .../homeserver_sample_config.html | 6 +- develop/usage/configuration/index.html | 6 +- .../configuration/logging_sample_config.html | 2 +- .../user_authentication/index.html | 2 +- .../user_authentication/refresh_tokens.html | 2 +- .../single_sign_on/cas.html | 2 +- .../single_sign_on/index.html | 2 +- .../single_sign_on/saml.html | 2 +- develop/user_directory.html | 2 +- develop/welcome_and_overview.html | 2 +- develop/workers.html | 2 +- 94 files changed, 6127 insertions(+), 100 deletions(-) create mode 100644 develop/usage/configuration/config_documentation.html diff --git a/develop/404.html b/develop/404.html index 17e9485c33..58f0d0a8fa 100644 --- a/develop/404.html +++ b/develop/404.html @@ -77,7 +77,7 @@ diff --git a/develop/CAPTCHA_SETUP.html b/develop/CAPTCHA_SETUP.html index 096e22bd61..ea9aec6772 100644 --- a/develop/CAPTCHA_SETUP.html +++ b/develop/CAPTCHA_SETUP.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/account_validity.html b/develop/admin_api/account_validity.html index c47e77eadb..eb4542f392 100644 --- a/develop/admin_api/account_validity.html +++ b/develop/admin_api/account_validity.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/delete_group.html b/develop/admin_api/delete_group.html index 7f2d1f5d71..affc8beab4 100644 --- a/develop/admin_api/delete_group.html +++ b/develop/admin_api/delete_group.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/event_reports.html b/develop/admin_api/event_reports.html index 63e58f975e..488a3fca01 100644 --- a/develop/admin_api/event_reports.html +++ b/develop/admin_api/event_reports.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/media_admin_api.html b/develop/admin_api/media_admin_api.html index 7440d915f8..cd84ea9a71 100644 --- a/develop/admin_api/media_admin_api.html +++ b/develop/admin_api/media_admin_api.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/purge_history_api.html b/develop/admin_api/purge_history_api.html index bced462065..649a096538 100644 --- a/develop/admin_api/purge_history_api.html +++ b/develop/admin_api/purge_history_api.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/register_api.html b/develop/admin_api/register_api.html index fa65f09dca..a94744fe1f 100644 --- a/develop/admin_api/register_api.html +++ b/develop/admin_api/register_api.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/room_membership.html b/develop/admin_api/room_membership.html index 562a3b6082..1dfa13cf75 100644 --- a/develop/admin_api/room_membership.html +++ b/develop/admin_api/room_membership.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/rooms.html b/develop/admin_api/rooms.html index 9c4efd4dc0..a4342a59b4 100644 --- a/develop/admin_api/rooms.html +++ b/develop/admin_api/rooms.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/server_notices.html b/develop/admin_api/server_notices.html index 58a31303a9..477993b730 100644 --- a/develop/admin_api/server_notices.html +++ b/develop/admin_api/server_notices.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/statistics.html b/develop/admin_api/statistics.html index b05a714110..a89bb8a42a 100644 --- a/develop/admin_api/statistics.html +++ b/develop/admin_api/statistics.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html index 94c2da194a..60ff0c1478 100644 --- a/develop/admin_api/user_admin_api.html +++ b/develop/admin_api/user_admin_api.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/version_api.html b/develop/admin_api/version_api.html index a2b50cad74..65a2cc1307 100644 --- a/develop/admin_api/version_api.html +++ b/develop/admin_api/version_api.html @@ -76,7 +76,7 @@ diff --git a/develop/application_services.html b/develop/application_services.html index 3c784adfe3..4f42552c78 100644 --- a/develop/application_services.html +++ b/develop/application_services.html @@ -76,7 +76,7 @@ diff --git a/develop/auth_chain_difference_algorithm.html b/develop/auth_chain_difference_algorithm.html index fdea17500c..c75bb06287 100644 --- a/develop/auth_chain_difference_algorithm.html +++ b/develop/auth_chain_difference_algorithm.html @@ -76,7 +76,7 @@ diff --git a/develop/code_style.html b/develop/code_style.html index b63f45d140..9f965d2dc1 100644 --- a/develop/code_style.html +++ b/develop/code_style.html @@ -76,7 +76,7 @@ diff --git a/develop/consent_tracking.html b/develop/consent_tracking.html index e0bce9b39f..62f29aa5db 100644 --- a/develop/consent_tracking.html +++ b/develop/consent_tracking.html @@ -76,7 +76,7 @@ diff --git a/develop/delegate.html b/develop/delegate.html index 5e13feafff..cefbee3616 100644 --- a/develop/delegate.html +++ b/develop/delegate.html @@ -76,7 +76,7 @@ diff --git a/develop/deprecation_policy.html b/develop/deprecation_policy.html index 87768c5c90..0323b32958 100644 --- a/develop/deprecation_policy.html +++ b/develop/deprecation_policy.html @@ -76,7 +76,7 @@ diff --git a/develop/development/cas.html b/develop/development/cas.html index df3e34dbd2..086a352996 100644 --- a/develop/development/cas.html +++ b/develop/development/cas.html @@ -76,7 +76,7 @@ diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html index 920ad727fd..505b9177d7 100644 --- a/develop/development/contributing_guide.html +++ b/develop/development/contributing_guide.html @@ -76,7 +76,7 @@ diff --git a/develop/development/database_schema.html b/develop/development/database_schema.html index eb4678413a..d2e647f7c7 100644 --- a/develop/development/database_schema.html +++ b/develop/development/database_schema.html @@ -76,7 +76,7 @@ diff --git a/develop/development/demo.html b/develop/development/demo.html index 9e1b6ae22e..36cae37ec9 100644 --- a/develop/development/demo.html +++ b/develop/development/demo.html @@ -76,7 +76,7 @@ diff --git a/develop/development/experimental_features.html b/develop/development/experimental_features.html index 82a97bc900..d26901cf13 100644 --- a/develop/development/experimental_features.html +++ b/develop/development/experimental_features.html @@ -76,7 +76,7 @@ diff --git a/develop/development/git.html b/develop/development/git.html index bf4c865f1d..7207b899dc 100644 --- a/develop/development/git.html +++ b/develop/development/git.html @@ -76,7 +76,7 @@ diff --git a/develop/development/internal_documentation/index.html b/develop/development/internal_documentation/index.html index 5becaa50a3..842dadd755 100644 --- a/develop/development/internal_documentation/index.html +++ b/develop/development/internal_documentation/index.html @@ -76,7 +76,7 @@ diff --git a/develop/development/releases.html b/develop/development/releases.html index 6dcd0fbade..0a46b2456d 100644 --- a/develop/development/releases.html +++ b/develop/development/releases.html @@ -76,7 +76,7 @@ diff --git a/develop/development/room-dag-concepts.html b/develop/development/room-dag-concepts.html index a03d34be03..e2918f7ab3 100644 --- a/develop/development/room-dag-concepts.html +++ b/develop/development/room-dag-concepts.html @@ -76,7 +76,7 @@ diff --git a/develop/development/saml.html b/develop/development/saml.html index 3990872c8f..4fc686f5ec 100644 --- a/develop/development/saml.html +++ b/develop/development/saml.html @@ -76,7 +76,7 @@ diff --git a/develop/development/url_previews.html b/develop/development/url_previews.html index a9769a0a49..42ad082399 100644 --- a/develop/development/url_previews.html +++ b/develop/development/url_previews.html @@ -76,7 +76,7 @@ diff --git a/develop/federate.html b/develop/federate.html index c7bb779047..17bff3ad7f 100644 --- a/develop/federate.html +++ b/develop/federate.html @@ -76,7 +76,7 @@ diff --git a/develop/index.html b/develop/index.html index c7cb7b3c24..0533e82999 100644 --- a/develop/index.html +++ b/develop/index.html @@ -76,7 +76,7 @@ diff --git a/develop/jwt.html b/develop/jwt.html index 166ff2425b..1a314e780b 100644 --- a/develop/jwt.html +++ b/develop/jwt.html @@ -76,7 +76,7 @@ diff --git a/develop/log_contexts.html b/develop/log_contexts.html index 72f20b01fb..2d71200b85 100644 --- a/develop/log_contexts.html +++ b/develop/log_contexts.html @@ -76,7 +76,7 @@ diff --git a/develop/manhole.html b/develop/manhole.html index 10c4624903..bec10e377e 100644 --- a/develop/manhole.html +++ b/develop/manhole.html @@ -76,7 +76,7 @@ diff --git a/develop/media_repository.html b/develop/media_repository.html index 496390e4bf..424115a014 100644 --- a/develop/media_repository.html +++ b/develop/media_repository.html @@ -76,7 +76,7 @@ diff --git a/develop/message_retention_policies.html b/develop/message_retention_policies.html index e3d98e7267..f3b1a628a7 100644 --- a/develop/message_retention_policies.html +++ b/develop/message_retention_policies.html @@ -76,7 +76,7 @@ diff --git a/develop/metrics-howto.html b/develop/metrics-howto.html index 25210dc730..33be421d4d 100644 --- a/develop/metrics-howto.html +++ b/develop/metrics-howto.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/account_data_callbacks.html b/develop/modules/account_data_callbacks.html index b19c41bed8..484f001e73 100644 --- a/develop/modules/account_data_callbacks.html +++ b/develop/modules/account_data_callbacks.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/account_validity_callbacks.html b/develop/modules/account_validity_callbacks.html index 046287ee84..920e14c04b 100644 --- a/develop/modules/account_validity_callbacks.html +++ b/develop/modules/account_validity_callbacks.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/background_update_controller_callbacks.html b/develop/modules/background_update_controller_callbacks.html index 4af2813554..be2a80eb09 100644 --- a/develop/modules/background_update_controller_callbacks.html +++ b/develop/modules/background_update_controller_callbacks.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/index.html b/develop/modules/index.html index 2bedcf353a..7ee3e44e56 100644 --- a/develop/modules/index.html +++ b/develop/modules/index.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/password_auth_provider_callbacks.html b/develop/modules/password_auth_provider_callbacks.html index 47b1ea573e..d0711b0d21 100644 --- a/develop/modules/password_auth_provider_callbacks.html +++ b/develop/modules/password_auth_provider_callbacks.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/porting_legacy_module.html b/develop/modules/porting_legacy_module.html index 40c3e5dfaa..ae15e8ae98 100644 --- a/develop/modules/porting_legacy_module.html +++ b/develop/modules/porting_legacy_module.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/presence_router_callbacks.html b/develop/modules/presence_router_callbacks.html index 3830f289fd..99b1cc1325 100644 --- a/develop/modules/presence_router_callbacks.html +++ b/develop/modules/presence_router_callbacks.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/spam_checker_callbacks.html b/develop/modules/spam_checker_callbacks.html index 274fe2c63e..ef2e6900c5 100644 --- a/develop/modules/spam_checker_callbacks.html +++ b/develop/modules/spam_checker_callbacks.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/third_party_rules_callbacks.html b/develop/modules/third_party_rules_callbacks.html index 4cc758818f..b9f7e924e7 100644 --- a/develop/modules/third_party_rules_callbacks.html +++ b/develop/modules/third_party_rules_callbacks.html @@ -76,7 +76,7 @@ diff --git a/develop/modules/writing_a_module.html b/develop/modules/writing_a_module.html index 3672ad1b20..9640a9c317 100644 --- a/develop/modules/writing_a_module.html +++ b/develop/modules/writing_a_module.html @@ -76,7 +76,7 @@ diff --git a/develop/openid.html b/develop/openid.html index 299fd56495..a87c9e72d5 100644 --- a/develop/openid.html +++ b/develop/openid.html @@ -76,7 +76,7 @@ diff --git a/develop/opentracing.html b/develop/opentracing.html index d9e1b5a0de..1742753471 100644 --- a/develop/opentracing.html +++ b/develop/opentracing.html @@ -76,7 +76,7 @@ diff --git a/develop/other/running_synapse_on_single_board_computers.html b/develop/other/running_synapse_on_single_board_computers.html index 7b45507aab..58b8227afa 100644 --- a/develop/other/running_synapse_on_single_board_computers.html +++ b/develop/other/running_synapse_on_single_board_computers.html @@ -76,7 +76,7 @@ diff --git a/develop/password_auth_providers.html b/develop/password_auth_providers.html index 87d1e680d9..ee8f6191b9 100644 --- a/develop/password_auth_providers.html +++ b/develop/password_auth_providers.html @@ -76,7 +76,7 @@ diff --git a/develop/postgres.html b/develop/postgres.html index b0273ff50c..2aaccb24ad 100644 --- a/develop/postgres.html +++ b/develop/postgres.html @@ -76,7 +76,7 @@ diff --git a/develop/print.html b/develop/print.html index f6b2edfc2c..5c141de46f 100644 --- a/develop/print.html +++ b/develop/print.html @@ -77,7 +77,7 @@ @@ -2960,6 +2960,2925 @@ useful just for development purposes. See

Configuration

This section contains information on tweaking Synapse via the various options in the configuration file. A configuration file should have been generated when you installed Synapse.

+

Configuring Synapse

+

This is intended as a guide to the Synapse configuration. The behavior of a Synapse instance can be modified +through the many configuration settings documented here — each config option is explained, +including what the default is, how to change the default and what sort of behaviour the setting governs. +Also included is an example configuration for each setting. If you don't want to spend a lot of time +thinking about options, the config as generated sets sensible defaults for all values. Do note however that the +database defaults to SQLite, which is not recommended for production usage. You can read more on this subject +here.

+

Config Conventions

+

Configuration options that take a time period can be set using a number +followed by a letter. Letters have the following meanings:

+ +

For example, setting redaction_retention_period: 5m would remove redacted +messages from the database after 5 minutes, rather than 5 months.

+

YAML

+

The configuration file is a YAML file, which means that certain syntax rules +apply if you want your config file to be read properly. A few helpful things to know:

+ +

Modules

+

Server admins can expand Synapse's functionality with external modules.

+

See here for more +documentation on how to configure or create custom modules for Synapse.

+
+

Config option: modules

+

Use the module sub-option to add modules under this option to extend functionality. +The module setting then has a sub-option, config, which can be used to define some configuration +for the module.

+

Defaults to none.

+

Example configuration:

+
modules:
+  - module: my_super_module.MySuperClass
+    config:
+      do_thing: true
+  - module: my_other_super_module.SomeClass
+    config: {}
+
+
+

Server

+

Define your homeserver name and other base options.

+
+

Config option: server_name

+

This sets the public-facing domain of the server.

+

The server_name name will appear at the end of usernames and room addresses +created on your server. For example if the server_name was example.com, +usernames on your server would be in the format @user:example.com

+

In most cases you should avoid using a matrix specific subdomain such as +matrix.example.com or synapse.example.com as the server_name for the same +reasons you wouldn't use user@email.example.com as your email address. +See here +for information on how to host Synapse on a subdomain while preserving +a clean server_name.

+

The server_name cannot be changed later so it is important to +configure this correctly before you start Synapse. It should be all +lowercase and may contain an explicit port.

+

There is no default for this option.

+

Example configuration #1:

+
server_name: matrix.org 
+
+

Example configuration #2:

+
server_name: localhost:8080
+
+
+

Config option: pid_file

+

When running Synapse as a daemon, the file to store the pid in. Defaults to none.

+

Example configuration:

+
pid_file: DATADIR/homeserver.pid
+
+
+

Config option: web_client_location

+

The absolute URL to the web client which / will redirect to. Defaults to none.

+

Example configuration:

+
web_client_location: https://riot.example.com/
+
+
+

Config option: public_baseurl

+

The public-facing base URL that clients use to access this Homeserver (not +including _matrix/...). This is the same URL a user might enter into the +'Custom Homeserver URL' field on their client. If you use Synapse with a +reverse proxy, this should be the URL to reach Synapse via the proxy. +Otherwise, it should be the URL to reach Synapse's client HTTP listener (see +'listeners' below).

+

Defaults to https://<server_name>/.

+

Example configuration:

+
public_baseurl: https://example.com/
+
+
+

Config option: serve_server_wellknown

+

By default, other servers will try to reach our server on port 8448, which can +be inconvenient in some environments.

+

Provided https://<server_name>/ on port 443 is routed to Synapse, this +option configures Synapse to serve a file at https://<server_name>/.well-known/matrix/server. +This will tell other servers to send traffic to port 443 instead.

+

This option currently defaults to false.

+

See https://matrix-org.github.io/synapse/latest/delegate.html for more +information.

+

Example configuration:

+
serve_server_wellknown: true
+
+
+

Config option: soft_file_limit

+

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. +Defaults to 0.

+

Example configuration:

+
soft_file_limit: 3
+
+
+

Config option: presence

+

Presence tracking allows users to see the state (e.g online/offline) +of other local and remote users. Set the enabled sub-option to false to
+disable presence tracking on this homeserver. Defaults to true. +This option replaces the previous top-level 'use_presence' option.

+

Example configuration:

+
presence:
+  enabled: false
+
+
+

Config option: require_auth_for_profile_requests

+

Whether to require authentication to retrieve profile data (avatars, display names) of other +users through the client API. Defaults to false. Note that profile data is also available +via the federation API, unless allow_profile_lookup_over_federation is set to false.

+

Example configuration:

+
require_auth_for_profile_requests: true
+
+
+

Config option: limit_profile_requests_to_users_who_share_rooms

+

Use this option to require a user to share a room with another user in order +to retrieve their profile information. Only checked on Client-Server +requests. Profile requests from other servers should be checked by the +requesting server. Defaults to false.

+

Example configuration:

+
limit_profile_requests_to_users_who_share_rooms: true
+
+
+

Config option: include_profile_data_on_invite

+

Use this option to prevent a user's profile data from being retrieved and +displayed in a room until they have joined it. By default, a user's +profile data is included in an invite event, regardless of the values +of the above two settings, and whether or not the users share a server. +Defaults to true.

+

Example configuration:

+
include_profile_data_on_invite: false
+
+
+

Config option: allow_public_rooms_without_auth

+

If set to true, removes the need for authentication to access the server's +public rooms directory through the client API, meaning that anyone can +query the room directory. Defaults to false.

+

Example configuration:

+
allow_public_rooms_without_auth: true
+
+
+

Config option: allow_public_rooms_without_auth

+

If set to true, allows any other homeserver to fetch the server's public +rooms directory via federation. Defaults to false.

+

Example configuration:

+
allow_public_rooms_over_federation: true
+
+
+

Config option: default_room_version

+

The default room version for newly created rooms on this server.

+

Known room versions are listed here

+

For example, for room version 1, default_room_version should be set +to "1".

+

Currently defaults to "9".

+

Example configuration:

+
default_room_version: "8"
+
+
+

Config option: gc_thresholds

+

The garbage collection threshold parameters to pass to gc.set_threshold, if defined. +Defaults to none.

+

Example configuration:

+
gc_thresholds: [700, 10, 10]
+
+
+

Config option: gc_min_interval

+

The minimum time in seconds between each GC for a generation, regardless of +the GC thresholds. This ensures that we don't do GC too frequently. A value of [1s, 10s, 30s] +indicates that a second must pass between consecutive generation 0 GCs, etc.

+

Defaults to [1s, 10s, 30s].

+

Example configuration:

+
gc_min_interval: [0.5s, 30s, 1m]
+
+
+

Config option: filter_timeline_limit

+

Set the limit on the returned events in the timeline in the get +and sync operations. Defaults to 100. A value of -1 means no upper limit.

+

Example configuration:

+
filter_timeline_limit: 5000
+
+
+

Config option: block_non_admin_invites

+

Whether room invites to users on this server should be blocked +(except those sent by local server admins). Defaults to false.

+

Example configuration:

+
block_non_admin_invites: true
+
+
+

Config option: enable_search

+

If set to false, new messages will not be indexed for searching and users +will receive errors when searching for messages. Defaults to true.

+

Example configuration:

+
enable_search: false
+
+
+

Config option: ip_range_blacklist

+

This option prevents outgoing requests from being sent to the specified blacklisted IP address +CIDR ranges. If this option is not specified then it defaults to private IP +address ranges (see the example below).

+

The blacklist applies to the outbound requests for federation, identity servers, +push servers, and for checking key validity for third-party invite events.

+

(0.0.0.0 and :: are always blacklisted, whether or not they are explicitly +listed here, since they correspond to unroutable addresses.)

+

This option replaces federation_ip_range_blacklist in Synapse v1.25.0.

+

Note: The value is ignored when an HTTP proxy is in use.

+

Example configuration:

+
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'
+  - '192.0.0.0/24'
+  - '169.254.0.0/16'
+  - '192.88.99.0/24'
+  - '198.18.0.0/15'
+  - '192.0.2.0/24'
+  - '198.51.100.0/24'
+  - '203.0.113.0/24'
+  - '224.0.0.0/4'
+  - '::1/128'
+  - 'fe80::/10'
+  - 'fc00::/7'
+  - '2001:db8::/32'
+  - 'ff00::/8'
+  - 'fec0::/10'
+
+
+

Config option: ip_range_whitelist

+

List of IP address CIDR ranges that should be allowed for federation, +identity servers, push servers, and for checking key validity for +third-party invite events. This is useful for specifying exceptions to +wide-ranging blacklisted target IP ranges - e.g. for communication with +a push server only visible in your network.

+

This whitelist overrides ip_range_blacklist and defaults to an empty +list.

+

Example configuration:

+
ip_range_whitelist:
+   - '192.168.1.1'
+
+
+

Config option: listeners

+

List of ports that Synapse should listen on, their purpose and their +configuration.

+

Sub-options for each listener include:

+ +

Valid resource names are:

+ +

Example configuration #1:

+
listeners:
+  # TLS-enabled listener: for when matrix traffic is sent directly to synapse.
+  #
+  # (Note that you will also need to give Synapse a TLS key and certificate: see the TLS section
+  # below.)
+  #
+  - port: 8448
+    type: http
+    tls: true
+    resources:
+      - names: [client, federation]
+
+

Example configuration #2:

+
listeners:
+  # Unsecure HTTP listener: for when matrix traffic passes through a reverse proxy
+  # that unwraps TLS.
+  #
+  # If you plan to use a reverse proxy, please see
+  # https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
+  #
+  - port: 8008
+    tls: false
+    type: http
+    x_forwarded: true
+    bind_addresses: ['::1', '127.0.0.1']
+
+    resources:
+      - names: [client, federation]
+        compress: false
+
+    # example additional_resources:
+    additional_resources:
+      "/_matrix/my/custom/endpoint":
+        module: my_module.CustomRequestHandler
+        config: {}
+
+  # Turn on the twisted ssh manhole service on localhost on the given
+  # port.
+  - port: 9000
+    bind_addresses: ['::1', '127.0.0.1']
+    type: manhole
+
+
+

Config option: manhole_settings

+

Connection settings for the manhole. You can find more information +on the manhole here. Manhole sub-options include:

+ +

Example configuration:

+
manhole_settings:
+  username: manhole
+  password: mypassword
+  ssh_priv_key_path: CONFDIR/id_rsa
+  ssh_pub_key_path: CONFDIR/id_rsa.pub
+
+
+

Config option: dummy_events_threshold

+

Forward extremities can build up in a room due to networking delays between +homeservers. Once this happens in a large room, calculation of the state of +that room can become quite expensive. To mitigate this, once the number of +forward extremities reaches a given threshold, Synapse will send an +org.matrix.dummy_event event, which will reduce the forward extremities +in the room.

+

This setting defines the threshold (i.e. number of forward extremities in the room) at which dummy events are sent. +The default value is 10.

+

Example configuration:

+
dummy_events_threshold: 5
+
+
+

Homeserver blocking

+

Useful options for Synapse admins.

+
+

Config option: admin_contact

+

How to reach the server admin, used in ResourceLimitError. Defaults to none.

+

Example configuration:

+
admin_contact: 'mailto:admin@server.com'
+
+
+

Config option: hs_disabled and hs_disabled_message

+

Blocks users from connecting to the homeserver and provides a human-readable reason +why the connection was blocked. Defaults to false.

+

Example configuration:

+
hs_disabled: true
+hs_disabled_message: 'Reason for why the HS is blocked'
+
+
+

Config option: limit_usage_by_mau

+

This option disables/enables monthly active user blocking. Used in cases where the admin or +server owner wants to limit to the number of monthly active users. When enabled and a limit is +reached the server returns a ResourceLimitError with error type Codes.RESOURCE_LIMIT_EXCEEDED. +Defaults to false. If this is enabled, a value for max_mau_value must also be set.

+

Example configuration:

+
limit_usage_by_mau: true 
+
+
+

Config option: max_mau_value

+

This option sets the hard limit of monthly active users above which the server will start +blocking user actions if limit_usage_by_mau is enabled. Defaults to 0.

+

Example configuration:

+
max_mau_value: 50
+
+
+

Config option: mau_trial_days

+

The option mau_trial_days is a means to add a grace period for active users. It +means that users must be active for the specified 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. Defaults to 0.

+

Example configuration:

+
mau_trial_days: 5
+
+
+

Config option: mau_limit_alerting

+

The option mau_limit_alerting is a means of limiting client-side alerting +should the mau limit be reached. This is useful for small instances +where the admin has 5 mau seats (say) for 5 specific people and no +interest increasing the mau limit further. Defaults to true, which +means that alerting is enabled.

+

Example configuration:

+
mau_limit_alerting: false
+
+
+

Config option: mau_stats_only

+

If enabled, the metrics for the number of monthly active users will +be populated, however no one will be limited based on these numbers. If limit_usage_by_mau +is true, this is implied to be true. Defaults to false.

+

Example configuration:

+
mau_stats_only: true
+
+
+

Config option: mau_limit_reserved_threepids

+

Sometimes the server admin will want to ensure certain accounts are +never blocked by mau checking. These accounts are specified by this option. +Defaults to none. Add accounts by specifying the medium and address of the +reserved threepid (3rd party identifier).

+

Example configuration:

+
mau_limit_reserved_threepids:
+  - medium: 'email'
+    address: 'reserved_user@example.com'
+
+
+

Config option: server_context

+

This option is used by phonehome stats to group together related servers. +Defaults to none.

+

Example configuration:

+
server_context: context
+
+
+

Config option: limit_remote_rooms

+

When this option is enabled, the room "complexity" will be checked before a user +joins a new remote room. If it is above the complexity limit, the server will +disallow joining, or will instantly leave. This is useful for homeservers that are +resource-constrained. Options for this setting include:

+ +

Room complexity is an arbitrary measure based on factors such as the number of +users in the room.

+

Example configuration:

+
limit_remote_rooms:
+  enabled: true
+  complexity: 0.5
+  complexity_error: "I can't let you do that, Dave."
+  admins_can_join: true
+
+
+

Config option: require_membership_for_aliases

+

Whether to require a user to be in the room to add an alias to it. +Defaults to true.

+

Example configuration:

+
require_membership_for_aliases: false
+
+
+

Config option: allow_per_room_profiles

+

Whether to allow per-room membership profiles through the sending of membership +events with profile information that differs from the target's global profile. +Defaults to true.

+

Example configuration:

+
allow_per_room_profiles: false
+
+
+

Config option: max_avatar_size

+

The largest permissible file size in bytes for a user avatar. Defaults to no restriction. +Use M for MB and K for KB.

+

Note that user avatar changes will not work if this is set without using Synapse's media repository.

+

Example configuration:

+
max_avatar_size: 10M
+
+
+

Config option: allowed_avatar_mimetypes

+

The MIME types allowed for user avatars. Defaults to no restriction.

+

Note that user avatar changes will not work if this is set without +using Synapse's media repository.

+

Example configuration:

+
allowed_avatar_mimetypes: ["image/png", "image/jpeg", "image/gif"]
+
+
+

Config option: redaction_retention_period

+

How long to keep redacted events in unredacted form in the database. After +this period redacted events get replaced with their redacted form in the DB.

+

Defaults to 7d. Set to null to disable.

+

Example configuration:

+
redaction_retention_period: 28d
+
+
+

Config option: user_ips_max_age

+

How long to track users' last seen time and IPs in the database.

+

Defaults to 28d. Set to null to disable clearing out of old rows.

+

Example configuration:

+
user_ips_max_age: 14d
+
+
+

Config option: request_token_inhibit_3pid_errors

+

Inhibits the /requestToken endpoints from returning an error that might leak +information about whether an e-mail address is in use or not on this +homeserver. Defaults to false. +Note that for some endpoints the error situation is the e-mail already being +used, and for others the error is entering the e-mail being unused. +If this option is enabled, instead of returning an error, these endpoints will +act as if no error happened and return a fake session ID ('sid') to clients.

+

Example configuration:

+
request_token_inhibit_3pid_errors: true
+
+
+

Config option: next_link_domain_whitelist

+

A list of domains that the domain portion of next_link parameters +must match.

+

This parameter is optionally provided by clients while requesting +validation of an email or phone number, and maps to a link that +users will be automatically redirected to after validation +succeeds. Clients can make use this parameter to aid the validation +process.

+

The whitelist is applied whether the homeserver or an identity server is handling validation.

+

The default value is no whitelist functionality; all domains are +allowed. Setting this value to an empty list will instead disallow +all domains.

+

Example configuration:

+
next_link_domain_whitelist: ["matrix.org"]
+
+
+

Config option: templates and custom_template_directory

+

These options define templates to use when generating email or HTML page contents. +The custom_template_directory determines which directory Synapse will try to +find template files in to use to generate email or HTML page contents. +If not set, or a file is not found within the template directory, a default +template from within the Synapse package will be used.

+

See here for more +information about using custom templates.

+

Example configuration:

+
templates:
+  custom_template_directory: /path/to/custom/templates/
+
+
+

Config option: retention

+

This option and the associated options determine message retention policy at the +server level.

+

Room admins and mods can define a retention period for their rooms using the +m.room.retention state event, and server admins can cap this period by setting +the allowed_lifetime_min and allowed_lifetime_max config options.

+

If this feature is enabled, Synapse will regularly look for and purge events +which are older than the room's maximum retention period. Synapse will also +filter events received over federation so that events that should have been +purged are ignored and not stored again.

+

The message retention policies feature is disabled by default.

+

This setting has the following sub-options:

+ +

Example configuration:

+
retention:
+  enabled: true
+  default_policy:
+    min_lifetime: 1d
+    max_lifetime: 1y
+  allowed_lifetime_min: 1d
+  allowed_lifetime_max: 1y
+  purge_jobs:
+    - longest_max_lifetime: 3d
+      interval: 12h
+    - shortest_max_lifetime: 3d
+      interval: 1d  
+
+
+

TLS

+

Options related to TLS.

+
+

Config option: tls_certificate_path

+

This option specifies a PEM-encoded X509 certificate for TLS. +This certificate, as of Synapse 1.0, will need to be a valid and verifiable +certificate, signed by a recognised Certificate Authority. Defaults to none.

+

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).

+

Example configuration:

+
tls_certificate_path: "CONFDIR/SERVERNAME.tls.crt"
+
+
+

Config option: tls_private_key_path

+

PEM-encoded private key for TLS. Defaults to none.

+

Example configuration:

+
tls_private_key_path: "CONFDIR/SERVERNAME.tls.key"
+
+
+

Config option: federation_verify_certificates +Whether to verify TLS server certificates for outbound federation requests.

+

Defaults to true. To disable certificate verification, set the option to false.

+

Example configuration:

+
federation_verify_certificates: false
+
+
+

Config option: federation_client_minimum_tls_version

+

The minimum TLS version that will be used for outbound federation requests.

+

Defaults to 1. Configurable to 1, 1.1, 1.2, or 1.3. Note +that setting this value higher than 1.2 will prevent federation to most +of the public Matrix network: only configure it to 1.3 if you have an +entirely private federation setup and you can ensure TLS 1.3 support.

+

Example configuration:

+
federation_client_minimum_tls_version: 1.2
+
+
+

Config option: federation_certificate_verification_whitelist

+

Skip federation certificate verification on a given whitelist +of domains.

+

This setting should only be used in very specific cases, such as +federation over Tor hidden services and similar. For private networks +of homeservers, you likely want to use a private CA instead.

+

Only effective if federation_verify_certicates is true.

+

Example configuration:

+
federation_certificate_verification_whitelist:
+  - lon.example.com
+  - "*.domain.com"
+  - "*.onion"
+
+
+

Config option: federation_custom_ca_list

+

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.

+

Example configuration:

+
federation_custom_ca_list:
+  - myCA1.pem
+  - myCA2.pem
+  - myCA3.pem
+
+
+

Federation

+

Options related to federation.

+
+

Config option: federation_domain_whitelist

+

Restrict federation to the given whitelist of domains. +N.B. we recommend also firewalling your federation listener to limit +inbound federation traffic as early as possible, rather than relying +purely on this application-layer restriction. If not specified, the +default is to whitelist everything.

+

Example configuration:

+
federation_domain_whitelist:
+  - lon.example.com
+  - nyc.example.com
+  - syd.example.com
+
+
+

Config option: federation_metrics_domains

+

Report prometheus metrics on the age of PDUs being sent to and received from +the given domains. This can be used to give an idea of "delay" on inbound +and outbound federation, though be aware that any delay can be due to problems +at either end or with the intermediate network.

+

By default, no domains are monitored in this way.

+

Example configuration:

+
federation_metrics_domains:
+  - matrix.org
+  - example.com
+
+
+

Config option: allow_profile_lookup_over_federation

+

Set to false to disable profile lookup over federation. By default, the +Federation API allows other homeservers to obtain profile data of any user +on this homeserver.

+

Example configuration:

+
allow_profile_lookup_over_federation: false
+
+
+

Config option: allow_device_name_lookup_over_federation

+

Set this option to false to disable device display name lookup over federation. By default, the +Federation API allows other homeservers to obtain device display names of any user +on this homeserver.

+

Example configuration:

+
allow_device_name_lookup_over_federation: false
+
+
+

Caching

+

Options related to caching

+
+

Config option: event_cache_size

+

The number of events to cache in memory. Not affected by +caches.global_factor. Defaults to 10K.

+

Example configuration:

+
event_cache_size: 15K
+
+
+

Config option: cache and associated values

+

A cache 'factor' is a multiplier that can be applied to each of +Synapse's caches in order to increase or decrease the maximum +number of entries that can be stored.

+

Caching can be configured through the following sub-options:

+ +

Example configuration:

+
caches:
+  global_factor: 1.0
+  per_cache_factors:
+    get_users_who_share_room_with_user: 2.0
+  expire_caches: false
+  sync_response_cache_duration: 2m
+
+
+

Database

+

Config options related to database settings.

+
+

Config option: database

+

The database setting defines the database that synapse uses to store all of +its data.

+

Associated sub-options:

+ +

For more information on using Synapse with Postgres, +see here.

+

Example SQLite configuration:

+
database:
+  name: sqlite3
+  args:
+    database: /path/to/homeserver.db
+
+

Example Postgres configuration:

+
database:
+  name: psycopg2
+  txn_limit: 10000
+  args:
+    user: synapse_user
+    password: secretpassword
+    database: synapse
+    host: localhost
+    port: 5432
+    cp_min: 5
+    cp_max: 10
+
+
+

Logging

+

Config options related to logging.

+
+

Config option: log_config

+

This option specifies a yaml python logging config file as described here.

+

Example configuration:

+
log_config: "CONFDIR/SERVERNAME.log.config"
+
+
+

Ratelimiting

+

Options related to ratelimiting in Synapse.

+

Each ratelimiting configuration is made of two parameters:

+ +
+

Config option: rc_message

+

Ratelimiting settings for client messaging.

+

This is a ratelimiting option for messages that ratelimits sending based on the account the client +is using. It defaults to: per_second: 0.2, burst_count: 10.

+

Example configuration:

+
rc_message:
+  per_second: 0.5
+  burst_count: 15
+
+
+

Config option: rc_registration

+

This option ratelimits registration requests based on the client's IP address. +It defaults to per_second: 0.17, burst_count: 3.

+

Example configuration:

+
rc_registration:
+  per_second: 0.15
+  burst_count: 2
+
+
+

Config option: rc_registration_token_validity

+

This option checks the validity of registration tokens that ratelimits requests based on +the client's IP address. +Defaults to per_second: 0.1, burst_count: 5.

+

Example configuration:

+
rc_registration_token_validity:
+  per_second: 0.3
+  burst_count: 6
+
+
+

Config option: rc_login

+

This option specifies several limits for login:

+ +

Example configuration:

+
rc_login:
+  address:
+    per_second: 0.15
+    burst_count: 5
+  account:
+    per_second: 0.18
+    burst_count: 4
+  failed_attempts:
+    per_second: 0.19
+    burst_count: 7
+
+
+

Config option: rc_admin_redaction

+

This option sets ratelimiting redactions by room admins. If this is not explicitly +set then it uses the same ratelimiting as per rc_message. This is useful +to allow room admins to deal with abuse quickly.

+

Example configuration:

+
rc_admin_redaction:
+  per_second: 1
+  burst_count: 50
+
+
+

Config option: rc_joins

+

This option allows for ratelimiting number of rooms a user can join. This setting has the following sub-options:

+ +

Example configuration:

+
rc_joins:
+  local:
+    per_second: 0.2
+    burst_count: 15
+  remote:
+    per_second: 0.03
+    burst_count: 12
+
+
+

Config option: rc_3pid_validation

+

This option ratelimits how often a user or IP can attempt to validate a 3PID. +Defaults to per_second: 0.003, burst_count: 5.

+

Example configuration:

+
rc_3pid_validation:
+  per_second: 0.003
+  burst_count: 5
+
+
+

Config option: rc_invites

+

This option sets ratelimiting how often invites can be sent in a room or to a +specific user. per_room defaults to per_second: 0.3, burst_count: 10 and +per_user defaults to per_second: 0.003, burst_count: 5.

+

Example configuration:

+
rc_invites:
+  per_room:
+    per_second: 0.5
+    burst_count: 5
+  per_user:
+    per_second: 0.004
+    burst_count: 3
+
+
+

Config option: rc_third_party_invite

+

This option ratelimits 3PID invites (i.e. invites sent to a third-party ID +such as an email address or a phone number) based on the account that's +sending the invite. Defaults to per_second: 0.2, burst_count: 10.

+

Example configuration:

+
rc_third_party_invite:
+  per_second: 0.2
+  burst_count: 10
+
+
+

Config option: rc_federation

+

Defines limits on federation requests.

+

The rc_federation configuration has the following sub-options:

+ +

Example configuration:

+
rc_federation:
+  window_size: 750
+  sleep_limit: 15
+  sleep_delay: 400
+  reject_limit: 40
+  concurrent: 5
+
+
+

Config option: federation_rr_transactions_per_room_per_second

+

Sets outgoing federation transaction frequency for sending read-receipts, +per-room.

+

If we end up trying to send out more read-receipts, they will get buffered up +into fewer transactions. Defaults to 50.

+

Example configuration:

+
federation_rr_transactions_per_room_per_second: 40
+
+
+

Media Store

+

Config options relating to Synapse media store.

+
+

Config option: enable_media_repo

+

Enable the media store service in the Synapse master. Defaults to true. +Set to false if you are using a separate media store worker.

+

Example configuration:

+
enable_media_repo: false
+
+
+

Config option: media_store_path

+

Directory where uploaded images and attachments are stored.

+

Example configuration:

+
media_store_path: "DATADIR/media_store"
+
+
+

Config option: media_storage_providers

+

Media storage providers allow media to be stored in different +locations. Defaults to none. Associated sub-options are:

+ +

Example configuration:

+
media_storage_providers:
+  - module: file_system
+    store_local: false
+    store_remote: false
+    store_synchronous: false
+    config:
+       directory: /mnt/some/other/directory
+
+
+

Config option: max_upload_size

+

The largest allowed upload size in bytes.

+

If you are using a reverse proxy you may also need to set this value in +your reverse proxy's config. Defaults to 50M. Notably Nginx has a small max body size by default. +See here for more on using a reverse proxy with Synapse.

+

Example configuration:

+
max_upload_size: 60M
+
+
+

Config option: max_image_pixels

+

Maximum number of pixels that will be thumbnailed. Defaults to 32M.

+

Example configuration:

+
max_image_pixels: 35M
+
+
+

Config option: dynamic_thumbnails

+

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. Defaults to false.

+

Example configuration:

+
dynamic_thumbnails: true
+
+
+

Config option: thumbnail_sizes

+

List of thumbnails to precalculate when an image is uploaded. Associated sub-options are:

+ +

Example configuration:

+
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
+
+

Config option: url_preview_enabled

+

This setting determines whether the preview URL API is enabled. +It is disabled by default. Set to true to enable. If enabled you must specify a +url_preview_ip_range_blacklist blacklist.

+

Example configuration:

+
url_preview_enabled: true
+
+
+

Config option: url_preview_ip_range_blacklist

+

List of IP address CIDR ranges that the URL preview spider is denied +from accessing. There are no defaults: you must explicitly +specify a list for URL previewing to work. You should specify any +internal services in your network that you do not want synapse to try +to connect to, otherwise anyone in any Matrix room could cause your +synapse to issue arbitrary GET requests to your internal services, +causing serious security issues.

+

(0.0.0.0 and :: are always blacklisted, whether or not they are explicitly +listed here, since they correspond to unroutable addresses.)

+

This must be specified if url_preview_enabled is set. It is recommended that +you use the following example list as a starting point.

+

Note: The value is ignored when an HTTP proxy is in use.

+

Example configuration:

+
url_preview_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'
+  - '192.0.0.0/24'
+  - '169.254.0.0/16'
+  - '192.88.99.0/24'
+  - '198.18.0.0/15'
+  - '192.0.2.0/24'
+  - '198.51.100.0/24'
+  - '203.0.113.0/24'
+  - '224.0.0.0/4'
+  - '::1/128'
+  - 'fe80::/10'
+  - 'fc00::/7'
+  - '2001:db8::/32'
+  - 'ff00::/8'
+  - 'fec0::/10'
+
+
+

Config option: url_preview_ip_range_whitelist

+

This option sets a 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. +This is useful for specifying exceptions to wide-ranging blacklisted +target IP ranges - e.g. for enabling URL previews for a specific private +website only visible in your network. Defaults to none.

+

Example configuration:

+
url_preview_ip_range_whitelist:
+   - '192.168.1.1'
+
+
+

Config option: url_preview_url_blacklist

+

Optional list of URL matches that the URL preview spider is +denied from accessing. You should use url_preview_ip_range_blacklist +in preference to this, otherwise someone could define a public DNS +entry that points to a private IP address and circumvent the blacklist. +This is more useful if you know there is an entire shape of URL that +you know that will never want synapse to try to spider.

+

Each list entry is a dictionary of url component attributes as returned +by urlparse.urlsplit as applied to the absolute form of the URL. See +here for more +information. Some examples are:

+ +

The values of the dictionary are treated as a filename match pattern +applied to that component of URLs, unless they start with a ^ in which +case they are treated as a regular expression match. If all the +specified component matches for a given list item succeed, the URL is +blacklisted.

+

Example configuration:

+
url_preview_url_blacklist:
+  # blacklist any URL with a username in its URI
+  - username: '*'
+
+  # blacklist all *.google.com URLs
+  - netloc: 'google.com'
+  - netloc: '*.google.com'
+
+  # blacklist all plain HTTP URLs
+  - scheme: 'http'
+
+  # blacklist http(s)://www.acme.com/foo
+  - netloc: 'www.acme.com'
+    path: '/foo'
+
+  # blacklist any URL with a literal IPv4 address
+  - netloc: '^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$'
+
+
+

Config option: max_spider_size

+

The largest allowed URL preview spidering size in bytes. Defaults to 10M.

+

Example configuration:

+
max_spider_size: 8M
+
+
+

Config option: url_preview_language

+

A list of values for the Accept-Language HTTP header used when +downloading webpages during URL preview generation. This allows +Synapse to specify the preferred languages that URL previews should +be in when communicating with remote servers.

+

Each value is a IETF language tag; a 2-3 letter identifier for a +language, optionally followed by subtags separated by '-', specifying +a country or region variant.

+

Multiple values can be provided, and a weight can be added to each by +using quality value syntax (;q=). '*' translates to any language.

+

Defaults to "en".

+

Example configuration:

+
 url_preview_accept_language:
+   - en-UK
+   - en-US;q=0.9
+   - fr;q=0.8
+   - *;q=0.7
+
+
+

Config option: oembed

+

oEmbed allows for easier embedding content from a website. It can be +used for generating URLs previews of services which support it. A default list of oEmbed providers +is included with Synapse. Set disable_default_providers to true to disable using +these default oEmbed URLs. Use additional_providers to specify additional files with oEmbed configuration (each +should be in the form of providers.json). By default this list is empty.

+

Example configuration:

+
oembed:
+  disable_default_providers: true
+  additional_providers:
+    - oembed/my_providers.json
+
+
+

Captcha

+

See here for full details on setting up captcha.

+
+

Config option: recaptcha_public_key

+

This homeserver's ReCAPTCHA public key. Must be specified if enable_registration_captcha is +enabled.

+

Example configuration:

+
recaptcha_public_key: "YOUR_PUBLIC_KEY"
+
+
+

Config option: recaptcha_private_key

+

This homeserver's ReCAPTCHA private key. Must be specified if enable_registration_captcha is +enabled.

+

Example configuration:

+
recaptcha_private_key: "YOUR_PRIVATE_KEY"
+
+
+

Config option: enable_registration_captcha

+

Set to true to enable ReCaptcha checks when registering, preventing signup +unless a captcha is answered. Requires a valid ReCaptcha public/private key. +Defaults to false.

+

Example configuration:

+
enable_registration_captcha: true
+
+
+

Config option: recaptcha_siteverify_api

+

The API endpoint to use for verifying m.login.recaptcha responses. +Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.

+

Example configuration:

+
recaptcha_siteverify_api: "https://my.recaptcha.site"
+
+
+

TURN

+

Options related to adding a TURN server to Synapse.

+
+

Config option: turn_uris

+

The public URIs of the TURN server to give to clients.

+

Example configuration:

+
turn_uris: [turn:example.org]
+
+
+

Config option: turn_shared_secret

+

The shared secret used to compute passwords for the TURN server.

+

Example configuration:

+
turn_shared_secret: "YOUR_SHARED_SECRET"
+
+
+

Config options: turn_username and turn_password

+

The Username and password if the TURN server needs them and does not use a token.

+

Example configuration:

+
turn_username: "TURNSERVER_USERNAME"
+turn_password: "TURNSERVER_PASSWORD"
+
+
+

Config option: turn_user_lifetime

+

How long generated TURN credentials last. Defaults to 1h.

+

Example configuration:

+
turn_user_lifetime: 2h
+
+
+

Config option: turn_allow_guests

+

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).

+

Example configuration:

+
turn_allow_guests: false
+
+
+

Registration

+

Registration can be rate-limited using the parameters in the Ratelimiting section of this manual.

+
+

Config option: enable_registration

+

Enable registration for new users. Defaults to false. It is highly recommended that if you enable registration, +you use either captcha, email, or token-based verification to verify that new users are not bots. In order to enable registration +without any verification, you must also set enable_registration_without_verification to true.

+

Example configuration:

+
enable_registration: true
+
+
+

Config option: enable_registration_without_verification +Enable registration without email or captcha verification. Note: this option is not recommended, +as registration without verification is a known vector for spam and abuse. Defaults to false. Has no effect +unless enable_registration is also enabled.

+

Example configuration:

+
enable_registration_without_verification: true
+
+
+

Config option: session_lifetime

+

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.

+

Example configuration:

+
session_lifetime: 24h
+
+
+

Config option: refresh_access_token_lifetime

+

Time that an access token remains valid for, if the session is using refresh tokens.

+

For more information about refresh tokens, please see the manual.

+

Note that this only applies to clients which advertise support for refresh tokens.

+

Note also that this is calculated at login time and refresh time: changes are not applied to +existing sessions until they are refreshed.

+

By default, this is 5 minutes.

+

Example configuration:

+
refreshable_access_token_lifetime: 10m
+
+
+

Config option: refresh_token_lifetime: 24h

+

Time that a refresh token remains valid for (provided that it is not +exchanged for another one first). +This option can be used to automatically log-out inactive sessions. +Please see the manual for more information.

+

Note also that this is calculated at login time and refresh time: +changes are not applied to existing sessions until they are refreshed.

+

By default, this is infinite.

+

Example configuration:

+
refresh_token_lifetime: 24h
+
+
+

Config option: nonrefreshable_access_token_lifetime

+

Time that an access token remains valid for, if the session is NOT +using refresh tokens.

+

Please note that not all clients support refresh tokens, so setting +this to a short value may be inconvenient for some users who will +then be logged out frequently.

+

Note also that this is calculated at login time: changes are not applied +retrospectively to existing sessions for users that have already logged in.

+

By default, this is infinite.

+

Example configuration:

+
nonrefreshable_access_token_lifetime: 24h
+
+
+

Config option: registrations_require_3pid

+

If this is set, the user must provide all of the specified types of 3PID when registering.

+

Example configuration:

+
registrations_require_3pid:
+  - email
+  - msisdn
+
+
+

Config option: disable_msisdn_registration

+

Explicitly disable asking for MSISDNs from the registration +flow (overrides registrations_require_3pid if MSISDNs are set as required).

+

Example configuration:

+
disable_msisdn_registration: true
+
+
+

Config option: allowed_local_3pids

+

Mandate that users are only allowed to associate certain formats of +3PIDs with accounts on this server, as specified by the medium and pattern sub-options.

+

Example configuration:

+
allowed_local_3pids:
+  - medium: email
+    pattern: '^[^@]+@matrix\.org$'
+  - medium: email
+    pattern: '^[^@]+@vector\.im$'
+  - medium: msisdn
+    pattern: '\+44'
+
+
+

Config option: enable_3pid_lookup

+

Enable 3PIDs lookup requests to identity servers from this server. Defaults to true.

+

Example configuration:

+
enable_3pid_lookup: false
+
+
+

Config option: registration_requires_token

+

Require users to submit a token during registration. +Tokens can be managed using the admin API. +Note that enable_registration must be set to true. +Disabling this option will not delete any tokens previously generated. +Defaults to false. Set to true to enable.

+

Example configuration:

+
registration_requires_token: true
+
+
+

Config option: registration_shared_secret

+

If set, allows registration of standard or admin accounts by anyone who +has the shared secret, even if registration is otherwise disabled.

+

Example configuration:

+
registration_shared_secret: <PRIVATE STRING>
+
+
+

Config option: bcrypt_rounds

+

Set the number of bcrypt rounds used to generate password hash. +Larger numbers increase the work factor needed to generate the hash. +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. +Example configuration:

+
bcrypt_rounds: 14
+
+
+

Config option: allow_guest_access

+

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. Defaults to false.

+

Example configuration:

+
allow_guest_access: true
+
+
+

Config option: default_identity_server

+

The identity server which we suggest that clients should use when users log +in on this server.

+

(By default, no suggestion is made, so it is left up to the client. +This setting is ignored unless public_baseurl is also explicitly set.)

+

Example configuration:

+
default_identity_server: https://matrix.org
+
+
+

Config option: account_threepid_delegates

+

Handle threepid (email/phone etc) registration and password resets through a set of +trusted identity servers. Note that this allows the configured identity server to +reset passwords for accounts!

+

Be aware that if email is not set, and SMTP options have not been +configured in the email config block, registration and user password resets via +email will be globally disabled.

+

Additionally, if msisdn is not set, registration and password resets via msisdn +will be disabled regardless, and users will not be able to associate an msisdn +identifier to their account. This is due to Synapse currently not supporting +any method of sending SMS messages on its own.

+

To enable using an identity server for operations regarding a particular third-party +identifier type, set the value to the URL of that identity server as shown in the +examples below.

+

Servers handling the these requests must answer the /requestToken endpoints defined +by the Matrix Identity Service API specification.

+

Example configuration:

+
account_threepid_delegates:
+    email: https://example.com     # Delegate email sending to example.com
+    msisdn: http://localhost:8090  # Delegate SMS sending to this local process
+
+
+

Config option: enable_set_displayname

+

Whether users are allowed to change their displayname after it has +been initially set. Useful when provisioning users based on the +contents of a third-party directory.

+

Does not apply to server administrators. Defaults to true.

+

Example configuration:

+
enable_set_displayname: false
+
+
+

Config option: enable_set_avatar_url

+

Whether users are allowed to change their avatar after it has been +initially set. Useful when provisioning users based on the contents +of a third-party directory.

+

Does not apply to server administrators. Defaults to true.

+

Example configuration:

+
enable_set_avatar_url: false
+
+
+

Config option: enable_3pid_changes

+

Whether users can change the third-party IDs associated with their accounts +(email address and msisdn).

+

Defaults to true.

+

Example configuration:

+
enable_3pid_changes: false
+
+
+

Config option: auto_join_rooms

+

Users who register on this homeserver will automatically be joined +to the rooms listed under this option.

+

By default, any room aliases included in this list will be created +as a publicly joinable room when the first user registers for the +homeserver. If the room already exists, make certain it is a publicly joinable +room, i.e. the join rule of the room must be set to 'public'. You can find more options +relating to auto-joining rooms below.

+

Example configuration:

+
auto_join_rooms:
+  - "#exampleroom:example.com"
+  - "#anotherexampleroom:example.com"
+
+
+

Config option: autocreate_auto_join_rooms

+

Where auto_join_rooms are specified, setting this flag ensures that +the rooms exist by creating them when the first user on the +homeserver registers.

+

By default the auto-created rooms are publicly joinable from any federated +server. Use the autocreate_auto_join_rooms_federated and +autocreate_auto_join_room_preset settings to customise this behaviour.

+

Setting to false means that if the rooms are not manually created, +users cannot be auto-joined since they do not exist.

+

Defaults to true.

+

Example configuration:

+
autocreate_auto_join_rooms: false
+
+
+

Config option: autocreate_auto_join_rooms_federated

+

Whether the rooms listen in auto_join_rooms that are auto-created are available +via federation. Only has an effect if autocreate_auto_join_rooms is true.

+

Note that whether a room is federated cannot be modified after +creation.

+

Defaults to true: the room will be joinable from other servers. +Set to false to prevent users from other homeservers from +joining these rooms.

+

Example configuration:

+
autocreate_auto_join_rooms_federated: false
+
+
+

Config option: autocreate_auto_join_room_preset

+

The room preset to use when auto-creating one of auto_join_rooms. Only has an +effect if autocreate_auto_join_rooms is true.

+

Possible values for this option are:

+ +

If a value of "private_chat" or "trusted_private_chat" is used then +auto_join_mxid_localpart must also be configured.

+

Defaults to "public_chat".

+

Example configuration:

+
autocreate_auto_join_room_preset: private_chat
+
+
+

Config option: auto_join_mxid_localpart

+

The local part of the user id which is used to create auto_join_rooms if +autocreate_auto_join_rooms is true. If this is not provided then the +initial user account that registers will be used to create the rooms.

+

The user id is also used to invite new users to any auto-join rooms which +are set to invite-only.

+

It must be configured if autocreate_auto_join_room_preset is set to +"private_chat" or "trusted_private_chat".

+

Note that this must be specified in order for new users to be correctly +invited to any auto-join rooms which have been set to invite-only (either +at the time of creation or subsequently).

+

Note that, if the room already exists, this user must be joined and +have the appropriate permissions to invite new members.

+

Example configuration:

+
auto_join_mxid_localpart: system
+
+
+

Config option: auto_join_rooms_for_guests

+

When auto_join_rooms is specified, setting this flag to false prevents +guest accounts from being automatically joined to the rooms.

+

Defaults to true.

+

Example configuration:

+
auto_join_rooms_for_guests: false
+
+
+

Config option: inhibit_user_in_use_error

+

Whether to inhibit errors raised when registering a new account if the user ID +already exists. If turned on, requests to /register/available will always +show a user ID as available, and Synapse won't raise an error when starting +a registration with a user ID that already exists. However, Synapse will still +raise an error if the registration completes and the username conflicts.

+

Defaults to false.

+

Example configuration:

+
inhibit_user_in_use_error: true
+
+
+

Metrics

+

Config options related to metrics.

+
+

Config option: enable_metrics

+

Set to true to enable collection and rendering of performance metrics. +Defaults to false.

+

Example configuration:

+
enable_metrics: true
+
+
+

Config option: sentry

+

Use this option to enable sentry integration. Provide the DSN assigned to you by sentry +with the dsn setting.

+

NOTE: While attempts are made to ensure that the logs don't contain +any sensitive information, this cannot be guaranteed. By enabling +this option the sentry server may therefore receive sensitive +information, and it in turn may then disseminate sensitive information +through insecure notification channels if so configured.

+

Example configuration:

+
sentry:
+    dsn: "..."
+
+
+

Config option: metrics_flags

+

Flags to enable Prometheus metrics which are not suitable to be +enabled by default, either for performance reasons or limited use. +Currently the only option is known_servers, which publishes +synapse_federation_known_servers, a gauge of the number of +servers this homeserver knows about, including itself. May cause +performance problems on large homeservers.

+

Example configuration:

+
metrics_flags:
+    known_servers: true
+
+
+

Config option: report_stats

+

Whether or not to report anonymized homeserver usage statistics. This is originally +set when generating the config. Set this option to true or false to change the current +behavior.

+

Example configuration:

+
report_stats: true
+
+
+

Config option: report_stats_endpoint

+

The endpoint to report the anonymized homeserver usage statistics to. +Defaults to https://matrix.org/report-usage-stats/push

+

Example configuration:

+
report_stats_endpoint: https://example.com/report-usage-stats/push
+
+
+

API Configuration

+

Config settings related to the client/server API

+
+

Config option: room_prejoin_state:

+

Controls for the state that is shared with users who receive an invite +to a room. By default, the following state event types are shared with users who +receive invites to the room:

+ +

To change the default behavior, use the following sub-options:

+ +

Example configuration:

+
room_prejoin_state:
+   disable_default_event_types: true
+   additional_event_types:
+     - org.example.custom.event.type
+     - m.room.join_rules
+
+
+

Config option: track_puppeted_user_ips

+

We record the IP address of clients used to access the API for various +reasons, including displaying it to the user in the "Where you're signed in" +dialog.

+

By default, when puppeting another user via the admin API, the client IP +address is recorded against the user who created the access token (ie, the +admin user), and not the puppeted user.

+

Set this option to true to also record the IP address against the puppeted +user. (This also means that the puppeted user will count as an "active" user +for the purpose of monthly active user tracking - see limit_usage_by_mau etc +above.)

+

Example configuration:

+
track_puppeted_user_ips: true
+
+
+

Config option: app_service_config_files

+

A list of application service config files to use.

+

Example configuration:

+
app_service_config_files:
+  - app_service_1.yaml
+  - app_service_2.yaml
+
+
+

Config option: track_appservice_user_ips

+

Defaults to false. Set to true to enable tracking of application service IP addresses. +Implicitly enables MAU tracking for application service users.

+

Example configuration:

+
track_appservice_user_ips: true
+
+
+

Config option: macaroon_secret_key

+

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.

+

Example configuration:

+
macaroon_secret_key: <PRIVATE STRING>
+
+
+

Config option: form_secret

+

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.

+

Example configuration:

+
form_secret: <PRIVATE STRING>
+
+
+

Signing Keys

+

Config options relating to signing keys

+
+

Config option: signing_key_path

+

Path to the signing key to sign messages with.

+

Example configuration:

+
signing_key_path: "CONFDIR/SERVERNAME.signing.key"
+
+
+

Config option: old_signing_keys

+

The keys that the server used to sign messages with but won't use +to sign new messages. For each key, key should be the base64-encoded public key, and +expired_tsshould be the time (in milliseconds since the unix epoch) that +it was last used.

+

It is possible to build an entry from an old signing.key file using the +export_signing_key script which is provided with synapse.

+

Example configuration:

+
old_signing_keys:
+  "ed25519:id": { key: "base64string", expired_ts: 123456789123 }
+
+
+

Config option: key_refresh_interval

+

How long key response published by this server is valid for. +Used to set the valid_until_ts in /key/v2 APIs. +Determines how quickly servers will query to check which keys +are still valid. Defaults to 1d.

+

Example configuration:

+
key_refresh_interval: 2d
+
+
+

Config option: trusted_key_servers:

+

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.

+

trusted_key_servers defaults to matrix.org, but using it will generate a +warning on start-up. To suppress this warning, set +suppress_key_server_warning to true.

+

Options for each entry in the list include:

+ +

Example configuration #1:

+
trusted_key_servers:
+  - server_name: "my_trusted_server.example.com"
+    verify_keys:
+      "ed25519:auto": "abcdefghijklmnopqrstuvwxyzabcdefghijklmopqr"
+  - server_name: "my_other_trusted_server.example.com"
+
+

Example configuration #2:

+
trusted_key_servers:
+  - server_name: "matrix.org"
+
+
+

Config option: suppress_key_server_warning

+

Set the following to true to disable the warning that is emitted when the +trusted_key_servers include 'matrix.org'. See above.

+

Example configuration:

+
suppress_key_server_warning: true
+
+
+

Config option: key_server_signing_keys_path

+

The signing keys to use when acting as a trusted key server. If not specified +defaults to the server signing key.

+

Can contain multiple keys, one per line.

+

Example configuration:

+
key_server_signing_keys_path: "key_server_signing_keys.key"
+
+
+

Single sign-on integration

+

The following settings can be used to make Synapse use a single sign-on +provider for authentication, instead of its internal password database.

+

You will probably also want to set the following options to false to +disable the regular login/registration flows:

+ +

You will also want to investigate the settings under the "sso" configuration +section below.

+
+

Config option: saml2_config

+

Enable SAML2 for registration and login. Uses pysaml2. To learn more about pysaml and +to find a full list options for configuring pysaml, read the docs here.

+

At least one of sp_config or config_path must be set in this section to +enable SAML login. You can either put your entire pysaml config inline using the sp_config +option, or you can specify a path to a psyaml config file with the sub-option config_path. +This setting has the following sub-options:

+ +

Once SAML support is enabled, a metadata file will be exposed at +https://<server>:<port>/_synapse/client/saml2/metadata.xml, which you may be able to +use to configure your SAML IdP with. Alternatively, you can manually configure +the IdP to use an ACS location of +https://<server>:<port>/_synapse/client/saml2/authn_response.

+

Example configuration:

+
saml2_config:
+  sp_config:
+    metadata:
+      local: ["saml2/idp.xml"]
+      remote:
+        - url: https://our_idp/metadata.xml
+    accepted_time_diff: 3
+
+    service:
+      sp:
+        allow_unsolicited: true
+
+    # The examples below are just used to generate our metadata xml, and you
+    # may well not need them, depending on your setup. Alternatively you
+    # may need a whole lot more detail - see the pysaml2 docs!
+    description: ["My awesome SP", "en"]
+    name: ["Test SP", "en"]
+
+    ui_info:
+      display_name:
+        - lang: en
+          text: "Display Name is the descriptive name of your service."
+      description:
+        - lang: en
+          text: "Description should be a short paragraph explaining the purpose of the service."
+      information_url:
+        - lang: en
+          text: "https://example.com/terms-of-service"
+      privacy_statement_url:
+        - lang: en
+          text: "https://example.com/privacy-policy"
+      keywords:
+        - lang: en
+          text: ["Matrix", "Element"]
+      logo:
+        - lang: en
+          text: "https://example.com/logo.svg"
+          width: "200"
+          height: "80"
+
+    organization:
+      name: Example com
+      display_name:
+        - ["Example co", "en"]
+      url: "http://example.com"
+
+    contact_person:
+      - given_name: Bob
+        sur_name: "the Sysadmin"
+        email_address": ["admin@example.com"]
+        contact_type": technical
+        
+  saml_session_lifetime: 5m
+  
+  user_mapping_provider:
+    # Below options are intended for the built-in provider, they should be 
+    # changed if using a custom module. 
+    config:
+      mxid_source_attribute: displayName
+      mxid_mapping: dotreplace
+  
+  grandfathered_mxid_source_attribute: upn
+
+  attribute_requirements:
+    - attribute: userGroup
+      value: "staff"
+    - attribute: department
+      value: "sales"
+
+  idp_entityid: 'https://our_idp/entityid'
+
+
+

Config option: oidc_providers

+

List of OpenID Connect (OIDC) / OAuth 2.0 identity providers, for registration +and login. See here +for information on how to configure these options.

+

For backwards compatibility, it is also possible to configure a single OIDC +provider via an oidc_config setting. This is now deprecated and admins are +advised to migrate to the oidc_providers format. (When doing that migration, +use oidc for the idp_id to ensure that existing users continue to be +recognised.)

+

Options for each entry include:

+ +

It is possible to configure Synapse to only allow logins if certain attributes +match particular values in the OIDC userinfo. The requirements can be listed under +attribute_requirements as shown here:

+
attribute_requirements:
+     - attribute: family_name
+       value: "Stephensson"
+     - attribute: groups
+       value: "admin"
+
+

All of the listed attributes must match for the login to be permitted. Additional attributes can be added to +userinfo by expanding the scopes section of the OIDC config to retrieve +additional information from the OIDC provider.

+

If the OIDC claim is a list, then the attribute must match any value in the list. +Otherwise, it must exactly match the value of the claim. Using the example +above, the family_name claim MUST be "Stephensson", but the groups +claim MUST contain "admin".

+

Example configuration:

+
oidc_providers:
+  # Generic example
+  #
+  - idp_id: my_idp
+    idp_name: "My OpenID provider"
+    idp_icon: "mxc://example.com/mediaid"
+    discover: false
+    issuer: "https://accounts.example.com/"
+    client_id: "provided-by-your-issuer"
+    client_secret: "provided-by-your-issuer"
+    client_auth_method: client_secret_post
+    scopes: ["openid", "profile"]
+    authorization_endpoint: "https://accounts.example.com/oauth2/auth"
+    token_endpoint: "https://accounts.example.com/oauth2/token"
+    userinfo_endpoint: "https://accounts.example.com/userinfo"
+    jwks_uri: "https://accounts.example.com/.well-known/jwks.json"
+    skip_verification: true
+    user_mapping_provider:
+      config:
+        subject_claim: "id"
+        localpart_template: "{{ user.login }}"
+        display_name_template: "{{ user.name }}"
+        email_template: "{{ user.email }}"
+    attribute_requirements:
+      - attribute: userGroup
+        value: "synapseUsers"
+
+
+

Config option: cas_config

+

Enable Central Authentication Service (CAS) for registration and login. +Has the following sub-options:

+ +

Example configuration:

+
cas_config:
+  enabled: true
+  server_url: "https://cas-server.com"
+  displayname_attribute: name
+  required_attributes:
+    userGroup: "staff"
+    department: None
+
+
+

Config option: sso

+

Additional settings to use with single-sign on systems such as OpenID Connect, +SAML2 and CAS.

+

Server admins can configure custom templates for pages related to SSO. See +here for more information.

+

Options include:

+ +

Example configuration:

+
sso:
+    client_whitelist:
+      - https://riot.im/develop
+      - https://my.custom.client/
+    update_profile_information: true
+
+
+

Config option: jwt_config

+

JSON web token integration. The following settings can be used to make +Synapse JSON web tokens for authentication, instead of its internal +password database.

+

Each JSON Web Token needs to contain a "sub" (subject) claim, which is +used as the localpart of the mxid.

+

Additionally, the expiration time ("exp"), not before time ("nbf"), +and issued at ("iat") claims are validated if present.

+

Note that this is a non-standard login type and client support is +expected to be non-existent.

+

See here for more.

+

Additional sub-options for this setting include:

+ +

Example configuration:

+
jwt_config:
+    enabled: true 
+    secret: "provided-by-your-issuer"
+    algorithm: "provided-by-your-issuer"
+    subject_claim: "name_of_claim"
+    issuer: "provided-by-your-issuer"
+    audiences:
+        - "provided-by-your-issuer"
+
+
+

Config option: password_config

+

Use this setting to enable password-based logins.

+

This setting has the following sub-options:

+ +

Example configuration:

+
password_config:
+   enabled: false
+   localdb_enabled: false
+   pepper: "EVEN_MORE_SECRET"
+
+   policy:
+      enabled: true
+      minimum_length: 15
+      require_digit: true
+      require_symbol: true
+      require_lowercase: true
+      require_uppercase: true
+
+
+

Config option: ui_auth

+

The amount of time to allow a user-interactive authentication session to be active.

+

This defaults to 0, meaning the user is queried for their credentials +before every action, but this can be overridden to allow a single +validation to be re-used. This weakens the protections afforded by +the user-interactive authentication process, by allowing for multiple +(and potentially different) operations to use the same validation session.

+

This is ignored for potentially "dangerous" operations (including +deactivating an account, modifying an account password, and +adding a 3PID).

+

Use the session_timeout sub-option here to change the time allowed for credential validation.

+

Example configuration:

+
ui_auth:
+    session_timeout: "15s"
+
+
+

Config option: email

+

Configuration for sending emails from Synapse.

+

Server admins can configure custom templates for email content. See +here for more information.

+

This setting has the following sub-options:

+ +

Example configuration:

+
email:
+  smtp_host: mail.server
+  smtp_port: 587
+  smtp_user: "exampleusername"
+  smtp_pass: "examplepassword"
+  require_transport_security: true
+  enable_tls: false
+  notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>"
+  app_name: my_branded_matrix_server
+  enable_notifs: true
+  notif_for_new_users: false
+  client_base_url: "http://localhost/riot"
+  validation_token_lifetime: 15m
+  invite_client_location: https://app.element.io
+
+  subjects:
+    message_from_person_in_room: "[%(app)s] You have a message on %(app)s from %(person)s in the %(room)s room..."
+    message_from_person: "[%(app)s] You have a message on %(app)s from %(person)s..."
+    messages_from_person: "[%(app)s] You have messages on %(app)s from %(person)s..."
+    messages_in_room: "[%(app)s] You have messages on %(app)s in the %(room)s room..."
+    messages_in_room_and_others: "[%(app)s] You have messages on %(app)s in the %(room)s room and others..."
+    messages_from_person_and_others: "[%(app)s] You have messages on %(app)s from %(person)s and others..."
+    invite_from_person_to_room: "[%(app)s] %(person)s has invited you to join the %(room)s room on %(app)s..."
+    invite_from_person: "[%(app)s] %(person)s has invited you to chat on %(app)s..."
+    password_reset: "[%(server_name)s] Password reset"
+    email_validation: "[%(server_name)s] Validate your email"
+
+
+

Push

+

Configuration settings related to push notifications

+
+

Config option: push

+

This setting defines options for push notifications.

+

This option has a number of sub-options. They are as follows:

+ +

Example configuration:

+
push:
+  include_content: false
+  group_unread_count_by_room: false
+
+
+

Rooms

+

Config options relating to rooms.

+
+

Config option: encryption_enabled_by_default

+

Controls whether locally-created rooms should be end-to-end encrypted by +default.

+

Possible options are "all", "invite", and "off". They are defined as:

+ +

The default value is "off".

+

Note that this option will only affect rooms created after it is set. It +will also not affect rooms created by other servers.

+

Example configuration:

+
encryption_enabled_by_default_for_room_type: invite
+
+
+

Config option: enable_group_creation

+

Set to true to allow non-server-admin users to create groups on this server

+

Example configuration:

+
enable_group_creation: true
+
+
+

Config option: group_creation_prefix

+

If enabled/present, non-server admins can only create groups with local parts +starting with this prefix.

+

Example configuration:

+
group_creation_prefix: "unofficial_"
+
+
+

Config option: user_directory

+

This setting defines options related to the user directory.

+

This option has the following sub-options:

+ +

Example configuration:

+
user_directory:
+    enabled: false
+    search_all_users: true
+    prefer_local_users: true
+
+
+

Config option: user_consent

+

For detailed instructions on user consent configuration, see here.

+

Parts of this section are required if enabling the consent resource under +listeners, in particular template_dir and version. # TODO: link listeners

+ +

Example configuration:

+
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
+
+
+

Config option: stats

+

Settings for local room and user statistics collection. See here +for more.

+ +

Example configuration:

+
stats:  
+  enabled: false
+
+
+

Config option: server_notices

+

Use this setting to enable a room which can be used to send notices +from the server to users. It is a special room which users cannot leave; notices +in the room come from a special "notices" user id.

+

If you use this setting, you must define the system_mxid_localpart +sub-setting, which defines the id of the user which will be used to send the +notices.

+

Sub-options for this setting include:

+ +

Example configuration:

+
server_notices:
+  system_mxid_localpart: notices
+  system_mxid_display_name: "Server Notices"
+  system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
+  room_name: "Server Notices"
+
+
+

Config option: enable_room_list_search

+

Set to false 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. Defaults to true.

+

Example configuration:

+
enable_room_list_search: false
+
+
+

Config option: alias_creation

+

The alias_creation option controls who is allowed to create aliases +on this server.

+

The format of this option is a list of rules that contain globs that +match against user_id, room_id and the new alias (fully qualified with +server name). The action in the first rule that matches is taken, +which can currently either be "allow" or "deny".

+

Missing user_id/room_id/alias fields default to "*".

+

If no rules match the request is denied. An empty list means no one +can create aliases.

+

Options for the rules include:

+ +

Example configuration:

+
alias_creation_rules:
+  - user_id: "bad_user"
+    alias: "spammy_alias"
+    room_id: "*"
+    action: deny
+
+
+

Config options: room_list_publication_rules

+

The room_list_publication_rules option controls who can publish and +which rooms can be published in the public room list.

+

The format of this option is the same as that for +alias_creation_rules.

+

If the room has one or more aliases associated with it, only one of +the aliases needs to match the alias rule. If there are no aliases +then only rules with alias: * match.

+

If no rules match the request is denied. An empty list means no one +can publish rooms.

+

Options for the rules include:

+ +

Example configuration:

+
room_list_publication_rules:
+  - user_id: "*"
+    alias: "*"
+    room_id: "*"
+    action: allow
+
+
+

Opentracing

+

Configuration options related to Opentracing support.

+
+

Config option: opentracing

+

These settings enable and configure opentracing, which implements distributed tracing. +This allows you to observe the causal chains of events across servers +including requests, key lookups etc., across any server running +synapse or any other services which support opentracing +(specifically those implemented with Jaeger).

+

Sub-options include:

+ +

Example configuration:

+
opentracing:
+    enabled: true
+    homeserver_whitelist:
+      - ".*"
+    force_tracing_for_users:
+      - "@user1:server_name"
+      - "@user2:server_name"
+
+    jaeger_config:
+      sampler:
+        type: const
+        param: 1
+      logging:
+        false
+
+
+

Workers

+

Configuration options related to workers.

+
+

Config option: send_federation

+

Controls sending of outbound federation transactions on the main process. +Set to false if using a federation sender worker. Defaults to true.

+

Example configuration:

+
send_federation: false
+
+
+

Config option: federation_sender_instances

+

It is possible to run multiple federation sender workers, in which case the +work is balanced across them. Use this setting to list the senders.

+

This configuration setting must be shared between all federation sender workers, and if +changed all federation sender workers must be stopped at the same time and then +started, to ensure that all instances are running with the same config (otherwise +events may be dropped).

+

Example configuration:

+
federation_sender_instances:
+  - federation_sender1
+
+
+

Config option: instance_map

+

When using workers this should be a map from worker name to the +HTTP replication listener of the worker, if configured.

+

Example configuration:

+
instance_map:
+  worker1:
+    host: localhost
+    port: 8034
+
+
+

Config option: stream_writers

+

Experimental: When using workers you can define which workers should +handle event persistence and typing notifications. Any worker +specified here must also be in the instance_map.

+

Example configuration:

+
stream_writers:
+  events: worker1
+  typing: worker1
+
+
+

Config option: run_background_task_on

+

The worker that is used to run background tasks (e.g. cleaning up expired +data). If not provided this defaults to the main process.

+

Example configuration:

+
run_background_tasks_on: worker1
+
+
+

Config option: worker_replication_secret

+

A shared secret used by the replication APIs to authenticate HTTP requests +from workers.

+

By default this is unused and traffic is not authenticated.

+

Example configuration:

+
worker_replication_secret: "secret_secret"
+
+

Config option: redis

+

Configuration for Redis when using workers. This must be enabled when +using workers (unless using old style direct TCP configuration). +This setting has the following sub-options:

+ +

Example configuration:

+
redis:
+  enabled: true
+  host: localhost
+  port: 6379
+  password: <secret_password>
+
+

Background Updates

+

Configuration settings related to background updates.

+
+

Config option: background_updates

+

Background updates are database updates that are run in the background in batches. +The duration, minimum batch size, default batch size, whether to sleep between batches and if so, how long to +sleep can all be configured. This is helpful to speed up or slow down the updates. +This setting has the following sub-options:

+ +

Example configuration:

+
background_updates:
+    background_update_duration_ms: 500
+    sleep_enabled: false
+    sleep_duration_ms: 300
+    min_batch_size: 10
+    default_batch_size: 50
+

Homeserver Sample Configuration File

Below is a sample homeserver configuration file. The homeserver configuration file can be tweaked to change the behaviour of your homeserver. A restart of the server is @@ -7889,7 +10808,7 @@ space, it will start writing new data into where the purged data was.

operating system, the server admin needs to run VACUUM FULL; (or VACUUM; for SQLite databases) on Synapse's database (see the related PostgreSQL documentation).

-

Modules

+

Modules

Synapse supports extending its functionality by configuring external modules.

Note: When using third-party modules, you effectively allow someone else to run custom code on your Synapse homeserver. Server admins are encouraged to verify the @@ -12826,7 +15745,7 @@ present this information through a series of pretty graphs.

image

Still, it's probably worth investigating why we're getting users from the database that often, and whether it's possible to reduce the amount of queries we make by adjusting our cache factor(s).

The persist_events transaction is responsible for saving new room events to the Synapse database, so can often show a high transaction duration.

-

Federation

+

Federation

The charts in the "Federation" section show information about incoming and outgoing federation requests. Federation data can be divided into two basic types: