Synapse has added stable support for MSC4143
+and serves GET /_matrix/client/v1/rtc/transports with the transports configured in
+matrix_rtc.transports.
Clients that implement the stable LiveKit transport from MSC4195
+expect transports of type m.livekit. The livekit transport type is deprecated. An
+m.livekit config entry should be added for each LiveKit SFU. As long as clients still
+depend on the unstable LiveKit transport from earlier versions of MSC4195,
+matching livekit entries should still be listed in addition.
The minimum supported Python version has been increased from v3.10 to v3.11.
@@ -6657,18 +6667,29 @@ These limits are applied in addition to the max_upload_size limit a
This setting has the following sub-options:
transports (array): A list of transport types and arguments to use for MatrixRTC connections. Defaults to [].
transports (array): A list of MatrixRTC transports advertised to clients on /_matrix/client/v1/rtc/transports and, if it is enabled via experimental_features.msc4143_enabled, the unstable /_matrix/client/unstable/org.matrix.msc4143/rtc/transports endpoint. Defaults to [].
Options for each entry include:
type (string): The type of transport to use to connect to the selective forwarding unit (SFU).
type (string): The type of transport to advertise to clients.
Transports of type m.livekit advertise the stable transport based on LiveKit’s selective
+forwarding unit (SFU).
url (string): The WebSocket URL of the LiveKit SFU. If type is “livekit”, either this or livekit_service_url is required.
Transports of type livekit advertise the unstable version of the LiveKit-based transport.
+This type is deprecated and should only be used when backwards compatibility for clients
+that don’t yet support the stable transport is required.
url (string): The WebSocket URL of the LiveKit SFU. If type is “m.livekit”, this is required. If type is “livekit”, either this or livekit_service_url is required.
Clients that support url will use the Client-Server API to (indirectly) interact with the LiveKit authorization service. The service needs to be set up as an application service in order to support these endpoints. See https://github.com/element-hq/lk-jwt-service for further details.
livekit_service_url (string): Deprecated. The HTTP URL of the LiveKit authorization service. If type is “livekit”, either this or url is required.
livekit_service_url (string): Deprecated. The HTTP URL of the LiveKit authorization service. If type is “livekit”, either this or url is required.
Clients that don’t support url will use livekit_service_url to directly interact with the LiveKit authorization service. This mode of operation is deprecated and should only be used for backwards compatibility.
max_upload_size limit a
Example configuration:
matrix_rtc:
transports:
+ - type: m.livekit
+ url: wss://livekit.example.com
- type: livekit
url: wss://livekit.example.com
livekit_service_url: https://matrix-rtc.example.com/livekit/jwt
diff --git a/develop/replication.html b/develop/replication.html
index cc8aded3e2..f3b9d39fd5 100644
--- a/develop/replication.html
+++ b/develop/replication.html
@@ -37,7 +37,7 @@
const path_to_root = "";
const default_light_theme = "light";
const default_dark_theme = "navy";
- window.path_to_searchindex_js = "searchindex-509f6cc2.js";
+ window.path_to_searchindex_js = "searchindex-7ceaf60c.js";
diff --git a/develop/reverse_proxy.html b/develop/reverse_proxy.html
index 945452be45..c6b8b6672c 100644
--- a/develop/reverse_proxy.html
+++ b/develop/reverse_proxy.html
@@ -37,7 +37,7 @@
const path_to_root = "";
const default_light_theme = "light";
const default_dark_theme = "navy";
- window.path_to_searchindex_js = "searchindex-509f6cc2.js";
+ window.path_to_searchindex_js = "searchindex-7ceaf60c.js";
diff --git a/develop/room_and_user_statistics.html b/develop/room_and_user_statistics.html
index c124629fca..c7f6747a8e 100644
--- a/develop/room_and_user_statistics.html
+++ b/develop/room_and_user_statistics.html
@@ -37,7 +37,7 @@
const path_to_root = "";
const default_light_theme = "light";
const default_dark_theme = "navy";
- window.path_to_searchindex_js = "searchindex-509f6cc2.js";
+ window.path_to_searchindex_js = "searchindex-7ceaf60c.js";
diff --git a/develop/schema/synapse-config.schema.json b/develop/schema/synapse-config.schema.json
index 0f62aad550..ac6b0a8fba 100644
--- a/develop/schema/synapse-config.schema.json
+++ b/develop/schema/synapse-config.schema.json
@@ -2628,22 +2628,22 @@
"properties": {
"type": {
"type": "string",
- "description": "The type of transport to use to connect to the selective forwarding unit (SFU).",
- "example": "livekit"
+ "description": "The type of transport to advertise to clients.\n\n- Transports of type `m.livekit` advertise the stable transport based on LiveKit's selective\n forwarding unit (SFU).\n\n- Transports of type `livekit` advertise the unstable version of the LiveKit-based transport.\n This type is deprecated and should only be used when backwards compatibility for clients\n that don't yet support the stable transport is required.",
+ "example": "m.livekit"
},
"url": {
"type": "string",
- "description": "The WebSocket URL of the LiveKit SFU. If type is \"livekit\", either this or `livekit_service_url` is required.\n\nClients that support `url` will use the Client-Server API to (indirectly) interact with the LiveKit authorization service. The service needs to be set up as an application service in order to support these endpoints. See https://github.com/element-hq/lk-jwt-service for further details.",
+ "description": "The WebSocket URL of the LiveKit SFU. If `type` is \"m.livekit\", this is required. If `type` is \"livekit\", either this or `livekit_service_url` is required.\n\nClients that support `url` will use the Client-Server API to (indirectly) interact with the LiveKit authorization service. The service needs to be set up as an application service in order to support these endpoints. See https://github.com/element-hq/lk-jwt-service for further details.",
"example": "wss://livekit.example.com"
},
"livekit_service_url": {
"type": "string",
- "description": "Deprecated. The HTTP URL of the LiveKit authorization service. If type is \"livekit\", either this or `url` is required.\n\nClients that don't support `url` will use `livekit_service_url` to directly interact with the LiveKit authorization service. This mode of operation is deprecated and should only be used for backwards compatibility.",
+ "description": "Deprecated. The HTTP URL of the LiveKit authorization service. If `type` is \"livekit\", either this or `url` is required.\n\nClients that don't support `url` will use `livekit_service_url` to directly interact with the LiveKit authorization service. This mode of operation is deprecated and should only be used for backwards compatibility.",
"example": "https://matrix-rtc.example.com/livekit/jwt"
}
}
},
- "description": "A list of transport types and arguments to use for MatrixRTC connections.",
+ "description": "A list of MatrixRTC transports advertised to clients on `/_matrix/client/v1/rtc/transports` and, if it is enabled via `experimental_features.msc4143_enabled`, the unstable `/_matrix/client/unstable/org.matrix.msc4143/rtc/transports` endpoint.",
"default": []
}
},
@@ -2651,6 +2651,10 @@
"examples": [
{
"transports": [
+ {
+ "type": "m.livekit",
+ "url": "wss://livekit.example.com"
+ },
{
"type": "livekit",
"url": "wss://livekit.example.com",
diff --git a/develop/searcher-c2a407aa.js b/develop/searcher-c2a407aa.js
index 06a9032032..7995cf1a0c 100644
--- a/develop/searcher-c2a407aa.js
+++ b/develop/searcher-c2a407aa.js
@@ -437,7 +437,7 @@ window.search = window.search || {};
if (yes) {
loadSearchScript(
window.path_to_searchindex_js ||
- path_to_root + 'searchindex-509f6cc2.js',
+ path_to_root + 'searchindex-7ceaf60c.js',
'mdbook-search-index');
search_wrap.classList.remove('hidden');
searchicon.setAttribute('aria-expanded', 'true');
diff --git a/develop/searchindex-509f6cc2.js b/develop/searchindex-509f6cc2.js
deleted file mode 100644
index c6fc287120..0000000000
--- a/develop/searchindex-509f6cc2.js
+++ /dev/null
@@ -1 +0,0 @@
-window.search = Object.assign(window.search, JSON.parse('{"doc_urls":["welcome_and_overview.html#introduction","welcome_and_overview.html#installing-and-using-synapse","welcome_and_overview.html#developing-on-synapse","welcome_and_overview.html#reporting-a-security-vulnerability","setup/installation.html#installation-instructions","setup/installation.html#choosing-your-server-name","setup/installation.html#installing-synapse","setup/installation.html#prebuilt-packages","setup/installation.html#installing-as-a-python-module-from-pypi","setup/installation.html#setting-up-synapse","setup/installation.html#using-postgresql","setup/installation.html#tls-certificates","setup/installation.html#client-well-known-uri","setup/installation.html#email","setup/installation.html#registering-a-user","setup/installation.html#setting-up-a-turn-server","setup/installation.html#url-previews","setup/installation.html#backups","setup/installation.html#troubleshooting-installation","setup/security.html#security","setup/security.html#content-repository","setup/security.html#firewall-configuration","postgres.html#using-postgres","postgres.html#install-postgres-client-libraries","postgres.html#set-up-database","postgres.html#synapse-config","postgres.html#postgresql-major-version-upgrades","postgres.html#backups","postgres.html#tuning-postgres","postgres.html#porting-from-sqlite","postgres.html#overview","postgres.html#using-the-port-script","postgres.html#troubleshooting","postgres.html#alternative-auth-methods","postgres.html#fixing-incorrect-collate-or-ctype","reverse_proxy.html#using-a-reverse-proxy-with-synapse","reverse_proxy.html#homeserver-configuration","reverse_proxy.html#reverse-proxy-configuration-examples","reverse_proxy.html#nginx","reverse_proxy.html#nginx-proxy-manager-or-npmplus","reverse_proxy.html#caddy-v2","reverse_proxy.html#apache","reverse_proxy.html#haproxy","reverse_proxy.html#relayd","reverse_proxy.html#lighttpd","reverse_proxy.html#health-check-endpoint","reverse_proxy.html#synapse-administration-endpoints","setup/forward_proxy.html#using-a-forward-proxy-with-synapse","setup/forward_proxy.html#configure","setup/forward_proxy.html#connection-types","setup/forward_proxy.html#troubleshooting","turn-howto.html#overview","turn-howto.html#requirements","turn-howto.html#synapse-setup","turn-howto.html#troubleshooting","setup/turn/coturn.html#coturn-turn-server","setup/turn/coturn.html#coturn-setup","setup/turn/coturn.html#initial-installation","setup/turn/coturn.html#configuration","setup/turn/eturnal.html#eturnal-turn-server","setup/turn/eturnal.html#eturnal-setup","setup/turn/eturnal.html#initial-installation","setup/turn/eturnal.html#configuration","setup/turn/eturnal.html#eturnalctl-opterations-script","delegate.html#delegation-of-incoming-federation-traffic","delegate.html#well-known-delegation","delegate.html#external-server","delegate.html#serving-a-well-knownmatrixserver-file-with-synapse","delegate.html#srv-dns-record-delegation","delegate.html#delegation-faq","delegate.html#when-do-i-need-delegation","delegate.html#should-i-use-a-reverse-proxy-for-federation-traffic","upgrade.html#upgrading-synapse","upgrade.html#rolling-back-to-older-versions","upgrade.html#upgrading-from-a-very-old-version","upgrade.html#upgrading-to-v11640","upgrade.html#python-311-is-now-required","upgrade.html#upgrading-to-v11630","upgrade.html#limit_profile_requests_to_users_who_share_rooms-now-requires-require_auth_for_profile_requests","upgrade.html#privacy-preserving-requesttoken-responses-are-now-enabled-by-default","upgrade.html#upgrading-to-v11610","upgrade.html#deprecation-of-matrix_rtclivekit_service_url","upgrade.html#upgrading-to-v11590","upgrade.html#change-of-signing-key-expiry-date-for-the-debianubuntu-package-repository-2026","upgrade.html#upgrading-to-v11580","upgrade.html#drop-support-for-ubuntu-2510-questing-quokka-add-support-for-ubuntu-2604-resolute-raccoon","upgrade.html#upgrading-to-v11570","upgrade.html#msc3861-auth-delegation-must-be-migrated-to-stable-matrix-authentication-service-integration","upgrade.html#upgrading-to-v11520","upgrade.html#workers-which-quarantine-media-must-be-stream-writers","upgrade.html#upgrading-to-v11500","upgrade.html#removal-of-the-systemd-pip-extra","upgrade.html#module-api-deprecation-of-the-deactivation-parameter-in-the-set_displayname-method","upgrade.html#updated-request-log-format-processed-request-","upgrade.html#upgrading-to-v11460","upgrade.html#drop-support-for-ubuntu-2504-plucky-puffin-and-add-support-for-2510-questing-quokka","upgrade.html#removal-of-msc2697-legacy-dehydrated-devices","upgrade.html#upgrading-to-v11440","upgrade.html#worker-support-for-unstable-msc4140-restart-endpoint","upgrade.html#unstable-mutual-rooms-endpoint-is-now-behind-an-experimental-feature-flag","upgrade.html#upgrading-to-v11430","upgrade.html#dropping-support-for-postgresql-13","upgrade.html#upgrading-to-v11420","upgrade.html#python-310-is-now-required","upgrade.html#sqlite-3400-is-now-required","upgrade.html#upgrading-to-v11410","upgrade.html#docker-images-now-based-on-debian-trixie-with-python-313","upgrade.html#upgrading-to-v11400","upgrade.html#users-of-synapse-s3-storage-provider-must-update-the-module-to-v160","upgrade.html#upgrading-to-v11390","upgrade.html#register-requests-from-old-application-service-implementations-may-break-when-using-mas","upgrade.html#upgrading-to-v11382","upgrade.html#drop-support-for-ubuntu-2410-oracular-oriole-and-add-support-for-ubuntu-2504-plucky-puffin","upgrade.html#upgrading-to-v11360","upgrade.html#deprecate-run_as_background_process-exported-as-part-of-the-module-api-interface-in-favor-of-moduleapirun_as_background_process","upgrade.html#metric-labels-have-changed-on-synapse_federation_last_received_pdu_time-and-synapse_federation_last_sent_pdu_time","upgrade.html#stable-integration-with-matrix-authentication-service","upgrade.html#upgrading-to-v11350","upgrade.html#on_user_registration-module-api-callback-may-now-run-on-any-worker","upgrade.html#upgrading-to-v11340","upgrade.html#icu-bundled-with-synapse","upgrade.html#upgrading-to-v11300","upgrade.html#documented-endpoint-which-can-be-delegated-to-a-federation-worker","upgrade.html#upgrading-to-v11260","upgrade.html#room-list-publication-rules-change","upgrade.html#change-of-signing-key-expiry-date-for-the-debianubuntu-package-repository","upgrade.html#upgrading-to-v11220","upgrade.html#dropping-support-for-postgresql-11-and-12","upgrade.html#upgrading-to-v11200","upgrade.html#removal-of-experimental-msc3886-feature","upgrade.html#authenticated-media-is-now-enforced-by-default","upgrade.html#upgrading-to-v11190","upgrade.html#minimum-supported-python-version","upgrade.html#upgrading-to-v11110","upgrade.html#new-worker-endpoints-for-authenticated-client-and-federation-media","upgrade.html#upgrading-to-v11060","upgrade.html#minimum-supported-rust-version","upgrade.html#upgrading-to-v11000","upgrade.html#minimum-supported-rust-version-1","upgrade.html#upgrading-to-v1930","upgrade.html#minimum-supported-rust-version-2","upgrade.html#upgrading-to-v1900","upgrade.html#app-service-query-parameter-authorization-is-now-a-configuration-option","upgrade.html#upgrading-to-v1890","upgrade.html#removal-of-unspecced-user-property-for-register","upgrade.html#upgrading-to-v1880","upgrade.html#minimum-supported-python-version-1","upgrade.html#removal-of-worker_replication_-settings","upgrade.html#upgrading-to-v1860","upgrade.html#minimum-supported-rust-version-3","upgrade.html#upgrading-to-v1850","upgrade.html#application-service-registration-with-user-property-deprecation","upgrade.html#upgrading-to-v1840","upgrade.html#deprecation-of-worker_replication_-configuration-settings","upgrade.html#example-change","upgrade.html#upgrading-to-v1810","upgrade.html#application-service-path--authentication-deprecations","upgrade.html#upgrading-to-v1800","upgrade.html#reporting-events-error-code-change","upgrade.html#upgrading-to-v1790","upgrade.html#the-on_threepid_bind-module-callback-method-has-been-deprecated","upgrade.html#upgrading-to-v1780","upgrade.html#deprecate-the-_synapseadminv1mediaserver_namedelete-admin-api","upgrade.html#upgrading-to-v1760","upgrade.html#faster-joins-are-enabled-by-default","upgrade.html#changes-to-the-account-data-replication-streams","upgrade.html#minimum-version-of-poetry-is-now-132","upgrade.html#upgrading-to-v1740","upgrade.html#unicode-support-in-user-search","upgrade.html#user-directory-rebuild","upgrade.html#upgrading-to-v1730","upgrade.html#legacy-prometheus-metric-names-have-now-been-removed","upgrade.html#upgrading-to-v1720","upgrade.html#dropping-support-for-postgresql-10","upgrade.html#upgrading-to-v1710","upgrade.html#removal-of-the-generate_short_term_login_token-module-api-method","upgrade.html#changes-to-the-events-received-by-application-services-interest","upgrade.html#legacy-prometheus-metric-names-are-now-disabled-by-default","upgrade.html#upgrading-to-v1690","upgrade.html#changes-to-the-receipts-replication-streams","upgrade.html#deprecation-of-legacy-prometheus-metric-names","upgrade.html#deprecation-of-the-generate_short_term_login_token-module-api-method","upgrade.html#upgrading-to-v1680","upgrade.html#sqlite-version-requirement","upgrade.html#rust-requirement-when-building-from-source","upgrade.html#upgrading-to-v1670","upgrade.html#direct-tcp-replication-is-no-longer-supported-migrate-to-redis","upgrade.html#minimum-version-of-poetry-is-now-v120","upgrade.html#rust-requirement-in-the-next-release","upgrade.html#sqlite-version-requirement-in-the-next-release","upgrade.html#upgrading-to-v1660","upgrade.html#delegation-of-email-validation-no-longer-supported","upgrade.html#upgrading-to-v1640","upgrade.html#deprecation-of-the-ability-to-delegate-e-mail-verification-to-identity-servers","upgrade.html#changes-to-the-event-replication-streams","upgrade.html#frozendict-release","upgrade.html#upgrading-to-v1620","upgrade.html#new-signatures-for-spam-checker-callbacks","upgrade.html#upgrading-to-v1610","upgrade.html#removal-of-deprecated-communitygroups","upgrade.html#worker-endpoints","upgrade.html#upgrading-to-v1600","upgrade.html#adding-a-new-unique-index-to-state_group_edges-could-fail-if-your-database-is-corrupted","upgrade.html#on-postgres","upgrade.html#on-sqlite","upgrade.html#for-more-details","upgrade.html#new-signature-for-the-spam-checker-callback-check_event_for_spam","upgrade.html#upgrading-to-v1590","upgrade.html#device-name-lookup-over-federation-has-been-disabled-by-default","upgrade.html#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types","upgrade.html#upgrading-to-v1580","upgrade.html#groupscommunities-feature-has-been-disabled-by-default","upgrade.html#upgrading-to-v1570","upgrade.html#changes-to-database-schema-for-application-services","upgrade.html#upgrading-to-v1560","upgrade.html#open-registration-without-verification-is-now-disabled-by-default","upgrade.html#groupscommunities-feature-has-been-deprecated","upgrade.html#change-in-behaviour-for-postgresql-databases-with-unsafe-locale","upgrade.html#upgrading-to-v1550","upgrade.html#synctl-script-has-been-moved","upgrade.html#compatibility-dropped-for-mjolnir-131-and-earlier","upgrade.html#upgrading-to-v1540","upgrade.html#legacy-structured-logging-configuration-removal","upgrade.html#upgrading-to-v1530","upgrade.html#dropping-support-for-webclient-listeners-and-non-https-web_client_location","upgrade.html#stablisation-of-msc3231","upgrade.html#time-based-cache-expiry-is-now-enabled-by-default","upgrade.html#deprecation-of-capability-orgmatrixmsc3283","upgrade.html#removal-of-user_may_create_room_with_invites","upgrade.html#upgrading-to-v1520","upgrade.html#twisted-security-release","upgrade.html#upgrading-to-v1510","upgrade.html#deprecation-of-webclient-listeners-and-non-https-web_client_location","upgrade.html#upgrading-to-v1500","upgrade.html#dropping-support-for-old-python-and-postgres-versions","upgrade.html#upgrading-to-v1470","upgrade.html#removal-of-old-room-admin-api","upgrade.html#deprecation-of-the-user_may_create_room_with_invites-module-callback","upgrade.html#upgrading-to-v1450","upgrade.html#changes-required-to-media-storage-provider-modules-when-reading-from-the-synapse-configuration-object","upgrade.html#upgrading-to-v1440","upgrade.html#the-url-preview-cache-is-no-longer-mirrored-to-storage-providers","upgrade.html#upgrading-to-v1430","upgrade.html#the-spaces-summary-apis-can-now-be-handled-by-workers","upgrade.html#upgrading-to-v1420","upgrade.html#removal-of-old-room-admin-api-1","upgrade.html#user-interactive-authentication-fallback-templates-can-now-display-errors","upgrade.html#removal-of-out-of-date-email-pushers","upgrade.html#upgrading-to-v1410","upgrade.html#add-support-for-routing-outbound-http-requests-via-a-proxy-for-federation","upgrade.html#deprecation-of-template_dir","upgrade.html#_synapseadminv1usersuseridmedia-must-be-handled-by-media-workers","upgrade.html#upgrading-to-v1390","upgrade.html#deprecation-of-the-current-third-party-rules-module-interface","upgrade.html#upgrading-to-v1380","upgrade.html#re-indexing-of-events-table-on-postgres-databases","upgrade.html#upgrading-to-v1370","upgrade.html#deprecation-of-the-current-spam-checker-interface","upgrade.html#upgrading-to-v1340","upgrade.html#room_invite_state_types-configuration-setting","upgrade.html#upgrading-to-v1330","upgrade.html#account-validity-html-templates-can-now-display-a-users-expiration-date","upgrade.html#upgrading-to-v1320","upgrade.html#regression-causing-connected-prometheus-instances-to-become-overwhelmed","upgrade.html#dropping-support-for-old-python-postgres-and-sqlite-versions","upgrade.html#removal-of-old-list-accounts-admin-api","upgrade.html#application-services-must-use-type-mloginapplication_service-when-registering-users","upgrade.html#upgrading-to-v1290","upgrade.html#requirement-for-x-forwarded-proto-header","upgrade.html#upgrading-to-v1270","upgrade.html#changes-to-callback-uri-for-oauth2--openid-connect-and-saml2","upgrade.html#changes-to-html-templates","upgrade.html#upgrading-to-v1260","upgrade.html#rolling-back-to-v1250-after-a-failed-upgrade","upgrade.html#upgrading-to-v1250","upgrade.html#last-release-supporting-python-35","upgrade.html#blacklisting-ip-ranges","upgrade.html#upgrading-to-v1240","upgrade.html#custom-openid-connect-mapping-provider-breaking-change","upgrade.html#removal-historical-synapse-admin-api","upgrade.html#upgrading-to-v1230","upgrade.html#structured-logging-configuration-breaking-changes","upgrade.html#upgrading-to-v1220","upgrade.html#thirdpartyeventrules-breaking-changes","upgrade.html#upgrading-to-v1210","upgrade.html#forwarding-_synapseclient-through-your-reverse-proxy","upgrade.html#new-html-templates","upgrade.html#updated-single-sign-on-html-templates","upgrade.html#upgrading-to-v1180","upgrade.html#docker--py3-suffix-will-be-removed-in-future-versions","upgrade.html#redis-replication-is-now-recommended-in-lieu-of-tcp-replication","upgrade.html#upgrading-to-v1140","upgrade.html#upgrading-to-v1130","upgrade.html#incorrect-database-migration-in-old-synapse-versions","upgrade.html#new-single-sign-on-html-templates","upgrade.html#synapse-sso-plugins-method-deprecation","upgrade.html#rolling-back-to-v1124-after-a-failed-upgrade","upgrade.html#upgrading-to-v1120","upgrade.html#upgrading-to-v1100","upgrade.html#upgrading-to-v180","upgrade.html#upgrading-to-v170","upgrade.html#upgrading-to-v150","upgrade.html#upgrading-to-v140","upgrade.html#new-custom-templates","upgrade.html#3pid-verification-changes","upgrade.html#email","upgrade.html#phone-numbers","upgrade.html#rolling-back-to-v131","upgrade.html#upgrading-to-v120","upgrade.html#upgrading-to-v110","upgrade.html#minimum-python-version","upgrade.html#minimum-postgresql-version","upgrade.html#upgrading-to-v10","upgrade.html#validation-of-tls-certificates","upgrade.html#email-1","upgrade.html#new-email-templates","upgrade.html#upgrading-to-v0990","upgrade.html#upgrading-to-v0340","upgrade.html#upgrading-to-v0337","upgrade.html#upgrading-to-v0273","upgrade.html#upgrading-to-v0150","upgrade.html#upgrading-to-v0110","upgrade.html#upgrading-to-v090","upgrade.html#upgrading-to-v080","upgrade.html#upgrading-to-v070","upgrade.html#upgrading-to-v060","upgrade.html#upgrading-to-v051","upgrade.html#upgrading-to-v050","upgrade.html#upgrading-to-v040","upgrade.html#upgrading-to-v030","upgrade.html#web-client","upgrade.html#upgrading-to-v020","upgrade.html#upgrading-to-v001","federate.html#setting-up-federation","federate.html#troubleshooting","federate.html#known-issues","federate.html#running-a-demo-federation-of-synapses","usage/configuration/index.html#configuration","usage/configuration/config_documentation.html#configuring-synapse","usage/configuration/config_documentation.html#config-conventions","usage/configuration/config_documentation.html#config-validation","usage/configuration/config_documentation.html#yaml","usage/configuration/config_documentation.html#modules","usage/configuration/config_documentation.html#modules-1","usage/configuration/config_documentation.html#server","usage/configuration/config_documentation.html#server_name","usage/configuration/config_documentation.html#pid_file","usage/configuration/config_documentation.html#daemonize","usage/configuration/config_documentation.html#print_pidfile","usage/configuration/config_documentation.html#user_agent_suffix","usage/configuration/config_documentation.html#use_frozen_dicts","usage/configuration/config_documentation.html#web_client_location","usage/configuration/config_documentation.html#public_baseurl","usage/configuration/config_documentation.html#serve_server_wellknown","usage/configuration/config_documentation.html#extra_well_known_client_content","usage/configuration/config_documentation.html#soft_file_limit","usage/configuration/config_documentation.html#presence","usage/configuration/config_documentation.html#require_auth_for_profile_requests","usage/configuration/config_documentation.html#limit_profile_requests_to_users_who_share_rooms","usage/configuration/config_documentation.html#include_profile_data_on_invite","usage/configuration/config_documentation.html#include_profile_updates_in_sync","usage/configuration/config_documentation.html#allow_public_rooms_without_auth","usage/configuration/config_documentation.html#allow_public_rooms_over_federation","usage/configuration/config_documentation.html#default_room_version","usage/configuration/config_documentation.html#gc_thresholds","usage/configuration/config_documentation.html#gc_min_interval","usage/configuration/config_documentation.html#filter_timeline_limit","usage/configuration/config_documentation.html#block_non_admin_invites","usage/configuration/config_documentation.html#enable_search","usage/configuration/config_documentation.html#ip_range_blacklist","usage/configuration/config_documentation.html#ip_range_whitelist","usage/configuration/config_documentation.html#listeners","usage/configuration/config_documentation.html#manhole","usage/configuration/config_documentation.html#manhole_settings","usage/configuration/config_documentation.html#http_proxy","usage/configuration/config_documentation.html#https_proxy","usage/configuration/config_documentation.html#no_proxy_hosts","usage/configuration/config_documentation.html#matrix_authentication_service","usage/configuration/config_documentation.html#dummy_events_threshold","usage/configuration/config_documentation.html#delete_stale_devices_after","usage/configuration/config_documentation.html#email","usage/configuration/config_documentation.html#max_event_delay_duration","usage/configuration/config_documentation.html#user_types","usage/configuration/config_documentation.html#homeserver-blocking","usage/configuration/config_documentation.html#admin_contact","usage/configuration/config_documentation.html#hs_disabled","usage/configuration/config_documentation.html#hs_disabled_message","usage/configuration/config_documentation.html#limit_usage_by_mau","usage/configuration/config_documentation.html#max_mau_value","usage/configuration/config_documentation.html#mau_trial_days","usage/configuration/config_documentation.html#mau_appservice_trial_days","usage/configuration/config_documentation.html#mau_limit_alerting","usage/configuration/config_documentation.html#mau_stats_only","usage/configuration/config_documentation.html#mau_limit_reserved_threepids","usage/configuration/config_documentation.html#server_context","usage/configuration/config_documentation.html#limit_remote_rooms","usage/configuration/config_documentation.html#require_membership_for_aliases","usage/configuration/config_documentation.html#allow_per_room_profiles","usage/configuration/config_documentation.html#max_avatar_size","usage/configuration/config_documentation.html#allowed_avatar_mimetypes","usage/configuration/config_documentation.html#redaction_retention_period","usage/configuration/config_documentation.html#redaction_allowed_period","usage/configuration/config_documentation.html#forgotten_room_retention_period","usage/configuration/config_documentation.html#user_ips_max_age","usage/configuration/config_documentation.html#request_token_inhibit_3pid_errors","usage/configuration/config_documentation.html#next_link_domain_whitelist","usage/configuration/config_documentation.html#templates","usage/configuration/config_documentation.html#retention","usage/configuration/config_documentation.html#tls","usage/configuration/config_documentation.html#tls_certificate_path","usage/configuration/config_documentation.html#tls_private_key_path","usage/configuration/config_documentation.html#federation_verify_certificates","usage/configuration/config_documentation.html#federation_client_minimum_tls_version","usage/configuration/config_documentation.html#federation_certificate_verification_whitelist","usage/configuration/config_documentation.html#federation_custom_ca_list","usage/configuration/config_documentation.html#federation","usage/configuration/config_documentation.html#federation_domain_whitelist","usage/configuration/config_documentation.html#federation_whitelist_endpoint_enabled","usage/configuration/config_documentation.html#federation_metrics_domains","usage/configuration/config_documentation.html#allow_profile_lookup_over_federation","usage/configuration/config_documentation.html#allow_device_name_lookup_over_federation","usage/configuration/config_documentation.html#federation-1","usage/configuration/config_documentation.html#caching","usage/configuration/config_documentation.html#event_cache_size","usage/configuration/config_documentation.html#caches","usage/configuration/config_documentation.html#reloading-cache-factors","usage/configuration/config_documentation.html#database","usage/configuration/config_documentation.html#database-1","usage/configuration/config_documentation.html#databases","usage/configuration/config_documentation.html#logging","usage/configuration/config_documentation.html#log_config","usage/configuration/config_documentation.html#ratelimiting","usage/configuration/config_documentation.html#rc_message","usage/configuration/config_documentation.html#rc_registration","usage/configuration/config_documentation.html#rc_registration_token_validity","usage/configuration/config_documentation.html#rc_login","usage/configuration/config_documentation.html#rc_admin_redaction","usage/configuration/config_documentation.html#rc_joins","usage/configuration/config_documentation.html#rc_joins_per_room","usage/configuration/config_documentation.html#rc_3pid_validation","usage/configuration/config_documentation.html#rc_invites","usage/configuration/config_documentation.html#rc_third_party_invite","usage/configuration/config_documentation.html#rc_media_create","usage/configuration/config_documentation.html#rc_federation","usage/configuration/config_documentation.html#rc_presence","usage/configuration/config_documentation.html#rc_delayed_event_mgmt","usage/configuration/config_documentation.html#rc_reports","usage/configuration/config_documentation.html#rc_room_creation","usage/configuration/config_documentation.html#rc_user_directory","usage/configuration/config_documentation.html#rc_profile","usage/configuration/config_documentation.html#federation_rr_transactions_per_room_per_second","usage/configuration/config_documentation.html#media-store","usage/configuration/config_documentation.html#enable_authenticated_media","usage/configuration/config_documentation.html#enable_media_repo","usage/configuration/config_documentation.html#enable_local_media_storage","usage/configuration/config_documentation.html#media_store_path","usage/configuration/config_documentation.html#max_pending_media_uploads","usage/configuration/config_documentation.html#unused_expiration_time","usage/configuration/config_documentation.html#media_storage_providers","usage/configuration/config_documentation.html#max_upload_size","usage/configuration/config_documentation.html#media_upload_limits","usage/configuration/config_documentation.html#max_image_pixels","usage/configuration/config_documentation.html#remote_media_download_burst_count","usage/configuration/config_documentation.html#remote_media_download_per_second","usage/configuration/config_documentation.html#prevent_media_downloads_from","usage/configuration/config_documentation.html#dynamic_thumbnails","usage/configuration/config_documentation.html#thumbnail_sizes","usage/configuration/config_documentation.html#media_retention","usage/configuration/config_documentation.html#url_preview_enabled","usage/configuration/config_documentation.html#url_preview_ip_range_blacklist","usage/configuration/config_documentation.html#url_preview_ip_range_whitelist","usage/configuration/config_documentation.html#url_preview_url_blacklist","usage/configuration/config_documentation.html#max_spider_size","usage/configuration/config_documentation.html#url_preview_accept_language","usage/configuration/config_documentation.html#oembed","usage/configuration/config_documentation.html#captcha","usage/configuration/config_documentation.html#recaptcha_public_key","usage/configuration/config_documentation.html#recaptcha_public_key_path","usage/configuration/config_documentation.html#recaptcha_private_key","usage/configuration/config_documentation.html#recaptcha_private_key_path","usage/configuration/config_documentation.html#enable_registration_captcha","usage/configuration/config_documentation.html#recaptcha_siteverify_api","usage/configuration/config_documentation.html#turn","usage/configuration/config_documentation.html#turn_uris","usage/configuration/config_documentation.html#turn_shared_secret","usage/configuration/config_documentation.html#turn_shared_secret_path","usage/configuration/config_documentation.html#turn_username","usage/configuration/config_documentation.html#turn_password","usage/configuration/config_documentation.html#turn_user_lifetime","usage/configuration/config_documentation.html#turn_allow_guests","usage/configuration/config_documentation.html#matrix_rtc","usage/configuration/config_documentation.html#registration","usage/configuration/config_documentation.html#enable_registration","usage/configuration/config_documentation.html#enable_registration_without_verification","usage/configuration/config_documentation.html#registrations_require_3pid","usage/configuration/config_documentation.html#disable_msisdn_registration","usage/configuration/config_documentation.html#allowed_local_3pids","usage/configuration/config_documentation.html#enable_3pid_lookup","usage/configuration/config_documentation.html#registration_requires_token","usage/configuration/config_documentation.html#registration_shared_secret","usage/configuration/config_documentation.html#registration_shared_secret_path","usage/configuration/config_documentation.html#bcrypt_rounds","usage/configuration/config_documentation.html#allow_guest_access","usage/configuration/config_documentation.html#default_identity_server","usage/configuration/config_documentation.html#account_threepid_delegates","usage/configuration/config_documentation.html#enable_set_displayname","usage/configuration/config_documentation.html#enable_set_avatar_url","usage/configuration/config_documentation.html#enable_3pid_changes","usage/configuration/config_documentation.html#auto_join_rooms","usage/configuration/config_documentation.html#autocreate_auto_join_rooms","usage/configuration/config_documentation.html#autocreate_auto_join_rooms_federated","usage/configuration/config_documentation.html#autocreate_auto_join_room_preset","usage/configuration/config_documentation.html#auto_join_mxid_localpart","usage/configuration/config_documentation.html#auto_join_rooms_for_guests","usage/configuration/config_documentation.html#inhibit_user_in_use_error","usage/configuration/config_documentation.html#allow_underscore_prefixed_registration","usage/configuration/config_documentation.html#user-session-management","usage/configuration/config_documentation.html#session_lifetime","usage/configuration/config_documentation.html#refreshable_access_token_lifetime","usage/configuration/config_documentation.html#refresh_token_lifetime","usage/configuration/config_documentation.html#nonrefreshable_access_token_lifetime","usage/configuration/config_documentation.html#ui_auth","usage/configuration/config_documentation.html#login_via_existing_session","usage/configuration/config_documentation.html#metrics","usage/configuration/config_documentation.html#enable_metrics","usage/configuration/config_documentation.html#sentry","usage/configuration/config_documentation.html#metrics_flags","usage/configuration/config_documentation.html#report_stats","usage/configuration/config_documentation.html#report_stats_endpoint","usage/configuration/config_documentation.html#api-configuration","usage/configuration/config_documentation.html#room_prejoin_state","usage/configuration/config_documentation.html#track_puppeted_user_ips","usage/configuration/config_documentation.html#app_service_config_files","usage/configuration/config_documentation.html#track_appservice_user_ips","usage/configuration/config_documentation.html#use_appservice_legacy_authorization","usage/configuration/config_documentation.html#macaroon_secret_key","usage/configuration/config_documentation.html#macaroon_secret_key_path","usage/configuration/config_documentation.html#form_secret","usage/configuration/config_documentation.html#form_secret_path","usage/configuration/config_documentation.html#signing-keys","usage/configuration/config_documentation.html#signing_key_path","usage/configuration/config_documentation.html#old_signing_keys","usage/configuration/config_documentation.html#key_refresh_interval","usage/configuration/config_documentation.html#trusted_key_servers","usage/configuration/config_documentation.html#suppress_key_server_warning","usage/configuration/config_documentation.html#key_server_signing_keys_path","usage/configuration/config_documentation.html#single-sign-on-integration","usage/configuration/config_documentation.html#saml2_config","usage/configuration/config_documentation.html#oidc_providers","usage/configuration/config_documentation.html#cas_config","usage/configuration/config_documentation.html#sso","usage/configuration/config_documentation.html#jwt_config","usage/configuration/config_documentation.html#password_config","usage/configuration/config_documentation.html#push","usage/configuration/config_documentation.html#push-1","usage/configuration/config_documentation.html#push_rules","usage/configuration/config_documentation.html#rooms","usage/configuration/config_documentation.html#encryption_enabled_by_default_for_room_type","usage/configuration/config_documentation.html#user_directory","usage/configuration/config_documentation.html#user_consent","usage/configuration/config_documentation.html#stats","usage/configuration/config_documentation.html#server_notices","usage/configuration/config_documentation.html#enable_room_list_search","usage/configuration/config_documentation.html#alias_creation_rules","usage/configuration/config_documentation.html#room_list_publication_rules","usage/configuration/config_documentation.html#default_power_level_content_override","usage/configuration/config_documentation.html#forget_rooms_on_leave","usage/configuration/config_documentation.html#exclude_rooms_from_sync","usage/configuration/config_documentation.html#exclude_rooms_from_presence","usage/configuration/config_documentation.html#opentracing","usage/configuration/config_documentation.html#opentracing-1","usage/configuration/config_documentation.html#coordinating-workers","usage/configuration/config_documentation.html#worker_replication_secret","usage/configuration/config_documentation.html#worker_replication_secret_path","usage/configuration/config_documentation.html#start_pushers","usage/configuration/config_documentation.html#pusher_instances","usage/configuration/config_documentation.html#send_federation","usage/configuration/config_documentation.html#federation_sender_instances","usage/configuration/config_documentation.html#instance_map","usage/configuration/config_documentation.html#stream_writers","usage/configuration/config_documentation.html#outbound_federation_restricted_to","usage/configuration/config_documentation.html#run_background_tasks_on","usage/configuration/config_documentation.html#task_scheduler","usage/configuration/config_documentation.html#update_user_directory_from_worker","usage/configuration/config_documentation.html#notify_appservices_from_worker","usage/configuration/config_documentation.html#media_instance_running_background_jobs","usage/configuration/config_documentation.html#redis","usage/configuration/config_documentation.html#individual-worker-configuration","usage/configuration/config_documentation.html#worker_app","usage/configuration/config_documentation.html#worker_name","usage/configuration/config_documentation.html#worker_listeners","usage/configuration/config_documentation.html#worker_manhole","usage/configuration/config_documentation.html#worker_daemonize","usage/configuration/config_documentation.html#worker_pid_file","usage/configuration/config_documentation.html#worker_log_config","usage/configuration/config_documentation.html#background-updates","usage/configuration/config_documentation.html#background_updates","usage/configuration/config_documentation.html#auto-accept-invites","usage/configuration/config_documentation.html#auto_accept_invites","usage/configuration/homeserver_sample_config.html#homeserver-sample-configuration-file","usage/configuration/logging_sample_config.html#logging-sample-configuration-file","structured_logging.html#structured-logging","structured_logging.html#google-cloud-logging-gke","templates.html#templates","templates.html#email-templates","templates.html#html-page-templates-for-registration-and-password-reset","templates.html#html-page-templates-for-single-sign-on-sso","usage/configuration/user_authentication/index.html#user-authentication","usage/configuration/user_authentication/single_sign_on/index.html#single-sign-on","openid.html#configuring-synapse-to-authenticate-against-an-openid-connect-provider","openid.html#preparing-synapse","openid.html#oidc-back-channel-logout","openid.html#sample-configs","openid.html#microsoft-azure-active-directory","openid.html#apple","openid.html#auth0","openid.html#authentik","openid.html#dex","openid.html#django-oauth-toolkit","openid.html#facebook","openid.html#forgejo","openid.html#github","openid.html#gitlab","openid.html#gitea","openid.html#google","openid.html#keycloak","openid.html#lemonldap","openid.html#mastodon","openid.html#pocket-id","openid.html#shibboleth-with-oidc-plugin","openid.html#twitch","openid.html#twitter","openid.html#xwiki","usage/configuration/user_authentication/single_sign_on/saml.html#saml","usage/configuration/user_authentication/single_sign_on/cas.html#cas","sso_mapping_providers.html#sso-mapping-providers","sso_mapping_providers.html#openid-mapping-providers","sso_mapping_providers.html#building-a-custom-openid-mapping-provider","sso_mapping_providers.html#default-openid-mapping-provider","sso_mapping_providers.html#saml-mapping-providers","sso_mapping_providers.html#building-a-custom-saml-mapping-provider","sso_mapping_providers.html#default-saml-mapping-provider","password_auth_providers.html#password-auth-provider-modules","password_auth_providers.html#required-methods","password_auth_providers.html#optional-methods","jwt.html#jwt-login-type","jwt.html#preparing-synapse","jwt.html#how-to-test-jwt-as-a-developer","usage/configuration/user_authentication/refresh_tokens.html#refresh-tokens","usage/configuration/user_authentication/refresh_tokens.html#background-and-motivation","usage/configuration/user_authentication/refresh_tokens.html#caveats","usage/configuration/user_authentication/refresh_tokens.html#configuration-guide","usage/configuration/user_authentication/refresh_tokens.html#using-refresh-token-expiry-to-log-out-inactive-sessions","CAPTCHA_SETUP.html#overview","CAPTCHA_SETUP.html#getting-api-keys","CAPTCHA_SETUP.html#configuring-ip-used-for-auth","application_services.html#registering-an-application-service","server_notices.html#server-notices","server_notices.html#user-experience","server_notices.html#synapse-configuration","server_notices.html#sending-notices","consent_tracking.html#support-in-synapse-for-tracking-agreement-to-server-terms-and-conditions","consent_tracking.html#collecting-policy-agreement-from-a-user","consent_tracking.html#enabling-consent-tracking-at-registration","consent_tracking.html#constructing-the-consent-uri","consent_tracking.html#sending-users-a-server-notice-asking-them-to-agree-to-the-policy","consent_tracking.html#blocking-users-from-using-the-server-until-they-agree-to-the-policy","user_directory.html#user-directory-api-implementation","user_directory.html#data-model","user_directory.html#configuration-options","user_directory.html#search-algorithm","user_directory.html#postgresql","user_directory.html#sqlite","message_retention_policies.html#message-retention-policies","message_retention_policies.html#server-configuration","message_retention_policies.html#default-policy","message_retention_policies.html#purge-jobs","message_retention_policies.html#lifetime-limits","message_retention_policies.html#room-configuration","message_retention_policies.html#note-on-reclaiming-disk-space","modules/index.html#modules","modules/index.html#using-modules","modules/index.html#using-multiple-modules","modules/index.html#current-status","modules/writing_a_module.html#writing-a-module","modules/writing_a_module.html#when-synapse-runs-with-several-modules-configured","modules/writing_a_module.html#handling-the-modules-configuration","modules/writing_a_module.html#registering-a-web-resource","modules/writing_a_module.html#registering-a-callback","modules/writing_a_module.html#caching","modules/spam_checker_callbacks.html#spam-checker-callbacks","modules/spam_checker_callbacks.html#callbacks","modules/spam_checker_callbacks.html#check_event_for_spam","modules/spam_checker_callbacks.html#user_may_join_room","modules/spam_checker_callbacks.html#user_may_invite","modules/spam_checker_callbacks.html#federated_user_may_invite","modules/spam_checker_callbacks.html#user_may_send_3pid_invite","modules/spam_checker_callbacks.html#user_may_create_room","modules/spam_checker_callbacks.html#user_may_create_room_alias","modules/spam_checker_callbacks.html#user_may_publish_room","modules/spam_checker_callbacks.html#user_may_send_state_event","modules/spam_checker_callbacks.html#check_username_for_spam","modules/spam_checker_callbacks.html#check_registration_for_spam","modules/spam_checker_callbacks.html#check_media_file_for_spam","modules/spam_checker_callbacks.html#should_drop_federated_event","modules/spam_checker_callbacks.html#check_login_for_spam","modules/spam_checker_callbacks.html#example","modules/third_party_rules_callbacks.html#third-party-rules-callbacks","modules/third_party_rules_callbacks.html#callbacks","modules/third_party_rules_callbacks.html#check_event_allowed","modules/third_party_rules_callbacks.html#on_create_room","modules/third_party_rules_callbacks.html#check_threepid_can_be_invited","modules/third_party_rules_callbacks.html#check_visibility_can_be_modified","modules/third_party_rules_callbacks.html#on_new_event","modules/third_party_rules_callbacks.html#check_can_shutdown_room","modules/third_party_rules_callbacks.html#check_can_deactivate_user","modules/third_party_rules_callbacks.html#on_profile_update","modules/third_party_rules_callbacks.html#on_user_deactivation_status_changed","modules/third_party_rules_callbacks.html#on_threepid_bind","modules/third_party_rules_callbacks.html#on_add_user_third_party_identifier","modules/third_party_rules_callbacks.html#on_remove_user_third_party_identifier","modules/third_party_rules_callbacks.html#example","modules/presence_router_callbacks.html#presence-router-callbacks","modules/presence_router_callbacks.html#callbacks","modules/presence_router_callbacks.html#get_users_for_states","modules/presence_router_callbacks.html#get_interested_users","modules/presence_router_callbacks.html#example","modules/account_validity_callbacks.html#account-validity-callbacks","modules/account_validity_callbacks.html#is_user_expired","modules/account_validity_callbacks.html#on_user_registration","modules/account_validity_callbacks.html#on_user_login","modules/password_auth_provider_callbacks.html#password-auth-provider-callbacks","modules/password_auth_provider_callbacks.html#callbacks","modules/password_auth_provider_callbacks.html#auth_checkers","modules/password_auth_provider_callbacks.html#check_3pid_auth","modules/password_auth_provider_callbacks.html#on_logged_out","modules/password_auth_provider_callbacks.html#get_username_for_registration","modules/password_auth_provider_callbacks.html#get_displayname_for_registration","modules/password_auth_provider_callbacks.html#is_3pid_allowed","modules/password_auth_provider_callbacks.html#example","modules/background_update_controller_callbacks.html#background-update-controller-callbacks","modules/background_update_controller_callbacks.html#on_update","modules/background_update_controller_callbacks.html#default_batch_size","modules/background_update_controller_callbacks.html#min_batch_size","modules/account_data_callbacks.html#account-data-callbacks","modules/account_data_callbacks.html#callbacks","modules/account_data_callbacks.html#on_account_data_updated","modules/account_data_callbacks.html#example","modules/add_extra_fields_to_client_events_unsigned.html#add-extra-fields-to-client-events-unsigned-section-callbacks","modules/add_extra_fields_to_client_events_unsigned.html#api","modules/federation_callbacks.html#federation-callbacks","modules/federation_callbacks.html#callbacks","modules/federation_callbacks.html#on_event_delivered_over_federation","modules/media_repository_callbacks.html#media-repository-callbacks","modules/media_repository_callbacks.html#get_media_config_for_user","modules/media_repository_callbacks.html#is_user_allowed_to_upload_media_of_size","modules/media_repository_callbacks.html#get_media_upload_limits_for_user","modules/media_repository_callbacks.html#on_media_upload_limit_exceeded","modules/ratelimit_callbacks.html#ratelimit-callbacks","modules/ratelimit_callbacks.html#get_ratelimit_override_for_user","modules/porting_legacy_module.html#porting-an-existing-module-that-uses-the-old-interface","workers.html#scaling-synapse-via-workers","workers.html#main-processworker-communication","workers.html#setting-up-workers","workers.html#shared-configuration","workers.html#worker-configuration","workers.html#running-synapse-with-workers","workers.html#start-synapse-with-poetry","workers.html#available-worker-applications","workers.html#synapseappgeneric_worker","workers.html#synapseapppusher","workers.html#synapseappappservice","workers.html#synapseappfederation_sender","workers.html#synapseappmedia_repository","workers.html#synapseappuser_dir","workers.html#historical-apps","workers.html#migration-from-old-config","workers.html#architectural-diagram","synctl_workers.html#using-synctl-with-workers","systemd-with-workers/index.html#setting-up-synapse-with-workers-and-systemd","systemd-with-workers/index.html#synapse-configuration-files","systemd-with-workers/index.html#set-up","systemd-with-workers/index.html#usage","systemd-with-workers/index.html#hardening","usage/administration/index.html#administration","usage/administration/backups.html#how-to-back-up-a-synapse-homeserver","usage/administration/backups.html#configuration-files","usage/administration/backups.html#server-signing-key","usage/administration/backups.html#database","usage/administration/backups.html#synapse-specfic-details","usage/administration/backups.html#quick-and-easy-database-backup-and-restore","usage/administration/backups.html#media-store","usage/administration/admin_api/index.html#the-admin-api","usage/administration/admin_api/index.html#authenticate-as-a-server-admin","usage/administration/admin_api/index.html#making-an-admin-api-request","admin_api/account_validity.html#account-validity-api","admin_api/account_validity.html#renew-account","usage/administration/admin_api/background_updates.html#background-updates-api","usage/administration/admin_api/background_updates.html#status","usage/administration/admin_api/background_updates.html#enabled","usage/administration/admin_api/background_updates.html#run","admin_api/fetch_event.html#fetch-event-api","admin_api/event_reports.html#show-reported-events","admin_api/event_reports.html#show-details-of-a-specific-event-report","admin_api/event_reports.html#delete-a-specific-event-report","admin_api/experimental_features.html#experimental-features-api","admin_api/experimental_features.html#enablingdisabling-features","admin_api/experimental_features.html#listing-enabled-features","admin_api/media_admin_api.html#querying-media","admin_api/media_admin_api.html#list-all-media-in-a-room","admin_api/media_admin_api.html#list-all-media-uploaded-by-a-user","admin_api/media_admin_api.html#query-a-piece-of-media-by-id","admin_api/media_admin_api.html#quarantine-media","admin_api/media_admin_api.html#downloading-quarantined-media","admin_api/media_admin_api.html#quarantining-media-by-id","admin_api/media_admin_api.html#remove-media-from-quarantine-by-id","admin_api/media_admin_api.html#quarantining-media-in-a-room","admin_api/media_admin_api.html#quarantining-all-media-of-a-user","admin_api/media_admin_api.html#protecting-media-from-being-quarantined","admin_api/media_admin_api.html#unprotecting-media-from-being-quarantined","admin_api/media_admin_api.html#listing-quarantined-media-changes","admin_api/media_admin_api.html#delete-local-media","admin_api/media_admin_api.html#delete-a-specific-local-media","admin_api/media_admin_api.html#delete-local-media-by-date-or-size","admin_api/media_admin_api.html#delete-media-uploaded-by-a-user","admin_api/media_admin_api.html#purge-remote-media-api","admin_api/purge_history_api.html#purge-history-api","admin_api/purge_history_api.html#purge-status-query","admin_api/purge_history_api.html#reclaim-disk-space-postgres","admin_api/register_api.html#shared-secret-registration","usage/administration/admin_api/registration_tokens.html#registration-tokens","usage/administration/admin_api/registration_tokens.html#registration-token-objects","usage/administration/admin_api/registration_tokens.html#list-all-tokens","usage/administration/admin_api/registration_tokens.html#get-one-token","usage/administration/admin_api/registration_tokens.html#create-token","usage/administration/admin_api/registration_tokens.html#update-token","usage/administration/admin_api/registration_tokens.html#delete-token","usage/administration/admin_api/registration_tokens.html#errors","admin_api/room_membership.html#edit-room-membership-api","admin_api/room_membership.html#parameters","admin_api/room_membership.html#usage","admin_api/rooms.html#list-room-api","admin_api/rooms.html#room-details-api","admin_api/rooms.html#room-members-api","admin_api/rooms.html#room-state-api","admin_api/rooms.html#room-messages-api","admin_api/rooms.html#room-timestamp-to-event-api","admin_api/rooms.html#block-room-api","admin_api/rooms.html#block-or-unblock-a-room","admin_api/rooms.html#get-block-status","admin_api/rooms.html#delete-room-api","admin_api/rooms.html#version-1-old-version","admin_api/rooms.html#version-2-new-version","admin_api/rooms.html#status-of-deleting-rooms","admin_api/rooms.html#query-by-room_id","admin_api/rooms.html#query-by-delete_id","admin_api/rooms.html#response","admin_api/rooms.html#undoing-room-deletions","admin_api/rooms.html#make-room-admin-api","admin_api/rooms.html#forward-extremities-admin-api","admin_api/rooms.html#check-for-forward-extremities","admin_api/rooms.html#deleting-forward-extremities","admin_api/rooms.html#event-context-api","admin_api/rooms.html#admin-space-hierarchy-endpoint","admin_api/scheduled_tasks.html#show-scheduled-tasks","admin_api/server_notices.html#server-notices","admin_api/statistics.html#users-media-usage-statistics","admin_api/statistics.html#get-largest-rooms-by-size-in-database","admin_api/user_admin_api.html#user-admin-api","admin_api/user_admin_api.html#query-user-account","admin_api/user_admin_api.html#create-or-modify-account","admin_api/user_admin_api.html#list-accounts","admin_api/user_admin_api.html#list-accounts-v2","admin_api/user_admin_api.html#list-accounts-v3","admin_api/user_admin_api.html#query-current-sessions-for-a-user","admin_api/user_admin_api.html#deactivate-account","admin_api/user_admin_api.html#suspendunsuspend-account","admin_api/user_admin_api.html#reset-password","admin_api/user_admin_api.html#get-whether-a-user-is-a-server-administrator-or-not","admin_api/user_admin_api.html#change-whether-a-user-is-a-server-administrator-or-not","admin_api/user_admin_api.html#list-room-memberships-of-a-user","admin_api/user_admin_api.html#list-joined-rooms-of-a-user","admin_api/user_admin_api.html#get-the-number-of-invites-sent-by-the-user","admin_api/user_admin_api.html#get-the-cumulative-number-of-rooms-a-user-has-joined-after-a-given-timestamp","admin_api/user_admin_api.html#account-data","admin_api/user_admin_api.html#user-media","admin_api/user_admin_api.html#list-media-uploaded-by-a-user","admin_api/user_admin_api.html#delete-media-uploaded-by-a-user","admin_api/user_admin_api.html#login-as-a-user","admin_api/user_admin_api.html#allow-replacing-master-cross-signing-key-without-user-interactive-auth","admin_api/user_admin_api.html#user-devices","admin_api/user_admin_api.html#list-all-devices","admin_api/user_admin_api.html#create-a-device","admin_api/user_admin_api.html#delete-multiple-devices","admin_api/user_admin_api.html#show-a-device","admin_api/user_admin_api.html#update-a-device","admin_api/user_admin_api.html#delete-a-device","admin_api/user_admin_api.html#list-all-pushers","admin_api/user_admin_api.html#controlling-whether-a-user-is-shadow-banned","admin_api/user_admin_api.html#override-ratelimiting-for-users","admin_api/user_admin_api.html#get-status-of-ratelimit","admin_api/user_admin_api.html#set-ratelimit","admin_api/user_admin_api.html#delete-ratelimit","admin_api/user_admin_api.html#check-username-availability","admin_api/user_admin_api.html#find-a-user-based-on-their-id-in-an-auth-provider","admin_api/user_admin_api.html#find-a-user-based-on-their-third-party-id-threepid-or-3pid","admin_api/user_admin_api.html#redact-events-of-a-user","admin_api/user_admin_api.html#check-the-status-of-a-redaction-process","admin_api/version_api.html#version-api","usage/administration/admin_api/federation.html#federation-api","usage/administration/admin_api/federation.html#list-of-destinations","usage/administration/admin_api/federation.html#destination-details-api","usage/administration/admin_api/federation.html#destination-rooms","usage/administration/admin_api/federation.html#reset-connection-timeout","admin_api/client_server_api_extensions.html#client-server-api-extensions","admin_api/client_server_api_extensions.html#see-soft-failed-events","admin_api/client_server_api_extensions.html#see-events-marked-spammy-by-policy-servers","manhole.html#using-the-synapse-manhole","manhole.html#configuring-the-manhole","manhole.html#security-settings","manhole.html#accessing-synapse-manhole","metrics-howto.html#how-to-monitor-synapse-metrics-using-prometheus","metrics-howto.html#monitoring-workers","usage/administration/monitoring/reporting_homeserver_usage_statistics.html#reporting-homeserver-usage-statistics","usage/administration/monitoring/reporting_homeserver_usage_statistics.html#available-statistics","usage/administration/monitoring/reporting_homeserver_usage_statistics.html#using-a-custom-statistics-collection-server","usage/administration/monthly_active_users.html#monthly-active-users","usage/administration/monthly_active_users.html#calculating-active-users","usage/administration/monthly_active_users.html#trial-days","usage/administration/monthly_active_users.html#limiting-usage-of-the-homeserver-when-the-maximum-mau-is-reached","usage/administration/monthly_active_users.html#metrics","usage/administration/understanding_synapse_through_grafana_graphs.html#understanding-synapse-through-grafana-graphs","usage/administration/understanding_synapse_through_grafana_graphs.html#message-event-send-time","usage/administration/understanding_synapse_through_grafana_graphs.html#transaction-count-and-transaction-duration","usage/administration/understanding_synapse_through_grafana_graphs.html#federation","usage/administration/understanding_synapse_through_grafana_graphs.html#caches","usage/administration/understanding_synapse_through_grafana_graphs.html#forward-extremities","usage/administration/understanding_synapse_through_grafana_graphs.html#garbage-collection","usage/administration/understanding_synapse_through_grafana_graphs.html#final-thoughts","usage/administration/useful_sql_for_admins.html#some-useful-sql-queries-for-synapse-admins","usage/administration/useful_sql_for_admins.html#size-of-full-matrix-db","usage/administration/useful_sql_for_admins.html#result-example","usage/administration/useful_sql_for_admins.html#show-top-20-larger-tables-by-row-count","usage/administration/useful_sql_for_admins.html#result-example-1","usage/administration/useful_sql_for_admins.html#show-top-20-larger-tables-by-storage-size","usage/administration/useful_sql_for_admins.html#result-example-2","usage/administration/useful_sql_for_admins.html#show-top-20-larger-rooms-by-state-events-count","usage/administration/useful_sql_for_admins.html#show-top-20-rooms-by-new-events-count-in-last-1-day","usage/administration/useful_sql_for_admins.html#show-top-20-users-on-homeserver-by-sent-events-messages-at-last-month","usage/administration/useful_sql_for_admins.html#show-last-100-messages-from-needed-user-with-room-names","usage/administration/useful_sql_for_admins.html#show-rooms-with-names-sorted-by-events-in-this-rooms","usage/administration/useful_sql_for_admins.html#result-example-3","usage/administration/useful_sql_for_admins.html#lookup-room-state-info-by-list-of-room_id","usage/administration/useful_sql_for_admins.html#show-users-and-devices-that-have-not-been-online-for-a-while","usage/administration/useful_sql_for_admins.html#clear-the-cache-of-a-remote-users-device-list","usage/administration/database_maintenance_tools.html#list-of-useful-tools-and-scripts-for-maintenance-synapse-database","usage/administration/database_maintenance_tools.html#purge-remote-media-api","usage/administration/database_maintenance_tools.html#purge-local-media-api","usage/administration/database_maintenance_tools.html#purge-history-api","usage/administration/database_maintenance_tools.html#synapse-compress-state","usage/administration/database_maintenance_tools.html#sql-for-analyzing-synapse-postgresql-database-stats","usage/administration/state_groups.html#how-do-state-groups-work","usage/administration/state_groups.html#known-bugs-with-state-groups","usage/administration/state_groups.html#compression-tool","usage/administration/request_log.html#request-log-format","usage/administration/admin_faq.html#admin-faq","usage/administration/admin_faq.html#how-do-i-become-a-server-admin","usage/administration/admin_faq.html#what-servers-are-my-server-talking-to","usage/administration/admin_faq.html#what-servers-are-currently-participating-in-this-room","usage/administration/admin_faq.html#what-users-are-registered-on-my-server","usage/administration/admin_faq.html#how-can-i-export-user-data","usage/administration/admin_faq.html#how-do-i-upgrade-from-a-very-old-version-of-synapse-to-the-latest","usage/administration/admin_faq.html#manually-resetting-passwords","usage/administration/admin_faq.html#i-have-a-problem-with-my-server-can-i-just-delete-my-database-and-start-again","usage/administration/admin_faq.html#ive-stuffed-up-access-to-my-room-how-can-i-delete-it-to-free-up-the-alias","usage/administration/admin_faq.html#how-can-i-find-the-lines-corresponding-to-a-given-http-request-in-my-homeserver-log","usage/administration/admin_faq.html#what-do-all-those-fields-in-the-processed-line-mean","usage/administration/admin_faq.html#what-are-the-biggest-rooms-on-my-server","usage/administration/admin_faq.html#people-cant-accept-room-invitations-from-me","usage/administration/admin_faq.html#help-synapse-is-slow-and-eats-all-my-ramcpu","usage/administration/admin_faq.html#running-out-of-file-handles","development/contributing_guide.html#contributing","development/contributing_guide.html#1-who-can-contribute-to-synapse","development/contributing_guide.html#2-what-do-i-need","development/contributing_guide.html#3-get-the-source","development/contributing_guide.html#4-install-the-dependencies","development/contributing_guide.html#running-synapse-via-poetry","development/contributing_guide.html#5-get-in-touch","development/contributing_guide.html#6-pick-an-issue","development/contributing_guide.html#7-turn-coffee-into-code-and-documentation","development/contributing_guide.html#making-changes-to-the-rust-code","development/contributing_guide.html#8-test-test-test","development/contributing_guide.html#run-the-linters","development/contributing_guide.html#run-the-unit-tests-twisted-trial","development/contributing_guide.html#running-tests-under-postgresql","development/contributing_guide.html#run-the-integration-tests-sytest","development/contributing_guide.html#run-the-integration-tests-complement","development/contributing_guide.html#prettier-formatting-with-gotestfmt","development/contributing_guide.html#9-submit-your-patch","development/contributing_guide.html#changelog","development/contributing_guide.html#how-do-i-know-what-to-call-the-changelog-file-before-i-create-the-pr","development/contributing_guide.html#debian-changelog","development/contributing_guide.html#sign-off","development/contributing_guide.html#10-turn-feedback-into-better-code","development/contributing_guide.html#11-find-a-new-issue","development/contributing_guide.html#notes-for-maintainers-on-merging-prs-etc","development/contributing_guide.html#conclusion","code_style.html#code-style","code_style.html#formatting-tools","code_style.html#general-rules","code_style.html#configuration-code-and-documentation-format","code_style.html#modules","development/reviews.html#some-notes-on-how-we-do-reviews","development/reviews.html#performing-a-review","development/releases.html#synapse-release-cycle","development/releases.html#bugfix-releases","development/releases.html#security-releases","development/git.html#some-notes-on-how-we-use-git","development/git.html#on-keeping-the-commit-history-clean","development/git.html#merges-squashes-rebases-wtf","development/git.html#git-branching-model","development/demo.html#synapse-demo-setup","development/demo.html#using-the-demo-scripts","opentracing.html#opentracing","opentracing.html#background","opentracing.html#setting-up-opentracing","opentracing.html#enable-opentracing-in-synapse","opentracing.html#homeserver-whitelisting","opentracing.html#configuring-jaeger","development/database_schema.html#synapse-database-schema-files","development/database_schema.html#logical-databases","development/database_schema.html#synapse-schema-versions","development/database_schema.html#full-schema-dumps","development/database_schema.html#building-full-schema-dumps","development/database_schema.html#delta-files","development/database_schema.html#sql-delta-files","development/database_schema.html#python-delta-files","development/database_schema.html#background-updates","development/database_schema.html#boolean-columns","development/database_schema.html#event_id-global-uniqueness","development/database_schema.html#worked-examples-of-gradual-migrations","development/database_schema.html#transforming-a-column-into-another-one-with-not-null-constraints","development/experimental_features.html#implementing-experimental-features-in-synapse","development/experimental_features.html#tracking-issues-for-experimental-features","development/dependencies.html#managing-dependencies-with-poetry","development/dependencies.html#installing","development/dependencies.html#background","development/dependencies.html#example-dependency","development/dependencies.html#tooling-recommendation-direnv","development/dependencies.html#how-do-i","development/dependencies.html#reset-my-venv-to-the-locked-environment","development/dependencies.html#delete-everything-and-start-over-from-scratch","development/dependencies.html#run-a-command-in-the-poetry-virtualenv","development/dependencies.html#inspect-the-poetry-virtualenv","development/dependencies.html#add-a-new-dependency","development/dependencies.html#remove-a-dependency","development/dependencies.html#update-the-version-range-for-an-existing-dependency","development/dependencies.html#update-a-dependency-in-the-locked-environment","development/dependencies.html#export-a-requirementstxt-file","development/dependencies.html#build-a-test-wheel","development/dependencies.html#handle-a-dependabot-pull-request","development/dependencies.html#troubleshooting","development/dependencies.html#check-the-version-of-poetry-with-poetry---version","development/dependencies.html#clear-caches-poetry-cache-clear---all-pypi","development/dependencies.html#remove-outdated-egg-info","development/dependencies.html#try---verbose-or---dry-run-arguments","development/synapse_architecture/cancellation.html#cancellation","development/synapse_architecture/cancellation.html#enabling-cancellation-for-an-endpoint","development/synapse_architecture/cancellation.html#mechanics","development/synapse_architecture/cancellation.html#deferredcancel","development/synapse_architecture/cancellation.html#cancellederror","development/synapse_architecture/cancellation.html#handling-cancellation-correctly","development/synapse_architecture/cancellation.html#async-function-calls","development/synapse_architecture/cancellation.html#cancellederrors","development/synapse_architecture/cancellation.html#creation-of-deferreds","development/synapse_architecture/cancellation.html#uncancelled-processing","log_contexts.html#log-contexts","log_contexts.html#logcontexts-without-asynchronous-code","log_contexts.html#the-sentinel-context","log_contexts.html#using-logcontexts-with-awaitables","log_contexts.html#always-await-your-awaitables","log_contexts.html#where-you-create-a-new-awaitable-make-it-follow-the-rules","log_contexts.html#deferred-callbacks","log_contexts.html#deferred-errbacks-and-cancellations","log_contexts.html#fire-and-forget","log_contexts.html#passing-synapse-deferreds-into-third-party-functions","log_contexts.html#a-note-on-garbage-collection-of-awaitable-chains","log_contexts.html#the-rust-side","log_contexts.html#debugging-logcontext-issues","replication.html#replication-architecture","replication.html#motivation","replication.html#architecture","replication.html#the-replication-protocol","replication.html#the-tcp-replication-module","development/synapse_architecture/streams.html#streams","development/synapse_architecture/streams.html#definition","development/synapse_architecture/streams.html#current-stream-id","development/synapse_architecture/streams.html#multi-writer-streams","development/synapse_architecture/streams.html#writing-to-streams","development/synapse_architecture/streams.html#subscribing-to-streams","development/synapse_architecture/streams.html#summary","development/synapse_architecture/streams.html#cheatsheet-for-creating-a-new-stream","tcp_replication.html#tcp-replication","tcp_replication.html#motivation","tcp_replication.html#overview","tcp_replication.html#architecture","tcp_replication.html#keep-alives","tcp_replication.html#start-up","tcp_replication.html#error-handling","tcp_replication.html#congestion","tcp_replication.html#reliability","tcp_replication.html#example","tcp_replication.html#list-of-commands","tcp_replication.html#remote_server_up-s-c","tcp_replication.html#new_server_joined-s-c","tcp_replication.html#cache-invalidation-stream","development/synapse_architecture/faster_joins.html#how-do-faster-joins-work","development/synapse_architecture/faster_joins.html#overview-processing-events-in-a-partially-joined-room","development/synapse_architecture/faster_joins.html#partial-state","development/synapse_architecture/faster_joins.html#approximation-error","development/synapse_architecture/faster_joins.html#fixing-the-approximation-with-a-resync","development/synapse_architecture/faster_joins.html#faster-joins-on-workers","development/synapse_architecture/faster_joins.html#notes-on-specific-cases","development/synapse_architecture/faster_joins.html#creating-events-during-a-partial-join","development/synapse_architecture/faster_joins.html#joining-after-a-partial-join","development/synapse_architecture/faster_joins.html#leaving-and-kicks-and-bans-after-a-partial-join","development/internal_documentation/index.html#internal-documentation","development/saml.html#how-to-test-saml-as-a-developer-without-a-server","development/cas.html#how-to-test-cas-as-a-developer-without-a-server","development/cas.html#prerequisites","development/cas.html#configure-synapse-and-element-to-use-cas","development/cas.html#testing-the-configuration","development/room-dag-concepts.html#room-dag-concepts","development/room-dag-concepts.html#edges","development/room-dag-concepts.html#depth-and-stream-ordering","development/room-dag-concepts.html#outliers","development/room-dag-concepts.html#out-of-band-membership-events","development/room-dag-concepts.html#forward-extremity","development/room-dag-concepts.html#backward-extremity","development/room-dag-concepts.html#state-groups","development/room-dag-concepts.html#stage-group-edges","auth_chain_difference_algorithm.html#auth-chain-difference-algorithm","auth_chain_difference_algorithm.html#definitions","auth_chain_difference_algorithm.html#breadth-first-walk-algorithm","auth_chain_difference_algorithm.html#chain-cover-index","auth_chain_difference_algorithm.html#example","auth_chain_difference_algorithm.html#using-the-index","auth_chain_difference_algorithm.html#worked-example","media_repository.html#media-repository","media_repository.html#local-media","media_repository.html#paths","media_repository.html#remote-media","media_repository.html#paths-1","media_repository.html#url-previews","media_repository.html#paths-2","room_and_user_statistics.html#room-and-user-statistics","room_and_user_statistics.html#synapse-developer-documentation","room_and_user_statistics.html#high-level-concepts","room_and_user_statistics.html#definitions","room_and_user_statistics.html#overview","development/internal_documentation/release_notes_review_checklist.html#release-notes-review-checklist","deprecation_policy.html#deprecation-policy","deprecation_policy.html#platform-dependencies","deprecation_policy.html#context","deprecation_policy.html#application-dependencies","deprecation_policy.html#context-1","other/running_synapse_on_single_board_computers.html#summary-of-performance-impact-of-running-on-resource-constrained-devices-such-as-sbcs","other/running_synapse_on_single_board_computers.html#presence","other/running_synapse_on_single_board_computers.html#joining","other/running_synapse_on_single_board_computers.html#sessions","other/running_synapse_on_single_board_computers.html#recommended-configuration"],"index":{"documentStore":{"docInfo":{"0":{"body":9,"breadcrumbs":3,"title":1},"1":{"body":55,"breadcrumbs":5,"title":3},"10":{"body":58,"breadcrumbs":3,"title":2},"100":{"body":0,"breadcrumbs":6,"title":2},"1000":{"body":61,"breadcrumbs":9,"title":7},"1001":{"body":74,"breadcrumbs":4,"title":2},"1002":{"body":49,"breadcrumbs":3,"title":1},"1003":{"body":106,"breadcrumbs":7,"title":5},"1004":{"body":3,"breadcrumbs":6,"title":4},"1005":{"body":8,"breadcrumbs":7,"title":5},"1006":{"body":31,"breadcrumbs":3,"title":1},"1007":{"body":0,"breadcrumbs":4,"title":2},"1008":{"body":66,"breadcrumbs":4,"title":2},"1009":{"body":70,"breadcrumbs":4,"title":2},"101":{"body":16,"breadcrumbs":8,"title":4},"1010":{"body":114,"breadcrumbs":6,"title":4},"1011":{"body":52,"breadcrumbs":3,"title":1},"1012":{"body":116,"breadcrumbs":4,"title":2},"1013":{"body":63,"breadcrumbs":4,"title":2},"1014":{"body":61,"breadcrumbs":5,"title":3},"1015":{"body":18,"breadcrumbs":4,"title":2},"1016":{"body":67,"breadcrumbs":4,"title":2},"1017":{"body":0,"breadcrumbs":5,"title":3},"1018":{"body":195,"breadcrumbs":6,"title":4},"1019":{"body":155,"breadcrumbs":6,"title":4},"102":{"body":0,"breadcrumbs":6,"title":2},"1020":{"body":198,"breadcrumbs":5,"title":3},"1021":{"body":91,"breadcrumbs":6,"title":3},"1022":{"body":46,"breadcrumbs":6,"title":3},"1023":{"body":0,"breadcrumbs":2,"title":1},"1024":{"body":144,"breadcrumbs":2,"title":1},"1025":{"body":55,"breadcrumbs":4,"title":3},"1026":{"body":29,"breadcrumbs":4,"title":3},"1027":{"body":76,"breadcrumbs":3,"title":2},"1028":{"body":5,"breadcrumbs":3,"title":2},"1029":{"body":6,"breadcrumbs":6,"title":4},"103":{"body":21,"breadcrumbs":8,"title":4},"1030":{"body":48,"breadcrumbs":4,"title":2},"1031":{"body":189,"breadcrumbs":5,"title":3},"1032":{"body":16,"breadcrumbs":5,"title":3},"1033":{"body":31,"breadcrumbs":6,"title":4},"1034":{"body":54,"breadcrumbs":4,"title":2},"1035":{"body":38,"breadcrumbs":5,"title":3},"1036":{"body":62,"breadcrumbs":5,"title":3},"1037":{"body":160,"breadcrumbs":4,"title":2},"1038":{"body":30,"breadcrumbs":4,"title":2},"1039":{"body":97,"breadcrumbs":5,"title":3},"104":{"body":15,"breadcrumbs":8,"title":4},"1040":{"body":73,"breadcrumbs":6,"title":4},"1041":{"body":552,"breadcrumbs":8,"title":6},"1042":{"body":163,"breadcrumbs":6,"title":4},"1043":{"body":102,"breadcrumbs":6,"title":4},"1044":{"body":6,"breadcrumbs":5,"title":3},"1045":{"body":17,"breadcrumbs":3,"title":1},"1046":{"body":102,"breadcrumbs":3,"title":1},"1047":{"body":154,"breadcrumbs":4,"title":2},"1048":{"body":90,"breadcrumbs":5,"title":3},"1049":{"body":0,"breadcrumbs":2,"title":0},"105":{"body":0,"breadcrumbs":6,"title":2},"1050":{"body":4,"breadcrumbs":6,"title":4},"1051":{"body":91,"breadcrumbs":7,"title":5},"1052":{"body":64,"breadcrumbs":6,"title":4},"1053":{"body":40,"breadcrumbs":5,"title":3},"1054":{"body":24,"breadcrumbs":5,"title":3},"1055":{"body":19,"breadcrumbs":4,"title":2},"1056":{"body":12,"breadcrumbs":7,"title":5},"1057":{"body":58,"breadcrumbs":6,"title":4},"1058":{"body":11,"breadcrumbs":5,"title":3},"1059":{"body":24,"breadcrumbs":5,"title":3},"106":{"body":22,"breadcrumbs":12,"title":8},"1060":{"body":53,"breadcrumbs":6,"title":4},"1061":{"body":0,"breadcrumbs":3,"title":1},"1062":{"body":24,"breadcrumbs":7,"title":5},"1063":{"body":29,"breadcrumbs":8,"title":6},"1064":{"body":16,"breadcrumbs":6,"title":4},"1065":{"body":6,"breadcrumbs":7,"title":5},"1066":{"body":46,"breadcrumbs":4,"title":1},"1067":{"body":37,"breadcrumbs":6,"title":3},"1068":{"body":31,"breadcrumbs":4,"title":1},"1069":{"body":74,"breadcrumbs":4,"title":1},"107":{"body":0,"breadcrumbs":6,"title":2},"1070":{"body":12,"breadcrumbs":4,"title":1},"1071":{"body":62,"breadcrumbs":6,"title":3},"1072":{"body":65,"breadcrumbs":6,"title":3},"1073":{"body":121,"breadcrumbs":4,"title":1},"1074":{"body":110,"breadcrumbs":5,"title":2},"1075":{"body":148,"breadcrumbs":5,"title":2},"1076":{"body":123,"breadcrumbs":6,"title":2},"1077":{"body":59,"breadcrumbs":8,"title":4},"1078":{"body":93,"breadcrumbs":6,"title":2},"1079":{"body":195,"breadcrumbs":7,"title":3},"108":{"body":16,"breadcrumbs":12,"title":8},"1080":{"body":104,"breadcrumbs":7,"title":3},"1081":{"body":63,"breadcrumbs":10,"title":6},"1082":{"body":506,"breadcrumbs":6,"title":2},"1083":{"body":29,"breadcrumbs":7,"title":3},"1084":{"body":215,"breadcrumbs":6,"title":2},"1085":{"body":113,"breadcrumbs":10,"title":6},"1086":{"body":163,"breadcrumbs":9,"title":5},"1087":{"body":117,"breadcrumbs":6,"title":2},"1088":{"body":91,"breadcrumbs":7,"title":3},"1089":{"body":0,"breadcrumbs":5,"title":2},"109":{"body":0,"breadcrumbs":6,"title":2},"1090":{"body":111,"breadcrumbs":4,"title":1},"1091":{"body":0,"breadcrumbs":4,"title":1},"1092":{"body":4,"breadcrumbs":5,"title":2},"1093":{"body":10,"breadcrumbs":6,"title":3},"1094":{"body":75,"breadcrumbs":4,"title":1},"1095":{"body":157,"breadcrumbs":4,"title":1},"1096":{"body":227,"breadcrumbs":6,"title":3},"1097":{"body":143,"breadcrumbs":6,"title":3},"1098":{"body":80,"breadcrumbs":5,"title":2},"1099":{"body":54,"breadcrumbs":5,"title":2},"11":{"body":113,"breadcrumbs":3,"title":2},"110":{"body":49,"breadcrumbs":13,"title":9},"1100":{"body":9,"breadcrumbs":4,"title":1},"1101":{"body":254,"breadcrumbs":7,"title":4},"1102":{"body":0,"breadcrumbs":6,"title":2},"1103":{"body":23,"breadcrumbs":5,"title":1},"1104":{"body":171,"breadcrumbs":5,"title":1},"1105":{"body":34,"breadcrumbs":5,"title":1},"1106":{"body":57,"breadcrumbs":6,"title":2},"1107":{"body":56,"breadcrumbs":6,"title":2},"1108":{"body":17,"breadcrumbs":6,"title":2},"1109":{"body":36,"breadcrumbs":5,"title":1},"111":{"body":0,"breadcrumbs":6,"title":2},"1110":{"body":49,"breadcrumbs":5,"title":1},"1111":{"body":106,"breadcrumbs":5,"title":1},"1112":{"body":152,"breadcrumbs":6,"title":2},"1113":{"body":7,"breadcrumbs":7,"title":3},"1114":{"body":13,"breadcrumbs":7,"title":3},"1115":{"body":105,"breadcrumbs":7,"title":3},"1116":{"body":46,"breadcrumbs":8,"title":3},"1117":{"body":207,"breadcrumbs":11,"title":6},"1118":{"body":136,"breadcrumbs":7,"title":2},"1119":{"body":191,"breadcrumbs":7,"title":2},"112":{"body":25,"breadcrumbs":16,"title":12},"1120":{"body":136,"breadcrumbs":8,"title":3},"1121":{"body":28,"breadcrumbs":8,"title":3},"1122":{"body":11,"breadcrumbs":8,"title":3},"1123":{"body":292,"breadcrumbs":10,"title":5},"1124":{"body":108,"breadcrumbs":8,"title":3},"1125":{"body":311,"breadcrumbs":10,"title":5},"1126":{"body":46,"breadcrumbs":4,"title":2},"1127":{"body":142,"breadcrumbs":10,"title":5},"1128":{"body":11,"breadcrumbs":10,"title":5},"1129":{"body":81,"breadcrumbs":6,"title":1},"113":{"body":0,"breadcrumbs":6,"title":2},"1130":{"body":38,"breadcrumbs":10,"title":5},"1131":{"body":30,"breadcrumbs":7,"title":2},"1132":{"body":0,"breadcrumbs":8,"title":3},"1133":{"body":26,"breadcrumbs":6,"title":1},"1134":{"body":88,"breadcrumbs":8,"title":3},"1135":{"body":95,"breadcrumbs":6,"title":1},"1136":{"body":41,"breadcrumbs":9,"title":4},"1137":{"body":43,"breadcrumbs":7,"title":2},"1138":{"body":62,"breadcrumbs":7,"title":2},"1139":{"body":37,"breadcrumbs":7,"title":2},"114":{"body":77,"breadcrumbs":13,"title":9},"1140":{"body":7,"breadcrumbs":8,"title":3},"1141":{"body":15,"breadcrumbs":12,"title":4},"1142":{"body":63,"breadcrumbs":9,"title":1},"1143":{"body":61,"breadcrumbs":12,"title":4},"1144":{"body":289,"breadcrumbs":11,"title":3},"1145":{"body":52,"breadcrumbs":9,"title":1},"1146":{"body":80,"breadcrumbs":10,"title":2},"1147":{"body":111,"breadcrumbs":10,"title":2},"1148":{"body":44,"breadcrumbs":6,"title":2},"1149":{"body":47,"breadcrumbs":6,"title":2},"115":{"body":57,"breadcrumbs":9,"title":5},"1150":{"body":16,"breadcrumbs":5,"title":1},"1151":{"body":33,"breadcrumbs":6,"title":2},"1152":{"body":28,"breadcrumbs":5,"title":1},"1153":{"body":44,"breadcrumbs":6,"title":2},"1154":{"body":22,"breadcrumbs":5,"title":1},"1155":{"body":15,"breadcrumbs":8,"title":3},"1156":{"body":0,"breadcrumbs":8,"title":3},"1157":{"body":0,"breadcrumbs":8,"title":3},"1158":{"body":18,"breadcrumbs":6,"title":1},"1159":{"body":15,"breadcrumbs":6,"title":1},"116":{"body":85,"breadcrumbs":9,"title":5},"1160":{"body":100,"breadcrumbs":11,"title":4},"1161":{"body":23,"breadcrumbs":5,"title":2},"1162":{"body":75,"breadcrumbs":5,"title":2},"1163":{"body":115,"breadcrumbs":4,"title":1},"1164":{"body":87,"breadcrumbs":5,"title":2},"1165":{"body":96,"breadcrumbs":4,"title":1},"1166":{"body":54,"breadcrumbs":14,"title":9},"1167":{"body":81,"breadcrumbs":6,"title":1},"1168":{"body":109,"breadcrumbs":6,"title":1},"1169":{"body":43,"breadcrumbs":6,"title":1},"117":{"body":0,"breadcrumbs":6,"title":2},"1170":{"body":153,"breadcrumbs":7,"title":2},"118":{"body":15,"breadcrumbs":11,"title":7},"119":{"body":0,"breadcrumbs":6,"title":2},"12":{"body":120,"breadcrumbs":5,"title":4},"120":{"body":16,"breadcrumbs":7,"title":3},"121":{"body":0,"breadcrumbs":6,"title":2},"122":{"body":21,"breadcrumbs":9,"title":5},"123":{"body":0,"breadcrumbs":6,"title":2},"124":{"body":35,"breadcrumbs":9,"title":5},"125":{"body":62,"breadcrumbs":12,"title":8},"126":{"body":0,"breadcrumbs":6,"title":2},"127":{"body":17,"breadcrumbs":9,"title":5},"128":{"body":0,"breadcrumbs":6,"title":2},"129":{"body":14,"breadcrumbs":8,"title":4},"13":{"body":55,"breadcrumbs":2,"title":1},"130":{"body":59,"breadcrumbs":9,"title":5},"131":{"body":0,"breadcrumbs":6,"title":2},"132":{"body":37,"breadcrumbs":8,"title":4},"133":{"body":0,"breadcrumbs":6,"title":2},"134":{"body":18,"breadcrumbs":11,"title":7},"135":{"body":0,"breadcrumbs":6,"title":2},"136":{"body":16,"breadcrumbs":8,"title":4},"137":{"body":0,"breadcrumbs":6,"title":2},"138":{"body":16,"breadcrumbs":8,"title":4},"139":{"body":0,"breadcrumbs":6,"title":2},"14":{"body":103,"breadcrumbs":3,"title":2},"140":{"body":16,"breadcrumbs":8,"title":4},"141":{"body":0,"breadcrumbs":6,"title":2},"142":{"body":50,"breadcrumbs":12,"title":8},"143":{"body":0,"breadcrumbs":6,"title":2},"144":{"body":21,"breadcrumbs":9,"title":5},"145":{"body":0,"breadcrumbs":6,"title":2},"146":{"body":29,"breadcrumbs":8,"title":4},"147":{"body":42,"breadcrumbs":7,"title":3},"148":{"body":0,"breadcrumbs":6,"title":2},"149":{"body":16,"breadcrumbs":8,"title":4},"15":{"body":13,"breadcrumbs":5,"title":4},"150":{"body":0,"breadcrumbs":6,"title":2},"151":{"body":26,"breadcrumbs":10,"title":6},"152":{"body":0,"breadcrumbs":6,"title":2},"153":{"body":32,"breadcrumbs":8,"title":4},"154":{"body":94,"breadcrumbs":6,"title":2},"155":{"body":0,"breadcrumbs":6,"title":2},"156":{"body":51,"breadcrumbs":9,"title":5},"157":{"body":0,"breadcrumbs":6,"title":2},"158":{"body":28,"breadcrumbs":9,"title":5},"159":{"body":0,"breadcrumbs":6,"title":2},"16":{"body":42,"breadcrumbs":3,"title":2},"160":{"body":91,"breadcrumbs":9,"title":5},"161":{"body":0,"breadcrumbs":6,"title":2},"162":{"body":20,"breadcrumbs":8,"title":4},"163":{"body":0,"breadcrumbs":6,"title":2},"164":{"body":32,"breadcrumbs":8,"title":4},"165":{"body":36,"breadcrumbs":9,"title":5},"166":{"body":26,"breadcrumbs":9,"title":5},"167":{"body":0,"breadcrumbs":6,"title":2},"168":{"body":50,"breadcrumbs":8,"title":4},"169":{"body":37,"breadcrumbs":7,"title":3},"17":{"body":6,"breadcrumbs":2,"title":1},"170":{"body":0,"breadcrumbs":6,"title":2},"171":{"body":77,"breadcrumbs":10,"title":6},"172":{"body":0,"breadcrumbs":6,"title":2},"173":{"body":16,"breadcrumbs":8,"title":4},"174":{"body":0,"breadcrumbs":6,"title":2},"175":{"body":15,"breadcrumbs":9,"title":5},"176":{"body":81,"breadcrumbs":10,"title":6},"177":{"body":56,"breadcrumbs":11,"title":7},"178":{"body":0,"breadcrumbs":6,"title":2},"179":{"body":33,"breadcrumbs":8,"title":4},"18":{"body":32,"breadcrumbs":3,"title":2},"180":{"body":115,"breadcrumbs":9,"title":5},"181":{"body":57,"breadcrumbs":9,"title":5},"182":{"body":9,"breadcrumbs":6,"title":2},"183":{"body":22,"breadcrumbs":7,"title":3},"184":{"body":35,"breadcrumbs":8,"title":4},"185":{"body":0,"breadcrumbs":6,"title":2},"186":{"body":63,"breadcrumbs":11,"title":7},"187":{"body":11,"breadcrumbs":9,"title":5},"188":{"body":26,"breadcrumbs":8,"title":4},"189":{"body":44,"breadcrumbs":9,"title":5},"19":{"body":16,"breadcrumbs":2,"title":1},"190":{"body":0,"breadcrumbs":6,"title":2},"191":{"body":63,"breadcrumbs":9,"title":5},"192":{"body":0,"breadcrumbs":6,"title":2},"193":{"body":44,"breadcrumbs":12,"title":8},"194":{"body":32,"breadcrumbs":8,"title":4},"195":{"body":34,"breadcrumbs":6,"title":2},"196":{"body":0,"breadcrumbs":6,"title":2},"197":{"body":82,"breadcrumbs":9,"title":5},"198":{"body":0,"breadcrumbs":6,"title":2},"199":{"body":6,"breadcrumbs":7,"title":3},"2":{"body":74,"breadcrumbs":4,"title":2},"20":{"body":122,"breadcrumbs":3,"title":2},"200":{"body":18,"breadcrumbs":6,"title":2},"201":{"body":0,"breadcrumbs":6,"title":2},"202":{"body":102,"breadcrumbs":12,"title":8},"203":{"body":29,"breadcrumbs":5,"title":1},"204":{"body":32,"breadcrumbs":5,"title":1},"205":{"body":9,"breadcrumbs":6,"title":2},"206":{"body":62,"breadcrumbs":10,"title":6},"207":{"body":0,"breadcrumbs":6,"title":2},"208":{"body":25,"breadcrumbs":11,"title":7},"209":{"body":123,"breadcrumbs":10,"title":6},"21":{"body":106,"breadcrumbs":3,"title":2},"210":{"body":0,"breadcrumbs":6,"title":2},"211":{"body":10,"breadcrumbs":8,"title":4},"212":{"body":0,"breadcrumbs":6,"title":2},"213":{"body":136,"breadcrumbs":9,"title":5},"214":{"body":0,"breadcrumbs":6,"title":2},"215":{"body":18,"breadcrumbs":11,"title":7},"216":{"body":19,"breadcrumbs":7,"title":3},"217":{"body":32,"breadcrumbs":10,"title":6},"218":{"body":0,"breadcrumbs":6,"title":2},"219":{"body":60,"breadcrumbs":7,"title":3},"22":{"body":8,"breadcrumbs":4,"title":2},"220":{"body":21,"breadcrumbs":9,"title":5},"221":{"body":0,"breadcrumbs":6,"title":2},"222":{"body":20,"breadcrumbs":9,"title":5},"223":{"body":0,"breadcrumbs":6,"title":2},"224":{"body":36,"breadcrumbs":11,"title":7},"225":{"body":18,"breadcrumbs":6,"title":2},"226":{"body":46,"breadcrumbs":11,"title":7},"227":{"body":25,"breadcrumbs":7,"title":3},"228":{"body":31,"breadcrumbs":6,"title":2},"229":{"body":0,"breadcrumbs":6,"title":2},"23":{"body":63,"breadcrumbs":6,"title":4},"230":{"body":42,"breadcrumbs":7,"title":3},"231":{"body":0,"breadcrumbs":6,"title":2},"232":{"body":19,"breadcrumbs":10,"title":6},"233":{"body":0,"breadcrumbs":6,"title":2},"234":{"body":20,"breadcrumbs":10,"title":6},"235":{"body":0,"breadcrumbs":6,"title":2},"236":{"body":24,"breadcrumbs":9,"title":5},"237":{"body":29,"breadcrumbs":8,"title":4},"238":{"body":0,"breadcrumbs":6,"title":2},"239":{"body":28,"breadcrumbs":14,"title":10},"24":{"body":70,"breadcrumbs":5,"title":3},"240":{"body":0,"breadcrumbs":6,"title":2},"241":{"body":18,"breadcrumbs":11,"title":7},"242":{"body":0,"breadcrumbs":6,"title":2},"243":{"body":19,"breadcrumbs":10,"title":6},"244":{"body":0,"breadcrumbs":6,"title":2},"245":{"body":26,"breadcrumbs":9,"title":5},"246":{"body":26,"breadcrumbs":12,"title":8},"247":{"body":12,"breadcrumbs":9,"title":5},"248":{"body":0,"breadcrumbs":6,"title":2},"249":{"body":70,"breadcrumbs":13,"title":9},"25":{"body":104,"breadcrumbs":4,"title":2},"250":{"body":43,"breadcrumbs":6,"title":2},"251":{"body":21,"breadcrumbs":8,"title":4},"252":{"body":0,"breadcrumbs":6,"title":2},"253":{"body":44,"breadcrumbs":11,"title":7},"254":{"body":0,"breadcrumbs":6,"title":2},"255":{"body":96,"breadcrumbs":10,"title":6},"256":{"body":0,"breadcrumbs":6,"title":2},"257":{"body":48,"breadcrumbs":9,"title":5},"258":{"body":0,"breadcrumbs":6,"title":2},"259":{"body":34,"breadcrumbs":7,"title":3},"26":{"body":35,"breadcrumbs":6,"title":4},"260":{"body":0,"breadcrumbs":6,"title":2},"261":{"body":75,"breadcrumbs":13,"title":9},"262":{"body":0,"breadcrumbs":6,"title":2},"263":{"body":27,"breadcrumbs":11,"title":7},"264":{"body":22,"breadcrumbs":11,"title":7},"265":{"body":32,"breadcrumbs":10,"title":6},"266":{"body":26,"breadcrumbs":11,"title":7},"267":{"body":0,"breadcrumbs":6,"title":2},"268":{"body":72,"breadcrumbs":9,"title":5},"269":{"body":0,"breadcrumbs":6,"title":2},"27":{"body":5,"breadcrumbs":3,"title":1},"270":{"body":99,"breadcrumbs":11,"title":7},"271":{"body":64,"breadcrumbs":7,"title":3},"272":{"body":0,"breadcrumbs":6,"title":2},"273":{"body":102,"breadcrumbs":9,"title":5},"274":{"body":0,"breadcrumbs":6,"title":2},"275":{"body":42,"breadcrumbs":9,"title":5},"276":{"body":57,"breadcrumbs":7,"title":3},"277":{"body":0,"breadcrumbs":6,"title":2},"278":{"body":66,"breadcrumbs":11,"title":7},"279":{"body":50,"breadcrumbs":9,"title":5},"28":{"body":58,"breadcrumbs":4,"title":2},"280":{"body":0,"breadcrumbs":6,"title":2},"281":{"body":39,"breadcrumbs":9,"title":5},"282":{"body":0,"breadcrumbs":6,"title":2},"283":{"body":61,"breadcrumbs":7,"title":3},"284":{"body":0,"breadcrumbs":6,"title":2},"285":{"body":50,"breadcrumbs":9,"title":5},"286":{"body":63,"breadcrumbs":7,"title":3},"287":{"body":46,"breadcrumbs":9,"title":5},"288":{"body":0,"breadcrumbs":6,"title":2},"289":{"body":46,"breadcrumbs":10,"title":6},"29":{"body":0,"breadcrumbs":4,"title":2},"290":{"body":24,"breadcrumbs":11,"title":7},"291":{"body":20,"breadcrumbs":6,"title":2},"292":{"body":0,"breadcrumbs":6,"title":2},"293":{"body":65,"breadcrumbs":10,"title":6},"294":{"body":19,"breadcrumbs":9,"title":5},"295":{"body":18,"breadcrumbs":9,"title":5},"296":{"body":57,"breadcrumbs":9,"title":5},"297":{"body":196,"breadcrumbs":6,"title":2},"298":{"body":16,"breadcrumbs":6,"title":2},"299":{"body":18,"breadcrumbs":6,"title":2},"3":{"body":14,"breadcrumbs":5,"title":3},"30":{"body":124,"breadcrumbs":3,"title":1},"300":{"body":51,"breadcrumbs":6,"title":2},"301":{"body":19,"breadcrumbs":6,"title":2},"302":{"body":0,"breadcrumbs":6,"title":2},"303":{"body":40,"breadcrumbs":7,"title":3},"304":{"body":216,"breadcrumbs":7,"title":3},"305":{"body":191,"breadcrumbs":5,"title":1},"306":{"body":95,"breadcrumbs":6,"title":2},"307":{"body":67,"breadcrumbs":7,"title":3},"308":{"body":10,"breadcrumbs":6,"title":2},"309":{"body":11,"breadcrumbs":6,"title":2},"31":{"body":144,"breadcrumbs":5,"title":3},"310":{"body":48,"breadcrumbs":7,"title":3},"311":{"body":17,"breadcrumbs":7,"title":3},"312":{"body":0,"breadcrumbs":6,"title":2},"313":{"body":61,"breadcrumbs":7,"title":3},"314":{"body":88,"breadcrumbs":5,"title":1},"315":{"body":53,"breadcrumbs":7,"title":3},"316":{"body":22,"breadcrumbs":6,"title":2},"317":{"body":223,"breadcrumbs":6,"title":2},"318":{"body":40,"breadcrumbs":6,"title":2},"319":{"body":42,"breadcrumbs":6,"title":2},"32":{"body":0,"breadcrumbs":3,"title":1},"320":{"body":16,"breadcrumbs":6,"title":2},"321":{"body":49,"breadcrumbs":6,"title":2},"322":{"body":97,"breadcrumbs":6,"title":2},"323":{"body":20,"breadcrumbs":6,"title":2},"324":{"body":20,"breadcrumbs":6,"title":2},"325":{"body":49,"breadcrumbs":6,"title":2},"326":{"body":24,"breadcrumbs":6,"title":2},"327":{"body":136,"breadcrumbs":6,"title":2},"328":{"body":25,"breadcrumbs":6,"title":2},"329":{"body":79,"breadcrumbs":6,"title":2},"33":{"body":67,"breadcrumbs":5,"title":3},"330":{"body":23,"breadcrumbs":6,"title":2},"331":{"body":68,"breadcrumbs":6,"title":2},"332":{"body":94,"breadcrumbs":6,"title":2},"333":{"body":132,"breadcrumbs":4,"title":3},"334":{"body":77,"breadcrumbs":2,"title":1},"335":{"body":64,"breadcrumbs":3,"title":2},"336":{"body":18,"breadcrumbs":5,"title":4},"337":{"body":15,"breadcrumbs":2,"title":1},"338":{"body":55,"breadcrumbs":5,"title":2},"339":{"body":74,"breadcrumbs":5,"title":2},"34":{"body":79,"breadcrumbs":6,"title":4},"340":{"body":39,"breadcrumbs":5,"title":2},"341":{"body":142,"breadcrumbs":4,"title":1},"342":{"body":16,"breadcrumbs":4,"title":1},"343":{"body":47,"breadcrumbs":4,"title":1},"344":{"body":5,"breadcrumbs":4,"title":1},"345":{"body":69,"breadcrumbs":4,"title":1},"346":{"body":13,"breadcrumbs":4,"title":1},"347":{"body":33,"breadcrumbs":4,"title":1},"348":{"body":18,"breadcrumbs":4,"title":1},"349":{"body":17,"breadcrumbs":4,"title":1},"35":{"body":134,"breadcrumbs":7,"title":4},"350":{"body":34,"breadcrumbs":4,"title":1},"351":{"body":12,"breadcrumbs":4,"title":1},"352":{"body":49,"breadcrumbs":4,"title":1},"353":{"body":47,"breadcrumbs":4,"title":1},"354":{"body":48,"breadcrumbs":4,"title":1},"355":{"body":24,"breadcrumbs":4,"title":1},"356":{"body":174,"breadcrumbs":4,"title":1},"357":{"body":36,"breadcrumbs":4,"title":1},"358":{"body":44,"breadcrumbs":4,"title":1},"359":{"body":35,"breadcrumbs":4,"title":1},"36":{"body":55,"breadcrumbs":5,"title":2},"360":{"body":55,"breadcrumbs":4,"title":1},"361":{"body":25,"breadcrumbs":4,"title":1},"362":{"body":18,"breadcrumbs":4,"title":1},"363":{"body":55,"breadcrumbs":4,"title":1},"364":{"body":16,"breadcrumbs":4,"title":1},"365":{"body":40,"breadcrumbs":4,"title":1},"366":{"body":19,"breadcrumbs":4,"title":1},"367":{"body":19,"breadcrumbs":4,"title":1},"368":{"body":18,"breadcrumbs":4,"title":1},"369":{"body":82,"breadcrumbs":4,"title":1},"37":{"body":3,"breadcrumbs":7,"title":4},"370":{"body":42,"breadcrumbs":4,"title":1},"371":{"body":414,"breadcrumbs":4,"title":1},"372":{"body":18,"breadcrumbs":4,"title":1},"373":{"body":71,"breadcrumbs":4,"title":1},"374":{"body":18,"breadcrumbs":4,"title":1},"375":{"body":18,"breadcrumbs":4,"title":1},"376":{"body":29,"breadcrumbs":4,"title":1},"377":{"body":98,"breadcrumbs":4,"title":1},"378":{"body":54,"breadcrumbs":4,"title":1},"379":{"body":46,"breadcrumbs":4,"title":1},"38":{"body":87,"breadcrumbs":4,"title":1},"380":{"body":642,"breadcrumbs":4,"title":1},"381":{"body":23,"breadcrumbs":4,"title":1},"382":{"body":45,"breadcrumbs":4,"title":1},"383":{"body":4,"breadcrumbs":5,"title":2},"384":{"body":12,"breadcrumbs":4,"title":1},"385":{"body":17,"breadcrumbs":4,"title":1},"386":{"body":16,"breadcrumbs":4,"title":1},"387":{"body":43,"breadcrumbs":4,"title":1},"388":{"body":22,"breadcrumbs":4,"title":1},"389":{"body":38,"breadcrumbs":4,"title":1},"39":{"body":122,"breadcrumbs":7,"title":4},"390":{"body":33,"breadcrumbs":4,"title":1},"391":{"body":29,"breadcrumbs":4,"title":1},"392":{"body":22,"breadcrumbs":4,"title":1},"393":{"body":47,"breadcrumbs":4,"title":1},"394":{"body":15,"breadcrumbs":4,"title":1},"395":{"body":116,"breadcrumbs":4,"title":1},"396":{"body":13,"breadcrumbs":4,"title":1},"397":{"body":23,"breadcrumbs":4,"title":1},"398":{"body":31,"breadcrumbs":4,"title":1},"399":{"body":27,"breadcrumbs":4,"title":1},"4":{"body":0,"breadcrumbs":3,"title":2},"40":{"body":42,"breadcrumbs":5,"title":2},"400":{"body":48,"breadcrumbs":4,"title":1},"401":{"body":59,"breadcrumbs":4,"title":1},"402":{"body":19,"breadcrumbs":4,"title":1},"403":{"body":21,"breadcrumbs":4,"title":1},"404":{"body":51,"breadcrumbs":4,"title":1},"405":{"body":58,"breadcrumbs":4,"title":1},"406":{"body":55,"breadcrumbs":4,"title":1},"407":{"body":387,"breadcrumbs":4,"title":1},"408":{"body":3,"breadcrumbs":4,"title":1},"409":{"body":43,"breadcrumbs":4,"title":1},"41":{"body":93,"breadcrumbs":4,"title":1},"410":{"body":12,"breadcrumbs":4,"title":1},"411":{"body":21,"breadcrumbs":4,"title":1},"412":{"body":39,"breadcrumbs":4,"title":1},"413":{"body":38,"breadcrumbs":4,"title":1},"414":{"body":31,"breadcrumbs":4,"title":1},"415":{"body":3,"breadcrumbs":4,"title":1},"416":{"body":69,"breadcrumbs":4,"title":1},"417":{"body":41,"breadcrumbs":4,"title":1},"418":{"body":32,"breadcrumbs":4,"title":1},"419":{"body":24,"breadcrumbs":4,"title":1},"42":{"body":341,"breadcrumbs":4,"title":1},"420":{"body":28,"breadcrumbs":4,"title":1},"421":{"body":154,"breadcrumbs":4,"title":1},"422":{"body":3,"breadcrumbs":4,"title":1},"423":{"body":41,"breadcrumbs":4,"title":1},"424":{"body":345,"breadcrumbs":4,"title":1},"425":{"body":46,"breadcrumbs":6,"title":3},"426":{"body":5,"breadcrumbs":4,"title":1},"427":{"body":141,"breadcrumbs":4,"title":1},"428":{"body":307,"breadcrumbs":4,"title":1},"429":{"body":4,"breadcrumbs":4,"title":1},"43":{"body":142,"breadcrumbs":4,"title":1},"430":{"body":16,"breadcrumbs":4,"title":1},"431":{"body":25,"breadcrumbs":4,"title":1},"432":{"body":51,"breadcrumbs":4,"title":1},"433":{"body":46,"breadcrumbs":4,"title":1},"434":{"body":49,"breadcrumbs":4,"title":1},"435":{"body":147,"breadcrumbs":4,"title":1},"436":{"body":51,"breadcrumbs":4,"title":1},"437":{"body":102,"breadcrumbs":4,"title":1},"438":{"body":63,"breadcrumbs":4,"title":1},"439":{"body":45,"breadcrumbs":4,"title":1},"44":{"body":138,"breadcrumbs":4,"title":1},"440":{"body":199,"breadcrumbs":4,"title":1},"441":{"body":51,"breadcrumbs":4,"title":1},"442":{"body":44,"breadcrumbs":4,"title":1},"443":{"body":82,"breadcrumbs":4,"title":1},"444":{"body":75,"breadcrumbs":4,"title":1},"445":{"body":91,"breadcrumbs":4,"title":1},"446":{"body":64,"breadcrumbs":4,"title":1},"447":{"body":44,"breadcrumbs":4,"title":1},"448":{"body":41,"breadcrumbs":4,"title":1},"449":{"body":52,"breadcrumbs":4,"title":1},"45":{"body":20,"breadcrumbs":6,"title":3},"450":{"body":29,"breadcrumbs":4,"title":1},"451":{"body":6,"breadcrumbs":5,"title":2},"452":{"body":215,"breadcrumbs":4,"title":1},"453":{"body":20,"breadcrumbs":4,"title":1},"454":{"body":36,"breadcrumbs":4,"title":1},"455":{"body":12,"breadcrumbs":4,"title":1},"456":{"body":26,"breadcrumbs":4,"title":1},"457":{"body":15,"breadcrumbs":4,"title":1},"458":{"body":74,"breadcrumbs":4,"title":1},"459":{"body":36,"breadcrumbs":4,"title":1},"46":{"body":27,"breadcrumbs":6,"title":3},"460":{"body":116,"breadcrumbs":4,"title":1},"461":{"body":12,"breadcrumbs":4,"title":1},"462":{"body":62,"breadcrumbs":4,"title":1},"463":{"body":77,"breadcrumbs":4,"title":1},"464":{"body":57,"breadcrumbs":4,"title":1},"465":{"body":33,"breadcrumbs":4,"title":1},"466":{"body":63,"breadcrumbs":4,"title":1},"467":{"body":157,"breadcrumbs":4,"title":1},"468":{"body":21,"breadcrumbs":4,"title":1},"469":{"body":91,"breadcrumbs":4,"title":1},"47":{"body":27,"breadcrumbs":7,"title":4},"470":{"body":39,"breadcrumbs":4,"title":1},"471":{"body":118,"breadcrumbs":4,"title":1},"472":{"body":15,"breadcrumbs":4,"title":1},"473":{"body":68,"breadcrumbs":4,"title":1},"474":{"body":50,"breadcrumbs":4,"title":1},"475":{"body":7,"breadcrumbs":4,"title":1},"476":{"body":14,"breadcrumbs":4,"title":1},"477":{"body":33,"breadcrumbs":4,"title":1},"478":{"body":14,"breadcrumbs":4,"title":1},"479":{"body":33,"breadcrumbs":4,"title":1},"48":{"body":131,"breadcrumbs":4,"title":1},"480":{"body":27,"breadcrumbs":4,"title":1},"481":{"body":13,"breadcrumbs":4,"title":1},"482":{"body":6,"breadcrumbs":4,"title":1},"483":{"body":12,"breadcrumbs":4,"title":1},"484":{"body":14,"breadcrumbs":4,"title":1},"485":{"body":33,"breadcrumbs":4,"title":1},"486":{"body":12,"breadcrumbs":4,"title":1},"487":{"body":12,"breadcrumbs":4,"title":1},"488":{"body":12,"breadcrumbs":4,"title":1},"489":{"body":36,"breadcrumbs":4,"title":1},"49":{"body":44,"breadcrumbs":5,"title":2},"490":{"body":111,"breadcrumbs":4,"title":1},"491":{"body":8,"breadcrumbs":4,"title":1},"492":{"body":47,"breadcrumbs":4,"title":1},"493":{"body":27,"breadcrumbs":4,"title":1},"494":{"body":21,"breadcrumbs":4,"title":1},"495":{"body":18,"breadcrumbs":4,"title":1},"496":{"body":70,"breadcrumbs":4,"title":1},"497":{"body":14,"breadcrumbs":4,"title":1},"498":{"body":30,"breadcrumbs":4,"title":1},"499":{"body":61,"breadcrumbs":4,"title":1},"5":{"body":70,"breadcrumbs":4,"title":3},"50":{"body":28,"breadcrumbs":4,"title":1},"500":{"body":35,"breadcrumbs":4,"title":1},"501":{"body":44,"breadcrumbs":4,"title":1},"502":{"body":21,"breadcrumbs":4,"title":1},"503":{"body":27,"breadcrumbs":4,"title":1},"504":{"body":103,"breadcrumbs":4,"title":1},"505":{"body":25,"breadcrumbs":4,"title":1},"506":{"body":25,"breadcrumbs":4,"title":1},"507":{"body":18,"breadcrumbs":4,"title":1},"508":{"body":69,"breadcrumbs":4,"title":1},"509":{"body":46,"breadcrumbs":4,"title":1},"51":{"body":44,"breadcrumbs":4,"title":1},"510":{"body":35,"breadcrumbs":4,"title":1},"511":{"body":71,"breadcrumbs":4,"title":1},"512":{"body":66,"breadcrumbs":4,"title":1},"513":{"body":19,"breadcrumbs":4,"title":1},"514":{"body":44,"breadcrumbs":4,"title":1},"515":{"body":33,"breadcrumbs":4,"title":1},"516":{"body":6,"breadcrumbs":6,"title":3},"517":{"body":28,"breadcrumbs":4,"title":1},"518":{"body":42,"breadcrumbs":4,"title":1},"519":{"body":41,"breadcrumbs":4,"title":1},"52":{"body":33,"breadcrumbs":4,"title":1},"520":{"body":42,"breadcrumbs":4,"title":1},"521":{"body":71,"breadcrumbs":4,"title":1},"522":{"body":63,"breadcrumbs":4,"title":1},"523":{"body":4,"breadcrumbs":4,"title":1},"524":{"body":14,"breadcrumbs":4,"title":1},"525":{"body":83,"breadcrumbs":4,"title":1},"526":{"body":42,"breadcrumbs":4,"title":1},"527":{"body":39,"breadcrumbs":4,"title":1},"528":{"body":16,"breadcrumbs":4,"title":1},"529":{"body":5,"breadcrumbs":5,"title":2},"53":{"body":66,"breadcrumbs":5,"title":2},"530":{"body":132,"breadcrumbs":4,"title":1},"531":{"body":67,"breadcrumbs":4,"title":1},"532":{"body":13,"breadcrumbs":4,"title":1},"533":{"body":22,"breadcrumbs":4,"title":1},"534":{"body":38,"breadcrumbs":4,"title":1},"535":{"body":70,"breadcrumbs":4,"title":1},"536":{"body":33,"breadcrumbs":4,"title":1},"537":{"body":38,"breadcrumbs":4,"title":1},"538":{"body":30,"breadcrumbs":4,"title":1},"539":{"body":5,"breadcrumbs":5,"title":2},"54":{"body":348,"breadcrumbs":4,"title":1},"540":{"body":27,"breadcrumbs":4,"title":1},"541":{"body":56,"breadcrumbs":4,"title":1},"542":{"body":26,"breadcrumbs":4,"title":1},"543":{"body":107,"breadcrumbs":4,"title":1},"544":{"body":18,"breadcrumbs":4,"title":1},"545":{"body":25,"breadcrumbs":4,"title":1},"546":{"body":26,"breadcrumbs":6,"title":3},"547":{"body":578,"breadcrumbs":4,"title":1},"548":{"body":1073,"breadcrumbs":4,"title":1},"549":{"body":276,"breadcrumbs":4,"title":1},"55":{"body":9,"breadcrumbs":9,"title":3},"550":{"body":153,"breadcrumbs":4,"title":1},"551":{"body":204,"breadcrumbs":4,"title":1},"552":{"body":168,"breadcrumbs":4,"title":1},"553":{"body":5,"breadcrumbs":4,"title":1},"554":{"body":172,"breadcrumbs":4,"title":1},"555":{"body":111,"breadcrumbs":4,"title":1},"556":{"body":4,"breadcrumbs":4,"title":1},"557":{"body":78,"breadcrumbs":4,"title":1},"558":{"body":195,"breadcrumbs":4,"title":1},"559":{"body":195,"breadcrumbs":4,"title":1},"56":{"body":0,"breadcrumbs":8,"title":2},"560":{"body":39,"breadcrumbs":4,"title":1},"561":{"body":157,"breadcrumbs":4,"title":1},"562":{"body":29,"breadcrumbs":4,"title":1},"563":{"body":155,"breadcrumbs":4,"title":1},"564":{"body":232,"breadcrumbs":4,"title":1},"565":{"body":136,"breadcrumbs":4,"title":1},"566":{"body":18,"breadcrumbs":4,"title":1},"567":{"body":23,"breadcrumbs":4,"title":1},"568":{"body":29,"breadcrumbs":4,"title":1},"569":{"body":5,"breadcrumbs":4,"title":1},"57":{"body":61,"breadcrumbs":8,"title":2},"570":{"body":128,"breadcrumbs":4,"title":1},"571":{"body":73,"breadcrumbs":5,"title":2},"572":{"body":36,"breadcrumbs":4,"title":1},"573":{"body":30,"breadcrumbs":4,"title":1},"574":{"body":23,"breadcrumbs":4,"title":1},"575":{"body":46,"breadcrumbs":4,"title":1},"576":{"body":25,"breadcrumbs":4,"title":1},"577":{"body":93,"breadcrumbs":4,"title":1},"578":{"body":73,"breadcrumbs":4,"title":1},"579":{"body":92,"breadcrumbs":4,"title":1},"58":{"body":511,"breadcrumbs":7,"title":1},"580":{"body":41,"breadcrumbs":4,"title":1},"581":{"body":21,"breadcrumbs":4,"title":1},"582":{"body":30,"breadcrumbs":4,"title":1},"583":{"body":19,"breadcrumbs":4,"title":1},"584":{"body":21,"breadcrumbs":4,"title":1},"585":{"body":34,"breadcrumbs":4,"title":1},"586":{"body":213,"breadcrumbs":4,"title":1},"587":{"body":24,"breadcrumbs":6,"title":3},"588":{"body":19,"breadcrumbs":4,"title":1},"589":{"body":26,"breadcrumbs":4,"title":1},"59":{"body":9,"breadcrumbs":9,"title":3},"590":{"body":64,"breadcrumbs":4,"title":1},"591":{"body":32,"breadcrumbs":4,"title":1},"592":{"body":21,"breadcrumbs":4,"title":1},"593":{"body":33,"breadcrumbs":4,"title":1},"594":{"body":26,"breadcrumbs":4,"title":1},"595":{"body":5,"breadcrumbs":5,"title":2},"596":{"body":96,"breadcrumbs":4,"title":1},"597":{"body":6,"breadcrumbs":6,"title":3},"598":{"body":112,"breadcrumbs":4,"title":1},"599":{"body":154,"breadcrumbs":9,"title":4},"6":{"body":19,"breadcrumbs":3,"title":2},"60":{"body":0,"breadcrumbs":8,"title":2},"600":{"body":294,"breadcrumbs":9,"title":4},"601":{"body":196,"breadcrumbs":5,"title":2},"602":{"body":70,"breadcrumbs":7,"title":4},"603":{"body":118,"breadcrumbs":3,"title":1},"604":{"body":309,"breadcrumbs":4,"title":2},"605":{"body":129,"breadcrumbs":8,"title":6},"606":{"body":480,"breadcrumbs":8,"title":6},"607":{"body":52,"breadcrumbs":5,"title":2},"608":{"body":23,"breadcrumbs":7,"title":2},"609":{"body":76,"breadcrumbs":14,"title":7},"61":{"body":27,"breadcrumbs":8,"title":2},"610":{"body":76,"breadcrumbs":9,"title":2},"611":{"body":44,"breadcrumbs":11,"title":4},"612":{"body":6,"breadcrumbs":9,"title":2},"613":{"body":77,"breadcrumbs":11,"title":4},"614":{"body":104,"breadcrumbs":8,"title":1},"615":{"body":80,"breadcrumbs":8,"title":1},"616":{"body":117,"breadcrumbs":8,"title":1},"617":{"body":82,"breadcrumbs":8,"title":1},"618":{"body":105,"breadcrumbs":10,"title":3},"619":{"body":127,"breadcrumbs":8,"title":1},"62":{"body":423,"breadcrumbs":7,"title":1},"620":{"body":64,"breadcrumbs":8,"title":1},"621":{"body":85,"breadcrumbs":8,"title":1},"622":{"body":49,"breadcrumbs":8,"title":1},"623":{"body":82,"breadcrumbs":8,"title":1},"624":{"body":82,"breadcrumbs":8,"title":1},"625":{"body":142,"breadcrumbs":8,"title":1},"626":{"body":121,"breadcrumbs":8,"title":1},"627":{"body":123,"breadcrumbs":8,"title":1},"628":{"body":76,"breadcrumbs":9,"title":2},"629":{"body":85,"breadcrumbs":10,"title":3},"63":{"body":41,"breadcrumbs":9,"title":3},"630":{"body":42,"breadcrumbs":8,"title":1},"631":{"body":111,"breadcrumbs":8,"title":1},"632":{"body":33,"breadcrumbs":8,"title":1},"633":{"body":22,"breadcrumbs":7,"title":1},"634":{"body":20,"breadcrumbs":7,"title":1},"635":{"body":167,"breadcrumbs":11,"title":3},"636":{"body":39,"breadcrumbs":11,"title":3},"637":{"body":275,"breadcrumbs":13,"title":5},"638":{"body":12,"breadcrumbs":12,"title":4},"639":{"body":39,"breadcrumbs":11,"title":3},"64":{"body":68,"breadcrumbs":5,"title":4},"640":{"body":272,"breadcrumbs":13,"title":5},"641":{"body":12,"breadcrumbs":12,"title":4},"642":{"body":76,"breadcrumbs":10,"title":4},"643":{"body":50,"breadcrumbs":8,"title":2},"644":{"body":269,"breadcrumbs":8,"title":2},"645":{"body":114,"breadcrumbs":9,"title":3},"646":{"body":53,"breadcrumbs":8,"title":2},"647":{"body":115,"breadcrumbs":9,"title":3},"648":{"body":14,"breadcrumbs":7,"title":2},"649":{"body":172,"breadcrumbs":7,"title":2},"65":{"body":24,"breadcrumbs":4,"title":3},"650":{"body":121,"breadcrumbs":6,"title":1},"651":{"body":143,"breadcrumbs":7,"title":2},"652":{"body":128,"breadcrumbs":13,"title":8},"653":{"body":18,"breadcrumbs":4,"title":1},"654":{"body":80,"breadcrumbs":6,"title":3},"655":{"body":34,"breadcrumbs":7,"title":4},"656":{"body":98,"breadcrumbs":6,"title":3},"657":{"body":42,"breadcrumbs":5,"title":2},"658":{"body":56,"breadcrumbs":5,"title":2},"659":{"body":108,"breadcrumbs":5,"title":2},"66":{"body":60,"breadcrumbs":3,"title":2},"660":{"body":6,"breadcrumbs":5,"title":2},"661":{"body":50,"breadcrumbs":10,"title":7},"662":{"body":182,"breadcrumbs":7,"title":4},"663":{"body":77,"breadcrumbs":7,"title":4},"664":{"body":80,"breadcrumbs":6,"title":3},"665":{"body":65,"breadcrumbs":10,"title":7},"666":{"body":57,"breadcrumbs":10,"title":7},"667":{"body":52,"breadcrumbs":7,"title":4},"668":{"body":174,"breadcrumbs":5,"title":2},"669":{"body":17,"breadcrumbs":5,"title":2},"67":{"body":43,"breadcrumbs":6,"title":5},"670":{"body":112,"breadcrumbs":5,"title":2},"671":{"body":125,"breadcrumbs":4,"title":1},"672":{"body":49,"breadcrumbs":4,"title":1},"673":{"body":214,"breadcrumbs":7,"title":3},"674":{"body":23,"breadcrumbs":6,"title":2},"675":{"body":71,"breadcrumbs":6,"title":2},"676":{"body":217,"breadcrumbs":6,"title":2},"677":{"body":105,"breadcrumbs":6,"title":2},"678":{"body":58,"breadcrumbs":6,"title":2},"679":{"body":53,"breadcrumbs":8,"title":4},"68":{"body":101,"breadcrumbs":5,"title":4},"680":{"body":36,"breadcrumbs":4,"title":1},"681":{"body":31,"breadcrumbs":5,"title":2},"682":{"body":76,"breadcrumbs":6,"title":3},"683":{"body":36,"breadcrumbs":5,"title":2},"684":{"body":51,"breadcrumbs":7,"title":2},"685":{"body":58,"breadcrumbs":10,"title":5},"686":{"body":36,"breadcrumbs":8,"title":3},"687":{"body":93,"breadcrumbs":8,"title":3},"688":{"body":69,"breadcrumbs":7,"title":2},"689":{"body":145,"breadcrumbs":6,"title":1},"69":{"body":0,"breadcrumbs":3,"title":2},"690":{"body":21,"breadcrumbs":11,"title":3},"691":{"body":4,"breadcrumbs":9,"title":1},"692":{"body":105,"breadcrumbs":9,"title":1},"693":{"body":121,"breadcrumbs":9,"title":1},"694":{"body":110,"breadcrumbs":9,"title":1},"695":{"body":89,"breadcrumbs":9,"title":1},"696":{"body":186,"breadcrumbs":9,"title":1},"697":{"body":138,"breadcrumbs":9,"title":1},"698":{"body":87,"breadcrumbs":9,"title":1},"699":{"body":89,"breadcrumbs":9,"title":1},"7":{"body":480,"breadcrumbs":3,"title":2},"70":{"body":60,"breadcrumbs":3,"title":2},"700":{"body":115,"breadcrumbs":9,"title":1},"701":{"body":121,"breadcrumbs":9,"title":1},"702":{"body":109,"breadcrumbs":9,"title":1},"703":{"body":87,"breadcrumbs":9,"title":1},"704":{"body":68,"breadcrumbs":9,"title":1},"705":{"body":101,"breadcrumbs":9,"title":1},"706":{"body":99,"breadcrumbs":9,"title":1},"707":{"body":25,"breadcrumbs":13,"title":4},"708":{"body":5,"breadcrumbs":10,"title":1},"709":{"body":213,"breadcrumbs":10,"title":1},"71":{"body":24,"breadcrumbs":6,"title":5},"710":{"body":86,"breadcrumbs":10,"title":1},"711":{"body":59,"breadcrumbs":10,"title":1},"712":{"body":61,"breadcrumbs":10,"title":1},"713":{"body":88,"breadcrumbs":10,"title":1},"714":{"body":61,"breadcrumbs":10,"title":1},"715":{"body":88,"breadcrumbs":10,"title":1},"716":{"body":131,"breadcrumbs":10,"title":1},"717":{"body":76,"breadcrumbs":10,"title":1},"718":{"body":64,"breadcrumbs":10,"title":1},"719":{"body":65,"breadcrumbs":10,"title":1},"72":{"body":159,"breadcrumbs":6,"title":2},"720":{"body":65,"breadcrumbs":10,"title":1},"721":{"body":65,"breadcrumbs":10,"title":1},"722":{"body":56,"breadcrumbs":11,"title":3},"723":{"body":4,"breadcrumbs":9,"title":1},"724":{"body":75,"breadcrumbs":9,"title":1},"725":{"body":95,"breadcrumbs":9,"title":1},"726":{"body":73,"breadcrumbs":9,"title":1},"727":{"body":33,"breadcrumbs":11,"title":3},"728":{"body":84,"breadcrumbs":9,"title":1},"729":{"body":37,"breadcrumbs":9,"title":1},"73":{"body":143,"breadcrumbs":8,"title":4},"730":{"body":36,"breadcrumbs":9,"title":1},"731":{"body":20,"breadcrumbs":13,"title":4},"732":{"body":0,"breadcrumbs":10,"title":1},"733":{"body":160,"breadcrumbs":10,"title":1},"734":{"body":95,"breadcrumbs":10,"title":1},"735":{"body":55,"breadcrumbs":10,"title":1},"736":{"body":217,"breadcrumbs":10,"title":1},"737":{"body":104,"breadcrumbs":10,"title":1},"738":{"body":88,"breadcrumbs":10,"title":1},"739":{"body":112,"breadcrumbs":10,"title":1},"74":{"body":91,"breadcrumbs":8,"title":4},"740":{"body":88,"breadcrumbs":13,"title":4},"741":{"body":103,"breadcrumbs":10,"title":1},"742":{"body":34,"breadcrumbs":10,"title":1},"743":{"body":44,"breadcrumbs":10,"title":1},"744":{"body":21,"breadcrumbs":11,"title":3},"745":{"body":4,"breadcrumbs":9,"title":1},"746":{"body":95,"breadcrumbs":9,"title":1},"747":{"body":112,"breadcrumbs":9,"title":1},"748":{"body":26,"breadcrumbs":21,"title":8},"749":{"body":48,"breadcrumbs":14,"title":1},"75":{"body":0,"breadcrumbs":6,"title":2},"750":{"body":8,"breadcrumbs":9,"title":2},"751":{"body":3,"breadcrumbs":8,"title":1},"752":{"body":94,"breadcrumbs":8,"title":1},"753":{"body":26,"breadcrumbs":11,"title":3},"754":{"body":81,"breadcrumbs":9,"title":1},"755":{"body":93,"breadcrumbs":9,"title":1},"756":{"body":104,"breadcrumbs":9,"title":1},"757":{"body":76,"breadcrumbs":9,"title":1},"758":{"body":23,"breadcrumbs":9,"title":2},"759":{"body":114,"breadcrumbs":8,"title":1},"76":{"body":21,"breadcrumbs":8,"title":4},"760":{"body":84,"breadcrumbs":16,"title":6},"761":{"body":85,"breadcrumbs":6,"title":4},"762":{"body":80,"breadcrumbs":5,"title":3},"763":{"body":153,"breadcrumbs":5,"title":3},"764":{"body":152,"breadcrumbs":4,"title":2},"765":{"body":96,"breadcrumbs":4,"title":2},"766":{"body":33,"breadcrumbs":5,"title":3},"767":{"body":36,"breadcrumbs":5,"title":3},"768":{"body":0,"breadcrumbs":5,"title":3},"769":{"body":1207,"breadcrumbs":3,"title":1},"77":{"body":0,"breadcrumbs":6,"title":2},"770":{"body":61,"breadcrumbs":3,"title":1},"771":{"body":38,"breadcrumbs":3,"title":1},"772":{"body":66,"breadcrumbs":3,"title":1},"773":{"body":111,"breadcrumbs":3,"title":1},"774":{"body":75,"breadcrumbs":3,"title":1},"775":{"body":16,"breadcrumbs":4,"title":2},"776":{"body":31,"breadcrumbs":5,"title":3},"777":{"body":36,"breadcrumbs":4,"title":2},"778":{"body":90,"breadcrumbs":8,"title":3},"779":{"body":42,"breadcrumbs":8,"title":5},"78":{"body":38,"breadcrumbs":8,"title":4},"780":{"body":70,"breadcrumbs":6,"title":3},"781":{"body":68,"breadcrumbs":5,"title":2},"782":{"body":62,"breadcrumbs":4,"title":1},"783":{"body":103,"breadcrumbs":4,"title":1},"784":{"body":25,"breadcrumbs":2,"title":1},"785":{"body":26,"breadcrumbs":6,"title":4},"786":{"body":24,"breadcrumbs":4,"title":2},"787":{"body":30,"breadcrumbs":5,"title":3},"788":{"body":25,"breadcrumbs":3,"title":1},"789":{"body":58,"breadcrumbs":5,"title":3},"79":{"body":32,"breadcrumbs":11,"title":7},"790":{"body":99,"breadcrumbs":7,"title":5},"791":{"body":116,"breadcrumbs":4,"title":2},"792":{"body":0,"breadcrumbs":5,"title":2},"793":{"body":79,"breadcrumbs":6,"title":3},"794":{"body":94,"breadcrumbs":7,"title":4},"795":{"body":36,"breadcrumbs":8,"title":3},"796":{"body":57,"breadcrumbs":7,"title":2},"797":{"body":11,"breadcrumbs":8,"title":3},"798":{"body":70,"breadcrumbs":6,"title":1},"799":{"body":64,"breadcrumbs":6,"title":1},"8":{"body":731,"breadcrumbs":5,"title":4},"80":{"body":0,"breadcrumbs":6,"title":2},"800":{"body":87,"breadcrumbs":6,"title":1},"801":{"body":64,"breadcrumbs":8,"title":3},"802":{"body":272,"breadcrumbs":8,"title":3},"803":{"body":171,"breadcrumbs":10,"title":5},"804":{"body":22,"breadcrumbs":9,"title":4},"805":{"body":38,"breadcrumbs":8,"title":3},"806":{"body":34,"breadcrumbs":7,"title":2},"807":{"body":26,"breadcrumbs":8,"title":3},"808":{"body":27,"breadcrumbs":6,"title":2},"809":{"body":24,"breadcrumbs":7,"title":3},"81":{"body":53,"breadcrumbs":6,"title":2},"810":{"body":14,"breadcrumbs":8,"title":4},"811":{"body":61,"breadcrumbs":8,"title":4},"812":{"body":47,"breadcrumbs":6,"title":2},"813":{"body":49,"breadcrumbs":7,"title":3},"814":{"body":17,"breadcrumbs":7,"title":3},"815":{"body":18,"breadcrumbs":8,"title":4},"816":{"body":39,"breadcrumbs":7,"title":3},"817":{"body":44,"breadcrumbs":7,"title":3},"818":{"body":29,"breadcrumbs":8,"title":4},"819":{"body":11,"breadcrumbs":8,"title":4},"82":{"body":0,"breadcrumbs":6,"title":2},"820":{"body":96,"breadcrumbs":8,"title":4},"821":{"body":30,"breadcrumbs":7,"title":3},"822":{"body":44,"breadcrumbs":8,"title":4},"823":{"body":104,"breadcrumbs":9,"title":5},"824":{"body":10,"breadcrumbs":8,"title":4},"825":{"body":60,"breadcrumbs":8,"title":4},"826":{"body":136,"breadcrumbs":8,"title":3},"827":{"body":26,"breadcrumbs":8,"title":3},"828":{"body":13,"breadcrumbs":9,"title":4},"829":{"body":194,"breadcrumbs":8,"title":3},"83":{"body":62,"breadcrumbs":13,"title":9},"830":{"body":56,"breadcrumbs":7,"title":2},"831":{"body":91,"breadcrumbs":8,"title":3},"832":{"body":111,"breadcrumbs":7,"title":2},"833":{"body":32,"breadcrumbs":7,"title":2},"834":{"body":138,"breadcrumbs":7,"title":2},"835":{"body":102,"breadcrumbs":7,"title":2},"836":{"body":23,"breadcrumbs":7,"title":2},"837":{"body":32,"breadcrumbs":6,"title":1},"838":{"body":31,"breadcrumbs":10,"title":4},"839":{"body":16,"breadcrumbs":7,"title":1},"84":{"body":0,"breadcrumbs":6,"title":2},"840":{"body":7,"breadcrumbs":7,"title":1},"841":{"body":771,"breadcrumbs":7,"title":3},"842":{"body":224,"breadcrumbs":7,"title":3},"843":{"body":38,"breadcrumbs":7,"title":3},"844":{"body":64,"breadcrumbs":7,"title":3},"845":{"body":273,"breadcrumbs":7,"title":3},"846":{"body":77,"breadcrumbs":8,"title":4},"847":{"body":30,"breadcrumbs":7,"title":3},"848":{"body":46,"breadcrumbs":7,"title":3},"849":{"body":47,"breadcrumbs":6,"title":2},"85":{"body":21,"breadcrumbs":16,"title":12},"850":{"body":140,"breadcrumbs":7,"title":3},"851":{"body":82,"breadcrumbs":8,"title":4},"852":{"body":213,"breadcrumbs":8,"title":4},"853":{"body":26,"breadcrumbs":7,"title":3},"854":{"body":56,"breadcrumbs":6,"title":2},"855":{"body":35,"breadcrumbs":6,"title":2},"856":{"body":118,"breadcrumbs":5,"title":1},"857":{"body":160,"breadcrumbs":7,"title":3},"858":{"body":30,"breadcrumbs":8,"title":4},"859":{"body":17,"breadcrumbs":8,"title":4},"86":{"body":0,"breadcrumbs":6,"title":2},"860":{"body":20,"breadcrumbs":7,"title":3},"861":{"body":36,"breadcrumbs":7,"title":3},"862":{"body":167,"breadcrumbs":7,"title":3},"863":{"body":161,"breadcrumbs":8,"title":4},"864":{"body":197,"breadcrumbs":8,"title":3},"865":{"body":78,"breadcrumbs":7,"title":2},"866":{"body":268,"breadcrumbs":8,"title":4},"867":{"body":82,"breadcrumbs":8,"title":4},"868":{"body":10,"breadcrumbs":7,"title":3},"869":{"body":85,"breadcrumbs":7,"title":3},"87":{"body":24,"breadcrumbs":13,"title":9},"870":{"body":355,"breadcrumbs":7,"title":3},"871":{"body":0,"breadcrumbs":6,"title":2},"872":{"body":509,"breadcrumbs":7,"title":3},"873":{"body":38,"breadcrumbs":7,"title":3},"874":{"body":41,"breadcrumbs":8,"title":4},"875":{"body":180,"breadcrumbs":6,"title":2},"876":{"body":35,"breadcrumbs":6,"title":2},"877":{"body":52,"breadcrumbs":6,"title":2},"878":{"body":33,"breadcrumbs":8,"title":4},"879":{"body":36,"breadcrumbs":9,"title":5},"88":{"body":0,"breadcrumbs":6,"title":2},"880":{"body":101,"breadcrumbs":8,"title":4},"881":{"body":55,"breadcrumbs":8,"title":4},"882":{"body":64,"breadcrumbs":8,"title":4},"883":{"body":67,"breadcrumbs":11,"title":7},"884":{"body":92,"breadcrumbs":6,"title":2},"885":{"body":0,"breadcrumbs":6,"title":2},"886":{"body":399,"breadcrumbs":8,"title":4},"887":{"body":111,"breadcrumbs":8,"title":4},"888":{"body":104,"breadcrumbs":6,"title":2},"889":{"body":85,"breadcrumbs":14,"title":10},"89":{"body":38,"breadcrumbs":9,"title":5},"890":{"body":0,"breadcrumbs":6,"title":2},"891":{"body":146,"breadcrumbs":6,"title":2},"892":{"body":39,"breadcrumbs":6,"title":2},"893":{"body":40,"breadcrumbs":7,"title":3},"894":{"body":104,"breadcrumbs":6,"title":2},"895":{"body":43,"breadcrumbs":6,"title":2},"896":{"body":29,"breadcrumbs":6,"title":2},"897":{"body":158,"breadcrumbs":6,"title":2},"898":{"body":98,"breadcrumbs":9,"title":5},"899":{"body":12,"breadcrumbs":7,"title":3},"9":{"body":6,"breadcrumbs":4,"title":3},"90":{"body":0,"breadcrumbs":6,"title":2},"900":{"body":56,"breadcrumbs":6,"title":2},"901":{"body":76,"breadcrumbs":6,"title":2},"902":{"body":20,"breadcrumbs":6,"title":2},"903":{"body":28,"breadcrumbs":7,"title":3},"904":{"body":73,"breadcrumbs":10,"title":6},"905":{"body":59,"breadcrumbs":12,"title":8},"906":{"body":234,"breadcrumbs":7,"title":3},"907":{"body":99,"breadcrumbs":8,"title":4},"908":{"body":35,"breadcrumbs":7,"title":2},"909":{"body":14,"breadcrumbs":6,"title":2},"91":{"body":34,"breadcrumbs":8,"title":4},"910":{"body":277,"breadcrumbs":6,"title":2},"911":{"body":42,"breadcrumbs":7,"title":3},"912":{"body":127,"breadcrumbs":6,"title":2},"913":{"body":84,"breadcrumbs":7,"title":3},"914":{"body":36,"breadcrumbs":11,"title":4},"915":{"body":49,"breadcrumbs":11,"title":4},"916":{"body":59,"breadcrumbs":13,"title":6},"917":{"body":33,"breadcrumbs":5,"title":3},"918":{"body":95,"breadcrumbs":4,"title":2},"919":{"body":40,"breadcrumbs":4,"title":2},"92":{"body":58,"breadcrumbs":11,"title":7},"920":{"body":63,"breadcrumbs":5,"title":3},"921":{"body":200,"breadcrumbs":7,"title":5},"922":{"body":108,"breadcrumbs":4,"title":2},"923":{"body":58,"breadcrumbs":10,"title":4},"924":{"body":375,"breadcrumbs":8,"title":2},"925":{"body":76,"breadcrumbs":11,"title":5},"926":{"body":47,"breadcrumbs":7,"title":3},"927":{"body":136,"breadcrumbs":7,"title":3},"928":{"body":57,"breadcrumbs":6,"title":2},"929":{"body":75,"breadcrumbs":10,"title":6},"93":{"body":25,"breadcrumbs":10,"title":6},"930":{"body":56,"breadcrumbs":5,"title":1},"931":{"body":59,"breadcrumbs":11,"title":5},"932":{"body":18,"breadcrumbs":10,"title":4},"933":{"body":83,"breadcrumbs":10,"title":4},"934":{"body":74,"breadcrumbs":7,"title":1},"935":{"body":82,"breadcrumbs":7,"title":1},"936":{"body":53,"breadcrumbs":8,"title":2},"937":{"body":28,"breadcrumbs":8,"title":2},"938":{"body":30,"breadcrumbs":8,"title":2},"939":{"body":0,"breadcrumbs":9,"title":5},"94":{"body":0,"breadcrumbs":6,"title":2},"940":{"body":4,"breadcrumbs":8,"title":4},"941":{"body":5,"breadcrumbs":6,"title":2},"942":{"body":21,"breadcrumbs":11,"title":7},"943":{"body":40,"breadcrumbs":6,"title":2},"944":{"body":25,"breadcrumbs":11,"title":7},"945":{"body":60,"breadcrumbs":6,"title":2},"946":{"body":65,"breadcrumbs":12,"title":8},"947":{"body":28,"breadcrumbs":14,"title":10},"948":{"body":30,"breadcrumbs":14,"title":10},"949":{"body":30,"breadcrumbs":12,"title":8},"95":{"body":21,"breadcrumbs":15,"title":11},"950":{"body":50,"breadcrumbs":10,"title":6},"951":{"body":31,"breadcrumbs":6,"title":2},"952":{"body":25,"breadcrumbs":10,"title":6},"953":{"body":15,"breadcrumbs":8,"title":4},"954":{"body":24,"breadcrumbs":10,"title":6},"955":{"body":21,"breadcrumbs":11,"title":7},"956":{"body":12,"breadcrumbs":8,"title":4},"957":{"body":6,"breadcrumbs":8,"title":4},"958":{"body":13,"breadcrumbs":7,"title":3},"959":{"body":5,"breadcrumbs":7,"title":3},"96":{"body":17,"breadcrumbs":9,"title":5},"960":{"body":7,"breadcrumbs":10,"title":6},"961":{"body":172,"breadcrumbs":6,"title":3},"962":{"body":15,"breadcrumbs":7,"title":4},"963":{"body":22,"breadcrumbs":5,"title":2},"964":{"body":257,"breadcrumbs":7,"title":3},"965":{"body":0,"breadcrumbs":5,"title":2},"966":{"body":44,"breadcrumbs":6,"title":3},"967":{"body":6,"breadcrumbs":6,"title":3},"968":{"body":13,"breadcrumbs":7,"title":4},"969":{"body":3,"breadcrumbs":6,"title":3},"97":{"body":0,"breadcrumbs":6,"title":2},"970":{"body":193,"breadcrumbs":6,"title":3},"971":{"body":4,"breadcrumbs":9,"title":6},"972":{"body":14,"breadcrumbs":6,"title":3},"973":{"body":95,"breadcrumbs":9,"title":6},"974":{"body":39,"breadcrumbs":12,"title":9},"975":{"body":91,"breadcrumbs":11,"title":8},"976":{"body":4,"breadcrumbs":8,"title":5},"977":{"body":25,"breadcrumbs":6,"title":3},"978":{"body":57,"breadcrumbs":8,"title":5},"979":{"body":224,"breadcrumbs":8,"title":5},"98":{"body":9,"breadcrumbs":10,"title":6},"980":{"body":136,"breadcrumbs":7,"title":4},"981":{"body":5,"breadcrumbs":3,"title":1},"982":{"body":39,"breadcrumbs":5,"title":3},"983":{"body":110,"breadcrumbs":4,"title":2},"984":{"body":41,"breadcrumbs":4,"title":2},"985":{"body":101,"breadcrumbs":5,"title":3},"986":{"body":75,"breadcrumbs":6,"title":4},"987":{"body":6,"breadcrumbs":4,"title":2},"988":{"body":9,"breadcrumbs":5,"title":3},"989":{"body":75,"breadcrumbs":7,"title":5},"99":{"body":20,"breadcrumbs":13,"title":9},"990":{"body":33,"breadcrumbs":6,"title":4},"991":{"body":9,"breadcrumbs":6,"title":4},"992":{"body":69,"breadcrumbs":4,"title":2},"993":{"body":165,"breadcrumbs":7,"title":5},"994":{"body":195,"breadcrumbs":6,"title":4},"995":{"body":82,"breadcrumbs":6,"title":4},"996":{"body":9,"breadcrumbs":6,"title":4},"997":{"body":32,"breadcrumbs":5,"title":3},"998":{"body":56,"breadcrumbs":5,"title":3},"999":{"body":119,"breadcrumbs":3,"title":1}},"docs":{"0":{"body":"Welcome to the documentation repository for Synapse, a Matrix homeserver implementation developed by Element.","breadcrumbs":"Welcome and Overview » Introduction","id":"0","title":"Introduction"},"1":{"body":"This documentation covers topics for installation, configuration and maintenance of your Synapse process: Learn how to install and configure your own instance, perhaps with Single\\nSign-On. See how to upgrade between Synapse versions. Administer your instance using the Admin\\nAPI, installing pluggable\\nmodules, or by accessing the manhole. Learn how to read log lines, configure logging or set up structured\\nlogging. Scale Synapse through additional worker processes. Set up monitoring and metrics to keep an eye on your\\nSynapse instance’s performance.","breadcrumbs":"Welcome and Overview » Installing and using Synapse","id":"1","title":"Installing and using Synapse"},"10":{"body":"By default Synapse uses an SQLite database and in doing so trades\\nperformance for convenience. Almost all installations should opt to use PostgreSQL\\ninstead. Advantages include: significant performance improvements due to the superior threading and\\ncaching model, smarter query optimiser allowing the DB to be run on separate hardware For information on how to install and use PostgreSQL in Synapse, please see Using Postgres SQLite is only acceptable for testing purposes. SQLite should not be used in\\na production server. Synapse will perform poorly when using\\nSQLite, especially when participating in large rooms.","breadcrumbs":"Installation » Using PostgreSQL","id":"10","title":"Using PostgreSQL"},"100":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.143.0","id":"100","title":"Upgrading to v1.143.0"},"1000":{"body":"Obviously, you don’t know if you should call your newsfile 1234.bugfix or 5678.bugfix until you create the PR, which leads to a\\nchicken-and-egg problem. There are two options for solving this: Open the PR without a changelog file, see what number you got, and then\\nadd the changelog file to your branch, or: Look at the list of all\\nissues/PRs, add one to the\\nhighest number you see, and quickly open the PR before somebody else claims\\nyour number. This\\nscript\\nmight be helpful if you find yourself doing this a lot. Sorry, we know it’s a bit fiddly, but it’s really helpful for us when we come\\nto put together a release!","breadcrumbs":"Contributing Guide » How do I know what to call the changelog file before I create the PR?","id":"1000","title":"How do I know what to call the changelog file before I create the PR?"},"1001":{"body":"Changes which affect the debian packaging files (in debian) are an\\nexception to the rule that all changes require a changelog.d file. In this case, you will need to add an entry to the debian changelog for the\\nnext release. For this, run the following command: dch This will make up a new version number (if there isn’t already an unreleased\\nversion in flight), and open an editor where you can add a new changelog entry.\\n(Our release process will ensure that the version number and maintainer name is\\ncorrected for the release.) If your change affects both the debian packaging and files outside the debian\\ndirectory, you will need both a regular newsfragment and an entry in the\\ndebian changelog. (Though typically such changes should be submitted as two\\nseparate pull requests.)","breadcrumbs":"Contributing Guide » Debian changelog","id":"1001","title":"Debian changelog"},"1002":{"body":"After you make a PR a comment from @CLAassistant will appear asking you to sign\\nthe CLA.\\nThis will link a page to allow you to confirm that you have read and agreed to\\nthe CLA by signing in with GitHub. Alternatively, you can sign off before opening a PR by going to https://cla-assistant.io/element-hq/synapse. We accept contributions under a legally identifiable name, such as\\nyour name on government documentation or common-law names (names\\nclaimed by legitimate usage or repute). Unfortunately, we cannot\\naccept anonymous contributions at this time.","breadcrumbs":"Contributing Guide » Sign off","id":"1002","title":"Sign off"},"1003":{"body":"Once the Pull Request is opened, you will see a few things: our automated CI (Continuous Integration) pipeline will run (again) the linters, the unit tests, the integration tests and more; one or more of the developers will take a look at your Pull Request and offer feedback. From this point, you should: Look at the results of the CI pipeline. If there is any error, fix the error. If a developer has requested changes, make these changes and let us know if it is ready for a developer to review again. A pull request is a conversation, if you disagree with the suggestions, please respond and discuss it. Create a new commit with the changes. Please do NOT overwrite the history. New commits make the reviewer’s life easier. Push this commits to your Pull Request. Back to 1. Once the pull request is ready for review again please re-request review from whichever developer did your initial\\nreview (or leave a comment in the pull request that you believe all required changes have been done). Once both the CI and the developers are happy, the patch will be merged into Synapse and released shortly!","breadcrumbs":"Contributing Guide » 10. Turn feedback into better code.","id":"1003","title":"10. Turn feedback into better code."},"1004":{"body":"By now, you know the drill!","breadcrumbs":"Contributing Guide » 11. Find a new issue.","id":"1004","title":"11. Find a new issue."},"1005":{"body":"There are some notes for those with commit access to the project on how we\\nmanage git here.","breadcrumbs":"Contributing Guide » Notes for maintainers on merging PRs etc","id":"1005","title":"Notes for maintainers on merging PRs etc"},"1006":{"body":"That’s it! Matrix is a very open and collaborative project as you might expect\\ngiven our obsession with open communication. If we’re going to successfully\\nmatrix together all the fragmented communication technologies out there we are\\nreliant on contributions and collaboration from the community to do so. So\\nplease get involved - and we hope you have as much fun hacking on Matrix as we\\ndo!","breadcrumbs":"Contributing Guide » Conclusion","id":"1006","title":"Conclusion"},"1007":{"body":"","breadcrumbs":"Code Style » Code Style","id":"1007","title":"Code Style"},"1008":{"body":"The Synapse codebase uses a number of code formatting tools in order to\\nquickly and automatically check for formatting (and sometimes logical)\\nerrors in code. The necessary tools are: ruff, which can spot common errors and enforce a consistent style; and mypy, a type checker. See the contributing guide for instructions\\non how to install the above tools and run the linters. It’s worth noting that modern IDEs and text editors can run these tools\\nautomatically on save. It may be worth looking into whether this\\nfunctionality is supported in your editor for a more convenient\\ndevelopment workflow. It is not, however, recommended to run mypy\\non save as it takes a while and can be very resource intensive.","breadcrumbs":"Code Style » Formatting tools","id":"1008","title":"Formatting tools"},"1009":{"body":"Naming: Use CamelCase for class and type names Use underscores for function_names and variable_names. Docstrings: should follow the google code\\nstyle.\\nSee the examples\\nin the sphinx documentation. Imports: Imports should be sorted by isort as described above. Prefer to import classes and functions rather than packages or\\nmodules. Example: from synapse.types import UserID\\n...\\nuser_id = UserID(local, server) is preferred over: from synapse import types\\n...\\nuser_id = types.UserID(local, server) (or any other variant). This goes against the advice in the Google style guide, but it\\nmeans that errors in the name are caught early (at import time). Avoid wildcard imports ( from synapse.types import *) and\\nrelative imports ( from .types import UserID).","breadcrumbs":"Code Style » General rules","id":"1009","title":"General rules"},"101":{"body":"In line with our deprecation policy, we’ve dropped\\nsupport for PostgreSQL 13, as it is no longer supported upstream.\\nThis release of Synapse requires PostgreSQL 14+.","breadcrumbs":"Upgrading between Synapse Versions » Dropping support for PostgreSQL 13","id":"101","title":"Dropping support for PostgreSQL 13"},"1010":{"body":"When adding a configuration option to the code, if several settings are grouped into a single dict, ensure that your code\\ncorrectly handles the top-level option being set to None (as it will be if no sub-options are enabled). The configuration manual acts as a\\nreference to Synapse’s configuration options for server administrators.\\nRemember that many readers will be unfamiliar with YAML and server\\nadministration in general, so it is important that when you add\\na configuration option the documentation be as easy to understand as possible, which\\nincludes following a consistent format. Some guidelines follow: Each option should be listed in the config manual with the following format: The name of the option, prefixed by ###. A comment which describes the default behaviour (i.e. what\\nhappens if the setting is omitted), as well as what the effect\\nwill be if the setting is changed. An example setting, using backticks to define the code block For boolean (on/off) options, convention is that this example\\nshould be the opposite to the default. For other options, the example should give\\nsome non-default value which is likely to be useful to the reader. There should be a horizontal rule between each option, which can be achieved by adding --- before and\\nafter the option. true and false are spelt thus (as opposed to True, etc.) Example:","breadcrumbs":"Code Style » Configuration code and documentation format","id":"1010","title":"Configuration code and documentation format"},"1011":{"body":"Use the module sub-option to add a module under modules to extend functionality.\\nThe module setting then has a sub-option, config, which can be used to define some configuration\\nfor the module. Defaults to none. Example configuration: modules: - module: my_super_module.MySuperClass config: do_thing: true - module: my_other_super_module.SomeClass config: {} Note that the sample configuration is generated from the synapse code\\nand is maintained by a script, scripts-dev/generate_sample_config.sh.\\nMaking sure that the output from this script matches the desired format\\nis left as an exercise for the reader!","breadcrumbs":"Code Style » modules","id":"1011","title":"modules"},"1012":{"body":"The Synapse team works off a shared review queue – any new pull requests for\\nSynapse (or related projects) has a review requested from the entire team. Team\\nmembers should process this queue using the following rules: Any high urgency pull requests (e.g. fixes for broken continuous integration\\nor fixes for release blockers); Follow-up reviews for pull requests which have previously received reviews; Any remaining pull requests. For the latter two categories above, older pull requests should be prioritised. It is explicit that there is no priority given to pull requests from the team\\n(vs from the community). If a pull request requires a quick turn around, please\\nexplicitly communicate this via #synapse-dev:matrix.org\\nor as a comment on the pull request. Once an initial review has been completed and the author has made additional changes,\\nfollow-up reviews should go back to the same reviewer. This helps build a shared\\ncontext and conversation between author and reviewer. As a team we aim to keep the number of inflight pull requests to a minimum to ensure\\nthat ongoing work is finished before starting new work.","breadcrumbs":"Reviewing Code » Some notes on how we do reviews","id":"1012","title":"Some notes on how we do reviews"},"1013":{"body":"To communicate to the rest of the team the status of each pull request, team\\nmembers should do the following: Assign themselves to the pull request (they should be left assigned to the\\npull request until it is merged, closed, or are no longer the reviewer); Review the pull request by leaving comments, questions, and suggestions; Mark the pull request appropriately (as needing changes or accepted). If you are unsure about a particular part of the pull request (or are not confident\\nin your understanding of part of the code) then ask questions or request review\\nfrom the team again. When requesting review from the team be sure to leave a comment\\nwith the rationale on why you’re putting it back in the queue.","breadcrumbs":"Reviewing Code » Performing a review","id":"1013","title":"Performing a review"},"1014":{"body":"Releases of Synapse follow a two week release cycle with new releases usually\\noccurring on Tuesdays: Day 0: Synapse N - 1 is released. Day 7: Synapse N release candidate 1 is released. Days 7 - 13: Synapse N release candidates 2+ are released, if bugs are found. Day 14: Synapse N is released. Note that this schedule might be modified depending on the availability of the\\nSynapse team, e.g. releases may be skipped to avoid holidays. Release announcements can be found in the release category of the Matrix blog.","breadcrumbs":"Release Cycle » Synapse Release Cycle","id":"1014","title":"Synapse Release Cycle"},"1015":{"body":"If a bug is found after release that is deemed severe enough (by a combination\\nof the impacted users and the impact on those users) then a bugfix release may\\nbe issued. This may be at any point in the release cycle.","breadcrumbs":"Release Cycle » Bugfix releases","id":"1015","title":"Bugfix releases"},"1016":{"body":"Security will sometimes be backported to the previous version and released\\nimmediately before the next release candidate. An example of this might be: Day 0: Synapse N - 1 is released. Day 7: Synapse (N - 1).1 is released as Synapse N - 1 + the security fix. Day 7: Synapse N release candidate 1 is released (including the security fix). Depending on the impact and complexity of security fixes, multiple fixes might\\nbe held to be released together. In some cases, a pre-disclosure of a security release will be issued as a notice\\nto Synapse operators that there is an upcoming security release. These can be\\nfound in the security category of the Matrix blog.","breadcrumbs":"Release Cycle » Security releases","id":"1016","title":"Security releases"},"1017":{"body":"","breadcrumbs":"Git Usage » Some notes on how we use git","id":"1017","title":"Some notes on how we use git"},"1018":{"body":"In an ideal world, our git commit history would be a linear progression of\\ncommits each of which contains a single change building on what came\\nbefore. Here, by way of an arbitrary example, is the top of git log --graph b2dba0607: Note how the commit comment explains clearly what is changing and why. Also\\nnote the absence of merge commits, as well as the absence of commits called\\nthings like (to pick a few culprits): “pep8”, “fix broken\\ntest”, “oops”, “typo”, or “Who’s\\nthe president?”. There are a number of reasons why keeping a clean commit history is a good\\nthing: From time to time, after a change lands, it turns out to be necessary to\\nrevert it, or to backport it to a release branch. Those operations are much easier when the change is contained in a single commit. Similarly, it’s much easier to answer questions like “is the fix for /publicRooms on the release branch?” if that change consists of a single\\ncommit. Likewise: “what has changed on this branch in the last week?” is much\\nclearer without merges and “pep8” commits everywhere. Sometimes we need to figure out where a bug got introduced, or some\\nbehaviour changed. One way of doing that is with git bisect: pick an\\narbitrary commit between the known good point and the known bad point, and\\nsee how the code behaves. However, that strategy fails if the commit you\\nchose is the middle of someone’s epic branch in which they broke the world\\nbefore putting it back together again. One counterargument is that it is sometimes useful to see how a PR evolved as\\nit went through review cycles. This is true, but that information is always\\navailable via the GitHub UI (or via the little-known refs/pull\\nnamespace). Of course, in reality, things are more complicated than that. We have release\\nbranches as well as develop and master, and we deliberately merge changes\\nbetween them. Bugs often slip through and have to be fixed later. That’s all\\nfine: this not a cast-iron rule which must be obeyed, but an ideal to aim\\ntowards.","breadcrumbs":"Git Usage » On keeping the commit history clean","id":"1018","title":"On keeping the commit history clean"},"1019":{"body":"Ok, so that’s what we’d like to achieve. How do we achieve it? The TL;DR is: when you come to merge a pull request, you probably want to\\n“squash and merge”: . (This applies whether you are merging your own PR, or that of another\\ncontributor.) “Squash and merge” 1 takes all of the changes in the\\nPR, and bundles them into a single commit. GitHub gives you the opportunity to\\nedit the commit message before you confirm, and normally you should do so,\\nbecause the default will be useless (again: * woops typo is not a useful\\nthing to keep in the historical record). The main problem with this approach comes when you have a series of pull\\nrequests which build on top of one another: as soon as you squash-merge the\\nfirst PR, you’ll end up with a stack of conflicts to resolve in all of the\\nothers. In general, it’s best to avoid this situation in the first place by\\ntrying not to have multiple related PRs in flight at the same time. Still,\\nsometimes that’s not possible and doing a regular merge is the lesser evil. Another occasion in which a regular merge makes more sense is a PR where you’ve\\ndeliberately created a series of commits each of which makes sense in its own\\nright. For example: a PR which gradually propagates a refactoring operation\\nthrough the codebase, or a\\nPR which is the culmination of several other\\nPRs. In this case the ability\\nto figure out when a particular change/bug was introduced could be very useful. Ultimately: this is not a hard-and-fast-rule. If in doubt, ask yourself “do\\neach of the commits I am about to merge make sense in their own right”, but\\nremember that we’re just doing our best to balance “keeping the commit history\\nclean” with other factors.","breadcrumbs":"Git Usage » Merges, squashes, rebases: wtf?","id":"1019","title":"Merges, squashes, rebases: wtf?"},"102":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.142.0","id":"102","title":"Upgrading to v1.142.0"},"1020":{"body":"A lot of words have been\\nwritten in the past about git branching models (no really, a\\nlot). I tend to\\nthink the whole thing is overblown. Fundamentally, it’s not that\\ncomplicated. Here’s how we do it. Let’s start with a picture: It looks complicated, but it’s really not. There’s one basic rule: anyone is\\nfree to merge from any more-stable branch to any less-stable branch at any time 2. (The principle behind this is that if a\\nchange is good enough for the more-stable branch, then it’s also good enough go\\nput in a less-stable branch.) Meanwhile, merging (or squashing, as per the above) from a less-stable to a\\nmore-stable branch is a deliberate action in which you want to publish a change\\nor a set of changes to (some subset of) the world: for example, this happens\\nwhen a PR is landed, or as part of our release process. So, what counts as a more- or less-stable branch? A little reflection will show\\nthat our active branches are ordered thus, from more-stable to less-stable: master (tracks our last release). release-vX.Y (the branch where we prepare the next release) 3. PR branches which are targeting the release. develop (our “mainline” branch containing our bleeding-edge). regular PR branches. The corollary is: if you have a bugfix that needs to land in both release-vX.Y and develop, then you should base your PR on release-vX.Y, get it merged there, and then merge from release-vX.Y to develop. (If a fix lands in develop and we later need it in a\\nrelease-branch, we can of course cherry-pick it, but landing it in the release\\nbranch first helps reduce the chance of annoying conflicts.) [1]: “Squash and merge” is GitHub’s term for this\\noperation. Given that there is no merge involved, I’m not convinced it’s the\\nmost intuitive name. ^ [2]: Well, anyone with commit access. ^ [3]: Very, very occasionally (I think this has happened once in\\nthe history of Synapse), we’ve had two releases in flight at once. Obviously, release-v1.2 is more-stable than release-v1.3. ^","breadcrumbs":"Git Usage » Git branching model","id":"1020","title":"Git branching model"},"1021":{"body":"DO NOT USE THESE DEMO SERVERS IN PRODUCTION Requires you to have a Synapse development environment setup. The demo setup allows running three federation Synapse servers, with server\\nnames localhost:8480, localhost:8481, and localhost:8482. You can access them via any Matrix client over HTTP at localhost:8080, localhost:8081, and localhost:8082 or over HTTPS at localhost:8480, localhost:8481, and localhost:8482. To enable the servers to communicate, self-signed SSL certificates are generated\\nand the servers are configured in a highly insecure way, including: Not checking certificates over federation. Not verifying keys. The servers are configured to store their data under demo/8080, demo/8081, and demo/8082. This includes configuration, logs, SQLite databases, and media. Note that when joining a public room on a different homeserver via “#foo:bar.net”,\\nthen you are (in the current implementation) joining a room with room_id “foo”.\\nThis means that it won’t work if your homeserver already has a room with that\\nname.","breadcrumbs":"Testing » Demo scripts » Synapse demo setup","id":"1021","title":"Synapse demo setup"},"1022":{"body":"There’s three main scripts with straightforward purposes: start.sh will start the Synapse servers, generating any missing configuration. This accepts a single parameter --no-rate-limit to “disable” rate limits\\n(they actually still exist, but are very high). stop.sh will stop the Synapse servers. clean.sh will delete the configuration, databases, log files, etc. To start a completely new set of servers, run: ./demo/stop.sh; ./demo/clean.sh && ./demo/start.sh","breadcrumbs":"Testing » Demo scripts » Using the demo scripts","id":"1022","title":"Using the demo scripts"},"1023":{"body":"","breadcrumbs":"OpenTracing » OpenTracing","id":"1023","title":"OpenTracing"},"1024":{"body":"OpenTracing is a semi-standard being adopted by a number of distributed\\ntracing platforms. It is a common api for facilitating vendor-agnostic\\ntracing instrumentation. That is, we can use the OpenTracing api and\\nselect one of a number of tracer implementations to do the heavy lifting\\nin the background. Our current selected implementation is Jaeger. OpenTracing is a tool which gives an insight into the causal\\nrelationship of work done in and between servers. The servers each track\\nevents and report them to a centralised server - in Synapse’s case:\\nJaeger. The basic unit used to represent events is the span. The span\\nroughly represents a single piece of work that was done and the time at\\nwhich it occurred. A span can have child spans, meaning that the work of\\nthe child had to be completed for the parent span to complete, or it can\\nhave follow-on spans which represent work that is undertaken as a result\\nof the parent but is not depended on by the parent to in order to\\nfinish. Since this is undertaken in a distributed environment a request to\\nanother server, such as an RPC or a simple GET, can be considered a span\\n(a unit or work) for the local server. This causal link is what\\nOpenTracing aims to capture and visualise. In order to do this metadata\\nabout the local server’s span, i.e the ‘span context’, needs to be\\nincluded with the request to the remote. It is up to the remote server to decide what it does with the spans it\\ncreates. This is called the sampling policy and it can be configured\\nthrough Jaeger’s settings. For OpenTracing concepts see https://opentracing.io/docs/overview/what-is-tracing/. For more information about Jaeger’s implementation see https://www.jaegertracing.io/docs/","breadcrumbs":"OpenTracing » Background","id":"1024","title":"Background"},"1025":{"body":"To receive OpenTracing spans, start up a Jaeger server. This can be done\\nusing docker like so: docker run -d --name jaeger \\\\ -p 6831:6831/udp \\\\ -p 6832:6832/udp \\\\ -p 5778:5778 \\\\ -p 16686:16686 \\\\ -p 14268:14268 \\\\ jaegertracing/all-in-one:1 By default, Synapse will publish traces to Jaeger on localhost.\\nIf Jaeger is hosted elsewhere, point Synapse to the correct host by setting opentracing.jaeger_config.local_agent.reporting_host in the Synapse configuration\\nor by setting the JAEGER_AGENT_HOST environment variable to the desired address. Latest documentation is probably at\\nhttps://www.jaegertracing.io/docs/latest/getting-started.","breadcrumbs":"OpenTracing » Setting up OpenTracing","id":"1025","title":"Setting up OpenTracing"},"1026":{"body":"OpenTracing is not enabled by default. It must be enabled in the\\nhomeserver config by adding the opentracing option to your config file. You can find\\ndocumentation about how to do this in the config manual under the header ‘Opentracing’.\\nSee below for an example Opentracing configuration: opentracing: enabled: true homeserver_whitelist: - \\"mytrustedhomeserver.org\\" - \\"*.myotherhomeservers.com\\"","breadcrumbs":"OpenTracing » Enable OpenTracing in Synapse","id":"1026","title":"Enable OpenTracing in Synapse"},"1027":{"body":"The homeserver whitelist is configured using regular expressions. A list\\nof regular expressions can be given and their union will be compared\\nwhen propagating any spans contexts to another homeserver. Though it’s mostly safe to send and receive span contexts to and from\\nuntrusted users since span contexts are usually opaque ids it can lead\\nto two problems, namely: If the span context is marked as sampled by the sending homeserver\\nthe receiver will sample it. Therefore two homeservers with wildly\\ndifferent sampling policies could incur higher sampling counts than\\nintended. Sending servers can attach arbitrary data to spans, known as\\n‘baggage’. For safety this has been disabled in Synapse but that\\ndoesn’t prevent another server sending you baggage which will be\\nlogged to OpenTracing’s logs.","breadcrumbs":"OpenTracing » Homeserver whitelisting","id":"1027","title":"Homeserver whitelisting"},"1028":{"body":"Sampling strategies can be set as in this document: https://www.jaegertracing.io/docs/latest/sampling/.","breadcrumbs":"OpenTracing » Configuring Jaeger","id":"1028","title":"Configuring Jaeger"},"1029":{"body":"Synapse’s database schema is stored in the synapse.storage.schema module.","breadcrumbs":"Database Schemas » Synapse database schema files","id":"1029","title":"Synapse database schema files"},"103":{"body":"The minimum supported Python version has been increased from v3.9 to v3.10.\\nYou will need Python 3.10+ to run Synapse v1.142.0. If you use current versions of the matrixorg/synapse\\nDocker images, no action is required.","breadcrumbs":"Upgrading between Synapse Versions » Python 3.10+ is now required","id":"103","title":"Python 3.10+ is now required"},"1030":{"body":"Synapse supports splitting its datastore across multiple physical databases (which can\\nbe useful for large installations), and the schema files are therefore split according\\nto the logical database they apply to. At the time of writing, the following “logical” databases are supported: state - used to store Matrix room state (more specifically, state_groups,\\ntheir relationships and contents). main - stores everything else. Additionally, the common directory contains schema files for tables which must be\\npresent on all physical databases.","breadcrumbs":"Database Schemas » Logical databases","id":"1030","title":"Logical databases"},"1031":{"body":"Synapse manages its database schema via “schema versions”. These are mainly used to\\nhelp avoid confusion if the Synapse codebase is rolled back after the database is\\nupdated. They work as follows: The Synapse codebase defines a constant synapse.storage.schema.SCHEMA_VERSION\\nwhich represents the expectations made about the database by that version. For\\nexample, as of Synapse v1.36, this is 59. The database stores a “compatibility version” in schema_compat_version.compat_version which defines the SCHEMA_VERSION of the\\noldest version of Synapse which will work with the database. On startup, if compat_version is found to be newer than SCHEMA_VERSION, Synapse will refuse to\\nstart. Synapse automatically updates this field from synapse.storage.schema.SCHEMA_COMPAT_VERSION. Whenever a backwards-incompatible change is made to the database format (normally\\nvia a delta file), synapse.storage.schema.SCHEMA_COMPAT_VERSION is also updated\\nso that administrators can not accidentally roll back to a too-old version of Synapse. Generally, the goal is to maintain compatibility with at least one or two previous\\nreleases of Synapse, so any substantial change tends to require multiple releases and a\\nbit of forward-planning to get right. As a worked example: we want to remove the room_stats_historical table. Here is how it\\nmight pan out. Replace any code that reads from room_stats_historical with alternative\\nimplementations, but keep writing to it in case of rollback to an earlier version.\\nAlso, increase synapse.storage.schema.SCHEMA_VERSION. In this\\ninstance, there is no existing code which reads from room_stats_historical, so\\nour starting point is: v1.36.0: SCHEMA_VERSION=59, SCHEMA_COMPAT_VERSION=59 Next (say in Synapse v1.37.0): remove the code that writes to room_stats_historical, but don’t yet remove the table in case of rollback to\\nv1.36.0. Again, we increase synapse.storage.schema.SCHEMA_VERSION, but\\nbecause we have not broken compatibility with v1.36, we do not yet update SCHEMA_COMPAT_VERSION. We now have: v1.37.0: SCHEMA_VERSION=60, SCHEMA_COMPAT_VERSION=59. Later (say in Synapse v1.38.0): we can remove the table altogether. This will\\nbreak compatibility with v1.36.0, so we must update SCHEMA_COMPAT_VERSION accordingly.\\nThere is no need to update synapse.storage.schema.SCHEMA_VERSION, since there is no\\nchange to the Synapse codebase here. So we end up with: v1.38.0: SCHEMA_VERSION=60, SCHEMA_COMPAT_VERSION=60. If in doubt about whether to update SCHEMA_VERSION or not, it is generally best to\\nlean towards doing so.","breadcrumbs":"Database Schemas » Synapse schema versions","id":"1031","title":"Synapse schema versions"},"1032":{"body":"In the full_schemas directories, only the most recently-numbered snapshot is used\\n( 54 at the time of writing). Older snapshots (eg, 16) are present for historical\\nreference only.","breadcrumbs":"Database Schemas » Full schema dumps","id":"1032","title":"Full schema dumps"},"1033":{"body":"If you want to recreate these schemas, they need to be made from a database that\\nhas had all background updates run. To do so, use the make_full_schema.sh script. This will produce new full.sql.postgres and full.sql.sqlite files, after having applied ALL\\nschema deltas and background updates. Run poetry run scripts-dev/make_full_schema.sh -h for usage instructions.","breadcrumbs":"Database Schemas » Building full schema dumps","id":"1033","title":"Building full schema dumps"},"1034":{"body":"Delta files define the steps required to upgrade the database from an earlier version.\\nThey can be written as either a file containing a series of SQL statements, or a Python\\nmodule. Synapse remembers which delta files it has applied to a database (they are stored in the applied_schema_deltas table) and will not re-apply them (even if a given file is\\nsubsequently updated). Delta files should be placed in a directory named synapse/storage/schema//delta//.\\nThey are applied in alphanumeric order, so by convention the first two characters\\nof the filename should be an integer such as 01, to put the file in the right order.","breadcrumbs":"Database Schemas » Delta files","id":"1034","title":"Delta files"},"1035":{"body":"These should be named *.sql, or — for changes which should only be applied for a\\ngiven database engine — *.sql.posgres or *.sql.sqlite. For example, a delta which\\nadds a new column to the foo table might be called 01add_bar_to_foo.sql. Note that our SQL parser is a bit simple - it understands comments ( -- and /*...*/),\\nbut complex statements which require a ; in the middle of them (such as CREATE TRIGGER) are beyond it and you’ll have to use a Python delta file.","breadcrumbs":"Database Schemas » SQL delta files","id":"1035","title":"SQL delta files"},"1036":{"body":"For more flexibility, a delta file can take the form of a python module. These should\\nbe named *.py. Note that database-engine-specific modules are not supported here –\\ninstead you can write if isinstance(database_engine, PostgresEngine) or similar. A Python delta module should define either or both of the following functions: import synapse.config.homeserver\\nimport synapse.storage.engines\\nimport synapse.storage.types def run_create( cur: synapse.storage.types.Cursor, database_engine: synapse.storage.engines.BaseDatabaseEngine,\\n) -> None: \\"\\"\\"Called whenever an existing or new database is to be upgraded\\"\\"\\" ... def run_upgrade( cur: synapse.storage.types.Cursor, database_engine: synapse.storage.engines.BaseDatabaseEngine, config: synapse.config.homeserver.HomeServerConfig,\\n) -> None: \\"\\"\\"Called whenever an existing database is to be upgraded.\\"\\"\\" ...","breadcrumbs":"Database Schemas » Python delta files","id":"1036","title":"Python delta files"},"1037":{"body":"It is sometimes appropriate to perform database migrations as part of a background\\nprocess (instead of blocking Synapse until the migration is done). In particular,\\nthis is useful for migrating data when adding new columns or tables. Pending background updates stored in the background_updates table and are denoted\\nby a unique name, the current status (stored in JSON), and some dependency information: Whether the update requires a previous update to be complete. A rough ordering for which to complete updates. A new background update needs to be added to the background_updates table: INSERT INTO background_updates (ordering, update_name, depends_on, progress_json) VALUES (7706, \'my_background_update\', \'a_previous_background_update\' \'{}\'); And then needs an associated handler in the appropriate datastore: self.db_pool.updates.register_background_update_handler( \\"my_background_update\\", update_handler=self._my_background_update,\\n) There are a few types of updates that can be performed, see the BackgroundUpdater: register_background_update_handler: A generic handler for custom SQL register_background_index_update: Create an index in the background register_background_validate_constraint: Validate a constraint in the background\\n(PostgreSQL-only) register_background_validate_constraint_and_delete_rows: Similar to register_background_validate_constraint, but deletes rows which don’t fit\\nthe constraint. For register_background_update_handler, the generic handler must track progress\\nand then finalize the background update: async def _my_background_update(self, progress: JsonDict, batch_size: int) -> int: def _do_something(txn: LoggingTransaction) -> int: ... self.db_pool.updates._background_update_progress_txn( txn, \\"my_background_update\\", {\\"last_processed\\": last_processed} ) return last_processed - prev_last_processed num_processed = await self.db_pool.runInteraction(\\"_do_something\\", _do_something) await self.db_pool.updates._end_background_update(\\"my_background_update\\") return num_processed Synapse will attempt to rate-limit how often background updates are run via the\\ngiven batch-size and the returned number of processed entries (and how long the\\nfunction took to run). See background update controller callbacks.","breadcrumbs":"Database Schemas » Background updates","id":"1037","title":"Background updates"},"1038":{"body":"Boolean columns require special treatment, since SQLite treats booleans the\\nsame as integers. Any new boolean column must be added to the BOOLEAN_COLUMNS list in synapse/_scripts/synapse_port_db.py. This tells the port script to cast\\nthe integer value from SQLite to a boolean before writing the value to the\\npostgres database.","breadcrumbs":"Database Schemas » Boolean columns","id":"1038","title":"Boolean columns"},"1039":{"body":"event_id’s can be considered globally unique although there has been a lot of\\ndebate on this topic in places like MSC2779 and MSC2848 which\\nhas no resolution yet (as of 2022-09-01). There are several places in Synapse\\nand even in the Matrix APIs like GET /_matrix/federation/v1/event/{eventId}\\nwhere we assume that event IDs are globally unique. When scoping event_id in a database schema, it is often nice to accompany it\\nwith room_id ( PRIMARY KEY (room_id, event_id) and a FOREIGN KEY(room_id) REFERENCES rooms(room_id)) which makes flexible lookups easy. For example it\\nmakes it very easy to find and clean up everything in a room when it needs to be\\npurged (no need to use sub- select query or join from the events table). A note on collisions: In room versions 1 and 2 it’s possible to end up with\\ntwo events with the same event_id (in the same or different rooms). After room\\nversion 3, that can only happen with a hash collision, which we basically hope\\nwill never happen (SHA256 has a massive big key space).","breadcrumbs":"Database Schemas » event_id global uniqueness","id":"1039","title":"event_id global uniqueness"},"104":{"body":"The minimum supported SQLite version has been increased from 3.27.0 to 3.40.0. If you use current versions of the matrixorg/synapse\\nDocker images, no action is required.","breadcrumbs":"Upgrading between Synapse Versions » SQLite 3.40.0+ is now required","id":"104","title":"SQLite 3.40.0+ is now required"},"1040":{"body":"Some migrations need to be performed gradually. A prime example of this is anything\\nwhich would need to do a large table scan — including adding columns, indices or NOT NULL constraints to non-empty tables — such a migration should be done as a\\nbackground update where possible, at least on Postgres.\\nWe can afford to be more relaxed about SQLite databases since they are usually\\nused on smaller deployments and SQLite does not support the same concurrent\\nDDL operations as Postgres. We also typically insist on having at least one Synapse version’s worth of\\nbackwards compatibility, so that administrators can roll back Synapse if an upgrade\\ndid not go smoothly. This sometimes results in having to plan a migration across multiple versions\\nof Synapse. This section includes an example and may include more in the future.","breadcrumbs":"Database Schemas » Worked examples of gradual migrations","id":"1040","title":"Worked examples of gradual migrations"},"1041":{"body":"This example illustrates how you would introduce a new column, write data into it\\nbased on data from an old column and then drop the old column. We are aiming for semantic equivalence to: ALTER TABLE mytable ADD COLUMN new_column INTEGER;\\nUPDATE mytable SET new_column = old_column * 100;\\nALTER TABLE mytable ALTER COLUMN new_column ADD CONSTRAINT NOT NULL;\\nALTER TABLE mytable DROP COLUMN old_column; Synapse version N SCHEMA_VERSION = S\\nSCHEMA_COMPAT_VERSION = ... # unimportant at this stage Invariants: old_column is read by Synapse and written to by Synapse. Synapse version N + 1 SCHEMA_VERSION = S + 1\\nSCHEMA_COMPAT_VERSION = ... # unimportant at this stage Changes:\\n1. ALTER TABLE mytable ADD COLUMN new_column INTEGER; Invariants: old_column is read by Synapse and written to by Synapse. new_column is written to by Synapse. Notes: new_column can’t have a NOT NULL NOT VALID constraint yet, because the previous Synapse version did not write to the new column (since we haven’t bumped the SCHEMA_COMPAT_VERSION yet, we still need to be compatible with the previous version). Synapse version N + 2 SCHEMA_VERSION = S + 2\\nSCHEMA_COMPAT_VERSION = S + 1 # this signals that we can\'t roll back to a time before new_column existed Changes: On Postgres, add a NOT VALID constraint to ensure new rows are compliant. SQLite does not have such a construct, but it would be unnecessary anyway since there is no way to concurrently perform this migration on SQLite. ALTER TABLE mytable ADD CONSTRAINT CHECK new_column_not_null (new_column IS NOT NULL) NOT VALID; Start a background update to perform migration: it should gradually run e.g. UPDATE mytable SET new_column = old_column * 100 WHERE 0 < mytable_id AND mytable_id <= 5;\\nThis background update is technically pointless on SQLite, but you must schedule it anyway so that the portdb script to migrate to Postgres still works. Upon completion of the background update, you should run VALIDATE CONSTRAINT on Postgres to turn the NOT VALID constraint into a valid one. ALTER TABLE mytable VALIDATE CONSTRAINT new_column_not_null;\\nThis will take some time but does NOT hold an exclusive lock over the table. Invariants: old_column is read by Synapse and written to by Synapse. new_column is written to by Synapse and new rows always have a non- NULL value in this field. Notes: If you wish, you can convert the CHECK (new_column IS NOT NULL) to a NOT NULL constraint free of charge in Postgres by adding the NOT NULL constraint and then dropping the CHECK constraint, because Postgres can statically verify that the NOT NULL constraint is implied by the CHECK constraint without performing a table scan. It might be tempting to make version N + 2 redundant by moving the background update to N + 1 and delaying adding the NOT NULL constraint to N + 3, but that would mean the constraint would always be validated in the foreground in N + 3. Whereas if the N + 2 step is kept, the migration in N + 3 would be fast in the happy case. Synapse version N + 3 SCHEMA_VERSION = S + 3\\nSCHEMA_COMPAT_VERSION = S + 1 # we can\'t roll back to a time before new_column existed Changes: (Postgres) Update the table to populate values of new_column in case the background update had not completed. Additionally, VALIDATE CONSTRAINT to make the check fully valid. -- you ideally want an index on `new_column` or e.g. `(new_column) WHERE new_column IS NULL` first, or perhaps you can find a way to skip this if the `NOT NULL` constraint has already been validated.\\nUPDATE mytable SET new_column = old_column * 100 WHERE new_column IS NULL; -- this is a no-op if it already ran as part of the background update\\nALTER TABLE mytable VALIDATE CONSTRAINT new_column_not_null; (SQLite) Recreate the table by precisely following the 12-step procedure for SQLite table schema changes.\\nDuring this table rewrite, you should recreate new_column as NOT NULL and populate any outstanding NULL values at the same time.\\nUnfortunately, you can’t drop old_column yet because it must be present for compatibility with the Postgres schema, as needed by portdb.\\n(Otherwise you could do this all in one go with SQLite!) Invariants: old_column is written to by Synapse (but no longer read by Synapse!). new_column is read by Synapse and written to by Synapse. Moreover, all rows have a non- NULL value in this field, as guaranteed by a schema constraint. Notes: We can’t drop old_column yet, or even stop writing to it, because that would break a rollback to the previous version of Synapse. Application code can now rely on new_column being populated. The remaining steps are only motivated by the wish to clean-up old columns. Synapse version N + 4 SCHEMA_VERSION = S + 4\\nSCHEMA_COMPAT_VERSION = S + 3 # we can\'t roll back to a time before new_column was entirely non-NULL Invariants: old_column exists but is not written to or read from by Synapse. new_column is read by Synapse and written to by Synapse. Moreover, all rows have a non- NULL value in this field, as guaranteed by a schema constraint. Notes: We can’t drop old_column yet because that would break a rollback to the previous version of Synapse. TODO: It may be possible to relax this and drop the column straight away as long as the previous version of Synapse detected a rollback occurred and stopped attempting to write to the column. This could possibly be done by checking whether the database’s schema compatibility version was S + 3. Synapse version N + 5 SCHEMA_VERSION = S + 5\\nSCHEMA_COMPAT_VERSION = S + 4 # we can\'t roll back to a time before old_column was no longer being touched Changes:\\n1. ALTER TABLE mytable DROP COLUMN old_column;","breadcrumbs":"Database Schemas » Transforming a column into another one, with NOT NULL constraints","id":"1041","title":"Transforming a column into another one, with NOT NULL constraints"},"1042":{"body":"It can be desirable to implement “experimental” features which are disabled by\\ndefault and must be explicitly enabled via the Synapse configuration. This is\\napplicable for features which: Are unstable in the Matrix spec (e.g. those defined by an MSC that has not yet been merged). Developers are not confident in their use by general Synapse administrators/users\\n(e.g. a feature is incomplete, buggy, performs poorly, or needs further testing). Note that this only really applies to features which are expected to be desirable\\nto a broad audience. The module infrastructure should\\ninstead be investigated for non-standard features. Guarding experimental features behind configuration flags should help with some\\nof the following scenarios: Ensure that clients do not assume that unstable features exist (failing\\ngracefully if they do not). Unstable features do not become de-facto standards and can be removed\\naggressively (since only those who have opted-in will be affected). Ease finding the implementation of unstable features in Synapse (for future\\nremoval or stabilization). Ease testing a feature (or removal of feature) due to enabling/disabling without\\ncode changes. It also becomes possible to ask for wider testing, if desired. Experimental configuration flags should be disabled by default (requiring Synapse\\nadministrators to explicitly opt-in), although there are situations where it makes\\nsense (from a product point-of-view) to enable features by default. This is\\nexpected and not an issue. It is not a requirement for experimental features to be behind a configuration flag,\\nbut one should be used if unsure. New experimental configuration flags should be added under the experimental_features\\nconfiguration key (see the synapse.config.experimental file) and either explain\\n(briefly) what is being enabled, or include the MSC number.\\nThe configuration flag should link to the tracking issue for the experimental feature (see below).","breadcrumbs":"Experimental features » Implementing experimental features in Synapse","id":"1042","title":"Implementing experimental features in Synapse"},"1043":{"body":"In the interest of having some documentation around experimental features, without\\npolluting the stable documentation, all new experimental features should have a tracking issue with the T-ExperimentalFeature label,\\nkept open as long as the experimental feature is present in Synapse. The configuration option for the feature should have a comment linking to the tracking issue,\\nfor ease of discoverability. As a guideline, the issue should contain: Context for why this experimental feature is in Synapse This could well be a link to somewhere else, where this context is already available. If applicable, why the feature is enabled by default. (Why do we need to enable it by default and why is it safe?) If applicable, setup instructions for any non-standard components or configuration needed by the feature.\\n(Ideally this will be moved to the configuration manual after stabilisation.) Design decisions behind the Synapse implementation.\\n(Ideally this will be moved to the developers’ documentation after stabilisation.) Any caveats around the current implementation of the feature, such as: missing aspects breakage or incompatibility that is expected if/when the feature is stabilised,\\nor when the feature is turned on/off Criteria for how we know whether we can remove the feature in the future.","breadcrumbs":"Experimental features » Tracking issues for experimental features","id":"1043","title":"Tracking issues for experimental features"},"1044":{"body":"This is a quick cheat sheet for developers on how to use poetry.","breadcrumbs":"Dependency management » Managing dependencies with Poetry","id":"1044","title":"Managing dependencies with Poetry"},"1045":{"body":"See the contributing guide. Developers should use Poetry 2.2.0 or higher. If you encounter problems related\\nto poetry, please double-check your poetry version.","breadcrumbs":"Dependency management » Installing","id":"1045","title":"Installing"},"1046":{"body":"Synapse uses a variety of third-party Python packages to function as a homeserver.\\nSome of these are direct dependencies, listed in pyproject.toml under the [tool.poetry.dependencies] section. The rest are transitive dependencies (the\\nthings that our direct dependencies themselves depend on, and so on recursively.) We maintain a locked list of all our dependencies (transitive included) so that\\nwe can track exactly which version of each dependency appears in a given release.\\nSee here\\nfor discussion of why we wanted this for Synapse. We chose to use poetry to manage this locked list; see this comment\\nfor the reasoning. The locked dependencies get included in our “self-contained” releases: namely,\\nour docker images and our debian packages. We also use the locked dependencies\\nin development and our continuous integration. Separately, our “broad” dependencies—the version ranges specified in pyproject.toml—are included as metadata in our “sdists” and “wheels” uploaded\\nto PyPI. Installing from PyPI or from\\nthe Synapse source tree directly will not use the locked dependencies; instead,\\nthey’ll pull in the latest version of each package available at install time.","breadcrumbs":"Dependency management » Background","id":"1046","title":"Background"},"1047":{"body":"An example may help. We have a broad dependency on phonenumbers, as declared in\\nthis snippet from pyproject.toml as of Synapse 1.57: [tool.poetry.dependencies]\\n# ...\\nphonenumbers = \\">=8.2.0\\" In our lockfile this is pinned\\nto version 8.12.44, even though newer versions are available. [[package]]\\nname = \\"phonenumbers\\"\\nversion = \\"8.12.44\\"\\ndescription = \\"Python version of Google\'s common library for parsing, formatting, storing and validating international phone numbers.\\"\\ncategory = \\"main\\"\\noptional = false\\npython-versions = \\"*\\" The lockfile also includes a cryptographic checksum\\nof the sdists and wheels provided for this version of phonenumbers. [metadata.files]\\n# ...\\nphonenumbers = [ {file = \\"phonenumbers-8.12.44-py2.py3-none-any.whl\\", hash = \\"sha256:cc1299cf37b309ecab6214297663ab86cb3d64ae37fd5b88e904fe7983a874a6\\"}, {file = \\"phonenumbers-8.12.44.tar.gz\\", hash = \\"sha256:26cfd0257d1704fe2f88caff2caabb70d16a877b1e65b6aae51f9fbbe10aa8ce\\"},\\n] We can see this pinned version inside the docker image for that release: $ docker pull matrixdotorg/synapse:latest\\n...\\n$ docker run --entrypoint pip matrixdotorg/synapse:latest show phonenumbers\\nName: phonenumbers\\nVersion: 9.0.15\\nSummary: Python version of Google\'s common library for parsing, formatting, storing and validating international phone numbers.\\nHome-page: https://github.com/daviddrysdale/python-phonenumbers\\nAuthor: David Drysdale\\nAuthor-email: dmd@lurklurk.org\\nLicense: Apache License 2.0\\nLocation: /usr/local/lib/python3.12/site-packages\\nRequires:\\nRequired-by: matrix-synapse Whereas the wheel metadata just contains the broad dependencies: $ cd /tmp\\n$ wget https://files.pythonhosted.org/packages/ca/5e/d722d572cc5b3092402b783d6b7185901b444427633bd8a6b00ea0dd41b7/matrix_synapse-1.57.0rc1-py3-none-any.whl\\n...\\n$ unzip -c matrix_synapse-1.57.0rc1-py3-none-any.whl matrix_synapse-1.57.0rc1.dist-info/METADATA | grep phonenumbers\\nRequires-Dist: phonenumbers (>=8.2.0)","breadcrumbs":"Dependency management » Example dependency","id":"1047","title":"Example dependency"},"1048":{"body":"direnv is a tool for activating environments in your\\nshell inside a given directory. Its support for poetry is unofficial (a\\ncommunity wiki recipe only), but works solidly in our experience. We thoroughly\\nrecommend it for daily use. To use it: Install direnv - it’s likely\\npackaged for your system already. Teach direnv about poetry. The shell config here\\nneeds to be added to ~/.config/direnv/direnvrc (or more generally $XDG_CONFIG_HOME/direnv/direnvrc). Mark the synapse checkout as a poetry project: echo layout poetry > .envrc. Convince yourself that you trust this .envrc configuration and project.\\nThen formally confirm this to direnv by running direnv allow. Then whenever you navigate to the synapse checkout, you should be able to run\\ne.g. mypy instead of poetry run mypy; python instead of poetry run python; and your shell commands will automatically run in the\\ncontext of poetry’s venv, without having to run poetry shell beforehand.","breadcrumbs":"Dependency management » Tooling recommendation: direnv","id":"1048","title":"Tooling recommendation: direnv"},"1049":{"body":"","breadcrumbs":"Dependency management » How do I…","id":"1049","title":"How do I…"},"105":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.141.0","id":"105","title":"Upgrading to v1.141.0"},"1050":{"body":"poetry install --all-extras --sync","breadcrumbs":"Dependency management » …reset my venv to the locked environment?","id":"1050","title":"…reset my venv to the locked environment?"},"1051":{"body":"# Stop the current virtualenv if active\\n$ deactivate # Remove all of the files from the current environment.\\n# Don\'t worry, even though it says \\"all\\", this will only\\n# remove the Poetry virtualenvs for the current project.\\n$ poetry env remove --all # Reactivate Poetry shell to create the virtualenv again\\n$ poetry shell\\n# Install everything again\\n$ poetry install --extras all If you want to go even further and remove the Poetry caches: # Find your Poetry cache directory\\n# Docs: https://github.com/python-poetry/poetry/blob/main/docs/configuration.md#cache-directory\\n$ poetry config cache-dir # Remove packages from all cached repositories\\n$ poetry cache clear --all . # Go completely nuclear and clear out everything Poetry cache related\\n# including the wheel artifacts which is not covered by the above command\\n# (see https://github.com/python-poetry/poetry/issues/10304)\\n#\\n# This is necessary in order to rebuild or fetch new wheels.\\n$ rm -rf $(poetry config cache-dir)","breadcrumbs":"Dependency management » …delete everything and start over from scratch?","id":"1051","title":"…delete everything and start over from scratch?"},"1052":{"body":"Use poetry run cmd args when you need the python virtualenv context.\\nTo avoid typing poetry run all the time, you can run poetry shell\\nto start a new shell in the poetry virtualenv context. Within poetry shell, python, pip, mypy, trial, etc. are all run inside the project virtualenv\\nand isolated from the rest o the system. Roughly speaking, the translation from a traditional virtualenv is: env/bin/activate -> poetry shell, and deactivate -> close the terminal (Ctrl-D, exit, etc.) See also the direnv recommendation above, which makes poetry run and poetry shell unnecessary.","breadcrumbs":"Dependency management » …run a command in the poetry virtualenv?","id":"1052","title":"…run a command in the poetry virtualenv?"},"1053":{"body":"Some suggestions: # Current env only\\npoetry env info\\n# All envs: this allows you to have e.g. a poetry managed venv for Python 3.7,\\n# and another for Python 3.10.\\npoetry env list --full-path\\npoetry run pip list Note that poetry show describes the abstract lock file rather than your\\non-disk environment. With that said, poetry show --tree can sometimes be\\nuseful.","breadcrumbs":"Dependency management » …inspect the poetry virtualenv?","id":"1053","title":"…inspect the poetry virtualenv?"},"1054":{"body":"Either: manually update pyproject.toml; then poetry lock; or else poetry add packagename. See poetry add --help; note the --dev, --extras and --optional flags in particular. Include the updated pyproject.toml and poetry.lock files in your commit.","breadcrumbs":"Dependency management » …add a new dependency?","id":"1054","title":"…add a new dependency?"},"1055":{"body":"This is not done often and is untested, but poetry remove packagename ought to do the trick. Alternatively, manually update pyproject.toml and poetry lock. Include the updated pyproject.toml and poetry.lock\\nfiles in your commit.","breadcrumbs":"Dependency management » …remove a dependency?","id":"1055","title":"…remove a dependency?"},"1056":{"body":"Best done by manually editing pyproject.toml, then poetry lock.\\nInclude the updated pyproject.toml and poetry.lock in your commit.","breadcrumbs":"Dependency management » …update the version range for an existing dependency?","id":"1056","title":"…update the version range for an existing dependency?"},"1057":{"body":"Use poetry update packagename to use the latest version of packagename in the locked environment, without\\naffecting the broad dependencies listed in the wheel. There doesn’t seem to be a way to do this whilst locking a specific version of packagename. We can workaround this (crudely) as follows: poetry add packagename==1.2.3\\n# This should update pyproject.lock. # Now undo the changes to pyproject.toml. For example\\n# git restore pyproject.toml # Get poetry to recompute the content-hash of pyproject.toml without changing\\n# the locked package versions.\\npoetry lock Either way, include the updated poetry.lock file in your commit.","breadcrumbs":"Dependency management » …update a dependency in the locked environment?","id":"1057","title":"…update a dependency in the locked environment?"},"1058":{"body":"poetry export --extras all Be wary of bugs in poetry export and pip install -r requirements.txt.","breadcrumbs":"Dependency management » …export a requirements.txt file?","id":"1058","title":"…export a requirements.txt file?"},"1059":{"body":"I usually use poetry run pip install build && poetry run python -m build because build is a standardish tool which\\ndoesn’t require poetry. (It’s what we use in CI too). However, you could try poetry build too.","breadcrumbs":"Dependency management » …build a test wheel?","id":"1059","title":"…build a test wheel?"},"106":{"body":"The Docker images are now based on Debian trixie and use Python 3.13. If you\\nare using the Docker images as a base image you may need to e.g. adjust the\\npaths you mount any additional Python packages at.","breadcrumbs":"Upgrading between Synapse Versions » Docker images now based on Debian trixie with Python 3.13","id":"106","title":"Docker images now based on Debian trixie with Python 3.13"},"1060":{"body":"Synapse uses Dependabot to keep the poetry.lock and Cargo.lock file\\nup-to-date with the latest releases of our dependencies. The changelog check is\\nomitted for Dependabot PRs; the release script will include them in the\\nchangelog. When reviewing a dependabot PR, ensure that: the lockfile changes look reasonable; the upstream changelog file (linked in the description) doesn’t include any\\nbreaking changes; continuous integration passes. In particular, any updates to the type hints (usually packages which start with types-)\\nshould be safe to merge if linting passes.","breadcrumbs":"Dependency management » …handle a Dependabot pull request?","id":"1060","title":"…handle a Dependabot pull request?"},"1061":{"body":"","breadcrumbs":"Dependency management » Troubleshooting","id":"1061","title":"Troubleshooting"},"1062":{"body":"The minimum version of poetry supported by Synapse is 1.3.2. It can also be useful to check the version of poetry-core in use. If you’ve\\ninstalled poetry with pipx, try pipx runpip poetry list | grep poetry-core.","breadcrumbs":"Dependency management » Check the version of poetry with poetry --version.","id":"1062","title":"Check the version of poetry with poetry --version."},"1063":{"body":"Poetry caches a bunch of information about packages that isn’t readily available\\nfrom PyPI. (This is what makes poetry seem slow when doing the first poetry install.) Try poetry cache list and poetry cache clear --all to see if that fixes things.","breadcrumbs":"Dependency management » Clear caches: poetry cache clear --all pypi.","id":"1063","title":"Clear caches: poetry cache clear --all pypi."},"1064":{"body":"Delete the matrix_synapse.egg-info/ directory from the root of your Synapse\\ninstall. This stores some cached information about dependencies and often conflicts with\\nletting Poetry do the right thing.","breadcrumbs":"Dependency management » Remove outdated egg-info","id":"1064","title":"Remove outdated egg-info"},"1065":{"body":"Sometimes useful to see what poetry’s internal logic is.","breadcrumbs":"Dependency management » Try --verbose or --dry-run arguments.","id":"1065","title":"Try --verbose or --dry-run arguments."},"1066":{"body":"Sometimes, requests take a long time to service and clients disconnect\\nbefore Synapse produces a response. To avoid wasting resources, Synapse\\ncan cancel request processing for select endpoints marked with the @cancellable decorator. Synapse makes use of Twisted’s Deferred.cancel() feature to make\\ncancellation work. The @cancellable decorator does nothing by itself\\nand merely acts as a flag, signalling to developers and other code alike\\nthat a method can be cancelled.","breadcrumbs":"Synapse Architecture » Cancellation » Cancellation","id":"1066","title":"Cancellation"},"1067":{"body":"Check that the endpoint method, and any async functions in its call\\ntree handle cancellation correctly. See Handling cancellation correctly\\nfor a list of things to look out for. Add the @cancellable decorator to the on_GET/POST/PUT/DELETE\\nmethod. It’s not recommended to make non- GET methods cancellable,\\nsince cancellation midway through some database updates is less\\nlikely to be handled correctly.","breadcrumbs":"Synapse Architecture » Cancellation » Enabling cancellation for an endpoint","id":"1067","title":"Enabling cancellation for an endpoint"},"1068":{"body":"There are two stages to cancellation: downward propagation of a cancel() call, followed by upwards propagation of a CancelledError\\nout of a blocked await.\\nBoth Twisted and asyncio have a cancellation mechanism. Method Exception Exception inherits from Twisted Deferred.cancel() twisted.internet.defer.CancelledError Exception (!) asyncio Task.cancel() asyncio.CancelledError BaseException","breadcrumbs":"Synapse Architecture » Cancellation » Mechanics","id":"1068","title":"Mechanics"},"1069":{"body":"When Synapse starts handling a request, it runs the async method\\nresponsible for handling it using defer.ensureDeferred, which returns\\na Deferred. For example: def do_something() -> Deferred[None]: ... @cancellable\\nasync def on_GET() -> Tuple[int, JsonDict]: d = make_deferred_yieldable(do_something()) await d return 200, {} request = defer.ensureDeferred(on_GET()) When a client disconnects early, Synapse checks for the presence of the @cancellable decorator on on_GET. Since on_GET is cancellable, Deferred.cancel() is called on the Deferred from defer.ensureDeferred, ie. request. Twisted knows which Deferred request is waiting on and passes the cancel() call on to d. The Deferred being waited on, d, may have its own handling for cancel() and pass the call on to other Deferreds. Eventually, a Deferred handles the cancel() call by resolving itself\\nwith a CancelledError.","breadcrumbs":"Synapse Architecture » Cancellation » Deferred.cancel()","id":"1069","title":"Deferred.cancel()"},"107":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.140.0","id":"107","title":"Upgrading to v1.140.0"},"1070":{"body":"The CancelledError gets raised out of the await and bubbles up, as\\nper normal Python exception handling.","breadcrumbs":"Synapse Architecture » Cancellation » CancelledError","id":"1070","title":"CancelledError"},"1071":{"body":"In general, when writing code that might be subject to cancellation, two\\nthings must be considered: The effect of CancelledErrors raised out of awaits. The effect of Deferreds being cancel()ed. Examples of code that handles cancellation incorrectly include: try-except blocks which swallow CancelledErrors. Code that shares the same Deferred, which may be cancelled, between\\nmultiple requests. Code that starts some processing that’s exempt from cancellation, but\\nuses a logging context from cancellable code. The logging context\\nwill be finished upon cancellation, while the uncancelled processing\\nis still using it. Some common patterns are listed below in more detail.","breadcrumbs":"Synapse Architecture » Cancellation » Handling cancellation correctly","id":"1071","title":"Handling cancellation correctly"},"1072":{"body":"Most functions in Synapse are relatively straightforward from a\\ncancellation standpoint: they don’t do anything with Deferreds and\\npurely call and await other async functions. An async function handles cancellation correctly if its own code\\nhandles cancellation correctly and all the async function it calls\\nhandle cancellation correctly. For example: async def do_two_things() -> None: check_something() await do_something() await do_something_else() do_two_things handles cancellation correctly if do_something and do_something_else handle cancellation correctly. That is, when checking whether a function handles cancellation\\ncorrectly, its implementation and all its async function calls need to\\nbe checked, recursively. As check_something is not async, it does not need to be checked.","breadcrumbs":"Synapse Architecture » Cancellation » async function calls","id":"1072","title":"async function calls"},"1073":{"body":"Because Twisted’s CancelledErrors are Exceptions, it’s easy to\\naccidentally catch and suppress them. Care must be taken to ensure that CancelledErrors are allowed to propagate upwards. Bad: try: await do_something()\\nexcept Exception: # `CancelledError` gets swallowed here. logger.info(...) Good: try: await do_something()\\nexcept CancelledError: raise\\nexcept Exception: logger.info(...) OK: try: check_something() # A `CancelledError` won\'t ever be raised here.\\nexcept Exception: logger.info(...) Good: try: await do_something()\\nexcept ValueError: logger.info(...) defer.gatherResults defer.gatherResults produces a Deferred which: broadcasts cancel() calls to every Deferred being waited on. wraps the first exception it sees in a FirstError. Together, this means that CancelledErrors will be wrapped in\\na FirstError unless unwrapped. Such FirstErrors are liable to be\\nswallowed, so they must be unwrapped. Bad: async def do_something() -> None: await make_deferred_yieldable( defer.gatherResults([...], consumeErrors=True) ) try: await do_something()\\nexcept CancelledError: raise\\nexcept Exception: # `FirstError(CancelledError)` gets swallowed here. logger.info(...) Good: async def do_something() -> None: await make_deferred_yieldable( defer.gatherResults([...], consumeErrors=True) ).addErrback(unwrapFirstError) try: await do_something()\\nexcept CancelledError: raise\\nexcept Exception: logger.info(...)","breadcrumbs":"Synapse Architecture » Cancellation » CancelledErrors","id":"1073","title":"CancelledErrors"},"1074":{"body":"If a function creates a Deferred, the effect of cancelling it must be considered. Deferreds that get shared are likely to have unintended behaviour when cancelled. Bad: cache: Dict[str, Deferred[None]] = {} def wait_for_room(room_id: str) -> Deferred[None]: deferred = cache.get(room_id) if deferred is None: deferred = Deferred() cache[room_id] = deferred # `deferred` can have multiple waiters. # All of them will observe a `CancelledError` # if any one of them is cancelled. return make_deferred_yieldable(deferred) # Request 1\\nawait wait_for_room(\\"!aAAaaAaaaAAAaAaAA:matrix.org\\")\\n# Request 2\\nawait wait_for_room(\\"!aAAaaAaaaAAAaAaAA:matrix.org\\") Good: cache: Dict[str, Deferred[None]] = {} def wait_for_room(room_id: str) -> Deferred[None]: deferred = cache.get(room_id) if deferred is None: deferred = Deferred() cache[room_id] = deferred # `deferred` will never be cancelled now. # A `CancelledError` will still come out of # the `await`. # `delay_cancellation` may also be used. return make_deferred_yieldable(stop_cancellation(deferred)) # Request 1\\nawait wait_for_room(\\"!aAAaaAaaaAAAaAaAA:matrix.org\\")\\n# Request 2\\nawait wait_for_room(\\"!aAAaaAaaaAAAaAaAA:matrix.org\\") Good: cache: Dict[str, List[Deferred[None]]] = {} def wait_for_room(room_id: str) -> Deferred[None]: if room_id not in cache: cache[room_id] = [] # Each request gets its own `Deferred` to wait on. deferred = Deferred() cache[room_id]].append(deferred) return make_deferred_yieldable(deferred) # Request 1\\nawait wait_for_room(\\"!aAAaaAaaaAAAaAaAA:matrix.org\\")\\n# Request 2\\nawait wait_for_room(\\"!aAAaaAaaaAAAaAaAA:matrix.org\\")","breadcrumbs":"Synapse Architecture » Cancellation » Creation of Deferreds","id":"1074","title":"Creation of Deferreds"},"1075":{"body":"Some async functions may kick off some async processing which is\\nintentionally protected from cancellation, by stop_cancellation or\\nother means. If the async processing inherits the logcontext of the\\nrequest which initiated it, care must be taken to ensure that the\\nlogcontext is not finished before the async processing completes. Bad: cache: ObservableDeferred[None] | None = None async def do_something_else( to_resolve: Deferred[None]\\n) -> None: await ... logger.info(\\"done!\\") to_resolve.callback(None) async def do_something() -> None: if not cache: to_resolve = Deferred() cache = ObservableDeferred(to_resolve) # `do_something_else` will never be cancelled and # can outlive the `request-1` logging context. run_in_background(do_something_else, to_resolve) await make_deferred_yieldable(cache.observe()) with LoggingContext(\\"request-1\\"): await do_something() Good: cache: ObservableDeferred[None] | None = None async def do_something_else( to_resolve: Deferred[None]\\n) -> None: await ... logger.info(\\"done!\\") to_resolve.callback(None) async def do_something() -> None: if not cache: to_resolve = Deferred() cache = ObservableDeferred(to_resolve) run_in_background(do_something_else, to_resolve) # We\'ll wait until `do_something_else` is # done before raising a `CancelledError`. await make_deferred_yieldable( delay_cancellation(cache.observe()) ) else: await make_deferred_yieldable(cache.observe()) with LoggingContext(\\"request-1\\"): await do_something() OK: cache: ObservableDeferred[None] | None = None async def do_something_else( to_resolve: Deferred[None]\\n) -> None: await ... logger.info(\\"done!\\") to_resolve.callback(None) async def do_something() -> None: if not cache: to_resolve = Deferred() cache = ObservableDeferred(to_resolve) # `do_something_else` will get its own independent # logging context. `request-1` will not count any # metrics from `do_something_else`. run_as_background_process( \\"do_something_else\\", do_something_else, to_resolve, ) await make_deferred_yieldable(cache.observe()) with LoggingContext(\\"request-1\\"): await do_something()","breadcrumbs":"Synapse Architecture » Cancellation » Uncancelled processing","id":"1075","title":"Uncancelled processing"},"1076":{"body":"To help track the processing of individual requests, synapse uses a\\n‘ log context’ to track which request it is handling at any given\\nmoment. The “current” log context is stored in the Rust extension\\n( synapse.synapse_rust.logcontext), which resolves it from the current\\ntokio task (if we are running inside one) and otherwise from the current OS\\nthread; a logging.Filter is then used to fish the information back out and\\nadd it to each log record. Storing it in Rust means a single source of truth is\\nvisible from both Python (the reactor and its thread pool) and Rust (tokio\\ntasks), so log records emitted from either — including from Rust code polled on\\na worker thread — are attributed to the right request. See the Rust side below. Logcontexts are also used for CPU and database accounting, so that we\\ncan track which requests were responsible for high CPU use or database\\nactivity. The synapse.logging.context module provides facilities for managing\\nthe current log context (as well as providing the LoggingContextFilter\\nclass). Asynchronous functions make the whole thing complicated, so this document describes\\nhow it all works, and how to write code which follows the rules. In this document, “awaitable” refers to any object which can be awaited. In the context of\\nSynapse, that normally means either a coroutine or a Twisted Deferred.","breadcrumbs":"Synapse Architecture » Log Contexts » Log Contexts","id":"1076","title":"Log Contexts"},"1077":{"body":"In the absence of any asynchronous voodoo, things are simple enough. As with\\nany code of this nature, the rule is that our function should leave\\nthings as it found them: from synapse.logging import context # omitted from future snippets def handle_request(request_id): request_context = context.LoggingContext() calling_context = context.set_current_context(request_context) try: request_context.request = request_id do_request_handling() logger.debug(\\"finished\\") finally: context.set_current_context(calling_context) def do_request_handling(): logger.debug(\\"phew\\") # this will be logged against request_id LoggingContext implements the context management methods, so the above\\ncan be written much more succinctly as: def handle_request(request_id): with context.LoggingContext() as request_context: request_context.request = request_id do_request_handling() logger.debug(\\"finished\\") def do_request_handling(): logger.debug(\\"phew\\")","breadcrumbs":"Synapse Architecture » Log Contexts » Logcontexts without asynchronous code","id":"1077","title":"Logcontexts without asynchronous code"},"1078":{"body":"The default logcontext is synapse.logging.context.SENTINEL_CONTEXT, which is an empty\\nsentinel value to represent the root logcontext. This is what is used when there is no\\nother logcontext set. The phrase “clear/reset the logcontext” means to set the current\\nlogcontext to the sentinel logcontext. No CPU/database usage metrics are recorded against the sentinel logcontext. Ideally, nothing from the Synapse homeserver would be logged against the sentinel\\nlogcontext as we want to know which server the logs came from. In practice, this is not\\nalways the case yet especially outside of request handling. Global things outside of Synapse (e.g. Twisted reactor code) should run in the sentinel logcontext. It’s only when it calls into application code that a logcontext\\ngets activated. This means the reactor should be started in the sentinel logcontext,\\nand any time an awaitable yields control back to the reactor, it should reset the\\nlogcontext to be the sentinel logcontext. This is important to avoid leaking the\\ncurrent logcontext to the reactor (which would then get picked up and associated with\\nthe next thing the reactor does).","breadcrumbs":"Synapse Architecture » Log Contexts » The sentinel context","id":"1078","title":"The sentinel context"},"1079":{"body":"Awaitables break the linear flow of code so that there is no longer a single entry point\\nwhere we should set the logcontext and a single exit point where we should remove it. Consider the example above, where do_request_handling needs to do some\\nblocking operation, and returns an awaitable: async def handle_request(request_id): with context.LoggingContext() as request_context: request_context.request = request_id await do_request_handling() logger.debug(\\"finished\\") In the above flow: The logcontext is set do_request_handling is called, and returns an awaitable handle_request awaits the awaitable Execution of handle_request is suspended So we have stopped processing the request (and will probably go on to\\nstart processing the next), without clearing the logcontext. To circumvent this problem, synapse code assumes that, wherever you have\\nan awaitable, you will want to await it. To that end, wherever\\nfunctions return awaitables, we adopt the following conventions: Rules for functions returning awaitables: If the awaitable is already complete, the function returns with the\\nsame logcontext it started with. If the awaitable is incomplete, the function clears the logcontext\\nbefore returning; when the awaitable completes, it restores the\\nlogcontext before running any callbacks. That sounds complicated, but actually it means a lot of code (including\\nthe example above) “just works”. There are two cases: If do_request_handling returns a completed awaitable, then the\\nlogcontext will still be in place. In this case, execution will\\ncontinue immediately after the await; the “finished” line will\\nbe logged against the right context, and the with block restores\\nthe original context before we return to the caller. If the returned awaitable is incomplete, do_request_handling clears\\nthe logcontext before returning. The logcontext is therefore clear\\nwhen handle_request awaits the awaitable. Once do_request_handling’s awaitable completes, it will reinstate\\nthe logcontext, before running the second half of handle_request,\\nso again the “finished” line will be logged against the right context,\\nand the with block restores the original context. As an aside, it’s worth noting that handle_request follows our rules though that only matters if the caller has its own logcontext which it\\ncares about. The following sections describe pitfalls and helpful patterns when\\nimplementing these rules.","breadcrumbs":"Synapse Architecture » Log Contexts » Using logcontexts with awaitables","id":"1079","title":"Using logcontexts with awaitables"},"108":{"body":"Deployments that make use of the synapse-s3-storage-provider\\nmodule must update it to v1.6.0,\\notherwise users will be unable to upload or download media.","breadcrumbs":"Upgrading between Synapse Versions » Users of synapse-s3-storage-provider must update the module to v1.6.0","id":"108","title":"Users of synapse-s3-storage-provider must update the module to v1.6.0"},"1080":{"body":"Whenever you get an awaitable back from a function, you should await on\\nit as soon as possible. Do not pass go; do not do any logging; do not\\ncall any other functions. async def fun(): logger.debug(\\"starting\\") await do_some_stuff() # just like this coro = more_stuff() result = await coro # also fine, of course return result Provided this pattern is followed all the way back up to the callchain\\nto where the logcontext was set, this will make things work out ok:\\nprovided do_some_stuff and more_stuff follow the rules above, then\\nso will fun. It’s all too easy to forget to await: for instance if we forgot that do_some_stuff returned an awaitable, we might plough on regardless. This\\nleads to a mess; it will probably work itself out eventually, but not\\nbefore a load of stuff has been logged against the wrong context.\\n(Normally, other things will break, more obviously, if you forget to await, so this tends not to be a major problem in practice.) Of course sometimes you need to do something a bit fancier with your\\nawaitable - not all code follows the linear A-then-B-then-C pattern.\\nNotes on implementing more complex patterns are in later sections.","breadcrumbs":"Synapse Architecture » Log Contexts » Always await your awaitables","id":"1080","title":"Always await your awaitables"},"1081":{"body":"Most of the time, an awaitable comes from another synapse function.\\nSometimes, though, we need to make up a new awaitable, or we get an awaitable\\nback from external code. We need to make it follow our rules. The easy way to do it is by using context.make_deferred_yieldable. Suppose we want to implement sleep, which returns a deferred which will run its callbacks after a\\ngiven number of seconds. That might look like: # not a logcontext-rules-compliant function\\ndef get_sleep_deferred(seconds): d = defer.Deferred() reactor.callLater(seconds, d.callback, None) return d That doesn’t follow the rules, but we can fix it by calling it through context.make_deferred_yieldable: async def sleep(seconds): return await context.make_deferred_yieldable(get_sleep_deferred(seconds))","breadcrumbs":"Synapse Architecture » Log Contexts » Where you create a new awaitable, make it follow the rules","id":"1081","title":"Where you create a new awaitable, make it follow the rules"},"1082":{"body":"When a deferred callback is called, it inherits the current logcontext. The deferred\\ncallback chain can resume a coroutine, which if following our logcontext rules, will\\nrestore its own logcontext, then run: until it yields control back to the reactor, setting the sentinel logcontext or until it finishes, restoring the logcontext it was started with (calling context) This behavior creates two specific issues: Issue 1: The first issue is that the callback may have reset the logcontext to the\\nsentinel before returning. This means our calling function will continue with the\\nsentinel logcontext instead of the logcontext it was started with (bad). Issue 2: The second issue is that the current logcontext that called the deferred\\ncallback could finish before the callback finishes (bad). In the following example, the deferred callback is called with the “main” logcontext and\\nruns until we yield control back to the reactor in the await inside clock.sleep(0).\\nSince clock.sleep(0) follows our logcontext rules, it sets the logcontext to the\\nsentinel before yielding control back to the reactor. Our main function continues with\\nthe sentinel logcontext (first bad thing) instead of the “main” logcontext. Then the with LoggingContext(\\"main\\") block exits, finishing the “main” logcontext and yielding\\ncontrol back to the reactor again. Finally, later on when clock.sleep(0) completes,\\nour with LoggingContext(\\"competing\\") block exits, and restores the previous “main”\\nlogcontext which has already finished, resulting in WARNING: Re-starting finished log context main and leaking the main logcontext into the reactor which will then\\nerronously be associated with the next task the reactor picks up. async def competing_callback(): # Since this is run with the \\"main\\" logcontext, when the \\"competing\\" # logcontext exits, it will restore the previous \\"main\\" logcontext which has # already finished and results in \\"WARNING: Re-starting finished log context main\\" # and leaking the `main` logcontext into the reactor. with LoggingContext(\\"competing\\"): await clock.sleep(0) def main(): with LoggingContext(\\"main\\"): d = defer.Deferred() d.addCallback(lambda _: defer.ensureDeferred(competing_callback())) # Call the callback within the \\"main\\" logcontext. d.callback(None) # Bad: This will be logged against sentinel logcontext logger.debug(\\"ugh\\") main() Solution 1: We could of course fix this by following the general rule of “always\\nawait your awaitables”: async def main(): with LoggingContext(\\"main\\"): d = defer.Deferred() d.addCallback(lambda _: defer.ensureDeferred(competing_callback())) d.callback(None) # Wait for `d` to finish before continuing so the \\"main\\" logcontext is # still active. This works because `d` already follows our logcontext # rules. If not, we would also have to use `make_deferred_yieldable(d)`. await d # Good: This will be logged against the \\"main\\" logcontext logger.debug(\\"phew\\") Solution 2: We could also fix this by surrounding the call to d.callback with a PreserveLoggingContext, which will reset the logcontext to the sentinel before calling\\nthe callback, and restore the “main” logcontext afterwards before continuing the main\\nfunction. This solves the problem because when the “competing” logcontext exits, it will\\nrestore the sentinel logcontext which is never finished by its nature, so there is no\\nwarning and no leakage into the reactor. async def main(): with LoggingContext(\\"main\\"): d = defer.Deferred() d.addCallback(lambda _: defer.ensureDeferred(competing_callback())) d.callback(None) with PreserveLoggingContext(): # Call the callback with the sentinel logcontext. d.callback(None) # Good: This will be logged against the \\"main\\" logcontext logger.debug(\\"phew\\") Solution 3: But let’s say you do want to run (fire-and-forget) the deferred\\ncallback in the current context without running into issues: We can solve the first issue by using run_in_background(...) to run the callback in\\nthe current logcontext and it handles the magic behind the scenes of a) restoring the\\ncalling logcontext before returning to the caller and b) resetting the logcontext to the\\nsentinel after the deferred completes and we yield control back to the reactor to avoid\\nleaking the logcontext into the reactor. To solve the second issue, we can extend the lifetime of the “main” logcontext by\\navoiding the LoggingContext’s context manager lifetime methods\\n( __enter__/ __exit__). We can still set “main” as the current logcontext by using PreserveLoggingContext and passing in the “main” logcontext. async def main(): main_context = LoggingContext(\\"main\\") with PreserveLoggingContext(main_context): d = defer.Deferred() d.addCallback(lambda _: defer.ensureDeferred(competing_callback())) # The whole lambda will be run in the \\"main\\" logcontext. But we\'re using # a trick to return the deferred `d` itself so that `run_in_background` # will wait on that to complete and reset the logcontext to the sentinel # when it does to avoid leaking the \\"main\\" logcontext into the reactor. run_in_background(lambda: (d.callback(None), d)[1]) # Good: This will be logged against the \\"main\\" logcontext logger.debug(\\"phew\\") ... # Wherever possible, it\'s best to finish the logcontext by calling `__exit__` at some\\n# point. This allows us to catch bugs if we later try to erroneously restart a finished\\n# logcontext.\\n#\\n# Since the \\"main\\" logcontext stores the `LoggingContext.previous_context` when it is\\n# created, we can wrap this call in `PreserveLoggingContext()` to restore the correct\\n# previous logcontext. Our goal is to have the calling context remain unchanged after\\n# finishing the \\"main\\" logcontext.\\nwith PreserveLoggingContext(): # Finish the \\"main\\" logcontext with main_context: # Empty block - We\'re just trying to call `__exit__` on the \\"main\\" context # manager to finish it. We can\'t call `__exit__` directly as the code expects us # to `__enter__` before calling `__exit__` to `start`/`stop` things # appropriately. And in any case, it\'s probably best not to call the internal # methods directly. pass The same thing applies if you have some deferreds stored somewhere which you want to\\ncallback in the current logcontext.","breadcrumbs":"Synapse Architecture » Log Contexts » Deferred callbacks","id":"1082","title":"Deferred callbacks"},"1083":{"body":"The same care should be taken when calling errbacks on deferreds. An errback and\\ncallback act the same in this regard (see section above). d = defer.Deferred()\\nd.addErrback(some_other_function)\\nd.errback(failure) Additionally, cancellation is the same as directly calling the errback with a twisted.internet.defer.CancelledError: d = defer.Deferred()\\nd.addErrback(some_other_function)\\nd.cancel()","breadcrumbs":"Synapse Architecture » Log Contexts » Deferred errbacks and cancellations","id":"1083","title":"Deferred errbacks and cancellations"},"1084":{"body":"Sometimes you want to fire off a chain of execution, but not wait for\\nits result. That might look a bit like this: async def do_request_handling(): await foreground_operation() # *don\'t* do this background_operation() logger.debug(\\"Request handling complete\\") async def background_operation(): await first_background_step() logger.debug(\\"Completed first step\\") await second_background_step() logger.debug(\\"Completed second step\\") The above code does a couple of steps in the background after do_request_handling has finished. The log lines are still logged\\nagainst the request_context logcontext, which may or may not be\\ndesirable. There are two big problems with the above, however. The first\\nproblem is that, if background_operation returns an incomplete\\nawaitable, it will expect its caller to await immediately, so will have\\ncleared the logcontext. In this example, that means that ‘Request\\nhandling complete’ will be logged without any context. The second problem, which is potentially even worse, is that when the\\nawaitable returned by background_operation completes, it will restore\\nthe original logcontext. There is nothing waiting on that awaitable, so\\nthe logcontext will leak into the reactor and possibly get attached to\\nsome arbitrary future operation. There are two potential solutions to this. One option is to surround the call to background_operation with a PreserveLoggingContext call. That will reset the logcontext before\\nstarting background_operation (so the context restored when the\\ndeferred completes will be the empty logcontext), and will restore the\\ncurrent logcontext before continuing the foreground process: async def do_request_handling(): await foreground_operation() # start background_operation off in the empty logcontext, to # avoid leaking the current context into the reactor. with PreserveLoggingContext(): background_operation() # this will now be logged against the request context logger.debug(\\"Request handling complete\\") Obviously that option means that the operations done in background_operation would be not be logged against a logcontext\\n(though that might be fixed by setting a different logcontext via a with LoggingContext(...) in background_operation). The second option is to use context.run_in_background, which wraps a\\nfunction so that it doesn’t reset the logcontext even when it returns\\nan incomplete awaitable, and adds a callback to the returned awaitable to\\nreset the logcontext. In other words, it turns a function that follows\\nthe Synapse rules about logcontexts and awaitables into one which behaves\\nmore like an external function — the opposite operation to that\\ndescribed in the previous section. It can be used like this: async def do_request_handling(): await foreground_operation() context.run_in_background(background_operation) # this will now be logged against the request context logger.debug(\\"Request handling complete\\")","breadcrumbs":"Synapse Architecture » Log Contexts » Fire-and-forget","id":"1084","title":"Fire-and-forget"},"1085":{"body":"A typical example of this is where we want to collect together two or\\nmore awaitables via defer.gatherResults: a1 = operation1()\\na2 = operation2()\\na3 = defer.gatherResults([a1, a2]) This is really a variation of the fire-and-forget problem above, in that\\nwe are firing off a1 and a2 without awaiting on them. The difference\\nis that we now have third-party code attached to their callbacks. Anyway\\neither technique given in the Fire-and-forget\\nsection will work. Of course, the new awaitable returned by gather needs to be\\nwrapped in order to make it follow the logcontext rules before we can\\nyield it, as described in Where you create a new awaitable, make it\\nfollow the\\nrules. So, option one: reset the logcontext before starting the operations to\\nbe gathered: async def do_request_handling(): with PreserveLoggingContext(): a1 = operation1() a2 = operation2() result = await defer.gatherResults([a1, a2]) In this case particularly, though, option two, of using context.run_in_background almost certainly makes more sense, so that operation1 and operation2 are both logged against the original\\nlogcontext. This looks like: async def do_request_handling(): a1 = context.run_in_background(operation1) a2 = context.run_in_background(operation2) result = await make_deferred_yieldable(defer.gatherResults([a1, a2]))","breadcrumbs":"Synapse Architecture » Log Contexts » Passing synapse deferreds into third-party functions","id":"1085","title":"Passing synapse deferreds into third-party functions"},"1086":{"body":"It turns out that our logcontext rules do not play nicely with awaitable\\nchains which get orphaned and garbage-collected. Imagine we have some code that looks like this: listener_queue = [] def on_something_interesting(): for d in listener_queue: d.callback(\\"foo\\") async def await_something_interesting(): new_awaitable = defer.Deferred() listener_queue.append(new_awaitable) with PreserveLoggingContext(): await new_awaitable Obviously, the idea here is that we have a bunch of things which are\\nwaiting for an event. (It’s just an example of the problem here, but a\\nrelatively common one.) Now let’s imagine two further things happen. First of all, whatever was\\nwaiting for the interesting thing goes away. (Perhaps the request times\\nout, or something even more interesting happens.) Secondly, let’s suppose that we decide that the interesting thing is\\nnever going to happen, and we reset the listener queue: def reset_listener_queue(): listener_queue.clear() So, both ends of the awaitable chain have now dropped their references,\\nand the awaitable chain is now orphaned, and will be garbage-collected at\\nsome point. Note that await_something_interesting is a coroutine,\\nwhich Python implements as a generator function. When Python\\ngarbage-collects generator functions, it gives them a chance to\\nclean up by making the await (or yield) raise a GeneratorExit\\nexception. In our case, that means that the __exit__ handler of PreserveLoggingContext will carefully restore the request context, but\\nthere is now nothing waiting for its return, so the request context is\\nnever cleared. To reiterate, this problem only arises when both ends of a awaitable\\nchain are dropped. Dropping the the reference to an awaitable you’re\\nsupposed to be awaiting is bad practice, so this doesn’t\\nactually happen too much. Unfortunately, when it does happen, it will\\nlead to leaked logcontexts which are incredibly hard to track down.","breadcrumbs":"Synapse Architecture » Log Contexts » A note on garbage-collection of awaitable chains","id":"1086","title":"A note on garbage-collection of awaitable chains"},"1087":{"body":"The “current” logcontext is stored in the Rust extension rather than in a\\nPython thread-local, so that it is visible from both Python and Rust. current_context() and set_current_context() are imported from synapse.logging.context as usual — the Rust storage is an implementation\\ndetail that Python code does not need to care about. set_current_context only ever runs on a Python thread, i.e. the reactor or one\\nof its thread pools, where it does the getrusage CPU accounting. It is never\\ncalled from a tokio worker thread. Therefore, CPU accounting is not captured\\nwhen executing purely Rust work. What Rust code does need to be aware of is that when spawning a future onto\\nthe tokio runtime, the current logcontext must be captured and carried along, so\\nthat log records emitted while the future is polled (including any log::\\nrecords from dependencies, and any Python invoked back from Rust) are attributed\\ncorrectly. Don’t use a bare tokio::spawn. Instead use LogContextHandle::capture(py) plus LogContextHandle::scope, which capture\\nthe caller’s logcontext from the Python side and record it on the spawned task;\\nthis is what create_deferred does. current_context() returns the task’s\\ncaptured context first, so LoggingContextFilter — and therefore pyo3-log —\\nsees the right context on worker threads without any per-log-record work.","breadcrumbs":"Synapse Architecture » Log Contexts » The Rust side","id":"1087","title":"The Rust side"},"1088":{"body":"Debugging logcontext issues can be tricky as leaking or losing a logcontext will surface\\ndownstream and can point to an unrelated part of the codebase. It’s best to enable debug\\nlogging for synapse.logging.context.debug (needs to be explicitly configured) and go\\nbackwards in the logs from the point where the issue is observed to find the root cause. log.config.yaml loggers: # Unlike other loggers, this one needs to be explicitly configured to see debug logs. synapse.logging.context.debug: level: DEBUG Note that some of these traces ( LoggingContext(...).__enter__/ __exit__) are\\nemitted from Rust via pyo3-log, which caches logger levels for performance.\\nConfiguring the logger in the logging config (as above) works — the cache is\\nflushed whenever the config is (re)loaded, including on SIGHUP — but enabling\\nthe logger at runtime (e.g. setLevel(logging.DEBUG) from the manhole) will\\nnot surface the Rust-emitted traces until you also flush the cache: import logging\\nfrom synapse.synapse_rust import reset_logging_config logging.getLogger(\\"synapse.logging.context.debug\\").setLevel(logging.DEBUG)\\nreset_logging_config()","breadcrumbs":"Synapse Architecture » Log Contexts » Debugging logcontext issues","id":"1088","title":"Debugging logcontext issues"},"1089":{"body":"","breadcrumbs":"Synapse Architecture » Replication » Replication Architecture","id":"1089","title":"Replication Architecture"},"109":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.139.0","id":"109","title":"Upgrading to v1.139.0"},"1090":{"body":"We’d like to be able to split some of the work that synapse does into\\nmultiple python processes. In theory multiple synapse processes could\\nshare a single postgresql database and we\'d scale up by running more\\nsynapse processes. However much of synapse assumes that only one process\\nis interacting with the database, both for assigning unique identifiers\\nwhen inserting into tables, notifying components about new updates, and\\nfor invalidating its caches. So running multiple copies of the current code isn’t an option. One way\\nto run multiple processes would be to have a single writer process and\\nmultiple reader processes connected to the same database. In order to do\\nthis we’d need a way for the reader process to invalidate its in-memory\\ncaches when an update happens on the writer. One way to do this is for\\nthe writer to present an append-only log of updates which the readers\\ncan consume to invalidate their caches and to push updates to listening\\nclients or pushers. Synapse already stores much of its data as an append-only log so that it\\ncan correctly respond to /sync requests so the amount of code changes\\nneeded to expose the append-only log to the readers should be fairly\\nminimal.","breadcrumbs":"Synapse Architecture » Replication » Motivation","id":"1090","title":"Motivation"},"1091":{"body":"","breadcrumbs":"Synapse Architecture » Replication » Architecture","id":"1091","title":"Architecture"},"1092":{"body":"See the TCP replication documentation.","breadcrumbs":"Synapse Architecture » Replication » The Replication Protocol","id":"1092","title":"The Replication Protocol"},"1093":{"body":"Information about how the tcp replication module is structured, including how\\nthe classes interact, can be found in synapse/replication/tcp/__init__.py","breadcrumbs":"Synapse Architecture » Replication » The TCP Replication Module","id":"1093","title":"The TCP Replication Module"},"1094":{"body":"Synapse has a concept of “streams”, which are roughly described in id_generators.py.\\nGenerally speaking, streams are a series of notifications that something in Synapse’s database has changed that the application might need to respond to.\\nFor example: The events stream reports new events (PDUs) that Synapse creates, or that Synapse accepts from another homeserver. The account data stream reports changes to users’ account data. The to-device stream reports when a device has a new to-device message. See synapse.replication.tcp.streams for the full list of streams. It is very helpful to understand the streams mechanism when working on any part of Synapse that needs to respond to changes—especially if those changes are made by different workers.\\nTo that end, let’s describe streams formally, paraphrasing from the docstring of AbstractStreamIdGenerator.","breadcrumbs":"Synapse Architecture » Streams » Streams","id":"1094","title":"Streams"},"1095":{"body":"A stream is an append-only log T1, T2, ..., Tn, ... of facts 1 which grows over time.\\nOnly “writers” can add facts to a stream, and there may be multiple writers. Each fact has an ID, called its “stream ID”.\\nReaders should only process facts in ascending stream ID order. Roughly speaking, each stream is backed by a database table.\\nIt should have a stream_id (or similar) bigint column holding stream IDs, plus additional columns as necessary to describe the fact.\\nTypically, a fact is expressed with a single row in its backing table. 2\\nWithin a stream, no two facts may have the same stream_id. Aside. Some additional notes on streams’ backing tables. Rich would like to ditch the backing tables. The backing tables may have other uses.\\n> For example, the events table serves backs the events stream, and is read when processing new events.\\n> But old rows are read from the table all the time, whenever Synapse needs to lookup some facts about an event. Rich suspects that sometimes the stream is backed by multiple tables, so the stream proper is the union of those tables. Stream writers can “reserve” a stream ID, and then later mark it as having being completed.\\nStream writers need to track the completion of each stream fact.\\nIn the happy case, completion means a fact has been written to the stream table.\\nBut unhappy cases (e.g. transaction rollback due to an error) also count as completion.\\nOnce completed, the rows written with that stream ID are fixed, and no new rows\\nwill be inserted with that ID.","breadcrumbs":"Synapse Architecture » Streams » Definition","id":"1095","title":"Definition"},"1096":{"body":"For any given stream reader (including writers themselves), we may define a per-writer current stream ID: A current stream ID for a writer W is the largest stream ID such that\\nall transactions added by W with equal or smaller ID have completed. Similarly, there is a “linear” notion of current stream ID: A “linear” current stream ID is the largest stream ID such that\\nall facts (added by any writer) with equal or smaller ID have completed. Because different stream readers A and B learn about new facts at different times, A and B may disagree about current stream IDs.\\nPut differently: we should think of stream readers as being independent of each other, proceeding through a stream of facts at different rates. The above definition does not give a unique current stream ID, in fact there can\\nbe a range of current stream IDs. Synapse uses both the minimum and maximum IDs\\nfor different purposes. Most often the maximum is used, as its generally\\nbeneficial for workers to advance their IDs as soon as possible. However, the\\nminimum is used in situations where e.g. another worker is going to wait until\\nthe stream advances past a position. NB. For both senses of “current”, that if a writer opens a transaction that never completes, the current stream ID will never advance beyond that writer’s last written stream ID. For single-writer streams, the per-writer current ID and the linear current ID are the same.\\nBoth senses of current ID are monotonic, but they may “skip” or jump over IDs because facts complete out of order. Example.\\nConsider a single-writer stream which is initially at ID 1. Action Current stream ID Notes 1 Reserve 2 1 Reserve 3 1 Complete 3 1 current ID unchanged, waiting for 2 to complete Complete 2 3 current ID jumps from 1 -> 3 Reserve 4 3 Reserve 5 3 Reserve 6 3 Complete 5 3 Complete 4 5 current ID jumps 3->5, even though 6 is pending Complete 6 6","breadcrumbs":"Synapse Architecture » Streams » Current stream ID","id":"1096","title":"Current stream ID"},"1097":{"body":"There are two ways to view a multi-writer stream. Treat it as a collection of distinct single-writer streams, one\\nfor each writer. Treat it as a single stream. The single stream (option 2) is conceptually simpler, and easier to represent (a single stream id).\\nHowever, it requires each reader to know about the entire set of writers, to ensures that readers don’t erroneously advance their current stream position too early and miss a fact from an unknown writer.\\nIn contrast, multiple parallel streams (option 1) are more complex, requiring more state to represent (map from writer to stream id).\\nThe payoff for doing so is that readers can “peek” ahead to facts that completed on one writer no matter the state of the others, reducing latency. Note that a multi-writer stream can be viewed in both ways.\\nFor example, the events stream is treated as multiple single-writer streams (option 1) by the sync handler, so that events are sent to clients as soon as possible.\\nBut the background process that works through events treats them as a single linear stream. Another useful example is the cache invalidation stream.\\nThe facts this stream holds are instructions to “you should now invalidate these cache entries”.\\nWe only ever treat this as a multiple single-writer streams as there is no important ordering between cache invalidations.\\n(Invalidations are self-contained facts; and the invalidations commute/are idempotent).","breadcrumbs":"Synapse Architecture » Streams » Multi-writer streams","id":"1097","title":"Multi-writer streams"},"1098":{"body":"Writers need to track: track their current position (i.e. its own per-writer stream ID). their facts currently awaiting completion. At startup, the current position of that writer can be found by querying the database (which suggests that facts need to be written to the database atomically, in a transaction); and there are no facts awaiting completion. To reserve a stream ID, call nextval on the appropriate postgres sequence. To write a fact to the stream: insert the appropriate rows to the appropriate backing table. To complete a fact, first remove it from your map of facts currently awaiting completion.\\nThen, if no earlier fact is awaiting completion, the writer can advance its current position in that stream.\\nUpon doing so it should emit an RDATA message 3, once for every fact between the old and the new stream ID.","breadcrumbs":"Synapse Architecture » Streams » Writing to streams","id":"1098","title":"Writing to streams"},"1099":{"body":"Readers need to track the current position of every writer. At startup, they can find this by contacting each writer with a REPLICATE message,\\nrequesting that all writers reply describing their current position in their streams.\\nWriters reply with a POSITION message. To learn about new facts, readers should listen for RDATA messages and process them to respond to the new fact.\\nThe RDATA itself is not a self-contained representation of the fact;\\nreaders will have to query the stream tables for the full details.\\nReaders must also advance their record of the writer’s current position for that stream.","breadcrumbs":"Synapse Architecture » Streams » Subscribing to streams","id":"1099","title":"Subscribing to streams"},"11":{"body":"The default configuration exposes a single HTTP port on the local\\ninterface: http://localhost:8008. It is suitable for local testing,\\nbut for any practical use, you will need Synapse’s APIs to be served\\nover HTTPS. The recommended way to do so is to set up a reverse proxy on port 8448. You can find documentation on doing so in the reverse proxy documentation. Alternatively, you can configure Synapse to expose an HTTPS port. To do\\nso, you will need to edit homeserver.yaml, as follows: First, under the listeners option, add the configuration for the\\nTLS-enabled listener like so: listeners: - port: 8448 type: http tls: true resources: - names: [client, federation] You will also need to add the options tls_certificate_path and tls_private_key_path. to your configuration file. You will need to manage provisioning of\\nthese certificates yourself. You can find more information about these options as well as how to configure synapse in the configuration manual. If you are using your own certificate, be sure to use a .pem file that\\nincludes the full certificate chain including any intermediate certificates\\n(for instance, if using certbot, use fullchain.pem as your certificate, not cert.pem). For a more detailed guide to configuring your server for federation, see Federation.","breadcrumbs":"Installation » TLS certificates","id":"11","title":"TLS certificates"},"110":{"body":"Application Services that do not set inhibit_login=true when calling POST /_matrix/client/v3/register will receive the error IO.ELEMENT.MSC4190.M_APPSERVICE_LOGIN_UNSUPPORTED in response. This is a\\nresult of MSC4190: Device management for application\\nservices which\\nadds new endpoints for application services to create encryption-ready devices\\nwith other than /login or /register without inhibit_login=true. If an application service you use starts to fail with the mentioned error,\\nensure it is up to date. If it is, then kindly let the author know that they\\nneed to update their implementation to call /register with inhibit_login=true.","breadcrumbs":"Upgrading between Synapse Versions » /register requests from old application service implementations may break when using MAS","id":"110","title":"/register requests from old application service implementations may break when using MAS"},"1100":{"body":"In a nutshell: we have an append-only log with a “buffer/scratchpad” at the end where we have to wait for the sequence to be linear and contiguous.","breadcrumbs":"Synapse Architecture » Streams » Summary","id":"1100","title":"Summary"},"1101":{"body":"These rough notes and links may help you to create a new stream and add all the\\nnecessary registration and event handling. Create your stream: Create a Postgres-specific database delta file to add a new SEQUENCE (this will be referenced by the MultiWriterIdGenerator below). Update synapse/_scripts/synapse_port_db.py so it knows about your new SEQUENCE: add a new _setup_sequence(...) create a stream class and stream row class will need an ID generator may need writer configuration, if there isn’t already an obvious source of configuration for which workers should be designated as writers to your new stream. if adding new writer configuration, add Docker-worker configuration, which lets us configure the writer worker in Complement tests: [1], [2] Ensure that it’s been correctly added to synapse/replication/tcp/handler.py and it’s streams_to_replicate attribute to ensure that changes are actually replicated. most of the time, you will likely introduce a new datastore class for the concept represented by the new stream, unless there is already an obvious datastore that covers it. consider whether it may make sense to introduce a handler Register your stream in: STREAMS_MAP Advance your stream in: process_replication_position of your appropriate datastore don’t forget the super call If you’re going to do any caching that needs invalidation from new rows: add invalidations to process_replication_rows of your appropriate datastore don’t forget the super call add local-only invalidations to your writer transactions Update docs: Update the Stream\\nwriters\\nsection in the worker docs with a new section for the stream If this stream can only be handled by specific workers, add a new section to the upgrade notes. For streams to be used in sync: add a new field to StreamToken add a new StreamKeyType add appropriate wake-up rules in on_rdata locally on the same worker when completing a write, e.g. in your handler add the stream in bound_future_token we use the word fact here for two reasons.\\nFirstly, the word “event” is already heavily overloaded (PDUs, EDUs, account data, …) and we don’t need to make that worse.\\nSecondly, “fact” emphasises that the things we append to a stream cannot change after the fact. ↩ A fact might be expressed with 0 rows, e.g. if we opened a transaction to persist an event, but failed and rolled the transaction back before marking the fact as completed.\\nIn principle a fact might be expressed with 2 or more rows; if so, each of those rows should share the fact’s stream ID. ↩ This communication used to happen directly with the writers over TCP;\\nnowadays it’s done via Redis’s Pubsub. ↩","breadcrumbs":"Synapse Architecture » Streams » Cheatsheet for creating a new stream","id":"1101","title":"Cheatsheet for creating a new stream"},"1102":{"body":"","breadcrumbs":"Synapse Architecture » TCP Replication » TCP Replication","id":"1102","title":"TCP Replication"},"1103":{"body":"Previously the workers used an HTTP long poll mechanism to get updates\\nfrom the master, which had the problem of causing a lot of duplicate\\nwork on the server. This TCP protocol replaces those APIs with the aim\\nof increased efficiency.","breadcrumbs":"Synapse Architecture » TCP Replication » Motivation","id":"1103","title":"Motivation"},"1104":{"body":"The protocol is based on fire and forget, line based commands. An\\nexample flow would be (where ‘>’ indicates master to worker and\\n‘<’ worker to master flows): > SERVER example.com\\n< REPLICATE\\n> POSITION events master 53 53\\n> RDATA events master 54 [\\"$foo1:bar.com\\", ...]\\n> RDATA events master 55 [\\"$foo4:bar.com\\", ...] The example shows the server accepting a new connection and sending its identity\\nwith the SERVER command, followed by the client server to respond with the\\nposition of all streams. The server then periodically sends RDATA commands\\nwhich have the format RDATA , where\\nthe format of is defined by the individual streams. The is the name of the Synapse process that generated the data\\n(usually “master”). We expect an RDATA for every row in the DB. Error reporting happens by either the client or server sending an ERROR\\ncommand, and usually the connection will be closed. Since the protocol is a simple line based, its possible to manually\\nconnect to the server using a tool like netcat. A few things should be\\nnoted when manually using the protocol: The federation stream is only available if federation sending has\\nbeen disabled on the main process. The server will only time connections out that have sent a PING\\ncommand. If a ping is sent then the connection will be closed if no\\nfurther commands are received within 15s. Both the client and\\nserver protocol implementations will send an initial PING on\\nconnection and ensure at least one command every 5s is sent (not\\nnecessarily PING). RDATA commands usually include a numeric token, however if the\\nstream has multiple rows to replicate per token the server will send\\nmultiple RDATA commands, with all but the last having a token of batch. See the documentation on commands.RdataCommand for\\nfurther details.","breadcrumbs":"Synapse Architecture » TCP Replication » Overview","id":"1104","title":"Overview"},"1105":{"body":"The basic structure of the protocol is line based, where the initial\\nword of each line specifies the command. The rest of the line is parsed\\nbased on the command. For example, the RDATA command is defined as: RDATA (Note that may contains spaces, but cannot contain\\nnewlines.) Blank lines are ignored.","breadcrumbs":"Synapse Architecture » TCP Replication » Architecture","id":"1105","title":"Architecture"},"1106":{"body":"Both sides are expected to send at least one command every 5s or so, and\\nshould send a PING command if necessary. If either side do not receive\\na command within e.g. 15s then the connection should be closed. Because the server may be connected to manually using e.g. netcat, the\\ntimeouts aren’t enabled until an initial PING command is seen. Both\\nthe client and server implementations below send a PING command\\nimmediately on connection to ensure the timeouts are enabled. This ensures that both sides can quickly realize if the tcp connection\\nhas gone and handle the situation appropriately.","breadcrumbs":"Synapse Architecture » TCP Replication » Keep alives","id":"1106","title":"Keep alives"},"1107":{"body":"When a new connection is made, the server: Sends a SERVER command, which includes the identity of the server,\\nallowing the client to detect if its connected to the expected\\nserver Sends a PING command as above, to enable the client to time out\\nconnections promptly. The client: Sends a NAME command, allowing the server to associate a human\\nfriendly name with the connection. This is optional. Sends a PING as above Sends a REPLICATE to get the current position of all streams. On receipt of a SERVER command, checks that the server name\\nmatches the expected server name.","breadcrumbs":"Synapse Architecture » TCP Replication » Start up","id":"1107","title":"Start up"},"1108":{"body":"If either side detects an error it can send an ERROR command and close\\nthe connection. If the client side loses the connection to the server it should\\nreconnect, following the steps above.","breadcrumbs":"Synapse Architecture » TCP Replication » Error handling","id":"1108","title":"Error handling"},"1109":{"body":"If the server sends messages faster than the client can consume them the\\nserver will first buffer a (fairly large) number of commands and then\\ndisconnect the client. This ensures that we don’t queue up an unbounded\\nnumber of commands in memory and gives us a potential opportunity to\\nsquawk loudly. When/if the client recovers it can reconnect to the\\nserver and ask for missed messages.","breadcrumbs":"Synapse Architecture » TCP Replication » Congestion","id":"1109","title":"Congestion"},"111":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.138.2","id":"111","title":"Upgrading to v1.138.2"},"1110":{"body":"In general the replication stream should be considered an unreliable\\ntransport since e.g. commands are not resent if the connection\\ndisappears. The exception to that are the replication streams, i.e. RDATA commands,\\nsince these include tokens which can be used to restart the stream on\\nconnection errors. The client should keep track of the token in the last RDATA command\\nreceived for each stream so that on reconnection it can start streaming\\nfrom the correct place. Note: not all RDATA have valid tokens due to\\nbatching. See RdataCommand for more details.","breadcrumbs":"Synapse Architecture » TCP Replication » Reliability","id":"1110","title":"Reliability"},"1111":{"body":"An example interaction is shown below. Each line is prefixed with ‘>’\\nor ‘<’ to indicate which side is sending, these are not included on\\nthe wire: * connection established *\\n> SERVER localhost:8823\\n> PING 1490197665618\\n< NAME synapse.app.appservice\\n< PING 1490197665618\\n< REPLICATE\\n> POSITION events master 1 1\\n> POSITION backfill master 1 1\\n> POSITION caches master 1 1\\n> RDATA caches master 2 [\\"get_user_by_id\\",[\\"@01register-user:localhost:8823\\"],1490197670513]\\n> RDATA events master 14 [\\"$149019767112vOHxz:localhost:8823\\", \\"!AFDCvgApUmpdfVjIXm:localhost:8823\\",\\"m.room.guest_access\\",\\"\\",null]\\n< PING 1490197675618\\n> ERROR server stopping\\n* connection closed by server * The POSITION command sent by the server is used to set the clients\\nposition without needing to send data with the RDATA command. An example of a batched set of RDATA is: > RDATA caches master batch [\\"get_user_by_id\\",[\\"@test:localhost:8823\\"],1490197670513]\\n> RDATA caches master batch [\\"get_user_by_id\\",[\\"@test2:localhost:8823\\"],1490197670513]\\n> RDATA caches master batch [\\"get_user_by_id\\",[\\"@test3:localhost:8823\\"],1490197670513]\\n> RDATA caches master 54 [\\"get_user_by_id\\",[\\"@test4:localhost:8823\\"],1490197670513] In this case the client shouldn’t advance their caches token until it\\nsees the the last RDATA.","breadcrumbs":"Synapse Architecture » TCP Replication » Example","id":"1111","title":"Example"},"1112":{"body":"The list of valid commands, with which side can send it: server (S) or\\nclient (C): SERVER (S) Sent at the start to identify which server the client is talking to RDATA (S) A single update in a stream POSITION (S) On receipt of a POSITION command clients should check if they have missed any\\nupdates, and if so then fetch them out of band. Sent in response to a\\nREPLICATE command (but can happen at any time). The POSITION command includes the source of the stream. Currently all streams\\nare written by a single process (usually “master”). If fetching missing\\nupdates via HTTP API, rather than via the DB, then processes should make the\\nrequest to the appropriate process. Two positions are included, the “new” position and the last position sent respectively.\\nThis allows servers to tell instances that the positions have advanced but no\\ndata has been written, without clients needlessly checking to see if they\\nhave missed any updates. Instances will only fetch stuff if there is a gap between\\ntheir current position and the given last position. ERROR (S, C) There was an error PING (S, C) Sent periodically to ensure the connection is still alive NAME (C) Sent at the start by client to inform the server who they are REPLICATE (C) Asks the server for the current position of all streams. USER_SYNC (C) A user has started or stopped syncing on this process. CLEAR_USER_SYNC (C) The server should clear all associated user sync data from the worker. This is used when a worker is shutting down. FEDERATION_ACK (C) Acknowledge receipt of some federation data","breadcrumbs":"Synapse Architecture » TCP Replication » List of commands","id":"1112","title":"List of commands"},"1113":{"body":"Inform other processes that a remote server may have come back online.","breadcrumbs":"Synapse Architecture » TCP Replication » REMOTE_SERVER_UP (S, C)","id":"1113","title":"REMOTE_SERVER_UP (S, C)"},"1114":{"body":"Informs other processes that a remote server has just joined a room. See synapse/replication/tcp/commands.py for a detailed description and\\nthe format of each command.","breadcrumbs":"Synapse Architecture » TCP Replication » NEW_SERVER_JOINED (S, C)","id":"1114","title":"NEW_SERVER_JOINED (S, C)"},"1115":{"body":"The cache invalidation stream is used to inform workers when they need\\nto invalidate any of their caches in the data store. This is done by\\nstreaming all cache invalidations done on master down to the workers,\\nassuming that any caches on the workers also exist on the master. Each individual cache invalidation results in a row being sent down\\nreplication, which includes the cache name (the name of the function)\\nand they key to invalidate. For example: > RDATA caches master 550953771 [\\"get_user_by_id\\", [\\"@bob:example.com\\"], 1550574873251] Alternatively, an entire cache can be invalidated by sending down a null\\ninstead of the key. For example: > RDATA caches master 550953772 [\\"get_user_by_id\\", null, 1550574873252] However, there are times when a number of caches need to be invalidated\\nat the same time with the same key. To reduce traffic we batch those\\ninvalidations into a single poke by defining a special cache name that\\nworkers understand to mean to expand to invalidate the correct caches. Currently the special cache names are declared in synapse/storage/_base.py and are: cs_cache_fake ─ invalidates caches that depend on the current\\nstate","breadcrumbs":"Synapse Architecture » TCP Replication » Cache Invalidation Stream","id":"1115","title":"Cache Invalidation Stream"},"1116":{"body":"This is a work-in-progress set of notes with two goals: act as a reference, explaining how Synapse implements faster joins; and record the rationale behind our choices. See also MSC3902. The key idea is described by MSC3706. This allows servers to\\nrequest a lightweight response to the federation /send_join endpoint.\\nThis is called a faster join, also known as a partial join. In these\\nnotes we’ll usually use the word “partial” as it matches the database schema.","breadcrumbs":"Synapse Architecture » Faster remote joins » How do faster joins work?","id":"1116","title":"How do faster joins work?"},"1117":{"body":"The response to a partial join consists of the requested join event J, a list of the servers in the room (according to the state before J), a subset of the state of the room before J, the full auth chain of that state subset. Synapse marks the room as partially joined by adding a row to the database table partial_state_rooms. It also marks the join event J as “partially stated”,\\nmeaning that we have neither received nor computed the full state before/after J. This is done by adding a row to partial_state_events. DB schema matrix=> \\\\d partial_state_events\\nTable \\"matrix.partial_state_events\\" Column │ Type │ Collation │ Nullable │ Default\\n══════════╪══════╪═══════════╪══════════╪═════════ room_id │ text │ │ not null │ event_id │ text │ │ not null │ matrix=> \\\\d partial_state_rooms Table \\"matrix.partial_state_rooms\\" Column │ Type │ Collation │ Nullable │ Default ════════════════════════╪════════╪═══════════╪══════════╪═════════ room_id │ text │ │ not null │ device_lists_stream_id │ bigint │ │ not null │ 0 join_event_id │ text │ │ │ joined_via │ text │ │ │ matrix=> \\\\d partial_state_rooms_servers Table \\"matrix.partial_state_rooms_servers\\" Column │ Type │ Collation │ Nullable │ Default ═════════════╪══════╪═══════════╪══════════╪═════════ room_id │ text │ │ not null │ server_name │ text │ │ not null │ Indices, foreign-keys and check constraints are omitted for brevity. While partially joined to a room, Synapse receives events E from remote\\nhomeservers as normal, and can create events at the request of its local users.\\nHowever, we run into trouble when we enforce the checks on an event. Is a valid event, otherwise it is dropped. For an event to be valid, it\\nmust contain a room_id, and it must comply with the event format of that\\nroom version. Passes signature checks, otherwise it is dropped. Passes hash checks, otherwise it is redacted before being processed further. Passes authorization rules based on the event’s auth events, otherwise it\\nis rejected. Passes authorization rules based on the state before the event, otherwise\\nit is rejected. Passes authorization rules based on the current state of the room,\\notherwise it is “soft failed”. We can enforce checks 1–4 without any problems.\\nBut we cannot enforce checks 5 or 6 with complete certainty, since Synapse does\\nnot know the full state before E, nor that of the room.","breadcrumbs":"Synapse Architecture » Faster remote joins » Overview: processing events in a partially-joined room","id":"1117","title":"Overview: processing events in a partially-joined room"},"1118":{"body":"Instead, we make a best-effort approximation.\\nWhile the room is considered partially joined, Synapse tracks the “partial\\nstate” before events.\\nThis works in a similar way as regular state: The partial state before J is that given to us by the partial join response. The partial state before an event E is the resolution of the partial states\\nafter each of E’s prev_events. If E is rejected or a message event, the partial state after E is the\\npartial state before E. Otherwise, the partial state after E is the partial state before E, plus E itself. More concisely, partial state propagates just like full state; the only\\ndifference is that we “seed” it with an incomplete initial state.\\nSynapse records that we have only calculated partial state for this event with\\na row in partial_state_events. While the room remains partially stated, check 5 on incoming events to that\\nroom becomes: Passes authorization rules based on the resolution between the partial\\nstate before E and E’s auth events. If the event fails to pass\\nauthorization rules, it is rejected. Additionally, check 6 is deleted: no soft-failures are enforced. While partially joined, the current partial state of the room is defined as the\\nresolution across the partial states after all forward extremities in the room. Remark. Events with partial state are not considered outliers.","breadcrumbs":"Synapse Architecture » Faster remote joins » Partial state","id":"1118","title":"Partial state"},"1119":{"body":"Using partial state means the auth checks can fail in a few different ways 1. We may erroneously accept an incoming event in check 5 based on partial state\\nwhen it would have been rejected based on full state, or vice versa. This means that an event could erroneously be added to the current partial\\nstate of the room when it would not be present in the full state of the room,\\nor vice versa. Additionally, we may have skipped soft-failing an event that would have been\\nsoft-failed based on full state. (Note that the discrepancies described in the last two bullets are user-visible.) This means that we have to be very careful when we want to lookup pieces of room\\nstate in a partially-joined room. Our approximation of the state may be\\nincorrect or missing. But we can make some educated guesses. If our partial state is likely to be correct, or the consequences of our partial state being incorrect are minor, then we proceed as normal, and let the resync process fix up any mistakes (see\\nbelow). When is our partial state likely to be correct? It’s more accurate the closer we are to the partial join event. (So we should\\nideally complete the resync as soon as possible.) Non-member events: we will have received them as part of the partial join\\nresponse, if they were part of the room state at that point. We may\\nincorrectly accept or reject updates to that state (at first because we lack\\nremote membership information; later because of compounding errors), so these\\ncan become incorrect over time. Local members’ memberships: we are the only ones who can create join and\\nknock events for our users. We can’t be completely confident in the\\ncorrectness of bans, invites and kicks from other homeservers, but the resync\\nprocess should correct any mistakes. Remote members’ memberships: we did not receive these in the /send_join\\nresponse, so we have essentially no idea if these are correct or not. In short, we deem it acceptable to trust the partial state for non-membership\\nand local membership events. For remote membership events, we wait for the\\nresync to complete, at which point we have the full state of the room and can\\nproceed as normal.","breadcrumbs":"Synapse Architecture » Faster remote joins » Approximation error","id":"1119","title":"Approximation error"},"112":{"body":"Ubuntu 24.10 Oracular Oriole has been end-of-life since 10 Jul\\n2025. This release drops support for Ubuntu\\n24.10, and in its place adds support for Ubuntu 25.04 Plucky Puffin. This notice also applies to the v1.139.0 release.","breadcrumbs":"Upgrading between Synapse Versions » Drop support for Ubuntu 24.10 Oracular Oriole, and add support for Ubuntu 25.04 Plucky Puffin","id":"112","title":"Drop support for Ubuntu 24.10 Oracular Oriole, and add support for Ubuntu 25.04 Plucky Puffin"},"1120":{"body":"The partial-state approximation is only a temporary affair. In the background,\\nsynapse beings a “resync” process. This is a continuous loop, starting at the\\npartial join event and proceeding downwards through the event graph. For each E seen in the room since partial join, Synapse will fetch the event ids in the state of the room before E, via /state_ids; the event ids in the full auth chain of E, included in the /state_ids\\nresponse; and any events from the previous two bullets that Synapse hasn’t persisted, via `/state. This means Synapse has (or can compute) the full state before E, which allows\\nSynapse to properly authorise or reject E. At this point ,the event\\nis considered to have “full state” rather than “partial state”. We record this\\nby removing E from the partial_state_events table. [ TODO: Does Synapse persist a new state group for the full state\\nbefore E, or do we alter the (partial-)state group in-place? Are state groups\\never marked as partially-stated? ] This scheme means it is possible for us to have accepted and sent an event to\\nclients, only to reject it during the resync. From a client’s perspective, the\\neffect is similar to a retroactive\\nstate change due to state resolution—i.e. a “state reset”. 2 When all events since the join J have been fully-stated, the room resync\\nprocess is complete. We record this by removing the room from partial_state_rooms.","breadcrumbs":"Synapse Architecture » Faster remote joins » Fixing the approximation with a resync","id":"1120","title":"Fixing the approximation with a resync"},"1121":{"body":"For the time being, the resync process happens on the master worker.\\nA new replication stream un_partial_stated_room is added. Whenever a resync\\ncompletes and a partial-state room becomes fully stated, a new message is sent\\ninto that stream containing the room ID.","breadcrumbs":"Synapse Architecture » Faster remote joins » Faster joins on workers","id":"1121","title":"Faster joins on workers"},"1122":{"body":"NB. The notes below are rough. Some of them are hidden under \\ndisclosures because they have yet to be implemented in mainline Synapse.","breadcrumbs":"Synapse Architecture » Faster remote joins » Notes on specific cases","id":"1122","title":"Notes on specific cases"},"1123":{"body":"When sending out messages during a partial join, we assume our partial state is\\naccurate and proceed as normal. For this to have any hope of succeeding at all,\\nour partial state must contain an entry for each of the (type, state key) pairs specified by the auth rules: m.room.create m.room.join_rules m.room.power_levels m.room.third_party_invite m.room.member The first four of these should be present in the state before J that is given\\nto us in the partial join response; only membership events are omitted. In order\\nfor us to consider the user joined, we must have their membership event. That\\nmeans the only possible omission is the target’s membership in an invite, kick\\nor ban. The worst possibility is that we locally invite someone who is banned according to\\nthe full state, because we lack their ban in our current partial state. The rest\\nof the federation—at least, those who are fully joined—should correctly\\nenforce the membership transition constraints. So any the erroneous invite should be ignored by fully-joined\\nhomeservers and resolved by the resync for partially-joined homeservers. In more generality, there are two problems we’re worrying about here: We might create an event that is valid under our partial state, only to later\\nfind out that is actually invalid according to the full state. Or: we might refuse to create an event that is invalid under our partial\\nstate, even though it would be perfectly valid under the full state. However we expect such problems to be unlikely in practise, because We trust that the room has sensible power levels, e.g. that bad actors with\\nhigh power levels are demoted before their ban. We trust that the resident server provides us up-to-date power levels, join\\nrules, etc. State changes in rooms are relatively infrequent, and the resync period is\\nrelatively quick. Sending out the event over federation TODO: needs prose fleshing out. Normally: send out in a fed txn to all HSes in the room.\\nWe only know that some HSes were in the room at some point. Wat do.\\nSend it out to the list of servers from the first join. TODO what do we do here if we have full state?\\nIf the prev event was created by us, we can risk sending it to the wrong HS. (Motivation: privacy concern of the content. Not such a big deal for a public room or an encrypted room. But non-encrypted invite-only…)\\nBut don’t want to send out sensitive data in other HS’s events in this way. Suppose we discover after resync that we shouldn’t have sent out one our events (not a prev_event) to a target HS. Not much we can do.\\nWhat about if we didn’t send them an event but shouldn’t’ve?\\nE.g. what if someone joined from a new HS shortly after you did? We wouldn’t talk to them.\\nCould imagine sending out the “Missed” events after the resync but… painful to work out what they should have seen if they joined/left.\\nInstead, just send them the latest event (if they’re still in the room after resync) and let them backfill.(?) Don’t do this currently. If anyone who has received our messages sends a message to a HS we missed, they can backfill our messages Gap: rooms which are infrequently used and take a long time to resync.","breadcrumbs":"Synapse Architecture » Faster remote joins » Creating events during a partial join","id":"1123","title":"Creating events during a partial join"},"1124":{"body":"NB. Not yet implemented. TODO: needs prose fleshing out. Liase with Matthieu. Explain why /send_join\\n(Rich was surprised we didn’t just create it locally. Answer: to try and avoid\\na join which then gets rejected after resync.) We don’t know for sure that any join we create would be accepted.\\nE.g. the joined user might have been banned; the join rules might have changed in a way that we didn’t realise… some way in which the partial state was mistaken.\\nInstead, do another partial make-join/send-join handshake to confirm that the join works. Probably going to get a bunch of duplicate state events and auth events…. but the point of partial joins is that these should be small. Many are already persisted = good. What if the second send_join response includes a different list of reisdent HSes? Could ignore it. Could even have a special flag that says “just make me a join”, i.e. don’t bother giving me state or servers in room. Deffo want the auth chain tho. SQ: wrt device lists it’s a lot safer to ignore it!!!!! What if the state at the second join is inconsistent with what we have? Ignore it?","breadcrumbs":"Synapse Architecture » Faster remote joins » Joining after a partial join","id":"1124","title":"Joining after a partial join"},"1125":{"body":"NB. Not yet implemented. When you’re fully joined to a room, to have U leave a room their homeserver\\nneeds to create a new leave event for U which will be accepted by other homeservers,\\nand send that event U out to the homeservers in the federation. When is a leave event accepted? See v10 auth rules: If type is m.room.member: […]\\n>\\n> 5. If membership is leave:\\n>\\n> 1. If the sender matches state_key, allow if and only if that user’s current membership state is invite, join, or knock.\\n2. […] I think this means that (well-formed!) self-leaves are governed entirely by\\n4.5.1. This means that if we correctly calculate state which says that U is\\ninvited, joined or knocked and include it in the leave’s auth events, our event\\nis accepted by checks 4 and 5 on incoming events. Passes authorization rules based on the event’s auth events, otherwise\\n> it is rejected. Passes authorization rules based on the state before the event, otherwise\\n> it is rejected. The only way to fail check 6 is if the receiving server’s current state of the\\nroom says that U is banned, has left, or has no membership event. But this is\\nfine: the receiving server already thinks that U isn’t in the room. Passes authorization rules based on the current state of the room,\\n> otherwise it is “soft failed”. For the second point (publishing the leave event), the best thing we can do is\\nto is publish to all HSes we know to be currently in the room. If they miss that\\nevent, they might send us traffic in the room that we don’t care about. This is\\na problem with leaving after a “full” join; we don’t seek to fix this with\\npartial joins. (With that said: there’s nothing machine-readable in the /send response. I don’t\\nthink we can deduce “destination has left the room” from a failure to /send an\\nevent into that room?) Can we still do this during a partial join? We can create leave events and can choose what gets included in our auth events,\\nso we can be sure that we pass check 4 on incoming events. For check 5, we might\\nhave an incorrect view of the state before an event.\\nThe only way we might erroneously think a leave is valid is if the partial state before the leave has U joined, invited or knocked, but the full state before the leave has U banned, left or not present, in which case the leave doesn’t make anything worse: other HSes already consider\\nus as not in the room, and will continue to do so after seeing the leave. The remaining obstacle is then: can we safely broadcast the leave event? We may\\nmiss servers or incorrectly think that a server is in the room. Or the\\ndestination server may be offline and miss the transaction containing our leave\\nevent.This should self-heal when they see an event whose prev_events descends\\nfrom our leave. Another option we considered was to use federation /send_leave to ask a\\nfully-joined server to send out the event on our behalf. But that introduces\\ncomplexity without much benefit. Besides, as Rich put it, sending out leaves is pretty best-effort currently so this is probably good enough as-is. Cleanup after the last leave TODO: what cleanup is necessary? Is it all just nice-to-have to save unused\\nwork? Is this exhaustive? ↩ Clients should refresh caches to detect such a change. Rumour has it that\\nsliding sync will fix this. ↩","breadcrumbs":"Synapse Architecture » Faster remote joins » Leaving (and kicks and bans) after a partial join","id":"1125","title":"Leaving (and kicks and bans) after a partial join"},"1126":{"body":"This section covers implementation documentation for various parts of Synapse. If a developer is planning to make a change to a feature of Synapse, it can be useful for\\ngeneral documentation of how that feature is implemented to be available. This saves the\\ndeveloper time in place of needing to understand how the feature works by reading the\\ncode. Documentation that would be more useful for the perspective of a system administrator,\\nrather than a developer who’s intending to change to code, should instead be placed\\nunder the Usage section of the documentation.","breadcrumbs":"Internal Documentation » Internal Documentation","id":"1126","title":"Internal Documentation"},"1127":{"body":"https://fujifish.github.io/samling/samling.html (https://github.com/fujifish/samling) is a great resource for being able to tinker with the\\nSAML options within Synapse without needing to deploy and configure a complicated software stack. To make Synapse (and therefore Element) use it: Use the samling.html URL above or deploy your own and visit the IdP Metadata tab. Copy the XML to your clipboard. On your Synapse server, create a new file samling.xml next to your homeserver.yaml with\\nthe XML from step 2 as the contents. Edit your homeserver.yaml to include: saml2_config: sp_config: allow_unknown_attributes: true # Works around a bug with AVA Hashes: https://github.com/IdentityPython/pysaml2/issues/388 metadata: local: [\\"samling.xml\\"] Ensure that your homeserver.yaml has a setting for public_baseurl: public_baseurl: http://localhost:8080/ Run apt-get install xmlsec1 and pip install --upgrade --force \'pysaml2>=4.5.0\' to ensure\\nthe dependencies are installed and ready to go. Restart Synapse. Then in Element: Visit the login page and point Element towards your homeserver using the public_baseurl above. Click the Single Sign-On button. On the samling page, enter a Name Identifier and add a SAML Attribute for uid=your_localpart.\\nThe response must also be signed. Click “Next”. Click “Post Response” (change nothing). You should be logged in. If you try and repeat this process, you may be automatically logged in using the information you\\ngave previously. To fix this, open your developer console ( F12 or Ctrl+Shift+I) while on the\\nsamling page and clear the site data. In Chrome, this will be a button on the Application tab.","breadcrumbs":"Internal Documentation » Single Sign-On » SAML » How to test SAML as a developer without a server","id":"1127","title":"How to test SAML as a developer without a server"},"1128":{"body":"The django-mama-cas project is an\\neasy to run CAS implementation built on top of Django.","breadcrumbs":"Internal Documentation » Single Sign-On » CAS » How to test CAS as a developer without a server","id":"1128","title":"How to test CAS as a developer without a server"},"1129":{"body":"Create a new virtualenv: python3 -m venv Activate your virtualenv: source /path/to/your/virtualenv/bin/activate Install Django and django-mama-cas: python -m pip install \\"django<3\\" \\"django-mama-cas==2.4.0\\" Create a Django project in the current directory: django-admin startproject cas_test . Follow the install directions for django-mama-cas Setup the SQLite database: python manage.py migrate Create a user: python manage.py createsuperuser Use whatever you want as the username and password. Leave the other fields blank. Use the built-in Django test server to serve the CAS endpoints on port 8000: python manage.py runserver You should now have a Django project configured to serve CAS authentication with\\na single user created.","breadcrumbs":"Internal Documentation » Single Sign-On » CAS » Prerequisites","id":"1129","title":"Prerequisites"},"113":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.136.0","id":"113","title":"Upgrading to v1.136.0"},"1130":{"body":"Modify your homeserver.yaml to enable CAS and point it to your locally\\nrunning Django test server: cas_config: enabled: true server_url: \\"http://localhost:8000\\" service_url: \\"http://localhost:8081\\" #displayname_attribute: name #required_attributes: # name: value Restart Synapse. Note that the above configuration assumes the homeserver is running on port 8081\\nand that the CAS server is on port 8000, both on localhost.","breadcrumbs":"Internal Documentation » Single Sign-On » CAS » Configure Synapse (and Element) to use CAS","id":"1130","title":"Configure Synapse (and Element) to use CAS"},"1131":{"body":"Then in Element: Visit the login page with a Element pointing at your homeserver. Click the Single Sign-On button. Login using the credentials created with createsuperuser. You should be logged in. If you want to repeat this process you’ll need to manually logout first: http://localhost:8000/admin/ Click “logout” in the top right.","breadcrumbs":"Internal Documentation » Single Sign-On » CAS » Testing the configuration","id":"1131","title":"Testing the configuration"},"1132":{"body":"","breadcrumbs":"Internal Documentation » Room DAG concepts » Room DAG concepts","id":"1132","title":"Room DAG concepts"},"1133":{"body":"The word “edge” comes from graph theory lingo. An edge is just a connection\\nbetween two events. In Synapse, we connect events by specifying their prev_events. A subsequent event points back at a previous event. A (oldest) <---- B <---- C (most recent)","breadcrumbs":"Internal Documentation » Room DAG concepts » Edges","id":"1133","title":"Edges"},"1134":{"body":"Events are normally sorted by (topological_ordering, stream_ordering) where topological_ordering is just depth. In other words, we first sort by depth\\nand then tie-break based on stream_ordering. depth is incremented as new\\nmessages are added to the DAG. Normally, stream_ordering is an auto\\nincrementing integer, but backfilled events start with stream_ordering=-1 and decrement. Incremental /sync?since=xxx returns things in the order they arrive at the server\\n( stream_ordering). Initial /sync, /messages (and /backfill in the federation API) return them in\\nthe order determined by the event graph (topological_ordering, stream_ordering). The general idea is that, if you’re following a room in real-time (i.e. /sync), you probably want to see the messages as they arrive at your server,\\nrather than skipping any that arrived late; whereas if you’re looking at a\\nhistorical section of timeline (i.e. /messages), you want to see the best\\nrepresentation of the state of the room as others were seeing it at the time.","breadcrumbs":"Internal Documentation » Room DAG concepts » Depth and stream ordering","id":"1134","title":"Depth and stream ordering"},"1135":{"body":"We mark an event as an outlier when we haven’t figured out the state for the\\nroom at that point in the DAG yet. They are “floating” events that we haven’t\\nyet correlated to the DAG. Outliers typically arise when we fetch the auth chain or state for a given\\nevent. When that happens, we just grab the events in the state/auth chain,\\nwithout calculating the state at those events, or backfilling their prev_events. Since we don’t have the state at any events fetched in that\\nway, we mark them as outliers. So, typically, we won’t have the prev_events of an outlier in the database,\\n(though it’s entirely possible that we might have them for some other\\nreason). Other things that make outliers different from regular events: We don’t have state for them, so there should be no entry in event_to_state_groups for an outlier. (In practice this isn’t always\\nthe case, though I’m not sure why: see https://github.com/matrix-org/synapse/issues/12201). We don’t record entries for them in the event_edges, event_forward_extremeties or event_backward_extremities tables. Since outliers are not tied into the DAG, they do not normally form part of the\\ntimeline sent down to clients via /sync or /messages; however there is an\\nexception:","breadcrumbs":"Internal Documentation » Room DAG concepts » Outliers","id":"1135","title":"Outliers"},"1136":{"body":"A special case of outlier events are some membership events for federated rooms\\nthat we aren’t full members of. For example: invites received over federation, before we join the room rejections for said invites knock events for rooms that we would like to join but have not yet joined. In all the above cases, we don’t have the state for the room, which is why they\\nare treated as outliers. They are a bit special though, in that they are\\nproactively sent to clients via /sync.","breadcrumbs":"Internal Documentation » Room DAG concepts » Out-of-band membership events","id":"1136","title":"Out-of-band membership events"},"1137":{"body":"Most-recent-in-time events in the DAG which are not referenced by any other\\nevents’ prev_events yet. (In this definition, outliers, rejected events, and\\nsoft-failed events don’t count.) The forward extremities of a room (or at least, a subset of them, if there are\\nmore than ten) are used as the prev_events when the next event is sent. The “current state” of a room (ie: the state which would be used if we\\ngenerated a new event) is, therefore, the resolution of the room states\\nat each of the forward extremities.","breadcrumbs":"Internal Documentation » Room DAG concepts » Forward extremity","id":"1137","title":"Forward extremity"},"1138":{"body":"The current marker of where we have backfilled up to and will generally be the prev_events of the oldest-in-time events we have in the DAG. This gives a starting point when\\nbackfilling history. Note that, unlike forward extremities, we typically don’t have any backward\\nextremity events themselves in the database - or, if we do, they will be “outliers” (see\\nabove). Either way, we don’t expect to have the room state at a backward extremity. When we persist a non-outlier event, if it was previously a backward extremity,\\nwe clear it as a backward extremity and set all of its prev_events as the new\\nbackward extremities if they aren’t already persisted as non-outliers. This\\ntherefore keeps the backward extremities up-to-date.","breadcrumbs":"Internal Documentation » Room DAG concepts » Backward extremity","id":"1138","title":"Backward extremity"},"1139":{"body":"For every non-outlier event we need to know the state at that event. Instead of\\nstoring the full state for each event in the DB (i.e. a event_id -> state\\nmapping), which is very space inefficient when state doesn’t change, we\\ninstead assign each different set of state a “state group” and then have\\nmappings of event_id -> state_group and state_group -> state.","breadcrumbs":"Internal Documentation » Room DAG concepts » State groups","id":"1139","title":"State groups"},"114":{"body":"The run_as_background_process function is now a method of the ModuleApi class. If\\nyou were using the function directly from the module API, it will continue to work fine\\nbut the background process metrics will not include an accurate server_name label.\\nThis kind of metric labeling isn’t relevant for many use cases and is used to\\ndifferentiate Synapse instances running in the same Python process (relevant to Synapse\\nPro: Small Hosts). We recommend updating your usage to use the new ModuleApi.run_as_background_process method to stay on top of future changes. Example run_as_background_process upgrade Before: class MyModule: def __init__(self, module_api: ModuleApi) -> None: run_as_background_process(__name__ + \\":setup_database\\", self.setup_database) After: class MyModule: def __init__(self, module_api: ModuleApi) -> None: module_api.run_as_background_process(__name__ + \\":setup_database\\", self.setup_database)","breadcrumbs":"Upgrading between Synapse Versions » Deprecate run_as_background_process exported as part of the module API interface in favor of ModuleApi.run_as_background_process","id":"114","title":"Deprecate run_as_background_process exported as part of the module API interface in favor of ModuleApi.run_as_background_process"},"1140":{"body":"TODO: state_group_edges is a further optimization…\\nnotes from @Azrenbeth, https://pastebin.com/seUGVGeT","breadcrumbs":"Internal Documentation » Room DAG concepts » Stage group edges","id":"1140","title":"Stage group edges"},"1141":{"body":"The auth chain difference algorithm is used by V2 state resolution, where a\\nnaive implementation can be a significant source of CPU and DB usage.","breadcrumbs":"Internal Documentation » State Resolution » The Auth Chain Difference Algorithm » Auth Chain Difference Algorithm","id":"1141","title":"Auth Chain Difference Algorithm"},"1142":{"body":"A state set is a set of state events; e.g. the input of a state resolution\\nalgorithm is a collection of state sets. The auth chain of a set of events are all the events’ auth events and their\\nauth events, recursively (i.e. the events reachable by walking the graph induced\\nby an event’s auth events links). The auth chain difference of a collection of state sets is the union minus the\\nintersection of the sets of auth chains corresponding to the state sets, i.e an\\nevent is in the auth chain difference if it is reachable by walking the auth\\nevent graph from at least one of the state sets but not from all of the state\\nsets.","breadcrumbs":"Internal Documentation » State Resolution » The Auth Chain Difference Algorithm » Definitions","id":"1142","title":"Definitions"},"1143":{"body":"A way of calculating the auth chain difference without calculating the full auth\\nchains for each state set is to do a parallel breadth first walk (ordered by\\ndepth) of each state set’s auth chain. By tracking which events are reachable\\nfrom each state set we can finish early if every pending event is reachable from\\nevery state set. This can work well for state sets that have a small auth chain difference, but\\ncan be very inefficient for larger differences. However, this algorithm is still\\nused if we don’t have a chain cover index for the room (e.g. because we’re in\\nthe process of indexing it).","breadcrumbs":"Internal Documentation » State Resolution » The Auth Chain Difference Algorithm » Breadth First Walk Algorithm","id":"1143","title":"Breadth First Walk Algorithm"},"1144":{"body":"Synapse computes auth chain differences by pre-computing a “chain cover” index\\nfor the auth chain in a room, allowing us to efficiently make reachability queries\\nlike “is event A in the auth chain of event B?”. We could do this with an index\\nthat tracks all pairs (A, B) such that A is in the auth chain of B. However, this\\nwould be prohibitively large, scaling poorly as the room accumulates more state\\nevents. Instead, we break down the graph into chains. A chain is a subset of a DAG\\nwith the following property: for any pair of events E and F in the chain,\\nthe chain contains a path E -> F or a path F -> E. This forces a chain to be\\nlinear (without forks), e.g. E -> F -> G -> ... -> H. Each event in the chain\\nis given a sequence number local to that chain. The oldest event E in the\\nchain has sequence number 1. If E has a child F in the chain, then F has\\nsequence number 2. If E has a grandchild G in the chain, then G has\\nsequence number 3; and so on. Synapse ensures that each persisted event belongs to exactly one chain, and\\ntracks how the chains are connected to one another. This allows us to\\nefficiently answer reachability queries. Doing so uses less storage than\\ntracking reachability on an event-by-event basis, particularly when we have\\nfewer and longer chains. See Jagadish, H. (1990). A compression technique to materialize transitive closure. ACM Transactions on Database Systems (TODS), 15*(4)*, 558-598. for the original idea or Y. Chen, Y. Chen, An efficient algorithm for answering graph\\nreachability queries,\\nin: 2008 IEEE 24th International Conference on Data Engineering, April 2008,\\npp. 893–902. (PDF available via Google Scholar.) for a more modern take. In practical terms, the chain cover assigns every event a chain ID and sequence number (e.g. (5,3)), and maintains a map of links\\nbetween events in chains (e.g. (5,3) -> (2,4)) such that A is reachable by B\\n(i.e. A is in the auth chain of B) if and only if either: A and B have the same chain ID and A’s sequence number is less than B’s\\nsequence number; or there is a link L between B’s chain ID and A’s chain ID such that L.start_seq_no <= B.seq_no and A.seq_no <= L.end_seq_no. There are actually two potential implementations, one where we store links from\\neach chain to every other reachable chain (the transitive closure of the links\\ngraph), and one where we remove redundant links (the transitive reduction of the\\nlinks graph) e.g. if we have chains C3 -> C2 -> C1 then the link C3 -> C1\\nwould not be stored. Synapse uses the former implementation so that it doesn’t\\nneed to recurse to test reachability between chains. This trades-off extra storage\\nin order to save CPU cycles and DB queries.","breadcrumbs":"Internal Documentation » State Resolution » The Auth Chain Difference Algorithm » Chain Cover Index","id":"1144","title":"Chain Cover Index"},"1145":{"body":"An example auth graph would look like the following, where chains have been\\nformed based on type/state_key and are denoted by colour and are labelled with (chain ID, sequence number). Links are denoted by the arrows (links in grey\\nare those that would be remove in the second implementation described above). Note that we don’t include all links between events and their auth events, as\\nmost of those links would be redundant. For example, all events point to the\\ncreate event, but each chain only needs the one link from it’s base to the\\ncreate event.","breadcrumbs":"Internal Documentation » State Resolution » The Auth Chain Difference Algorithm » Example","id":"1145","title":"Example"},"1146":{"body":"This index can be used to calculate the auth chain difference of the state sets\\nby looking at the chain ID and sequence numbers reachable from each state set: For every state set lookup the chain ID/sequence numbers of each state event Use the index to find all chains and the maximum sequence number reachable\\nfrom each state set. The auth chain difference is then all events in each chain that have sequence\\nnumbers between the maximum sequence number reachable from any state set and\\nthe minimum reachable by all state sets (if any). Note that steps 2 is effectively calculating the auth chain for each state set\\n(in terms of chain IDs and sequence numbers), and step 3 is calculating the\\ndifference between the union and intersection of the auth chains.","breadcrumbs":"Internal Documentation » State Resolution » The Auth Chain Difference Algorithm » Using the Index","id":"1146","title":"Using the Index"},"1147":{"body":"For example, given the above graph, we can calculate the difference between\\nstate sets consisting of: S1: Alice’s invite (4,1) and Bob’s second join (2,2); and S2: Alice’s second join (4,3) and Bob’s first join (2,1). Using the index we see that the following auth chains are reachable from each\\nstate set: S1: (1,1), (2,2), (3,1) & (4,1) S2: (1,1), (2,1), (3,2) & (4,3) And so, for each the ranges that are in the auth chain difference: Chain 1: None, (since everything can reach the create event). Chain 2: The range (1, 2] (i.e. just 2), as 1 is reachable by all state\\nsets and the maximum reachable is 2 (corresponding to Bob’s second join). Chain 3: Similarly the range (1, 2] (corresponding to the second power\\nlevel). Chain 4: The range (1, 3] (corresponding to both of Alice’s joins). So the final result is: Bob’s second join (2,2), the second power level (3,2) and both of Alice’s joins (4,2) & (4,3).","breadcrumbs":"Internal Documentation » State Resolution » The Auth Chain Difference Algorithm » Worked Example","id":"1147","title":"Worked Example"},"1148":{"body":"Synapse implementation-specific details for the media repository The media repository stores avatars, attachments and their thumbnails for media uploaded by local\\nusers. caches avatars, attachments and their thumbnails for media uploaded by remote\\nusers. caches resources and thumbnails used for URL previews. All media in Matrix can be identified by a unique MXC URI,\\nconsisting of a server name and media ID: mxc:///","breadcrumbs":"Internal Documentation » Media Repository » Media Repository","id":"1148","title":"Media Repository"},"1149":{"body":"Synapse generates 24 character media IDs for content uploaded by local users.\\nThese media IDs consist of upper and lowercase letters and are case-sensitive.\\nOther homeserver implementations may generate media IDs differently. Local media is recorded in the local_media_repository table, which includes\\nmetadata such as MIME types, upload times and file sizes.\\nNote that this table is shared by the URL cache, which has a different media ID\\nscheme.","breadcrumbs":"Internal Documentation » Media Repository » Local Media","id":"1149","title":"Local Media"},"115":{"body":"Previously, the synapse_federation_last_received_pdu_time and synapse_federation_last_sent_pdu_time metrics both used the server_name label to\\ndifferentiate between different servers that we send and receive events from. Since we’re now using the server_name label to differentiate between different Synapse\\nhomeserver instances running in the same process, these metrics have been changed as follows: synapse_federation_last_received_pdu_time now uses the origin_server_name label synapse_federation_last_sent_pdu_time now uses the destination_server_name label The Grafana dashboard JSON in contrib/grafana/synapse.json has been updated to reflect\\nthis change but you will need to manually update your own existing Grafana dashboards\\nusing these metrics.","breadcrumbs":"Upgrading between Synapse Versions » Metric labels have changed on synapse_federation_last_received_pdu_time and synapse_federation_last_sent_pdu_time","id":"115","title":"Metric labels have changed on synapse_federation_last_received_pdu_time and synapse_federation_last_sent_pdu_time"},"1150":{"body":"A file with media ID aabbcccccccccccccccccccc and its 128x96 image/jpeg\\nthumbnail, created by scaling, would be stored at: local_content/aa/bb/cccccccccccccccccccc\\nlocal_thumbnails/aa/bb/cccccccccccccccccccc/128-96-image-jpeg-scale","breadcrumbs":"Internal Documentation » Media Repository » Paths","id":"1150","title":"Paths"},"1151":{"body":"When media from a remote homeserver is requested from Synapse, it is assigned\\na local filesystem_id, with the same format as locally-generated media IDs,\\nas described above. A record of remote media is stored in the remote_media_cache table, which\\ncan be used to map remote MXC URIs (server names and media IDs) to local filesystem_ids.","breadcrumbs":"Internal Documentation » Media Repository » Remote Media","id":"1151","title":"Remote Media"},"1152":{"body":"A file from matrix.org with filesystem_id aabbcccccccccccccccccccc and its 128x96 image/jpeg thumbnail, created by scaling, would be stored at: remote_content/matrix.org/aa/bb/cccccccccccccccccccc\\nremote_thumbnail/matrix.org/aa/bb/cccccccccccccccccccc/128-96-image-jpeg-scale Older thumbnails may omit the thumbnailing method: remote_thumbnail/matrix.org/aa/bb/cccccccccccccccccccc/128-96-image-jpeg Note that remote_thumbnail/ does not have an s.","breadcrumbs":"Internal Documentation » Media Repository » Paths","id":"1152","title":"Paths"},"1153":{"body":"When generating previews for URLs, Synapse may download and cache various\\nresources, including images. These resources are assigned temporary media IDs\\nof the form yyyy-mm-dd_aaaaaaaaaaaaaaaa, where yyyy-mm-dd is the current\\ndate and aaaaaaaaaaaaaaaa is a random sequence of 16 case-sensitive letters. The metadata for these cached resources is stored in the local_media_repository and local_media_repository_url_cache tables. Resources for URL previews are deleted after a few days.","breadcrumbs":"Internal Documentation » Media Repository » URL Previews","id":"1153","title":"URL Previews"},"1154":{"body":"The file with media ID yyyy-mm-dd_aaaaaaaaaaaaaaaa and its 128x96 image/jpeg thumbnail, created by scaling, would be stored at: url_cache/yyyy-mm-dd/aaaaaaaaaaaaaaaa\\nurl_cache_thumbnails/yyyy-mm-dd/aaaaaaaaaaaaaaaa/128-96-image-jpeg-scale","breadcrumbs":"Internal Documentation » Media Repository » Paths","id":"1154","title":"Paths"},"1155":{"body":"Synapse maintains room and user statistics in various tables. These can be used\\nfor administrative purposes but are also used when generating the public room\\ndirectory.","breadcrumbs":"Internal Documentation » Room and User Statistics » Room and User Statistics","id":"1155","title":"Room and User Statistics"},"1156":{"body":"","breadcrumbs":"Internal Documentation » Room and User Statistics » Synapse Developer Documentation","id":"1156","title":"Synapse Developer Documentation"},"1157":{"body":"","breadcrumbs":"Internal Documentation » Room and User Statistics » High-Level Concepts","id":"1157","title":"High-Level Concepts"},"1158":{"body":"subject: Something we are tracking stats about – currently a room or user. current row: An entry for a subject in the appropriate current statistics\\ntable. Each subject can have only one.","breadcrumbs":"Internal Documentation » Room and User Statistics » Definitions","id":"1158","title":"Definitions"},"1159":{"body":"Stats correspond to the present values. Current rows contain the most up-to-date\\nstatistics for a room. Each subject can only have one entry.","breadcrumbs":"Internal Documentation » Room and User Statistics » Overview","id":"1159","title":"Overview"},"116":{"body":"Support for Matrix Authentication Service (MAS) is now stable, with a simplified configuration.\\nThis stable integration requires MAS 0.20.0 or later. The existing experimental_features.msc3861 configuration option is now deprecated and will be removed in Synapse v1.157.0.\\n( Note: this previously read v1.137.0 but the removal date was missed.) Synapse deployments already using MAS should now use the new configuration options: matrix_authentication_service: # Enable the MAS integration enabled: true # The base URL where Synapse will contact MAS endpoint: http://localhost:8080 # The shared secret used to authenticate MAS requests, must be the same as `matrix.secret` in the MAS configuration # See https://element-hq.github.io/matrix-authentication-service/reference/configuration.html#matrix secret: \\"asecurerandomsecretstring\\" They must remove the experimental_features.msc3861 configuration option from their configuration. They can also remove the client previously used by Synapse in the MAS configuration as it is no longer in use.","breadcrumbs":"Upgrading between Synapse Versions » Stable integration with Matrix Authentication Service","id":"116","title":"Stable integration with Matrix Authentication Service"},"1160":{"body":"The Synapse release process includes a step to review the changelog before\\npublishing it. The following is a list of common points to check for: Check whether any similar entries that can be merged together (make sure to include all mentioned PRs at the end of the line, i.e. (#1234, #1235, …)). Link any MSCXXXX lines to the Matrix Spec Change itself: https://github.com/matrix-org/matrix-spec-proposals/pull/xxxx. Wrap any class names, variable names, etc. in back-ticks, if needed. Hoist any relevant security, deprecation, etc. announcements to the top of this version’s changelog for visibility. This includes any announcements in RCs for this release. Check the upgrade notes for any important announcements, and link to them from the changelog if warranted. Quickly skim and check that each entry is in the appropriate section. Entries under the Bugfixes section should ideally state what Synapse version the bug was introduced in. For example: “Fixed a bug introduced in v1.x.y” or if no version can be identified, “Fixed a long-standing bug …”.","breadcrumbs":"Internal Documentation » Releasing » Release Notes Review Checklist » Release notes review checklist","id":"1160","title":"Release notes review checklist"},"1161":{"body":"Synapse has a number of platform dependencies (Python, Rust, PostgreSQL, and SQLite)\\nand application dependencies (Python and Rust packages). This document outlines the\\npolicy towards which versions we support, and when we drop support for versions in the\\nfuture.","breadcrumbs":"Dependency Deprecation Policy » Deprecation Policy","id":"1161","title":"Deprecation Policy"},"1162":{"body":"Synapse follows the upstream support life cycles for Python and PostgreSQL,\\ni.e. when a version reaches End of Life Synapse will withdraw support for that\\nversion in future releases. Details on the upstream support life cycles for Python and PostgreSQL are\\ndocumented at https://endoflife.date/python and https://endoflife.date/postgresql. A Rust compiler is required to build Synapse from source. For any given release\\nthe minimum required version may be bumped up to a recent Rust version, and so\\npeople building from source should ensure they can fetch recent versions of Rust\\n(e.g. by using rustup). The oldest supported version of SQLite is the version provided by Debian oldstable or the oldest maintenance/security-supported Ubuntu LTS (Ubuntu versions with only Expanded Security Maintenance are not included).","breadcrumbs":"Dependency Deprecation Policy » Platform Dependencies","id":"1162","title":"Platform Dependencies"},"1163":{"body":"It is important for system admins to have a clear understanding of the platform\\nrequirements of Synapse and its deprecation policies so that they can\\neffectively plan upgrading their infrastructure ahead of time. This is\\nespecially important in contexts where upgrading the infrastructure requires\\nauditing and approval from a security team, or where otherwise upgrading is a\\nlong process. By following the upstream support life cycles Synapse can ensure that its\\ndependencies continue to get security patches, while not requiring system admins\\nto constantly update their platform dependencies to the latest versions. For Rust, the situation is a bit different given that a) the Rust foundation\\ndoes not generally support older Rust versions, and b) the library ecosystem\\ngenerally bump their minimum support Rust versions frequently. In general, the\\nSynapse team will try to avoid updating the dependency on Rust to the absolute\\nlatest version, but introducing a formal policy is hard given the constraints of\\nthe ecosystem. On a similar note, SQLite does not generally have a concept of “supported\\nrelease”; bugfixes are published for the latest minor release only. We chose to\\ntrack Debian’s oldstable as this is relatively conservative, predictably updated\\nand is consistent with the .deb packages released by Matrix.org.","breadcrumbs":"Dependency Deprecation Policy » Context","id":"1163","title":"Context"},"1164":{"body":"For application-level Python dependencies, we often specify loose version constraints\\n(ex. >=X.Y.Z) to be forwards compatible with any new versions. Upper bounds ( ) into clients\\nwhich support well-known lookup to automatically configure the homeserver and\\nidentity server URLs. This is useful so that users don’t have to memorize or think\\nabout the actual homeserver URL you are using. The URL https:///.well-known/matrix/client should return JSON in\\nthe following format. { \\"m.homeserver\\": { \\"base_url\\": \\"https://\\" }\\n} It can optionally contain identity server information as well. { \\"m.homeserver\\": { \\"base_url\\": \\"https://\\" }, \\"m.identity_server\\": { \\"base_url\\": \\"https://\\" }\\n} To work in browser based clients, the file must be served with the appropriate\\nCross-Origin Resource Sharing (CORS) headers. A recommended value would be Access-Control-Allow-Origin: * which would allow all browser based clients to\\nview it. In nginx this would be something like: location /.well-known/matrix/client { return 200 \'{\\"m.homeserver\\": {\\"base_url\\": \\"https://\\"}}\'; default_type application/json; add_header Access-Control-Allow-Origin *;\\n} You should also ensure the public_baseurl option in homeserver.yaml is set\\ncorrectly. public_baseurl should be set to the URL that clients will use to\\nconnect to your server. This is the same URL you put for the m.homeserver base_url above. public_baseurl: \\"https://\\"","breadcrumbs":"Installation » Client Well-Known URI","id":"12","title":"Client Well-Known URI"},"120":{"body":"Synapse now uses the Rust icu library for improved user search. Installing the\\nnative ICU library on your system is no longer required.","breadcrumbs":"Upgrading between Synapse Versions » ICU bundled with Synapse","id":"120","title":"ICU bundled with Synapse"},"121":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.130.0","id":"121","title":"Upgrading to v1.130.0"},"122":{"body":"The endpoint ^/_matrix/federation/v1/version$ can be delegated to a federation\\nworker. This is not new behaviour, but had not been documented yet. The list of delegatable endpoints has\\nbeen updated to include it. Make sure to check your reverse proxy rules if you\\nare using workers.","breadcrumbs":"Upgrading between Synapse Versions » Documented endpoint which can be delegated to a federation worker","id":"122","title":"Documented endpoint which can be delegated to a federation worker"},"123":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.126.0","id":"123","title":"Upgrading to v1.126.0"},"124":{"body":"The default room_list_publication_rules setting was changed to disallow\\nanyone (except server admins) from publishing to the room list by default. This is in line with Synapse policy of locking down features by default that can\\nbe abused without moderation. To keep the previous behavior of allowing publication by default, add the\\nfollowing to the config: room_list_publication_rules: - \\"action\\": \\"allow\\"","breadcrumbs":"Upgrading between Synapse Versions » Room list publication rules change","id":"124","title":"Room list publication rules change"},"125":{"body":"Administrators using the Debian/Ubuntu packages from packages.matrix.org,\\nplease be aware that we have recently updated the expiry date on the repository’s GPG signing key,\\nbut this change must be imported into your keyring. If you have the matrix-org-archive-keyring package installed and it updates before the current key expires, this should\\nhappen automatically. Otherwise, if you see an error similar to The following signatures were invalid: EXPKEYSIG F473DD4473365DE1, you\\nwill need to get a fresh copy of the keys. You can do so with: sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg The old version of the key will expire on 2025-03-15.","breadcrumbs":"Upgrading between Synapse Versions » Change of signing key expiry date for the Debian/Ubuntu package repository","id":"125","title":"Change of signing key expiry date for the Debian/Ubuntu package repository"},"126":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.122.0","id":"126","title":"Upgrading to v1.122.0"},"127":{"body":"In line with our deprecation policy, we’ve dropped\\nsupport for PostgreSQL 11 and 12, as they are no longer supported upstream.\\nThis release of Synapse requires PostgreSQL 13+.","breadcrumbs":"Upgrading between Synapse Versions » Dropping support for PostgreSQL 11 and 12","id":"127","title":"Dropping support for PostgreSQL 11 and 12"},"128":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.120.0","id":"128","title":"Upgrading to v1.120.0"},"129":{"body":"MSC3886\\nhas been closed (and will not enter the Matrix spec). As such, we are\\nremoving the experimental support for it in this release. The experimental_features.msc3886_endpoint configuration option has\\nbeen removed.","breadcrumbs":"Upgrading between Synapse Versions » Removal of experimental MSC3886 feature","id":"129","title":"Removal of experimental MSC3886 feature"},"13":{"body":"It is desirable for Synapse to have the capability to send email. This allows\\nSynapse to send password reset emails, send verifications when an email address\\nis added to a user’s account, and send email notifications to users when they\\nreceive new messages. To configure an SMTP server for Synapse, modify the configuration section\\nheaded email, and be sure to have at least the smtp_host, smtp_port\\nand notif_from fields filled out. You may also need to set smtp_user, smtp_pass, and require_transport_security. If email is not configured, password reset, registration and notifications via\\nemail will be disabled.","breadcrumbs":"Installation » Email","id":"13","title":"Email"},"130":{"body":"The enable_authenticated_media configuration option now defaults to true. This means that clients and remote (federated) homeservers now need to use\\nthe authenticated media endpoints in order to download media from your\\nhomeserver. As an exception, existing media that was stored on the server prior to\\nthis option changing to true will still be accessible over the\\nunauthenticated endpoints. The matrix.org homeserver has already been running with this option enabled\\nsince September 2024, so most common clients and homeservers should already\\nbe compatible. With that said, administrators who wish to disable this feature for broader\\ncompatibility can still do so by manually configuring enable_authenticated_media: False.","breadcrumbs":"Upgrading between Synapse Versions » Authenticated media is now enforced by default","id":"130","title":"Authenticated media is now enforced by default"},"131":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.119.0","id":"131","title":"Upgrading to v1.119.0"},"132":{"body":"The minimum supported Python version has been increased from v3.8 to v3.9.\\nYou will need Python 3.9+ to run Synapse v1.119.0 (due out Nov 7th, 2024). If you use current versions of the Matrix.org-distributed Docker images, no action is required.\\nPlease note that support for Ubuntu focal was dropped as well since it uses Python 3.8.","breadcrumbs":"Upgrading between Synapse Versions » Minimum supported Python version","id":"132","title":"Minimum supported Python version"},"133":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.111.0","id":"133","title":"Upgrading to v1.111.0"},"134":{"body":"Media repository workers handling\\nMedia APIs can now handle the following endpoint patterns: ^/_matrix/client/v1/media/.*$\\n^/_matrix/federation/v1/media/.*$ Please update your reverse proxy configuration.","breadcrumbs":"Upgrading between Synapse Versions » New worker endpoints for authenticated client and federation media","id":"134","title":"New worker endpoints for authenticated client and federation media"},"135":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.106.0","id":"135","title":"Upgrading to v1.106.0"},"136":{"body":"The minimum supported Rust version has been increased from v1.65.0 to v1.66.0.\\nUsers building from source will need to ensure their rustc version is up to\\ndate.","breadcrumbs":"Upgrading between Synapse Versions » Minimum supported Rust version","id":"136","title":"Minimum supported Rust version"},"137":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.100.0","id":"137","title":"Upgrading to v1.100.0"},"138":{"body":"The minimum supported Rust version has been increased from v1.61.0 to v1.65.0.\\nUsers building from source will need to ensure their rustc version is up to\\ndate.","breadcrumbs":"Upgrading between Synapse Versions » Minimum supported Rust version","id":"138","title":"Minimum supported Rust version"},"139":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.93.0","id":"139","title":"Upgrading to v1.93.0"},"14":{"body":"One way to create a new user is to do so from a client like Element. This requires registration to be enabled via\\nthe enable_registration\\nsetting. Alternatively, you can create new users from the command line. This can be done as follows: If synapse was installed via pip, activate the virtualenv as follows (if Synapse was\\ninstalled via a prebuilt package, register_new_matrix_user should already be\\non the search path): cd ~/synapse\\nsource env/bin/activate\\nsynctl start # if not already running Run the following command: register_new_matrix_user -c homeserver.yaml This will prompt you to add details for the new user, and will then connect to\\nthe running Synapse to create the new user. For example: New user localpart: erikj\\nPassword:\\nConfirm password:\\nMake admin [no]:\\nSuccess! This process uses a setting registration_shared_secret,\\nwhich is shared between Synapse itself and the register_new_matrix_user\\nscript. It doesn’t matter what it is (a random value is generated by --generate-config), but it should be kept secret, as anyone with knowledge of\\nit can register users, including admin accounts, on your server even if enable_registration is false.","breadcrumbs":"Installation » Registering a user","id":"14","title":"Registering a user"},"140":{"body":"The minimum supported Rust version has been increased from v1.60.0 to v1.61.0.\\nUsers building from source will need to ensure their rustc version is up to\\ndate.","breadcrumbs":"Upgrading between Synapse Versions » Minimum supported Rust version","id":"140","title":"Minimum supported Rust version"},"141":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.90.0","id":"141","title":"Upgrading to v1.90.0"},"142":{"body":"Synapse v1.81.0 deprecated application service authorization via query parameters as this is\\nconsidered insecure - and from Synapse v1.71.0 forwards the application service token has also been sent via the Authorization header], making the insecure\\nquery parameter authorization redundant. Since removing the ability to continue to use query parameters could break\\nbackwards compatibility it has now been put behind a configuration option, use_appservice_legacy_authorization.\\nThis option defaults to false, but can be activated by adding use_appservice_legacy_authorization: true to your configuration.","breadcrumbs":"Upgrading between Synapse Versions » App service query parameter authorization is now a configuration option","id":"142","title":"App service query parameter authorization is now a configuration option"},"143":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.89.0","id":"143","title":"Upgrading to v1.89.0"},"144":{"body":"Application services can no longer call /register with a user property to create new users.\\nThe standard username property should be used instead. See the Application Service specification\\nfor more information.","breadcrumbs":"Upgrading between Synapse Versions » Removal of unspecced user property for /register","id":"144","title":"Removal of unspecced user property for /register"},"145":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.88.0","id":"145","title":"Upgrading to v1.88.0"},"146":{"body":"The minimum supported Python version has been increased from v3.7 to v3.8.\\nYou will need Python 3.8 to run Synapse v1.88.0 (due out July 18th, 2023). If you use current versions of the Matrix.org-distributed Debian\\npackages or Docker images, no action is required.","breadcrumbs":"Upgrading between Synapse Versions » Minimum supported Python version","id":"146","title":"Minimum supported Python version"},"147":{"body":"As mentioned previously in Upgrading to v1.84.0, the following deprecated settings\\nare being removed in this release of Synapse: worker_replication_host worker_replication_http_port worker_replication_http_tls Please ensure that you have migrated to using main on your shared configuration’s instance_map\\n(or create one if necessary). This is required if you have any workers at all;\\nadministrators of single-process (monolith) installations don’t need to do anything. For an illustrative example, please see Upgrading to v1.84.0 below.","breadcrumbs":"Upgrading between Synapse Versions » Removal of worker_replication_* settings","id":"147","title":"Removal of worker_replication_* settings"},"148":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.86.0","id":"148","title":"Upgrading to v1.86.0"},"149":{"body":"The minimum supported Rust version has been increased from v1.58.1 to v1.60.0.\\nUsers building from source will need to ensure their rustc version is up to\\ndate.","breadcrumbs":"Upgrading between Synapse Versions » Minimum supported Rust version","id":"149","title":"Minimum supported Rust version"},"15":{"body":"For reliable VoIP calls to be routed via this homeserver, you MUST configure\\na TURN server. See TURN setup for details.","breadcrumbs":"Installation » Setting up a TURN server","id":"15","title":"Setting up a TURN server"},"150":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.85.0","id":"150","title":"Upgrading to v1.85.0"},"151":{"body":"Application services should ensure they call the /register endpoint with a username property. The legacy user property is considered deprecated and\\nshould no longer be included. A future version of Synapse (v1.88.0 or later) will remove support for legacy\\napplication service login.","breadcrumbs":"Upgrading between Synapse Versions » Application service registration with “user” property deprecation","id":"151","title":"Application service registration with “user” property deprecation"},"152":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.84.0","id":"152","title":"Upgrading to v1.84.0"},"153":{"body":"When using workers, worker_replication_host worker_replication_http_port worker_replication_http_tls should now be removed from individual worker YAML configurations and the main process should instead be added to the instance_map\\nin the shared YAML configuration, using the name main. The old worker_replication_* settings are now considered deprecated and are expected to be removed in Synapse v1.88.0.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of worker_replication_* configuration settings","id":"153","title":"Deprecation of worker_replication_* configuration settings"},"154":{"body":"Before: Shared YAML instance_map: generic_worker1: host: localhost port: 5678 tls: false Worker YAML worker_app: synapse.app.generic_worker\\nworker_name: generic_worker1 worker_replication_host: localhost\\nworker_replication_http_port: 3456\\nworker_replication_http_tls: false worker_listeners: - type: http port: 1234 resources: - names: [client, federation] - type: http port: 5678 resources: - names: [replication] worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml After: Shared YAML instance_map: main: host: localhost port: 3456 tls: false generic_worker1: host: localhost port: 5678 tls: false Worker YAML worker_app: synapse.app.generic_worker\\nworker_name: generic_worker1 worker_listeners: - type: http port: 1234 resources: - names: [client, federation] - type: http port: 5678 resources: - names: [replication] worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml Notes: tls is optional but mirrors the functionality of worker_replication_http_tls","breadcrumbs":"Upgrading between Synapse Versions » Example change","id":"154","title":"Example change"},"155":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.81.0","id":"155","title":"Upgrading to v1.81.0"},"156":{"body":"Synapse now attempts the versioned appservice paths before falling back to the legacy paths.\\nUsage of the legacy routes should be considered deprecated. Additionally, Synapse has supported sending the application service access token\\nvia the Authorization header\\nsince v1.70.0. For backwards compatibility it is also sent as the access_token\\nquery parameter. This is insecure and should be considered deprecated. A future version of Synapse (v1.88.0 or later) will remove support for legacy\\napplication service routes and query parameter authorization.","breadcrumbs":"Upgrading between Synapse Versions » Application service path & authentication deprecations","id":"156","title":"Application service path & authentication deprecations"},"157":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.80.0","id":"157","title":"Upgrading to v1.80.0"},"158":{"body":"Before this update, the POST /_matrix/client/v3/rooms/{roomId}/report/{eventId}\\nendpoint would return a 403 if a user attempted to report an event that they did not have access to.\\nThis endpoint will now return a 404 in this case instead. Clients that implement event reporting should check that their error handling code will handle this\\nchange.","breadcrumbs":"Upgrading between Synapse Versions » Reporting events error code change","id":"158","title":"Reporting events error code change"},"159":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.79.0","id":"159","title":"Upgrading to v1.79.0"},"16":{"body":"Synapse includes support for previewing URLs, which is disabled by default. To\\nturn it on you must enable the url_preview_enabled: True config parameter\\nand explicitly specify the IP ranges that Synapse is not allowed to spider for\\npreviewing in the url_preview_ip_range_blacklist configuration parameter.\\nThis is critical from a security perspective to stop arbitrary Matrix users\\nspidering ‘internal’ URLs on your network. At the very least we recommend that\\nyour loopback and RFC1918 IP addresses are blacklisted.","breadcrumbs":"Installation » URL previews","id":"16","title":"URL previews"},"160":{"body":"Synapse v1.79.0 deprecates the on_threepid_bind\\n“third-party rules” Synapse module callback method in favour of a new module method, on_add_user_third_party_identifier. on_threepid_bind will be removed in a future version of Synapse. You should check whether any Synapse\\nmodules in use in your deployment are making use of on_threepid_bind, and update them where possible. The arguments and functionality of the new method are the same. The justification behind the name change is that the old method’s name, on_threepid_bind, was\\nmisleading. A user is considered to “bind” their third-party ID to their Matrix ID only if they\\ndo so via an identity server\\n(so that users on other homeservers may find them). But this method was not called in that case -\\nit was only called when a user added a third-party identifier on the local homeserver. Module developers may also be interested in the related on_remove_user_third_party_identifier\\nmodule callback method that was also added in Synapse v1.79.0. This new method is called when a\\nuser removes a third-party identifier from their account.","breadcrumbs":"Upgrading between Synapse Versions » The on_threepid_bind module callback method has been deprecated","id":"160","title":"The on_threepid_bind module callback method has been deprecated"},"161":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.78.0","id":"161","title":"Upgrading to v1.78.0"},"162":{"body":"Synapse 1.78.0 replaces the /_synapse/admin/v1/media//delete\\nadmin API with an identical endpoint at /_synapse/admin/v1/media/delete. Please\\nupdate your tooling to use the new endpoint. The deprecated version will be removed\\nin a future release.","breadcrumbs":"Upgrading between Synapse Versions » Deprecate the /_synapse/admin/v1/media//delete admin API","id":"162","title":"Deprecate the /_synapse/admin/v1/media//delete admin API"},"163":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.76.0","id":"163","title":"Upgrading to v1.76.0"},"164":{"body":"When joining a room for the first time, Synapse 1.76.0 will request a partial join from the other server by default. Previously, server admins had to opt-in to this using an experimental config flag. Server admins can opt out of this feature for the time being by setting experimental: faster_joins: false in their server config.","breadcrumbs":"Upgrading between Synapse Versions » Faster joins are enabled by default","id":"164","title":"Faster joins are enabled by default"},"165":{"body":"Synapse has changed the format of the account data and devices replication\\nstreams (between workers). This is a forwards- and backwards-incompatible\\nchange: v1.75 workers cannot process account data replicated by v1.76 workers,\\nand vice versa. Once all workers are upgraded to v1.76 (or downgraded to v1.75), account data\\nand device replication will resume as normal.","breadcrumbs":"Upgrading between Synapse Versions » Changes to the account data replication streams","id":"165","title":"Changes to the account data replication streams"},"166":{"body":"The minimum supported version of Poetry is now 1.3.2 (previously 1.2.0, since\\nSynapse 1.67). If you have used poetry install to\\ninstall Synapse from a source checkout, you should upgrade poetry: see its installation instructions.\\nFor all other installation methods, no acction is required.","breadcrumbs":"Upgrading between Synapse Versions » Minimum version of Poetry is now 1.3.2","id":"166","title":"Minimum version of Poetry is now 1.3.2"},"167":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.74.0","id":"167","title":"Upgrading to v1.74.0"},"168":{"body":"This version introduces optional support for an improved user search dealing with Unicode characters. If you want to take advantage of this feature you need to install PyICU,\\nthe ICU native dependency and its development headers\\nso that PyICU can build since no prebuilt wheels are available. You can follow the PyICU documentation to do so,\\nand then do pip install matrix-synapse[user-search] for a PyPI install. Docker images and Debian packages need nothing specific as they already\\ninclude or specify ICU as an explicit dependency.","breadcrumbs":"Upgrading between Synapse Versions » Unicode support in user search","id":"168","title":"Unicode support in user search"},"169":{"body":"Synapse 1.74 queues a background update to rebuild the user directory,\\nin order to fix missing or erroneous entries. When this update begins, the user directory will be cleared out and rebuilt from\\nscratch. User directory lookups will be incomplete until the rebuild completes.\\nAdmins can monitor the rebuild’s progress by using the Background update Admin API.","breadcrumbs":"Upgrading between Synapse Versions » User directory rebuild","id":"169","title":"User directory rebuild"},"17":{"body":"Don’t forget to take backups of your new server!","breadcrumbs":"Installation » Backups","id":"17","title":"Backups"},"170":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.73.0","id":"170","title":"Upgrading to v1.73.0"},"171":{"body":"Synapse v1.69.0 included the deprecation of legacy Prometheus metric names\\nand offered an option to disable them.\\nSynapse v1.71.0 disabled legacy Prometheus metric names by default. This version, v1.73.0, removes those legacy Prometheus metric names entirely.\\nThis also means that the enable_legacy_metrics configuration option has been\\nremoved; it will no longer be possible to re-enable the legacy metric names. If you use metrics and have not yet updated your Grafana dashboard(s),\\nPrometheus console(s) or alerting rule(s), please consider doing so when upgrading\\nto this version.\\nNote that the included Grafana dashboard was updated in v1.72.0 to correct some\\nmetric names which were missed when legacy metrics were disabled by default. See v1.69.0: Deprecation of legacy Prometheus metric names\\nfor more context.","breadcrumbs":"Upgrading between Synapse Versions » Legacy Prometheus metric names have now been removed","id":"171","title":"Legacy Prometheus metric names have now been removed"},"172":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.72.0","id":"172","title":"Upgrading to v1.72.0"},"173":{"body":"In line with our deprecation policy, we’ve dropped\\nsupport for PostgreSQL 10, as it is no longer supported upstream. This release of Synapse requires PostgreSQL 11+.","breadcrumbs":"Upgrading between Synapse Versions » Dropping support for PostgreSQL 10","id":"173","title":"Dropping support for PostgreSQL 10"},"174":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.71.0","id":"174","title":"Upgrading to v1.71.0"},"175":{"body":"As announced with the release of Synapse 1.69.0, the deprecated generate_short_term_login_token module method has been removed. Modules relying on it can instead use the create_login_token method.","breadcrumbs":"Upgrading between Synapse Versions » Removal of the generate_short_term_login_token module API method","id":"175","title":"Removal of the generate_short_term_login_token module API method"},"176":{"body":"To align with spec (changed in MSC3905), Synapse now\\nonly considers local users to be interesting. In other words, the users namespace\\nregex is only be applied against local users of the homeserver. Please note, this probably doesn’t affect the expected behavior of your application\\nservice, since an interesting local user in a room still means all messages in the room\\n(from local or remote users) will still be considered interesting. And matching a room\\nwith the rooms or aliases namespace regex will still consider all events sent in the\\nroom to be interesting to the application service. If one of your application service’s users regex was intending to match a remote user,\\nthis will no longer match as you expect. The behavioral mismatch between matching all\\nlocal users and some remote users is why the spec was changed/clarified and this\\ncaveat is no longer supported.","breadcrumbs":"Upgrading between Synapse Versions » Changes to the events received by application services (interest)","id":"176","title":"Changes to the events received by application services (interest)"},"177":{"body":"Synapse v1.71.0 disables legacy Prometheus metric names by default.\\nFor administrators that still rely on them and have not yet had chance to update their\\nuses of the metrics, it’s still possible to specify enable_legacy_metrics: true in\\nthe configuration to re-enable them temporarily. Synapse v1.73.0 will remove legacy metric names altogether and at that point,\\nit will no longer be possible to re-enable them. If you do not use metrics or you have already updated your Grafana dashboard(s),\\nPrometheus console(s) and alerting rule(s), there is no action needed. See v1.69.0: Deprecation of legacy Prometheus metric names.","breadcrumbs":"Upgrading between Synapse Versions » Legacy Prometheus metric names are now disabled by default","id":"177","title":"Legacy Prometheus metric names are now disabled by default"},"178":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.69.0","id":"178","title":"Upgrading to v1.69.0"},"179":{"body":"Synapse now includes information indicating if a receipt applies to a thread when\\nreplicating it to other workers. This is a forwards- and backwards-incompatible\\nchange: v1.68 and workers cannot process receipts replicated by v1.69 workers, and\\nvice versa. Once all workers are upgraded to v1.69 (or downgraded to v1.68), receipts\\nreplication will resume as normal.","breadcrumbs":"Upgrading between Synapse Versions » Changes to the receipts replication streams","id":"179","title":"Changes to the receipts replication streams"},"18":{"body":"pip seems to leak lots of memory during installation. For instance, a Linux\\nhost with 512MB of RAM may run out of memory whilst installing Twisted. If this\\nhappens, you will have to individually install the dependencies which are\\nfailing, e.g.: pip install twisted If you have any other problems, feel free to ask in #synapse:matrix.org.","breadcrumbs":"Installation » Troubleshooting Installation","id":"18","title":"Troubleshooting Installation"},"180":{"body":"In current versions of Synapse, some Prometheus metrics are emitted under two different names,\\nwith one of the names being older but non-compliant with OpenMetrics and Prometheus conventions\\nand one of the names being newer but compliant. Synapse v1.71.0 will turn the old metric names off by default.\\nFor administrators that still rely on them and have not had chance to update their\\nuses of the metrics, it’s possible to specify enable_legacy_metrics: true in\\nthe configuration to re-enable them temporarily. Synapse v1.73.0 will remove legacy metric names altogether and it will no longer\\nbe possible to re-enable them. The Grafana dashboard, Prometheus recording rules and Prometheus Consoles included\\nin the contrib directory in the Synapse repository have been updated to no longer\\nrely on the legacy names. These can be used on a current version of Synapse\\nbecause current versions of Synapse emit both old and new names. You may need to update your alerting rules or any other rules that depend on\\nthe names of Prometheus metrics.\\nIf you want to test your changes before legacy names are disabled by default,\\nyou may specify enable_legacy_metrics: false in your homeserver configuration. A list of affected metrics is available on the Metrics How-to page.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of legacy Prometheus metric names","id":"180","title":"Deprecation of legacy Prometheus metric names"},"181":{"body":"The following method of the module API has been deprecated, and is scheduled to\\nbe remove in v1.71.0: def generate_short_term_login_token( self, user_id: str, duration_in_ms: int = (2 * 60 * 1000), auth_provider_id: str = \\"\\", auth_provider_session_id: Optional[str] = None,\\n) -> str: ... It has been replaced by an asynchronous equivalent: async def create_login_token( self, user_id: str, duration_in_ms: int = (2 * 60 * 1000), auth_provider_id: Optional[str] = None, auth_provider_session_id: Optional[str] = None,\\n) -> str: ... Synapse will log a warning when a module uses the deprecated method, to help\\nadministrators find modules using it.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of the generate_short_term_login_token module API method","id":"181","title":"Deprecation of the generate_short_term_login_token module API method"},"182":{"body":"Two changes announced in the upgrade notes for v1.67.0 have now landed in v1.68.0.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.68.0","id":"182","title":"Upgrading to v1.68.0"},"183":{"body":"Synapse now requires a SQLite version of 3.27.0 or higher if SQLite is configured as\\nSynapse’s database. Installations using Docker images from matrixdotorg, Debian packages from Matrix.org, or a PostgreSQL database are not affected.","breadcrumbs":"Upgrading between Synapse Versions » SQLite version requirement","id":"183","title":"SQLite version requirement"},"184":{"body":"Building from a source checkout of Synapse now requires a recent Rust compiler\\n(currently Rust 1.58.1, but see also the Platform Dependency Policy). Installations using Docker images from matrixdotorg, Debian packages from Matrix.org, or PyPI wheels via pip install matrix-synapse (on supported platforms and architectures) will not be affected.","breadcrumbs":"Upgrading between Synapse Versions » Rust requirement when building from source.","id":"184","title":"Rust requirement when building from source."},"185":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.67.0","id":"185","title":"Upgrading to v1.67.0"},"186":{"body":"Redis support was added in v1.13.0 with it becoming the recommended method in\\nv1.18.0. It replaced the old direct TCP connections (which was deprecated as of\\nv1.18.0) to the main process. With Redis, rather than all the workers connecting\\nto the main process, all the workers and the main process connect to Redis,\\nwhich relays replication commands between processes. This can give a significant\\nCPU saving on the main process and is a prerequisite for upcoming\\nperformance improvements. To migrate to Redis add the redis config,\\nand remove the TCP replication listener from config of the master and worker_replication_port from worker config. Note that a HTTP listener with a replication resource is still required.","breadcrumbs":"Upgrading between Synapse Versions » Direct TCP replication is no longer supported: migrate to Redis","id":"186","title":"Direct TCP replication is no longer supported: migrate to Redis"},"187":{"body":"The minimum supported version of poetry is now 1.2. This should only affect\\nthose installing from a source checkout.","breadcrumbs":"Upgrading between Synapse Versions » Minimum version of Poetry is now v1.2.0","id":"187","title":"Minimum version of Poetry is now v1.2.0"},"188":{"body":"From the next major release (v1.68.0) installing Synapse from a source checkout\\nwill require a recent Rust compiler. Those using packages or pip install matrix-synapse will not be affected. The simplest way of installing Rust is via rustup.rs","breadcrumbs":"Upgrading between Synapse Versions » Rust requirement in the next release","id":"188","title":"Rust requirement in the next release"},"189":{"body":"From the next major release (v1.68.0) Synapse will require SQLite 3.27.0 or\\nhigher. Synapse v1.67.0 will be the last major release supporting SQLite\\nversions 3.22 to 3.26. Those using Docker images or Debian packages from Matrix.org will not be\\naffected. If you have installed from source, you should check the version of\\nSQLite used by Python with: python -c \\"import sqlite3; print(sqlite3.sqlite_version)\\" If this is too old, refer to your distribution for advice on upgrading.","breadcrumbs":"Upgrading between Synapse Versions » SQLite version requirement in the next release","id":"189","title":"SQLite version requirement in the next release"},"19":{"body":"This page lays out security best-practices when running Synapse. If you believe you have encountered a security issue, see our Security\\nDisclosure Policy.","breadcrumbs":"Security » Security","id":"19","title":"Security"},"190":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.66.0","id":"190","title":"Upgrading to v1.66.0"},"191":{"body":"As of this version, Synapse no longer allows the tasks of verifying email address\\nownership, and password reset confirmation, to be delegated to an identity server.\\nThis removal was previously planned for Synapse 1.64.0, but was delayed until now to give\\nhomeserver administrators more notice of the change. To continue to allow users to add email addresses to their homeserver accounts,\\nand perform password resets, make sure that Synapse is configured with a working\\nemail server in the email configuration\\nsection\\n(including, at a minimum, a notif_from setting.) Specifying an email setting under account_threepid_delegates will now cause\\nan error at startup.","breadcrumbs":"Upgrading between Synapse Versions » Delegation of email validation no longer supported","id":"191","title":"Delegation of email validation no longer supported"},"192":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.64.0","id":"192","title":"Upgrading to v1.64.0"},"193":{"body":"Synapse v1.66.0 will remove the ability to delegate the tasks of verifying email address ownership, and password reset confirmation, to an identity server. If you require your homeserver to verify e-mail addresses or to support password resets via e-mail, please configure your homeserver with SMTP access so that it can send e-mails on its own behalf. Consult the configuration documentation for more information. The option that will be removed is account_threepid_delegates.email.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of the ability to delegate e-mail verification to identity servers","id":"193","title":"Deprecation of the ability to delegate e-mail verification to identity servers"},"194":{"body":"Synapse now includes a flag indicating if an event is an outlier when\\nreplicating it to other workers. This is a forwards- and backwards-incompatible\\nchange: v1.63 and workers cannot process events replicated by v1.64 workers, and\\nvice versa. Once all workers are upgraded to v1.64 (or downgraded to v1.63), event\\nreplication will resume as normal.","breadcrumbs":"Upgrading between Synapse Versions » Changes to the event replication streams","id":"194","title":"Changes to the event replication streams"},"195":{"body":"frozendict 2.3.3\\nhas recently been released, which fixes a memory leak that occurs during /sync\\nrequests. We advise server administrators who installed Synapse via pip to upgrade\\nfrozendict with pip install --upgrade frozendict. The Docker image matrixdotorg/synapse and the Debian packages from packages.matrix.org already\\ninclude the updated library.","breadcrumbs":"Upgrading between Synapse Versions » frozendict release","id":"195","title":"frozendict release"},"196":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.62.0","id":"196","title":"Upgrading to v1.62.0"},"197":{"body":"As a followup to changes in v1.60.0, the following spam-checker callbacks have changed signature: user_may_join_room user_may_invite user_may_send_3pid_invite user_may_create_room user_may_create_room_alias user_may_publish_room check_media_file_for_spam For each of these methods, the previous callback signature has been deprecated. Whereas callbacks used to return bool, they should now return Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\"]. For instance, if your module implements user_may_join_room as follows: async def user_may_join_room(self, user_id: str, room_id: str, is_invited: bool) if ...: # Request is spam return False # Request is not spam return True you should rewrite it as follows: async def user_may_join_room(self, user_id: str, room_id: str, is_invited: bool) if ...: # Request is spam, mark it as forbidden (you may use some more precise error # code if it is useful). return synapse.module_api.errors.Codes.FORBIDDEN # Request is not spam, mark it as such. return synapse.module_api.NOT_SPAM","breadcrumbs":"Upgrading between Synapse Versions » New signatures for spam checker callbacks","id":"197","title":"New signatures for spam checker callbacks"},"198":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.61.0","id":"198","title":"Upgrading to v1.61.0"},"199":{"body":"This release of Synapse will remove deprecated community/groups from codebase.","breadcrumbs":"Upgrading between Synapse Versions » Removal of deprecated community/groups","id":"199","title":"Removal of deprecated community/groups"},"2":{"body":"Contributions are welcome! Synapse is primarily written in Python. As a developer, you may be interested in the\\nfollowing documentation: Read the Contributing Guide. It is meant\\nto walk new contributors through the process of developing and submitting a\\nchange to the Synapse codebase (which is hosted on\\nGitHub). Set up your development\\nenvironment, then learn\\nhow to lint and test your code. Look at the issue tracker for\\nbugs to fix or features to add. If you’re new, it may be best to start with\\nthose labeled good first\\nissue. Understand how Synapse is\\nbuilt, how to migrate\\ndatabase schemas, learn about federation and how to set up a local\\nfederation for development. We like to keep our git history clean. Learn how to\\ndo so! And finally, contribute to this documentation! The source for which is located here.","breadcrumbs":"Welcome and Overview » Developing on Synapse","id":"2","title":"Developing on Synapse"},"20":{"body":"Matrix serves raw, user-supplied data in some APIs — specifically the content\\nrepository endpoints. Whilst we make a reasonable effort to mitigate against XSS attacks (for\\ninstance, by using CSP), a\\nMatrix homeserver should not be hosted on a domain hosting other web\\napplications. This especially applies to sharing the domain with Matrix web\\nclients and other sensitive applications like webmail. See\\nhttps://developer.github.com/changes/2014-04-25-user-content-security for more\\ninformation. Ideally, the homeserver should not simply be on a different subdomain, but on a\\ncompletely different registered\\ndomain\\n(also known as top-level site or eTLD+1). This is because some\\nattacks\\nare still possible as long as the two applications share the same registered\\ndomain. To illustrate this with an example, if your Element Web or other sensitive web\\napplication is hosted on A.example1.com, you should ideally host Synapse on example2.com. Some amount of protection is offered by hosting on B.example1.com instead, so this is also acceptable in some scenarios.\\nHowever, you should not host your Synapse on A.example1.com. Note that all of the above refers exclusively to the domain used in Synapse’s public_baseurl setting. In particular, it has no bearing on the domain\\nmentioned in MXIDs hosted on that server. Following this advice ensures that even if an XSS is found in Synapse, the\\nimpact to other applications will be minimal.","breadcrumbs":"Security » Content repository","id":"20","title":"Content repository"},"200":{"body":"For those who have deployed workers, following worker endpoints will no longer\\nexist and they can be removed from the reverse proxy configuration: ^/_matrix/federation/v1/get_groups_publicised$ ^/_matrix/client/(r0|v3|unstable)/joined_groups$ ^/_matrix/client/(r0|v3|unstable)/publicised_groups$ ^/_matrix/client/(r0|v3|unstable)/publicised_groups/ ^/_matrix/federation/v1/groups/ ^/_matrix/client/(r0|v3|unstable)/groups/","breadcrumbs":"Upgrading between Synapse Versions » Worker endpoints","id":"200","title":"Worker endpoints"},"201":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.60.0","id":"201","title":"Upgrading to v1.60.0"},"202":{"body":"This release of Synapse will add a unique index to the state_group_edges table, in order\\nto prevent accidentally introducing duplicate information (for example, because a database\\nbackup was restored multiple times). Duplicate rows being present in this table could cause drastic performance problems; see issue 11779 for more details. If your Synapse database already has had duplicate rows introduced into this table,\\nthis could fail, with either of these errors: On Postgres: synapse.storage.background_updates - 623 - INFO - background_updates-0 - Adding index state_group_edges_unique_idx to state_group_edges\\nsynapse.storage.background_updates - 282 - ERROR - background_updates-0 - Error doing update\\n...\\npsycopg2.errors.UniqueViolation: could not create unique index \\"state_group_edges_unique_idx\\"\\nDETAIL: Key (state_group, prev_state_group)=(2, 1) is duplicated. (The numbers may be different.) On SQLite: synapse.storage.background_updates - 623 - INFO - background_updates-0 - Adding index state_group_edges_unique_idx to state_group_edges\\nsynapse.storage.background_updates - 282 - ERROR - background_updates-0 - Error doing update\\n...\\nsqlite3.IntegrityError: UNIQUE constraint failed: state_group_edges.state_group, state_group_edges.prev_state_group Expand this section for steps to resolve this problem","breadcrumbs":"Upgrading between Synapse Versions » Adding a new unique index to state_group_edges could fail if your database is corrupted","id":"202","title":"Adding a new unique index to state_group_edges could fail if your database is corrupted"},"203":{"body":"Connect to your database with psql. BEGIN;\\nDELETE FROM state_group_edges WHERE (ctid, state_group, prev_state_group) IN ( SELECT row_id, state_group, prev_state_group FROM ( SELECT ctid AS row_id, MIN(ctid) OVER (PARTITION BY state_group, prev_state_group) AS min_row_id, state_group, prev_state_group FROM state_group_edges ) AS t1 WHERE row_id <> min_row_id\\n);\\nCOMMIT;","breadcrumbs":"Upgrading between Synapse Versions » On Postgres","id":"203","title":"On Postgres"},"204":{"body":"At the command-line, use sqlite3 path/to/your-homeserver-database.db: BEGIN;\\nDELETE FROM state_group_edges WHERE (rowid, state_group, prev_state_group) IN ( SELECT row_id, state_group, prev_state_group FROM ( SELECT rowid AS row_id, MIN(rowid) OVER (PARTITION BY state_group, prev_state_group) AS min_row_id, state_group, prev_state_group FROM state_group_edges ) WHERE row_id <> min_row_id\\n);\\nCOMMIT;","breadcrumbs":"Upgrading between Synapse Versions » On SQLite","id":"204","title":"On SQLite"},"205":{"body":"This comment on issue 11779\\nhas queries that can be used to check a database for this problem in advance.","breadcrumbs":"Upgrading between Synapse Versions » For more details","id":"205","title":"For more details"},"206":{"body":"The previous signature has been deprecated. Whereas check_event_for_spam callbacks used to return Union[str, bool], they should now return Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\"]. This is part of an ongoing refactoring of the SpamChecker API to make it less ambiguous and more powerful. If your module implements check_event_for_spam as follows: async def check_event_for_spam(event): if ...: # Event is spam return True # Event is not spam return False you should rewrite it as follows: async def check_event_for_spam(event): if ...: # Event is spam, mark it as forbidden (you may use some more precise error # code if it is useful). return synapse.module_api.errors.Codes.FORBIDDEN # Event is not spam, mark it as such. return synapse.module_api.NOT_SPAM","breadcrumbs":"Upgrading between Synapse Versions » New signature for the spam checker callback check_event_for_spam","id":"206","title":"New signature for the spam checker callback check_event_for_spam"},"207":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.59.0","id":"207","title":"Upgrading to v1.59.0"},"208":{"body":"The names of user devices are no longer visible to users on other homeservers by default.\\nDevice IDs are unaffected, as these are necessary to facilitate end-to-end encryption. To re-enable this functionality, set the allow_device_name_lookup_over_federation\\nhomeserver config option to true.","breadcrumbs":"Upgrading between Synapse Versions » Device name lookup over federation has been disabled by default","id":"208","title":"Device name lookup over federation has been disabled by default"},"209":{"body":"The synapse.app.appservice worker application type allowed you to configure a\\nsingle worker to use to notify application services of new events, as long\\nas this functionality was disabled on the main process with notify_appservices: False.\\nFurther, the synapse.app.user_dir worker application type allowed you to configure\\na single worker to be responsible for updating the user directory, as long as this\\nwas disabled on the main process with update_user_directory: False. To unify Synapse’s worker types, the synapse.app.appservice worker application\\ntype and the notify_appservices configuration option have been deprecated.\\nThe synapse.app.user_dir worker application type and update_user_directory\\nconfiguration option have also been deprecated. To get the same functionality as was provided by the deprecated options, it’s now recommended that the synapse.app.generic_worker\\nworker application type is used and that the notify_appservices_from_worker and/or update_user_directory_from_worker options are set to the name of a worker. For the time being, the old options can be used alongside the new options to make\\nit easier to transition between the two configurations, however please note that: the options must not contradict each other (otherwise Synapse won’t start); and the notify_appservices and update_user_directory options will be removed in a future release of Synapse. Please see the Notifying Application Services and Updating the User Directory sections of the worker\\ndocumentation for more information.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of the synapse.app.appservice and synapse.app.user_dir worker application types","id":"209","title":"Deprecation of the synapse.app.appservice and synapse.app.user_dir worker application types"},"21":{"body":"If your Matrix server is secured by a firewall, firewall rules for two different purposes are required. Client access to a Synapse server runs via the client port which is TCP port 443 by default. The client port has to be allowed inbound. Federation to exchange messages with other Matrix servers runs via TCP port 8448 by default or alternatively via regular HTTPS TCP port 443 (usually if run with delegation and/or behind a reverse proxy). So to allow federation in a firewall, make sure to allow the federation port of your Synapse server inbound. If you have outbound access limited by a firewall allowlist, make sure both TCP ports 443 and 8448 are allowed outbound. Direction Port Protocol Description Inbound 443 TCP Client access Inbound 8448 and/or 443 TCP Federation inbound, depending on the federation port used Outbound 8448 and 443 TCP Federation outbound, both ports are usually used","breadcrumbs":"Security » Firewall configuration","id":"21","title":"Firewall configuration"},"210":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.58.0","id":"210","title":"Upgrading to v1.58.0"},"211":{"body":"The non-standard groups/communities feature in Synapse has been disabled by default\\nand will be removed in Synapse v1.61.0.","breadcrumbs":"Upgrading between Synapse Versions » Groups/communities feature has been disabled by default","id":"211","title":"Groups/communities feature has been disabled by default"},"212":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.57.0","id":"212","title":"Upgrading to v1.57.0"},"213":{"body":"Synapse v1.57.0 includes a change to the\\nway transaction IDs are managed for application services. If your deployment uses a dedicated\\nworker for application service traffic, it must be stopped when the database is upgraded\\n(which normally happens when the main process is upgraded), to ensure the change is made safely\\nwithout any risk of reusing transaction IDs. Deployments which do not use separate worker processes can be upgraded as normal. Similarly,\\ndeployments where no application services are in use can be upgraded as normal. Recovering from an incorrect upgrade If the database schema is upgraded without stopping the worker responsible\\nfor AS traffic, then the following error may be given when attempting to start\\na Synapse worker or master process: ********************************************************************************** Error during initialisation: Postgres sequence \'application_services_txn_id_seq\' is inconsistent with associated table \'application_services_txns\'. This can happen if Synapse has been downgraded and then upgraded again, or due to a bad migration. To fix this error, shut down Synapse (including any and all workers) and run the following SQL: SELECT setval(\'application_services_txn_id_seq\', ( SELECT GREATEST(MAX(txn_id), 0) FROM application_services_txns )); See docs/postgres.md for more information. There may be more information in the logs.\\n********************************************************************************** This error may also be seen if Synapse is downgraded to an earlier version,\\nand then upgraded again to v1.57.0 or later. In either case: Ensure that the worker responsible for AS traffic is stopped. Run the SQL command given in the error message via psql. Synapse should then start correctly.","breadcrumbs":"Upgrading between Synapse Versions » Changes to database schema for application services","id":"213","title":"Changes to database schema for application services"},"214":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.56.0","id":"214","title":"Upgrading to v1.56.0"},"215":{"body":"Synapse will refuse to start if registration is enabled without email, captcha, or token-based verification unless the new config\\nflag enable_registration_without_verification is set to “true”.","breadcrumbs":"Upgrading between Synapse Versions » Open registration without verification is now disabled by default","id":"215","title":"Open registration without verification is now disabled by default"},"216":{"body":"The non-standard groups/communities feature in Synapse has been deprecated and will\\nbe disabled by default in Synapse v1.58.0. You can test disabling it by adding the following to your homeserver configuration: experimental_features: groups_enabled: false","breadcrumbs":"Upgrading between Synapse Versions » Groups/communities feature has been deprecated","id":"216","title":"Groups/communities feature has been deprecated"},"217":{"body":"Synapse now refuses to start when using PostgreSQL with non- C values for COLLATE and CTYPE unless the config flag allow_unsafe_locale, found in the database section of\\nthe configuration file, is set to true. See the PostgreSQL documentation\\nfor more information and instructions on how to fix a database with incorrect values.","breadcrumbs":"Upgrading between Synapse Versions » Change in behaviour for PostgreSQL databases with unsafe locale","id":"217","title":"Change in behaviour for PostgreSQL databases with unsafe locale"},"218":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.55.0","id":"218","title":"Upgrading to v1.55.0"},"219":{"body":"The synctl script has been made an entry point\\nand no longer exists at the root of Synapse’s source tree. If you wish to use synctl to manage your homeserver, you should invoke synctl directly, e.g. synctl start instead of ./synctl start or /path/to/synctl start. You will need to ensure synctl is on your PATH. This is automatically the case when using Debian packages or docker images\\nprovided by Matrix.org. When installing from a wheel, sdist, or PyPI, a synctl executable is added\\nto your Python installation’s bin. This should be on your PATH\\nautomatically, though you might need to activate a virtual environment\\ndepending on how you installed Synapse.","breadcrumbs":"Upgrading between Synapse Versions » synctl script has been moved","id":"219","title":"synctl script has been moved"},"22":{"body":"The minimum supported version of PostgreSQL is determined by the Dependency\\nDeprecation Policy.","breadcrumbs":"Using Postgres » Using Postgres","id":"22","title":"Using Postgres"},"220":{"body":"Synapse v1.55.0 drops support for Mjolnir 1.3.1 and earlier.\\nIf you use the Mjolnir module to moderate your homeserver,\\nplease upgrade Mjolnir to version 1.3.2 or later before upgrading Synapse.","breadcrumbs":"Upgrading between Synapse Versions » Compatibility dropped for Mjolnir 1.3.1 and earlier","id":"220","title":"Compatibility dropped for Mjolnir 1.3.1 and earlier"},"221":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.54.0","id":"221","title":"Upgrading to v1.54.0"},"222":{"body":"This release removes support for the structured: true logging configuration\\nwhich was deprecated in Synapse v1.23.0. If your logging configuration contains structured: true then it should be modified based on the structured logging documentation.","breadcrumbs":"Upgrading between Synapse Versions » Legacy structured logging configuration removal","id":"222","title":"Legacy structured logging configuration removal"},"223":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.53.0","id":"223","title":"Upgrading to v1.53.0"},"224":{"body":"Per the deprecation notice in Synapse v1.51.0, listeners of type webclient\\nare no longer supported and configuring them is a now a configuration error. Configuring a non-HTTP(S) web_client_location configuration is is now a\\nconfiguration error. Since the webclient listener is no longer supported, this\\nsetting only applies to the root path / of Synapse’s web server and no longer\\nthe /_matrix/client/ path.","breadcrumbs":"Upgrading between Synapse Versions » Dropping support for webclient listeners and non-HTTP(S) web_client_location","id":"224","title":"Dropping support for webclient listeners and non-HTTP(S) web_client_location"},"225":{"body":"The unstable validity-check endpoint for the Registration Tokens\\nfeature has been stabilised and moved from: /_matrix/client/unstable/org.matrix.msc3231/register/org.matrix.msc3231.login.registration_token/validity to: /_matrix/client/v1/register/m.login.registration_token/validity Please update any relevant reverse proxy or firewall configurations appropriately.","breadcrumbs":"Upgrading between Synapse Versions » Stablisation of MSC3231","id":"225","title":"Stablisation of MSC3231"},"226":{"body":"Formerly, entries in the cache were not evicted regardless of whether they were accessed after storing.\\nThis behavior has now changed. By default entries in the cache are now evicted after 30m of not being accessed.\\nTo change the default behavior, go to the caches section of the config and change the expire_caches and cache_entry_ttl flags as necessary. Please note that these flags replace the expiry_time flag in the config.\\nThe expiry_time flag will still continue to work, but it has been deprecated and will be removed in the future.","breadcrumbs":"Upgrading between Synapse Versions » Time-based cache expiry is now enabled by default","id":"226","title":"Time-based cache expiry is now enabled by default"},"227":{"body":"The capabilities of MSC3283 from the REST API /_matrix/client/r0/capabilities\\nbecomes stable. The old capabilities org.matrix.msc3283.set_displayname, org.matrix.msc3283.set_avatar_url and org.matrix.msc3283.3pid_changes are deprecated and scheduled to be removed in Synapse v1.54.0. The new capabilities m.set_displayname, m.set_avatar_url and m.3pid_changes are now active by default.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of capability org.matrix.msc3283.*","id":"227","title":"Deprecation of capability org.matrix.msc3283.*"},"228":{"body":"As announced with the release of Synapse 1.47.0,\\nthe deprecated user_may_create_room_with_invites module callback has been removed. Modules relying on it can instead implement user_may_invite\\nand use the get_room_state\\nmodule API to infer whether the invite is happening while creating a room (see this function\\nas an example). Alternately, modules can also implement on_create_room.","breadcrumbs":"Upgrading between Synapse Versions » Removal of user_may_create_room_with_invites","id":"228","title":"Removal of user_may_create_room_with_invites"},"229":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.52.0","id":"229","title":"Upgrading to v1.52.0"},"23":{"body":"Synapse will require the python postgres client library in order to\\nconnect to a postgres database. If you are using the matrix.org debian/ubuntu\\npackages, the necessary python\\nlibrary will already be installed, but you will need to ensure the\\nlow-level postgres library is installed, which you can do with apt install libpq5. For other pre-built packages, please consult the documentation from\\nthe relevant package. If you installed synapse in a\\nvirtualenv, you can install\\nthe library with: ~/synapse/env/bin/pip install \\"matrix-synapse[postgres]\\" (substituting the path to your virtualenv for ~/synapse/env, if\\nyou used a different path). You will require the postgres\\ndevelopment files. These are in the libpq-dev package on\\nDebian-derived distributions.","breadcrumbs":"Using Postgres » Install postgres client libraries","id":"23","title":"Install postgres client libraries"},"230":{"body":"Note that Twisted 22.1.0\\nhas recently been released, which fixes a security issue\\nwithin the Twisted library. We do not believe Synapse is affected by this vulnerability,\\nthough we advise server administrators who installed Synapse via pip to upgrade Twisted\\nwith pip install --upgrade Twisted treq as a matter of good practice. The Docker image matrixdotorg/synapse and the Debian packages from packages.matrix.org are using the\\nupdated library.","breadcrumbs":"Upgrading between Synapse Versions » Twisted security release","id":"230","title":"Twisted security release"},"231":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.51.0","id":"231","title":"Upgrading to v1.51.0"},"232":{"body":"Listeners of type webclient are deprecated and scheduled to be removed in\\nSynapse v1.53.0. Similarly, a non-HTTP(S) web_client_location configuration is deprecated and\\nwill become a configuration error in Synapse v1.53.0.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of webclient listeners and non-HTTP(S) web_client_location","id":"232","title":"Deprecation of webclient listeners and non-HTTP(S) web_client_location"},"233":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.50.0","id":"233","title":"Upgrading to v1.50.0"},"234":{"body":"In line with our deprecation policy,\\nwe’ve dropped support for Python 3.6 and PostgreSQL 9.6, as they are no\\nlonger supported upstream. This release of Synapse requires Python 3.7+ and PostgreSQL 10+.","breadcrumbs":"Upgrading between Synapse Versions » Dropping support for old Python and Postgres versions","id":"234","title":"Dropping support for old Python and Postgres versions"},"235":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.47.0","id":"235","title":"Upgrading to v1.47.0"},"236":{"body":"The following admin APIs were deprecated in Synapse 1.34\\n(released on 2021-05-17) and have now been removed: POST /_synapse/admin/v1//delete Any scripts still using the above APIs should be converted to use the Delete Room API.","breadcrumbs":"Upgrading between Synapse Versions » Removal of old Room Admin API","id":"236","title":"Removal of old Room Admin API"},"237":{"body":"The user_may_create_room_with_invites is deprecated and will be removed in a future\\nversion of Synapse. Modules implementing this callback can instead implement user_may_invite\\nand use the get_room_state\\nmodule API method to infer whether the invite is happening in the context of creating a\\nroom. We plan to remove this callback in January 2022.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of the user_may_create_room_with_invites module callback","id":"237","title":"Deprecation of the user_may_create_room_with_invites module callback"},"238":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.45.0","id":"238","title":"Upgrading to v1.45.0"},"239":{"body":"Media storage provider modules that read from the Synapse configuration object (i.e. that\\nread the value of hs.config.[...]) now need to specify the configuration section they’re\\nreading from. This means that if a module reads the value of e.g. hs.config.media_store_path,\\nit needs to replace it with hs.config.media.media_store_path.","breadcrumbs":"Upgrading between Synapse Versions » Changes required to media storage provider modules when reading from the Synapse configuration object","id":"239","title":"Changes required to media storage provider modules when reading from the Synapse configuration object"},"24":{"body":"Assuming your PostgreSQL database user is called postgres, first authenticate as the database user with: su - postgres\\n# Or, if your system uses sudo to get administrative rights\\nsudo -u postgres bash Then, create a postgres user and a database with: # this will prompt for a password for the new user\\ncreateuser --pwprompt synapse_user createdb --encoding=UTF8 --locale=C --template=template0 --owner=synapse_user synapse The above will create a user called synapse_user, and a database called synapse. Note that the PostgreSQL database must have the correct encoding set\\n(as shown above), otherwise it will not be able to store UTF8 strings. You may need to enable password authentication so synapse_user can\\nconnect to the database. See https://www.postgresql.org/docs/current/auth-pg-hba-conf.html.","breadcrumbs":"Using Postgres » Set up database","id":"24","title":"Set up database"},"240":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.44.0","id":"240","title":"Upgrading to v1.44.0"},"241":{"body":"The url_cache/ and url_cache_thumbnails/ directories in the media store are\\nno longer mirrored to storage providers. These two directories can be safely\\ndeleted from any configured storage providers to reclaim space.","breadcrumbs":"Upgrading between Synapse Versions » The URL preview cache is no longer mirrored to storage providers","id":"241","title":"The URL preview cache is no longer mirrored to storage providers"},"242":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.43.0","id":"242","title":"Upgrading to v1.43.0"},"243":{"body":"The available worker applications documentation\\nhas been updated to reflect that calls to the /spaces, /hierarchy, and /summary endpoints can now be routed to workers for both client API and\\nfederation requests.","breadcrumbs":"Upgrading between Synapse Versions » The spaces summary APIs can now be handled by workers","id":"243","title":"The spaces summary APIs can now be handled by workers"},"244":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.42.0","id":"244","title":"Upgrading to v1.42.0"},"245":{"body":"The following admin APIs were deprecated in Synapse 1.25\\n(released on 2021-01-13) and have now been removed: POST /_synapse/admin/v1/purge_room POST /_synapse/admin/v1/shutdown_room/ Any scripts still using the above APIs should be converted to use the Delete Room API.","breadcrumbs":"Upgrading between Synapse Versions » Removal of old Room Admin API","id":"245","title":"Removal of old Room Admin API"},"246":{"body":"This may affect you if you make use of custom HTML templates for the reCAPTCHA ( synapse/res/templates/recaptcha.html) or terms ( synapse/res/templates/terms.html) fallback pages. The template is now provided an error variable if the authentication\\nprocess failed. See the default templates linked above for an example.","breadcrumbs":"Upgrading between Synapse Versions » User-interactive authentication fallback templates can now display errors","id":"246","title":"User-interactive authentication fallback templates can now display errors"},"247":{"body":"Users will stop receiving message updates via email for addresses that were\\nonce, but not still, linked to their account.","breadcrumbs":"Upgrading between Synapse Versions » Removal of out-of-date email pushers","id":"247","title":"Removal of out-of-date email pushers"},"248":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.41.0","id":"248","title":"Upgrading to v1.41.0"},"249":{"body":"Since Synapse 1.6.0 (2019-11-26) you can set a proxy for outbound HTTP requests via\\nhttp_proxy/https_proxy environment variables. This proxy was set for: push url previews phone-home stats recaptcha validation CAS auth validation OpenID Connect Federation (checking public key revocation) In this version we have added support for outbound requests for: Outbound federation Downloading remote media Fetching public keys of other servers These requests use the same proxy configuration. If you have a proxy configuration we\\nrecommend to verify the configuration. It may be necessary to adjust the no_proxy\\nenvironment variable. See using a forward proxy with Synapse documentation for\\ndetails.","breadcrumbs":"Upgrading between Synapse Versions » Add support for routing outbound HTTP requests via a proxy for federation","id":"249","title":"Add support for routing outbound HTTP requests via a proxy for federation"},"25":{"body":"When you are ready to start using PostgreSQL, edit the database\\nsection in your config file to match the following lines: database: name: psycopg2 args: user: password: dbname: host: cp_min: 5 cp_max: 10 All key, values in args are passed to the psycopg2.connect(..)\\nfunction, except keys beginning with cp_, which are consumed by the\\ntwisted adbapi connection pool. See the libpq\\ndocumentation\\nfor a list of options which can be passed. You should consider tuning the args.keepalives_* options if there is any danger of\\nthe connection between your homeserver and database dropping, otherwise Synapse\\nmay block for an extended period while it waits for a response from the\\ndatabase server. Example values might be: database: args: # ... as above # seconds of inactivity after which TCP should send a keepalive message to the server keepalives_idle: 10 # the number of seconds after which a TCP keepalive message that is not # acknowledged by the server should be retransmitted keepalives_interval: 10 # the number of TCP keepalives that can be lost before the client\'s connection # to the server is considered dead keepalives_count: 3","breadcrumbs":"Using Postgres » Synapse config","id":"25","title":"Synapse config"},"250":{"body":"The template_dir settings in the sso, account_validity and email sections of the\\nconfiguration file are now deprecated. Server admins should use the new templates.custom_template_directory setting in the configuration file and use one single\\ncustom template directory for all aforementioned features. Template file names remain\\nunchanged. See the related documentation\\nfor more information and examples. We plan to remove support for these settings in October 2021.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of template_dir","id":"250","title":"Deprecation of template_dir"},"251":{"body":"The media repository worker documentation\\nhas been updated to reflect that calls to /_synapse/admin/v1/users/{userId}/media\\nmust now be handled by media repository workers. This is due to the new DELETE method\\nof this endpoint modifying the media store.","breadcrumbs":"Upgrading between Synapse Versions » /_synapse/admin/v1/users/{userId}/media must be handled by media workers","id":"251","title":"/_synapse/admin/v1/users/{userId}/media must be handled by media workers"},"252":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.39.0","id":"252","title":"Upgrading to v1.39.0"},"253":{"body":"The current third-party rules module interface is deprecated in favour of the new generic\\nmodules system introduced in Synapse v1.37.0. Authors of third-party rules modules can refer\\nto this documentation\\nto update their modules. Synapse administrators can refer to this documentation\\nto update their configuration once the modules they are using have been updated. We plan to remove support for the current third-party rules interface in September 2021.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of the current third-party rules module interface","id":"253","title":"Deprecation of the current third-party rules module interface"},"254":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.38.0","id":"254","title":"Upgrading to v1.38.0"},"255":{"body":"This release includes a database schema update which requires re-indexing one of\\nthe larger tables in the database, events. This could result in increased\\ndisk I/O for several hours or days after upgrading while the migration\\ncompletes. Furthermore, because we have to keep the old indexes until the new\\nindexes are ready, it could result in a significant, temporary, increase in\\ndisk space. To get a rough idea of the disk space required, check the current size of one\\nof the indexes. For example, from a psql shell, run the following sql: SELECT pg_size_pretty(pg_relation_size(\'events_order_room\')); We need to rebuild four indexes, so you will need to multiply this result\\nby four to give an estimate of the disk space required. For example, on one\\nparticular server: synapse=# select pg_size_pretty(pg_relation_size(\'events_order_room\')); pg_size_pretty\\n---------------- 288 MB\\n(1 row) On this server, it would be wise to ensure that at least 1152MB are free. The additional disk space will be freed once the migration completes. SQLite databases are unaffected by this change.","breadcrumbs":"Upgrading between Synapse Versions » Re-indexing of events table on Postgres databases","id":"255","title":"Re-indexing of events table on Postgres databases"},"256":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.37.0","id":"256","title":"Upgrading to v1.37.0"},"257":{"body":"The current spam checker interface is deprecated in favour of a new generic modules system.\\nAuthors of spam checker modules can refer to [this\\ndocumentation](modules/porting_legacy_module.md\\nto update their modules. Synapse administrators can refer to this\\ndocumentation\\nto update their configuration once the modules they are using have been updated. We plan to remove support for the current spam checker interface in August 2021. More module interfaces will be ported over to this new generic system in future versions\\nof Synapse.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of the current spam checker interface","id":"257","title":"Deprecation of the current spam checker interface"},"258":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.34.0","id":"258","title":"Upgrading to v1.34.0"},"259":{"body":"The room_invite_state_types configuration setting has been deprecated\\nand replaced with room_prejoin_state. See the sample configuration\\nfile. If you have set room_invite_state_types to the default value you\\nshould simply remove it from your configuration file. The default value\\nused to be: room_invite_state_types: - \\"m.room.join_rules\\" - \\"m.room.canonical_alias\\" - \\"m.room.avatar\\" - \\"m.room.encryption\\" - \\"m.room.name\\" If you have customised this value, you should remove room_invite_state_types and configure room_prejoin_state instead.","breadcrumbs":"Upgrading between Synapse Versions » room_invite_state_types configuration setting","id":"259","title":"room_invite_state_types configuration setting"},"26":{"body":"Postgres uses separate directories for database locations between major versions (typically /var/lib/postgresql//main). Therefore, it is recommended to stop Synapse and other services (MAS, etc) before upgrading Postgres major versions. It is also strongly recommended to back up your database beforehand to ensure no data loss arising from a failed upgrade.","breadcrumbs":"Using Postgres » Postgresql major version upgrades","id":"26","title":"Postgresql major version upgrades"},"260":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.33.0","id":"260","title":"Upgrading to v1.33.0"},"261":{"body":"This may affect you if you have enabled the account validity feature,\\nand have made use of a custom HTML template specified by the account_validity.template_dir or account_validity.account_renewed_html_path Synapse config options. The template can now accept an expiration_ts variable, which\\nrepresents the unix timestamp in milliseconds for the future date of\\nwhich their account has been renewed until. See the default\\ntemplate\\nfor an example of usage. ALso note that a new HTML template, account_previously_renewed.html,\\nhas been added. This is is shown to users when they attempt to renew\\ntheir account with a valid renewal token that has already been used\\nbefore. The default template contents can been found here,\\nand can also accept an expiration_ts variable. This template replaces\\nthe error message users would previously see upon attempting to use a\\nvalid renewal token more than once.","breadcrumbs":"Upgrading between Synapse Versions » Account Validity HTML templates can now display a user’s expiration date","id":"261","title":"Account Validity HTML templates can now display a user’s expiration date"},"262":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.32.0","id":"262","title":"Upgrading to v1.32.0"},"263":{"body":"This release introduces a\\nregression that can\\noverwhelm connected Prometheus instances. This issue is not present in\\nSynapse v1.32.0rc1. If you have been affected, please downgrade to 1.31.0. You then may need\\nto remove excess writeahead logs in order for Prometheus to recover.\\nInstructions for doing so are provided here.","breadcrumbs":"Upgrading between Synapse Versions » Regression causing connected Prometheus instances to become overwhelmed","id":"263","title":"Regression causing connected Prometheus instances to become overwhelmed"},"264":{"body":"In line with our deprecation policy,\\nwe’ve dropped support for Python 3.5 and PostgreSQL 9.5, as they are no\\nlonger supported upstream. This release of Synapse requires Python 3.6+ and PostgreSQL 9.6+ or\\nSQLite 3.22+.","breadcrumbs":"Upgrading between Synapse Versions » Dropping support for old Python, Postgres and SQLite versions","id":"264","title":"Dropping support for old Python, Postgres and SQLite versions"},"265":{"body":"The deprecated v1 “list accounts” admin API\\n( GET /_synapse/admin/v1/users/) has been removed in this\\nversion. The v2 list accounts API\\nhas been available since Synapse 1.7.0 (2019-12-13), and is accessible\\nunder GET /_synapse/admin/v2/users. The deprecation of the old endpoint was announced with Synapse 1.28.0\\n(released on 2021-02-25).","breadcrumbs":"Upgrading between Synapse Versions » Removal of old List Accounts Admin API","id":"265","title":"Removal of old List Accounts Admin API"},"266":{"body":"In compliance with the Application Service\\nspec,\\nApplication Services are now required to use the m.login.application_service type when registering users via the /_matrix/client/r0/register endpoint. This behaviour was deprecated in\\nSynapse v1.30.0. Please ensure your Application Services are up to date.","breadcrumbs":"Upgrading between Synapse Versions » Application Services must use type m.login.application_service when registering users","id":"266","title":"Application Services must use type m.login.application_service when registering users"},"267":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.29.0","id":"267","title":"Upgrading to v1.29.0"},"268":{"body":"When using Synapse with a reverse proxy (in particular, when using the x_forwarded option on an HTTP listener), Synapse now\\nexpects to receive an X-Forwarded-Proto header on incoming\\nHTTP requests. If it is not set, Synapse will log a warning on each\\nreceived request. To avoid the warning, administrators using a reverse proxy should ensure\\nthat the reverse proxy sets X-Forwarded-Proto header to https or http to indicate the protocol used\\nby the client. Synapse also requires the Host header to be preserved. See the reverse proxy documentation, where the\\nexample configurations have been updated to show how to set these\\nheaders. (Users of Caddy are unaffected, since we\\nbelieve it sets X-Forwarded-Proto by default.)","breadcrumbs":"Upgrading between Synapse Versions » Requirement for X-Forwarded-Proto header","id":"268","title":"Requirement for X-Forwarded-Proto header"},"269":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.27.0","id":"269","title":"Upgrading to v1.27.0"},"27":{"body":"Don’t forget to back up your database!","breadcrumbs":"Using Postgres » Backups","id":"27","title":"Backups"},"270":{"body":"This version changes the URI used for callbacks from OAuth2 and SAML2\\nidentity providers: If your server is configured for single sign-on via an OpenID\\nConnect or OAuth2 identity provider, you will need to add [synapse public baseurl]/_synapse/client/oidc/callback to the list\\nof permitted “redirect URIs” at the identity provider. See the OpenID docs for more information on setting\\nup OpenID Connect. If your server is configured for single sign-on via a SAML2 identity\\nprovider, you will need to add [synapse public baseurl]/_synapse/client/saml2/authn_response as a\\npermitted “ACS location” (also known as “allowed callback URLs”)\\nat the identity provider. The “Issuer” in the “AuthnRequest” to the SAML2 identity\\nprovider is also updated to [synapse public baseurl]/_synapse/client/saml2/metadata.xml. If\\nyour SAML2 identity provider uses this property to validate or\\notherwise identify Synapse, its configuration will need to be\\nupdated to use the new URL. Alternatively you could create a new,\\nseparate “EntityDescriptor” in your SAML2 identity provider with\\nthe new URLs and leave the URLs in the existing “EntityDescriptor”\\nas they were.","breadcrumbs":"Upgrading between Synapse Versions » Changes to callback URI for OAuth2 / OpenID Connect and SAML2","id":"270","title":"Changes to callback URI for OAuth2 / OpenID Connect and SAML2"},"271":{"body":"The HTML templates for SSO and email notifications now have Jinja2’s\\nautoescape\\nenabled for files ending in .html, .htm, and .xml. If you have\\ncustomised these templates and see issues when viewing them you might\\nneed to update them. It is expected that most configurations will need\\nno changes. If you have customised the templates names for these templates, it is\\nrecommended to verify they end in .html to ensure autoescape is\\nenabled. The above applies to the following templates: add_threepid.html add_threepid_failure.html add_threepid_success.html notice_expiry.html notice_expiry.html notif_mail.html (which, by default, includes room.html and notif.html) password_reset.html password_reset_confirmation.html password_reset_failure.html password_reset_success.html registration.html registration_failure.html registration_success.html sso_account_deactivated.html sso_auth_bad_user.html sso_auth_confirm.html sso_auth_success.html sso_error.html sso_login_idp_picker.html sso_redirect_confirm.html","breadcrumbs":"Upgrading between Synapse Versions » Changes to HTML templates","id":"271","title":"Changes to HTML templates"},"272":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.26.0","id":"272","title":"Upgrading to v1.26.0"},"273":{"body":"v1.26.0 includes a lot of large changes. If something problematic\\noccurs, you may want to roll-back to a previous version of Synapse.\\nBecause v1.26.0 also includes a new database schema version, reverting\\nthat version is also required alongside the generic rollback\\ninstructions mentioned above. In short, to roll back to v1.25.0 you need\\nto: Stop the server Decrease the schema version in the database: UPDATE schema_version SET version = 58; Delete the ignored users & chain cover data: DROP TABLE IF EXISTS ignored_users;\\nUPDATE rooms SET has_auth_chain_index = false; For PostgreSQL run: TRUNCATE event_auth_chain_links;\\nTRUNCATE event_auth_chains; For SQLite run: DELETE FROM event_auth_chain_links;\\nDELETE FROM event_auth_chains; Mark the deltas as not run (so they will re-run on upgrade). DELETE FROM applied_schema_deltas WHERE version = 59 AND file = \\"59/01ignored_user.py\\";\\nDELETE FROM applied_schema_deltas WHERE version = 59 AND file = \\"59/06chain_cover_index.sql\\"; Downgrade Synapse by following the instructions for your\\ninstallation method in the “Rolling back to older versions”\\nsection above.","breadcrumbs":"Upgrading between Synapse Versions » Rolling back to v1.25.0 after a failed upgrade","id":"273","title":"Rolling back to v1.25.0 after a failed upgrade"},"274":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.25.0","id":"274","title":"Upgrading to v1.25.0"},"275":{"body":"This is the last release of Synapse which guarantees support with Python\\n3.5, which passed its upstream End of Life date several months ago. We will attempt to maintain support through March 2021, but without\\nguarantees. In the future, Synapse will follow upstream schedules for ending support\\nof older versions of Python and PostgreSQL. Please upgrade to at least\\nPython 3.6 and PostgreSQL 9.6 as soon as possible.","breadcrumbs":"Upgrading between Synapse Versions » Last release supporting Python 3.5","id":"275","title":"Last release supporting Python 3.5"},"276":{"body":"Synapse v1.25.0 includes new settings, ip_range_blacklist and ip_range_whitelist, for controlling outgoing requests from Synapse for\\nfederation, identity servers, push, and for checking key validity for\\nthird-party invite events. The previous setting, federation_ip_range_blacklist, is deprecated. The new ip_range_blacklist defaults to private IP ranges if it is not defined. If you have never customised federation_ip_range_blacklist it is\\nrecommended that you remove that setting. If you have customised federation_ip_range_blacklist you should update\\nthe setting name to ip_range_blacklist. If you have a custom push server that is reached via private IP space\\nyou may need to customise ip_range_blacklist or ip_range_whitelist.","breadcrumbs":"Upgrading between Synapse Versions » Blacklisting IP ranges","id":"276","title":"Blacklisting IP ranges"},"277":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.24.0","id":"277","title":"Upgrading to v1.24.0"},"278":{"body":"This release allows the OpenID Connect mapping provider to perform\\nnormalisation of the localpart of the Matrix ID. This allows for the\\nmapping provider to specify different algorithms, instead of the default\\nway. If your Synapse configuration uses a custom mapping provider\\n( oidc_config.user_mapping_provider.module is specified and\\nnot equal to synapse.handlers.oidc_handler.JinjaOidcMappingProvider)\\nthen you must ensure that map_user_attributes of the\\nmapping provider performs some normalisation of the localpart returned. To match previous behaviour you can\\nuse the map_username_to_mxid_localpart function provided\\nby Synapse. An example is shown below: from synapse.types import map_username_to_mxid_localpart class MyMappingProvider: def map_user_attributes(self, userinfo, token): # ... your custom logic ... sso_user_id = ... localpart = map_username_to_mxid_localpart(sso_user_id) return {\\"localpart\\": localpart}","breadcrumbs":"Upgrading between Synapse Versions » Custom OpenID Connect mapping provider breaking change","id":"278","title":"Custom OpenID Connect mapping provider breaking change"},"279":{"body":"Historically, the Synapse Admin API has been accessible under: /_matrix/client/api/v1/admin /_matrix/client/unstable/admin /_matrix/client/r0/admin /_synapse/admin/v1 The endpoints with /_matrix/client/* prefixes have been removed as of\\nv1.24.0. The Admin API is now only accessible under: /_synapse/admin/v1 The only exception is the /admin/whois endpoint, which is also available via the client-server\\nAPI. The deprecation of the old endpoints was announced with Synapse 1.20.0\\n(released on 2020-09-22) and makes it easier for homeserver admins to\\nlock down external access to the Admin API endpoints.","breadcrumbs":"Upgrading between Synapse Versions » Removal historical Synapse Admin API","id":"279","title":"Removal historical Synapse Admin API"},"28":{"body":"The default settings should be fine for most deployments. For larger\\nscale deployments tuning some of the settings is recommended, details of\\nwhich can be found at https://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server. In particular, we’ve found tuning the following values helpful for\\nperformance: shared_buffers effective_cache_size work_mem maintenance_work_mem autovacuum_work_mem Note that the appropriate values for those fields depend on the amount\\nof free memory the database host has available. Additionally, admins of large deployments might want to consider using huge pages\\nto help manage memory, especially when using large values of shared_buffers. You\\ncan read more about that here.","breadcrumbs":"Using Postgres » Tuning Postgres","id":"28","title":"Tuning Postgres"},"280":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.23.0","id":"280","title":"Upgrading to v1.23.0"},"281":{"body":"This release deprecates use of the structured: true logging\\nconfiguration for structured logging. If your logging configuration\\ncontains structured: true then it should be modified based on the structured logging documentation. The structured and drains logging options are now deprecated and\\nshould be replaced by standard logging configuration of handlers and formatters. A future will release of Synapse will make using structured: true an\\nerror.","breadcrumbs":"Upgrading between Synapse Versions » Structured logging configuration breaking changes","id":"281","title":"Structured logging configuration breaking changes"},"282":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.22.0","id":"282","title":"Upgrading to v1.22.0"},"283":{"body":"This release introduces a backwards-incompatible change to modules\\nmaking use of ThirdPartyEventRules in Synapse. If you make use of a\\nmodule defined under the third_party_event_rules config option, please\\nmake sure it is updated to handle the below change: The http_client argument is no longer passed to modules as they are\\ninitialised. Instead, modules are expected to make use of the http_client property on the ModuleApi class. Modules are now passed\\na module_api argument during initialisation, which is an instance of ModuleApi. ModuleApi instances have a http_client property which\\nacts the same as the http_client argument previously passed to ThirdPartyEventRules modules.","breadcrumbs":"Upgrading between Synapse Versions » ThirdPartyEventRules breaking changes","id":"283","title":"ThirdPartyEventRules breaking changes"},"284":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.21.0","id":"284","title":"Upgrading to v1.21.0"},"285":{"body":"The reverse proxy documentation\\nhas been updated to include reverse proxy directives for /_synapse/client/* endpoints. As the user password reset flow now uses\\nendpoints under this prefix, you must update your reverse proxy\\nconfigurations for user password reset to work. Additionally, note that the Synapse worker documentation has been updated to state that the /_synapse/client/password_reset/email/submit_token\\nendpoint can be handled by all workers. If you make use of Synapse’s worker feature, please\\nupdate your reverse proxy configuration to reflect this change.","breadcrumbs":"Upgrading between Synapse Versions » Forwarding /_synapse/client through your reverse proxy","id":"285","title":"Forwarding /_synapse/client through your reverse proxy"},"286":{"body":"A new HTML template, password_reset_confirmation.html,\\nhas been added to the synapse/res/templates directory. If you are\\nusing a custom template directory, you may want to copy the template\\nover and modify it. Note that as of v1.20.0, templates do not need to be included in custom\\ntemplate directories for Synapse to start. The default templates will be\\nused if a custom template cannot be found. This page will appear to the user after clicking a password reset link\\nthat has been emailed to them. To complete password reset, the page must include a way to make a POST request to /_synapse/client/password_reset/{medium}/submit_token with the query\\nparameters from the original link, presented as a URL-encoded form. See\\nthe file itself for more details.","breadcrumbs":"Upgrading between Synapse Versions » New HTML templates","id":"286","title":"New HTML templates"},"287":{"body":"The saml_error.html template was removed from Synapse and replaced\\nwith the sso_error.html template. If your Synapse is configured to use\\nSAML and a custom sso_redirect_confirm_template_dir configuration then\\nany customisations of the saml_error.html template will need to be\\nmerged into the sso_error.html template. These templates are similar,\\nbut the parameters are slightly different: The msg parameter should be renamed to error_description. There is no longer a code parameter for the response code. A string error parameter is available that includes a short hint\\nof why a user is seeing the error page.","breadcrumbs":"Upgrading between Synapse Versions » Updated Single Sign-on HTML Templates","id":"287","title":"Updated Single Sign-on HTML Templates"},"288":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.18.0","id":"288","title":"Upgrading to v1.18.0"},"289":{"body":"From 10th August 2020, we will no longer publish Docker images with the -py3 tag suffix. The images tagged with the -py3 suffix have been identical to the non-suffixed tags\\nsince release 0.99.0, and the suffix is obsolete. On 10th August, we will remove the latest-py3 tag.\\nExisting per-release tags (such as v1.18.0-py3 will not\\nbe removed, but no new -py3 tags will be added. Scripts relying on the -py3 suffix will need to be\\nupdated.","breadcrumbs":"Upgrading between Synapse Versions » Docker -py3 suffix will be removed in future versions","id":"289","title":"Docker -py3 suffix will be removed in future versions"},"29":{"body":"","breadcrumbs":"Using Postgres » Porting from SQLite","id":"29","title":"Porting from SQLite"},"290":{"body":"When setting up worker processes, we now recommend the use of a Redis\\nserver for replication. The old direct TCP connection method is\\ndeprecated and will be removed in a future release. See\\nthe worker documentation for more details.","breadcrumbs":"Upgrading between Synapse Versions » Redis replication is now recommended in lieu of TCP replication","id":"290","title":"Redis replication is now recommended in lieu of TCP replication"},"291":{"body":"This version includes a database update which is run as part of the\\nupgrade, and which may take a couple of minutes in the case of a large\\nserver. Synapse will not respond to HTTP requests while this update is\\ntaking place.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.14.0","id":"291","title":"Upgrading to v1.14.0"},"292":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.13.0","id":"292","title":"Upgrading to v1.13.0"},"293":{"body":"A bug was introduced in Synapse 1.4.0 which could cause the room\\ndirectory to be incomplete or empty if Synapse was upgraded directly\\nfrom v1.2.1 or earlier, to versions between v1.4.0 and v1.12.x. This will not be a problem for Synapse installations which were: created at v1.4.0 or later, upgraded via v1.3.x, or upgraded straight from v1.2.1 or earlier to v1.13.0 or later. If completeness of the room directory is a concern, installations which\\nare affected can be repaired as follows: Run the following sql from a psql or sqlite3 console: INSERT INTO background_updates (update_name, progress_json, depends_on) VALUES (\'populate_stats_process_rooms\', \'{}\', \'current_state_events_membership\'); INSERT INTO background_updates (update_name, progress_json, depends_on) VALUES (\'populate_stats_process_users\', \'{}\', \'populate_stats_process_rooms\'); Restart synapse.","breadcrumbs":"Upgrading between Synapse Versions » Incorrect database migration in old synapse versions","id":"293","title":"Incorrect database migration in old synapse versions"},"294":{"body":"New templates ( sso_auth_confirm.html, sso_auth_success.html, and sso_account_deactivated.html) were added to Synapse. If your Synapse\\nis configured to use SSO and a custom sso_redirect_confirm_template_dir configuration then these templates\\nwill need to be copied from synapse/res/templates into that directory.","breadcrumbs":"Upgrading between Synapse Versions » New Single Sign-on HTML Templates","id":"294","title":"New Single Sign-on HTML Templates"},"295":{"body":"Plugins using the complete_sso_login method of synapse.module_api.ModuleApi should update to using the async/await\\nversion complete_sso_login_async which includes additional checks. The\\nnon-async version is considered deprecated.","breadcrumbs":"Upgrading between Synapse Versions » Synapse SSO Plugins Method Deprecation","id":"295","title":"Synapse SSO Plugins Method Deprecation"},"296":{"body":"v1.13.0 includes a lot of large changes. If something problematic\\noccurs, you may want to roll-back to a previous version of Synapse.\\nBecause v1.13.0 also includes a new database schema version, reverting\\nthat version is also required alongside the generic rollback\\ninstructions mentioned above. In short, to roll back to v1.12.4 you need\\nto: Stop the server Decrease the schema version in the database: UPDATE schema_version SET version = 57; Downgrade Synapse by following the instructions for your\\ninstallation method in the “Rolling back to older versions”\\nsection above.","breadcrumbs":"Upgrading between Synapse Versions » Rolling back to v1.12.4 after a failed upgrade","id":"296","title":"Rolling back to v1.12.4 after a failed upgrade"},"297":{"body":"This version includes a database update which is run as part of the\\nupgrade, and which may take some time (several hours in the case of a\\nlarge server). Synapse will not respond to HTTP requests while this\\nupdate is taking place. This is only likely to be a problem in the case of a server which is\\nparticipating in many rooms. As with all upgrades, it is recommended that you have a recent\\nbackup of your database which can be used for recovery in the event\\nof any problems. As an initial check to see if you will be affected, you can try\\nrunning the following query from the psql or sqlite3 console. It is safe to run it while Synapse is\\nstill running. SELECT MAX(q.v) FROM ( SELECT ( SELECT ej.json AS v FROM state_events se INNER JOIN event_json ej USING (event_id) WHERE se.room_id=rooms.room_id AND se.type=\'m.room.create\' AND se.state_key=\'\' LIMIT 1 ) FROM rooms WHERE rooms.room_version IS NULL\\n) q; This query will take about the same amount of time as the upgrade\\nprocess: ie, if it takes 5 minutes, then it is likely that Synapse\\nwill be unresponsive for 5 minutes during the upgrade. If you consider an outage of this duration to be acceptable, no\\nfurther action is necessary and you can simply start Synapse 1.12.0. If you would prefer to reduce the downtime, continue with the steps\\nbelow. The easiest workaround for this issue is to manually create a new\\nindex before upgrading. On PostgreSQL, his can be done as follows: CREATE INDEX CONCURRENTLY tmp_upgrade_1_12_0_index\\nON state_events(room_id) WHERE type = \'m.room.create\'; The above query may take some time, but is also safe to run while\\nSynapse is running. We assume that no SQLite users have databases large enough to be\\naffected. If you are affected, you can run a similar query,\\nomitting the CONCURRENTLY keyword. Note however that this\\noperation may in itself cause Synapse to stop running for some time.\\nSynapse admins are reminded that SQLite is not recommended for use\\noutside a test environment. Once the index has been created, the SELECT query in step 1 above\\nshould complete quickly. It is therefore safe to upgrade to Synapse\\n1.12.0. Once Synapse 1.12.0 has successfully started and is responding to\\nHTTP requests, the temporary index can be removed: DROP INDEX tmp_upgrade_1_12_0_index;","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.12.0","id":"297","title":"Upgrading to v1.12.0"},"298":{"body":"Synapse will now log a warning on start up if used with a PostgreSQL\\ndatabase that has a non-recommended locale set. See Postgres for details.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.10.0","id":"298","title":"Upgrading to v1.10.0"},"299":{"body":"Specifying a log_file config option will now cause Synapse to refuse\\nto start, and should be replaced by with the log_config option.\\nSupport for the log_file option was removed in v1.3.0 and has since\\nhad no effect.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.8.0","id":"299","title":"Upgrading to v1.8.0"},"3":{"body":"If you’ve found a security issue in Synapse or any other Element project,\\nplease report it to us in accordance with our Security Disclosure\\nPolicy. Thank you!","breadcrumbs":"Welcome and Overview » Reporting a security vulnerability","id":"3","title":"Reporting a security vulnerability"},"30":{"body":"The script synapse_port_db allows porting an existing synapse server\\nbacked by SQLite to using PostgreSQL. This is done as a two phase\\nprocess: Copy the existing SQLite database to a separate location and run\\nthe port script against that offline database. Shut down the server. Rerun the port script to port any data that\\nhas come in since taking the first snapshot. Restart server against\\nthe PostgreSQL database. The port script is designed to be run repeatedly against newer snapshots\\nof the SQLite database file. This makes it safe to repeat step 1 if\\nthere was a delay between taking the previous snapshot and being ready\\nto do step 2. It is safe to at any time kill the port script and restart it. However, under no circumstances should the SQLite database be VACUUMed between\\nmultiple runs of the script. Doing so can lead to an inconsistent copy of your database\\ninto Postgres.\\nTo avoid accidental error, the script will check that SQLite’s auto_vacuum mechanism\\nis disabled, but the script is not able to protect against a manual VACUUM operation\\nperformed either by the administrator or by any automated task that the administrator\\nmay have configured. Note that the database may take up significantly more (25% - 100% more)\\nspace on disk after porting to Postgres.","breadcrumbs":"Using Postgres » Overview","id":"30","title":"Overview"},"300":{"body":"In an attempt to configure Synapse in a privacy preserving way, the\\ndefault behaviours of allow_public_rooms_without_auth and allow_public_rooms_over_federation have been inverted. This means that\\nby default, only authenticated users querying the Client/Server API will\\nbe able to query the room directory, and relatedly that the server will\\nnot share room directory information with other servers over federation. If your installation does not explicitly set these settings one way or\\nthe other and you want either setting to be true then it will\\nnecessary to update your homeserver configuration file accordingly. For more details on the surrounding context see our explainer.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.7.0","id":"300","title":"Upgrading to v1.7.0"},"301":{"body":"This release includes a database migration which may take several\\nminutes to complete if there are a large number (more than a million or\\nso) of entries in the devices table. This is only likely to a be a\\nproblem on very large installations.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.5.0","id":"301","title":"Upgrading to v1.5.0"},"302":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.4.0","id":"302","title":"Upgrading to v1.4.0"},"303":{"body":"If you have configured a custom template directory with the email.template_dir option, be aware that there are new templates\\nregarding registration and threepid management (see below) that must be\\nincluded. registration.html and registration.txt registration_success.html and registration_failure.html add_threepid.html and add_threepid.txt add_threepid_failure.html and add_threepid_success.html Synapse will expect these files to exist inside the configured template\\ndirectory, and will fail to start if they are absent. To view the\\ndefault templates, see synapse/res/templates.","breadcrumbs":"Upgrading between Synapse Versions » New custom templates","id":"303","title":"New custom templates"},"304":{"body":"Note: As of this release, users will be unable to add phone numbers or\\nemail addresses to their accounts, without changes to the Synapse\\nconfiguration. This includes adding an email address during\\nregistration. It is possible for a user to associate an email address or phone number\\nwith their account, for a number of reasons: for use when logging in, as an alternative to the user id. in the case of email, as an alternative contact to help with account\\nrecovery. in the case of email, to receive notifications of missed messages. Before an email address or phone number can be added to a user’s\\naccount, or before such an address is used to carry out a\\npassword-reset, Synapse must confirm the operation with the owner of the\\nemail address or phone number. It does this by sending an email or text\\ngiving the user a link or token to confirm receipt. This process is\\nknown as ‘3pid verification’. (‘3pid’, or ‘threepid’, stands for\\nthird-party identifier, and we use it to refer to external identifiers\\nsuch as email addresses and phone numbers.) Previous versions of Synapse delegated the task of 3pid verification to\\nan identity server by default. In most cases this server is vector.im\\nor matrix.org. In Synapse 1.4.0, for security and privacy reasons, the homeserver will\\nno longer delegate this task to an identity server by default. Instead,\\nthe server administrator will need to explicitly decide how they would\\nlike the verification messages to be sent. In the medium term, the vector.im and matrix.org identity servers\\nwill disable support for delegated 3pid verification entirely. However,\\nin order to ease the transition, they will retain the capability for a\\nlimited period. Delegated email verification will be disabled on Monday\\n2nd December 2019 (giving roughly 2 months notice). Disabling delegated\\nSMS verification will follow some time after that once SMS verification\\nsupport lands in Synapse. Once delegated 3pid verification support has been disabled in the vector.im and matrix.org identity servers, all Synapse versions that\\ndepend on those instances will be unable to verify email and phone\\nnumbers through them. There are no imminent plans to remove delegated\\n3pid verification from Sydent generally. (Sydent is the identity server\\nproject that backs the vector.im and matrix.org instances).","breadcrumbs":"Upgrading between Synapse Versions » 3pid verification changes","id":"304","title":"3pid verification changes"},"305":{"body":"Following upgrade, to continue verifying email (e.g. as part of the\\nregistration process), admins can either:- Configure Synapse to use an email server. Run or choose an identity server which allows delegated email\\nverification and delegate to it. Configure SMTP in Synapse To configure an SMTP server for Synapse, modify the configuration\\nsection headed email, and be sure to have at least the smtp_host, smtp_port and notif_from fields filled out. You may also need to set smtp_user, smtp_pass, and require_transport_security. See the sample configuration file\\nfor more details on these settings. Delegate email to an identity server Some admins will wish to continue using email verification as part of\\nthe registration process, but will not immediately have an appropriate\\nSMTP server at hand. To this end, we will continue to support email verification delegation\\nvia the vector.im and matrix.org identity servers for two months.\\nSupport for delegated email verification will be disabled on Monday 2nd\\nDecember. The account_threepid_delegates dictionary defines whether the\\nhomeserver should delegate an external server (typically an identity\\nserver) to handle\\nsending confirmation messages via email and SMS. So to delegate email verification, in homeserver.yaml, set account_threepid_delegates.email to the base URL of an identity\\nserver. For example: account_threepid_delegates: email: https://example.com # Delegate email sending to example.com Note that account_threepid_delegates.email replaces the deprecated email.trust_identity_server_for_password_resets: if email.trust_identity_server_for_password_resets is set to true, and account_threepid_delegates.email is not set, then the first entry in trusted_third_party_id_servers will be used as the account_threepid_delegate for email. This is to ensure compatibility\\nwith existing Synapse installs that set up external server handling for\\nthese tasks before v1.4.0. If email.trust_identity_server_for_password_resets is true and no\\ntrusted identity server domains are configured, Synapse will report an\\nerror and refuse to start. If email.trust_identity_server_for_password_resets is false or\\nabsent and no email delegate is configured in account_threepid_delegates, then Synapse will send email verification\\nmessages itself, using the configured SMTP server (see above). that\\ntype.","breadcrumbs":"Upgrading between Synapse Versions » Email","id":"305","title":"Email"},"306":{"body":"Synapse does not support phone-number verification itself, so the only\\nway to maintain the ability for users to add phone numbers to their\\naccounts will be by continuing to delegate phone number verification to\\nthe matrix.org and vector.im identity servers (or another identity\\nserver that supports SMS sending). The account_threepid_delegates dictionary defines whether the\\nhomeserver should delegate an external server (typically an identity\\nserver) to handle\\nsending confirmation messages via email and SMS. So to delegate phone number verification, in homeserver.yaml, set account_threepid_delegates.msisdn to the base URL of an identity\\nserver. For example: account_threepid_delegates: msisdn: https://example.com # Delegate sms sending to example.com The matrix.org and vector.im identity servers will continue to\\nsupport delegated phone number verification via SMS until such time as\\nit is possible for admins to configure their servers to perform phone\\nnumber verification directly. More details will follow in a future\\nrelease.","breadcrumbs":"Upgrading between Synapse Versions » Phone numbers","id":"306","title":"Phone numbers"},"307":{"body":"If you encounter problems with v1.4.0, it should be possible to roll\\nback to v1.3.1, subject to the following: The ‘room statistics’ engine was heavily reworked in this release\\n(see #5971),\\nincluding significant changes to the database schema, which are not\\neasily reverted. This will cause the room statistics engine to stop\\nupdating when you downgrade. The room statistics are essentially unused in v1.3.1 (in future\\nversions of Synapse, they will be used to populate the room\\ndirectory), so there should be no loss of functionality. However,\\nthe statistics engine will write errors to the logs, which can be\\navoided by setting the following in homeserver.yaml: stats: enabled: false Don’t forget to re-enable it when you upgrade again, in preparation\\nfor its use in the room directory!","breadcrumbs":"Upgrading between Synapse Versions » Rolling back to v1.3.1","id":"307","title":"Rolling back to v1.3.1"},"308":{"body":"Some counter metrics have been renamed, with the old names deprecated.\\nSee the metrics\\ndocumentation\\nfor details.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.2.0","id":"308","title":"Upgrading to v1.2.0"},"309":{"body":"Synapse v1.1.0 removes support for older Python and PostgreSQL versions,\\nas outlined in our deprecation\\nnotice.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.1.0","id":"309","title":"Upgrading to v1.1.0"},"31":{"body":"Firstly, shut down the currently running synapse server and copy its\\ndatabase file (typically homeserver.db) to another location. Once the\\ncopy is complete, restart synapse. For instance: synctl stop\\ncp homeserver.db homeserver.db.snapshot\\nsynctl start Copy the old config file into a new config file: cp homeserver.yaml homeserver-postgres.yaml Edit the database section as described in the section Synapse config\\nabove and with the SQLite snapshot located at homeserver.db.snapshot\\nsimply run: synapse_port_db --sqlite-database homeserver.db.snapshot \\\\ --postgres-config homeserver-postgres.yaml The flag --curses displays a coloured curses progress UI. (NOTE: if your terminal is too small the script will error out) If the script took a long time to complete, or time has otherwise passed\\nsince the original snapshot was taken, repeat the previous steps with a\\nnewer snapshot. To complete the conversion shut down the synapse server and run the port\\nscript one last time, e.g. if the SQLite database is at homeserver.db\\nrun: synapse_port_db --sqlite-database homeserver.db \\\\ --postgres-config homeserver-postgres.yaml Once that has completed, change the synapse config to point at the\\nPostgreSQL database configuration file homeserver-postgres.yaml: synctl stop\\nmv homeserver.yaml homeserver-old-sqlite.yaml\\nmv homeserver-postgres.yaml homeserver.yaml\\nsynctl start Synapse should now be running against PostgreSQL.","breadcrumbs":"Using Postgres » Using the port script","id":"31","title":"Using the port script"},"310":{"body":"Synapse v1.1.0 has a minimum Python requirement of Python 3.5. Python\\n3.6 or Python 3.7 are recommended as they have improved internal string\\nhandling, significantly reducing memory usage. If you use current versions of the Matrix.org-distributed Debian\\npackages or Docker images, action is not required. If you install Synapse in a Python virtual environment, please see\\n“Upgrading to v0.34.0” for notes on setting up a new virtualenv under\\nPython 3.","breadcrumbs":"Upgrading between Synapse Versions » Minimum Python Version","id":"310","title":"Minimum Python Version"},"311":{"body":"If using PostgreSQL under Synapse, you will need to use PostgreSQL 9.5\\nor above. Please see the PostgreSQL\\ndocumentation for\\nmore details on upgrading your database.","breadcrumbs":"Upgrading between Synapse Versions » Minimum PostgreSQL Version","id":"311","title":"Minimum PostgreSQL Version"},"312":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.0","id":"312","title":"Upgrading to v1.0"},"313":{"body":"Synapse v1.0 is the first release to enforce validation of TLS\\ncertificates for the federation API. It is therefore essential that your\\ncertificates are correctly configured. Note, v1.0 installations will also no longer be able to federate with\\nservers that have not correctly configured their certificates. In rare cases, it may be desirable to disable certificate checking: for\\nexample, it might be essential to be able to federate with a given\\nlegacy server in a closed federation. This can be done in one of two\\nways:- Configure the global switch federation_verify_certificates to false. Configure a whitelist of server domains to trust via federation_certificate_verification_whitelist. See the sample configuration file\\nfor more details on these settings.","breadcrumbs":"Upgrading between Synapse Versions » Validation of TLS certificates","id":"313","title":"Validation of TLS certificates"},"314":{"body":"When a user requests a password reset, Synapse will send an email to the\\nuser to confirm the request. Previous versions of Synapse delegated the job of sending this email to\\nan identity server. If the identity server was somehow malicious or\\nbecame compromised, it would be theoretically possible to hijack an\\naccount through this means. Therefore, by default, Synapse v1.0 will send the confirmation email\\nitself. If Synapse is not configured with an SMTP server, password reset\\nvia email will be disabled. To configure an SMTP server for Synapse, modify the configuration\\nsection headed email, and be sure to have at least the smtp_host, smtp_port and notif_from fields filled out. You may also need to set smtp_user, smtp_pass, and require_transport_security. If you are absolutely certain that you wish to continue using an\\nidentity server for password resets, set trust_identity_server_for_password_resets to true. See the sample configuration file\\nfor more details on these settings.","breadcrumbs":"Upgrading between Synapse Versions » Email","id":"314","title":"Email"},"315":{"body":"Some new templates have been added to the default template directory for the purpose of\\nthe homeserver sending its own password reset emails. If you have configured a\\ncustom template_dir in your Synapse config, these files will need to be added. password_reset.html and password_reset.txt are HTML and plain text\\ntemplates respectively that contain the contents of what will be emailed\\nto the user upon attempting to reset their password via email. password_reset_success.html and password_reset_failure.html are HTML\\nfiles that the content of which (assuming no redirect URL is set) will\\nbe shown to the user after they attempt to click the link in the email\\nsent to them.","breadcrumbs":"Upgrading between Synapse Versions » New email templates","id":"315","title":"New email templates"},"316":{"body":"Please be aware that, before Synapse v1.0 is released around March 2019,\\nyou will need to replace any self-signed certificates with those\\nverified by a root CA. Information on how to do so can be found at the\\nACME docs.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.99.0","id":"316","title":"Upgrading to v0.99.0"},"317":{"body":"This release is the first to fully support Python 3. Synapse will\\nnow run on Python versions 3.5, or 3.6 (as well as 2.7). We\\nrecommend switching to Python 3, as it has been shown to give\\nperformance improvements. For users who have installed Synapse into a virtualenv, we recommend\\ndoing this by creating a new virtualenv. For example: virtualenv -p python3 ~/synapse/env3\\nsource ~/synapse/env3/bin/activate\\npip install matrix-synapse You can then start synapse as normal, having activated the new\\nvirtualenv: cd ~/synapse\\nsource env3/bin/activate\\nsynctl start Users who have installed from distribution packages should see the\\nrelevant package documentation. See below for notes on Debian\\npackages. When upgrading to Python 3, you must make sure that your log\\nfiles are configured as UTF-8, by adding encoding: utf8 to the RotatingFileHandler configuration (if you have one) in your .log.config file. For example, if your log.config\\nfile contains: handlers: file: class: logging.handlers.RotatingFileHandler formatter: precise filename: homeserver.log maxBytes: 104857600 backupCount: 10 filters: [context] console: class: logging.StreamHandler formatter: precise filters: [context] Then you should update this to be: handlers: file: class: logging.handlers.RotatingFileHandler formatter: precise filename: homeserver.log maxBytes: 104857600 backupCount: 10 filters: [context] encoding: utf8 console: class: logging.StreamHandler formatter: precise filters: [context] There is no need to revert this change if downgrading to\\nPython 2. We are also making available Debian packages which will run Synapse\\non Python 3. You can switch to these packages with apt-get install matrix-synapse-py3, however, please read debian/NEWS\\nbefore doing so. The existing matrix-synapse packages will\\ncontinue to use Python 2 for the time being. This release removes the riot.im from the default list of trusted\\nidentity servers. If riot.im is in your homeserver’s list of trusted_third_party_id_servers, you should remove it. It was added\\nin case a hypothetical future identity server was put there. If you\\ndon’t remove it, users may be unable to deactivate their accounts. This release no longer installs the (unmaintained) Matrix Console\\nweb client as part of the default installation. It is possible to\\nre-enable it by installing it separately and setting the web_client_location config option, but please consider switching\\nto another client.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.34.0","id":"317","title":"Upgrading to v0.34.0"},"318":{"body":"This release removes the example email notification templates from res/templates (they are now internal to the python package). This\\nshould only affect you if you (a) deploy your Synapse instance from a\\ngit checkout or a github snapshot URL, and (b) have email notifications\\nenabled. If you have email notifications enabled, you should ensure that email.template_dir is either configured to point at a directory where\\nyou have installed customised templates, or leave it unset to use the\\ndefault templates.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.33.7","id":"318","title":"Upgrading to v0.33.7"},"319":{"body":"This release expands the anonymous usage stats sent if the opt-in report_stats configuration is set to true. We now capture RSS memory\\nand cpu use at a very coarse level. This requires administrators to\\ninstall the optional psutil python module. We would appreciate it if you could assist by ensuring this module is\\navailable and report_stats is enabled. This will let us see if\\nperformance changes to synapse are having an impact to the general\\ncommunity.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.27.3","id":"319","title":"Upgrading to v0.27.3"},"32":{"body":"","breadcrumbs":"Using Postgres » Troubleshooting","id":"32","title":"Troubleshooting"},"320":{"body":"If you want to use the new URL previewing API\\n( /_matrix/media/r0/preview_url) then you have to explicitly enable it\\nin the config and update your dependencies dependencies. See README.rst\\nfor details.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.15.0","id":"320","title":"Upgrading to v0.15.0"},"321":{"body":"This release includes the option to send anonymous usage stats to\\nmatrix.org, and requires that administrators explicitly opt in or out by\\nsetting the report_stats option to either true or false. We would really appreciate it if you could help our project out by\\nreporting anonymized usage statistics from your homeserver. Only very\\nbasic aggregate data (e.g. number of users) will be reported, but it\\nhelps us to track the growth of the Matrix community, and helps us to\\nmake Matrix a success, as well as to convince other networks that they\\nshould peer with us.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.11.0","id":"321","title":"Upgrading to v0.11.0"},"322":{"body":"Application services have had a breaking API change in this version. They can no longer register themselves with a home server using the AS\\nHTTP API. This decision was made because a compromised application\\nservice with free reign to register any regex in effect grants full\\nread/write access to the home server if a regex of .* is used. An\\nattack where a compromised AS re-registers itself with .* was deemed\\ntoo big of a security risk to ignore, and so the ability to register\\nwith the HS remotely has been removed. It has been replaced by specifying a list of application service\\nregistrations in homeserver.yaml: app_service_config_files: [\\"registration-01.yaml\\", \\"registration-02.yaml\\"] Where registration-01.yaml looks like: url: # e.g. \\"https://my.application.service.com\\"\\nas_token: \\nhs_token: \\nsender_localpart: # This is a new field which denotes the user_id localpart when using the AS token\\nnamespaces: users: - exclusive: regex: # e.g. \\"@prefix_.*\\" aliases: - exclusive: regex: rooms: - exclusive: regex: ","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.9.0","id":"322","title":"Upgrading to v0.9.0"},"323":{"body":"Servers which use captchas will need to add their public key to: static/client/register/register_config.js window.matrixRegistrationConfig = { recaptcha_public_key: \\"YOUR_PUBLIC_KEY\\" }; This is required in order to support registration fallback (typically\\nused on mobile devices).","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.8.0","id":"323","title":"Upgrading to v0.8.0"},"324":{"body":"New dependencies are: pydenticon simplejson syutil matrix-angular-sdk To pull in these dependencies in a virtual env, run: python synapse/python_dependencies.py | xargs -n 1 pip install","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.7.0","id":"324","title":"Upgrading to v0.7.0"},"325":{"body":"To pull in new dependencies, run: python setup.py develop --user This update includes a change to the database schema. To upgrade you\\nfirst need to upgrade the database by running: python scripts/upgrade_db_to_v0.6.0.py Where is the location of the database, is the server name as specified in the\\nsynapse configuration, and is the location\\nof the signing key as specified in the synapse configuration. This may take some time to complete. Failures of signatures and content\\nhashes can safely be ignored.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.6.0","id":"325","title":"Upgrading to v0.6.0"},"326":{"body":"Depending on precisely when you installed v0.5.0 you may have ended up\\nwith a stale release of the reference matrix webclient installed as a\\npython module. To uninstall it and ensure you are depending on the\\nlatest module, please run: $ pip uninstall syweb","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.5.1","id":"326","title":"Upgrading to v0.5.1"},"327":{"body":"The webclient has been split out into a separate repository/package in\\nthis release. Before you restart your homeserver you will need to pull\\nin the webclient package by running: python setup.py develop --user This release completely changes the database schema and so requires\\nupgrading it before starting the new version of the homeserver. The script “database-prepare-for-0.5.0.sh” should be used to upgrade\\nthe database. This will save all user information, such as logins and\\nprofiles, but will otherwise purge the database. This includes messages,\\nwhich rooms the home server was a member of and room alias mappings. If you would like to keep your history, please take a copy of your\\ndatabase file and ask for help in #matrix:matrix.org. The upgrade\\nprocess is, unfortunately, non trivial and requires human intervention\\nto resolve any resulting conflicts during the upgrade process. Before running the command the homeserver should be first completely\\nshutdown. To run it, simply specify the location of the database, e.g.: ./scripts/database-prepare-for-0.5.0.sh “homeserver.db” Once this has successfully completed it will be safe to restart the\\nhomeserver. You may notice that the homeserver takes a few seconds\\nlonger to restart than usual as it reinitializes the database. On startup of the new version, users can either rejoin remote rooms\\nusing room aliases or by being reinvited. Alternatively, if any other\\nhomeserver sends a message to a room that the homeserver was previously\\nin the local HS will automatically rejoin the room.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.5.0","id":"327","title":"Upgrading to v0.5.0"},"328":{"body":"This release needs an updated syutil version. Run: python setup.py develop You will also need to upgrade your configuration as the signing key\\nformat has changed. Run: python -m synapse.app.homeserver --config-path --generate-config","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.4.0","id":"328","title":"Upgrading to v0.4.0"},"329":{"body":"This registration API now closely matches the login API. This introduces\\na bit more backwards and forwards between the HS and the client, but\\nthis improves the overall flexibility of the API. You can now GET on\\n/register to retrieve a list of valid registration flows. Upon choosing\\none, they are submitted in the same way as login, e.g: { type: m.login.password, user: foo, password: bar\\n} The default HS supports 2 flows, with and without Identity Server email\\nauthentication. Enabling captcha on the HS will add in an extra step to\\nall flows: m.login.recaptcha which must be completed before you can\\ntransition to the next stage. There is a new login type: m.login.email.identity which contains the threepidCreds key which\\nwere previously sent in the original register request. For more\\ninformation on this, see the specification.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.3.0","id":"329","title":"Upgrading to v0.3.0"},"33":{"body":"If you get an error along the lines of FATAL: Ident authentication failed for user \\"synapse_user\\", you may need to use an authentication method other than ident: If the synapse_user user has a password, add the password to the database:\\nsection of homeserver.yaml. Then add the following to pg_hba.conf: host synapse synapse_user ::1/128 md5 # or `scram-sha-256` instead of `md5` if you use that If the synapse_user user does not have a password, then a password doesn’t\\nhave to be added to homeserver.yaml. But the following does need to be added\\nto pg_hba.conf: host synapse synapse_user ::1/128 trust Note that line order matters in pg_hba.conf, so make sure that if you do add a\\nnew line, it is inserted before: host all all ::1/128 ident","breadcrumbs":"Using Postgres » Alternative auth methods","id":"33","title":"Alternative auth methods"},"330":{"body":"The VoIP specification has changed between v0.2.0 and v0.3.0. Users\\nshould refresh any browser tabs to get the latest web client code. Users\\non v0.2.0 of the web client will not be able to call those on v0.3.0 and\\nvice versa.","breadcrumbs":"Upgrading between Synapse Versions » Web Client","id":"330","title":"Web Client"},"331":{"body":"The home server now requires setting up of SSL config before it can run.\\nTo automatically generate default config use: $ python synapse/app/homeserver.py \\\\ --server-name machine.my.domain.name \\\\ --bind-port 8448 \\\\ --config-path homeserver.config \\\\ --generate-config This config can be edited if desired, for example to specify a different\\nSSL certificate to use. Once done you can run the home server using: $ python synapse/app/homeserver.py --config-path homeserver.config See the README.rst for more information. Also note that some config options have been renamed, including: “host” to “server-name” “database” to “database-path” “port” to “bind-port” and “unsecure-port”","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.2.0","id":"331","title":"Upgrading to v0.2.0"},"332":{"body":"This release completely changes the database schema and so requires\\nupgrading it before starting the new version of the homeserver. The script “database-prepare-for-0.0.1.sh” should be used to upgrade\\nthe database. This will save all user information, such as logins and\\nprofiles, but will otherwise purge the database. This includes messages,\\nwhich rooms the home server was a member of and room alias mappings. Before running the command the homeserver should be first completely\\nshutdown. To run it, simply specify the location of the database, e.g.: ./scripts/database-prepare-for-0.0.1.sh “homeserver.db” Once this has successfully completed it will be safe to restart the\\nhomeserver. You may notice that the homeserver takes a few seconds\\nlonger to restart than usual as it reinitializes the database. On startup of the new version, users can either rejoin remote rooms\\nusing room aliases or by being reinvited. Alternatively, if any other\\nhomeserver sends a message to a room that the homeserver was previously\\nin the local HS will automatically rejoin the room.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.0.1","id":"332","title":"Upgrading to v0.0.1"},"333":{"body":"Federation is the process by which users on different servers can participate\\nin the same room. For this to work, those other servers must be able to contact\\nyours to send messages. The server_name configured in the Synapse configuration file (often homeserver.yaml) defines how resources (users, rooms, etc.) will be\\nidentified (eg: @user:example.com, #room:example.com). By default,\\nit is also the domain that other servers will use to try to reach your\\nserver (via port 8448). This is easy to set up and will work provided\\nyou set the server_name to match your machine’s public DNS hostname. For this default configuration to work, you will need to listen for TLS\\nconnections on port 8448. The preferred way to do that is by using a\\nreverse proxy: see the reverse proxy documentation for instructions\\non how to correctly set one up. In some cases you might not want to run Synapse on the machine that has\\nthe server_name as its public DNS hostname, or you might want federation\\ntraffic to use a different port than 8448. For example, you might want to\\nhave your user names look like @user:example.com, but you want to run\\nSynapse on synapse.example.com on port 443. This can be done using\\ndelegation, which allows an admin to control where federation traffic should\\nbe sent. See the delegation documentation for instructions on how to set this up. Once federation has been configured, you should be able to join a room over\\nfederation. A good place to start is #synapse:matrix.org - a room for\\nSynapse admins.","breadcrumbs":"Federation » Setting up federation","id":"333","title":"Setting up federation"},"334":{"body":"You can use the federation tester\\nto check if your homeserver is configured correctly. Alternatively try the JSON API used by the federation tester.\\nNote that you’ll have to modify this URL to replace DOMAIN with your server_name. Hitting the API directly provides extra detail. The typical failure mode for federation is that when the server tries to join\\na room, it is rejected with “401: Unauthorized”. Generally this means that other\\nservers in the room could not access yours. (Joining a room over federation is\\na complicated dance which requires connections in both directions). Another common problem is that people on other servers can’t join rooms that\\nyou invite them to. This can be caused by an incorrectly-configured reverse\\nproxy: see the reverse proxy documentation for instructions on how\\nto correctly configure a reverse proxy.","breadcrumbs":"Federation » Troubleshooting","id":"334","title":"Troubleshooting"},"335":{"body":"HTTP 308 Permanent Redirect redirects are not followed: Due to missing features\\nin the HTTP library used by Synapse, 308 redirects are currently not followed by\\nfederating servers, which can cause M_UNKNOWN or 401 Unauthorized errors. This\\nmay affect users who are redirecting apex-to-www (e.g. example.com -> www.example.com),\\nand especially users of the Kubernetes Nginx Ingress module, which uses 308 redirect\\ncodes by default. For those Kubernetes users, this Stackoverflow post\\nmight be helpful. For other users, switching to a 301 Moved Permanently code may be\\nan option. 308 redirect codes will be supported properly in a future\\nrelease of Synapse.","breadcrumbs":"Federation » Known issues","id":"335","title":"Known issues"},"336":{"body":"If you want to get up and running quickly with a trio of homeservers in a\\nprivate federation, there is a script in the demo directory. This is mainly\\nuseful just for development purposes. See demo scripts.","breadcrumbs":"Federation » Running a demo federation of Synapses","id":"336","title":"Running a demo federation of Synapses"},"337":{"body":"This section contains information on tweaking Synapse via the various options in the configuration file. A configuration\\nfile should have been generated when you installed Synapse.","breadcrumbs":"Configuration » Configuration","id":"337","title":"Configuration"},"338":{"body":"This is intended as a guide to the Synapse configuration. The behavior of a Synapse instance can be modified\\nthrough the many configuration settings documented here — each config option is explained,\\nincluding what the default is, how to change the default and what sort of behaviour the setting governs.\\nAlso included is an example configuration for each setting. If you don’t want to spend a lot of time\\nthinking about options, the config as generated sets sensible defaults for all values. Do note however that the\\ndatabase defaults to SQLite, which is not recommended for production usage. You can read more on this subject here.","breadcrumbs":"Configuration » Configuration Manual » Configuring Synapse","id":"338","title":"Configuring Synapse"},"339":{"body":"Configuration options that take a time period can be set using a number\\nfollowed by a letter. Letters have the following meanings: s = second m = minute h = hour d = day w = week y = year For example, setting redaction_retention_period: 5m would remove redacted\\nmessages from the database after 5 minutes, rather than 5 months. In addition, configuration options referring to size use the following suffixes: K = KiB, or 1024 bytes M = MiB, or 1,048,576 bytes G = GiB, or 1,073,741,824 bytes T = TiB, or 1,099,511,627,776 bytes For example, setting max_avatar_size: 10M means that Synapse will not accept files larger than 10,485,760 bytes\\nfor a user avatar.","breadcrumbs":"Configuration » Configuration Manual » Config Conventions","id":"339","title":"Config Conventions"},"34":{"body":"Synapse will refuse to start when using a database with incorrect values of COLLATE and CTYPE unless the config flag allow_unsafe_locale, found in the database section of the config, is set to true. Using different locales can\\ncause issues if the locale library is updated from underneath the database, or\\nif a different version of the locale is used on any replicas. If you have a database with an unsafe locale, the safest way to fix the issue is to dump the database and recreate it with\\nthe correct locale parameter (as shown above). It is also possible to change the\\nparameters on a live database and run a REINDEX on the entire database,\\nhowever extreme care must be taken to avoid database corruption. Note that the above may fail with an error about duplicate rows if corruption\\nhas already occurred, and such duplicate rows will need to be manually removed.","breadcrumbs":"Using Postgres » Fixing incorrect COLLATE or CTYPE","id":"34","title":"Fixing incorrect COLLATE or CTYPE"},"340":{"body":"The configuration file can be validated with the following command: python -m synapse.config read -c To validate the entire file, omit read : python -m synapse.config -c To see how to set other options, check the help reference: python -m synapse.config --help","breadcrumbs":"Configuration » Configuration Manual » Config Validation","id":"340","title":"Config Validation"},"341":{"body":"The configuration file is a YAML file, which means that certain syntax rules\\napply if you want your config file to be read properly. A few helpful things to know: # before any option in the config will comment out that setting and either a default (if available) will\\nbe applied or Synapse will ignore the setting. Thus, in example #1 below, the setting will be read and\\napplied, but in example #2 the setting will not be read and a default will be applied. Example #1: pid_file: DATADIR/homeserver.pid Example #2: #pid_file: DATADIR/homeserver.pid Indentation matters! The indentation before a setting\\nwill determine whether a given setting is read as part of another\\nsetting, or considered on its own. Thus, in example #1, the enabled setting\\nis read as a sub-option of the presence setting, and will be properly applied. However, the lack of indentation before the enabled setting in example #2 means\\nthat when reading the config, Synapse will consider both presence and enabled as\\ndifferent settings. In this case, presence has no value, and thus a default applied, and enabled\\nis an option that Synapse doesn’t recognize and thus ignores. Example #1: presence: enabled: false Example #2: presence:\\nenabled: false In this manual, all top-level settings (ones with no indentation) are identified\\nat the beginning of their section (i.e. “### example_setting”) and\\nthe sub-options, if any, are identified and listed in the body of the section.\\nIn addition, each setting has an example of its usage, with the proper indentation\\nshown.","breadcrumbs":"Configuration » Configuration Manual » YAML","id":"341","title":"YAML"},"342":{"body":"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.","breadcrumbs":"Configuration » Configuration Manual » Modules","id":"342","title":"Modules"},"343":{"body":"(array) 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 []. Options for each entry include: module (string): Path to the Python class of the module. config (object): Configuration options for the module. Example configuration: modules:\\n- module: my_super_module.MySuperClass config: do_thing: true\\n- module: my_other_super_module.SomeClass config: {}","breadcrumbs":"Configuration » Configuration Manual » modules","id":"343","title":"modules"},"344":{"body":"Define your homeserver name and other base options.","breadcrumbs":"Configuration » Configuration Manual » Server","id":"344","title":"Server"},"345":{"body":"(string) 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 configurations: server_name: matrix.org server_name: localhost:8080","breadcrumbs":"Configuration » Configuration Manual » server_name","id":"345","title":"server_name"},"346":{"body":"(string|null) When running Synapse as a daemon, the file to store the pid in. Defaults to null. Example configuration: pid_file: DATADIR/homeserver.pid","breadcrumbs":"Configuration » Configuration Manual » pid_file","id":"346","title":"pid_file"},"347":{"body":"(boolean) Specifies whether Synapse should be started as a daemon process. If Synapse is being managed by systemd, this option must be omitted or set to false. This can also be set by the --daemonize ( -D) argument when starting Synapse. See worker_daemonize for more information on daemonizing workers. Defaults to false. Example configuration: daemonize: true","breadcrumbs":"Configuration » Configuration Manual » daemonize","id":"347","title":"daemonize"},"348":{"body":"(boolean) Print the path to the pidfile just before daemonizing. This can also be set by the --print-pidfile argument when starting Synapse. Defaults to false. Example configuration: print_pidfile: true","breadcrumbs":"Configuration » Configuration Manual » print_pidfile","id":"348","title":"print_pidfile"},"349":{"body":"(string|null) A suffix that is appended to the Synapse user-agent (ex. Synapse/v1.123.0). Defaults to null. Example configuration: user_agent_suffix: \' (I\'\'m a teapot; Linux x86_64)\'","breadcrumbs":"Configuration » Configuration Manual » user_agent_suffix","id":"349","title":"user_agent_suffix"},"35":{"body":"It is recommended to put a reverse proxy such as nginx, Apache, Caddy, HAProxy, relayd or lighttpd\\nin front of Synapse.\\nThis has the advantage of being able to expose the default HTTPS port (443) to Matrix\\nclients without requiring Synapse to bind to a privileged port (port numbers less than\\n1024), avoiding the need for CAP_NET_BIND_SERVICE or running as root. You should configure your reverse proxy to forward requests to /_matrix or /_synapse/client to Synapse, and have it set the X-Forwarded-For and X-Forwarded-Proto request headers. You should remember that Matrix clients and other Matrix servers do not\\nnecessarily need to connect to your server via the same server name or\\nport. Indeed, clients will use port 443 by default, whereas servers default to\\nport 8448. Where these are different, we refer to the ‘client port’ and the\\n‘federation port’. See the Matrix\\nspecification\\nfor more details of the algorithm used for federation connections, and Delegation for instructions on setting up delegation. NOTE: Your reverse proxy must not canonicalise or normalise\\nthe requested URI in any way (for example, by decoding %xx escapes).\\nBeware that Apache will canonicalise URIs unless you specify nocanon. Let’s assume that we expect clients to connect to our server at https://matrix.example.com, and other servers to connect at https://example.com:8448. The following sections detail the configuration of\\nthe reverse proxy and the homeserver.","breadcrumbs":"Configuring a Reverse Proxy » Using a reverse proxy with Synapse","id":"35","title":"Using a reverse proxy with Synapse"},"350":{"body":"(boolean) Determines whether we should freeze the internal dict object in FrozenEvent. Freezing prevents bugs where we accidentally share e.g. signature dicts. However, freezing a dict is expensive. ⚠️ Warning – This option is known to introduce a new class of comparison bugs in Synapse. Defaults to false. Example configuration: use_frozen_dicts: true","breadcrumbs":"Configuration » Configuration Manual » use_frozen_dicts","id":"350","title":"use_frozen_dicts"},"351":{"body":"(string|null) The absolute URL to the web client which / will redirect to. Defaults to null. Example configuration: web_client_location: https://riot.example.com/","breadcrumbs":"Configuration » Configuration Manual » web_client_location","id":"351","title":"web_client_location"},"352":{"body":"(string|null) 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). If unset or null, https:/// is used. Defaults to null. Example configuration: public_baseurl: https://example.com/","breadcrumbs":"Configuration » Configuration Manual » public_baseurl","id":"352","title":"public_baseurl"},"353":{"body":"(boolean) By default, other servers will try to reach our server on port 8448, which can be inconvenient in some environments. Provided https:/// on port 443 is routed to Synapse, this option configures Synapse to serve a file at https:///.well-known/matrix/server. This will tell other servers to send traffic to port 443 instead. This option currently defaults to false. See Delegation of incoming federation traffic for more information. Defaults to false. Example configuration: serve_server_wellknown: true","breadcrumbs":"Configuration » Configuration Manual » serve_server_wellknown","id":"353","title":"serve_server_wellknown"},"354":{"body":"(object) This option allows server runners to add arbitrary key-value pairs to the client-facing .well-known response. Note that the public_baseurl config option must be provided for Synapse to serve a response to /.well-known/matrix/client at all. If this option is provided, it parses the given yaml to json and serves it on /.well-known/matrix/client endpoint alongside the standard properties. Added in Synapse 1.62.0. Example configuration: extra_well_known_client_content: option1: value1 option2: value2","breadcrumbs":"Configuration » Configuration Manual » extra_well_known_client_content","id":"354","title":"extra_well_known_client_content"},"355":{"body":"(integer) 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","breadcrumbs":"Configuration » Configuration Manual » soft_file_limit","id":"355","title":"soft_file_limit"},"356":{"body":"(object) Presence tracking allows users to see the state (e.g online/offline) of other local and remote users. This option replaces the previous top-level use_presence option. This setting has the following sub-options: enabled (boolean|string): Set to false to disable presence tracking on this homeserver. Can also be set to a special value of “untracked” which ignores updates received via clients and federation, while still accepting updates from the module API. The “untracked” option was added in Synapse 1.96.0. Defaults to true. include_offline_users_on_sync (boolean): When clients perform an initial or full_state sync, presence results for offline users are not included by default. Setting include_offline_users_on_sync to true will always include offline users in the results. Defaults to false. last_active_granularity (duration): How long after a user was last active that they are still shown as “currently active” to other users. Larger values reduce the rate of presence updates sent to other users and servers. Added in Synapse 1.156.0. Defaults to \\"1m\\". sync_online_timeout (duration): How long after a client’s last sync request their presence is switched to offline. Clients are expected to keep a sync request open at (almost) all times while online, so this only needs to cover the gap between two consecutive sync requests. Note that if rc_presence is set to ratelimit how often syncs can affect presence, this must be greater than the ratelimit’s interval or users will incorrectly be marked as offline in between syncs. Added in Synapse 1.156.0. Defaults to \\"30s\\". idle_timeout (duration): How long after a user was last active that their presence is switched to “unavailable” (idle) while they remain connected. Must be greater than last_active_granularity. Added in Synapse 1.156.0. Defaults to \\"5m\\". Example configuration: presence: enabled: false include_offline_users_on_sync: false","breadcrumbs":"Configuration » Configuration Manual » presence","id":"356","title":"presence"},"357":{"body":"(boolean) Whether to require authentication to retrieve profile data (avatars, display names) of other users through the client API. Note that profile data is also available via the federation API, unless allow_profile_lookup_over_federation is set to false.\\nThis option must be enabled in order to use limit_profile_requests_to_users_who_share_rooms. Defaults to false. Example configuration: require_auth_for_profile_requests: true","breadcrumbs":"Configuration » Configuration Manual » require_auth_for_profile_requests","id":"357","title":"require_auth_for_profile_requests"},"358":{"body":"(boolean) 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.\\nThe check can only be applied to authenticated requests, so this option requires require_auth_for_profile_requests to be enabled as well. Synapse will refuse to start if this option is enabled without it. Defaults to false. Example configuration: limit_profile_requests_to_users_who_share_rooms: true","breadcrumbs":"Configuration » Configuration Manual » limit_profile_requests_to_users_who_share_rooms","id":"358","title":"limit_profile_requests_to_users_who_share_rooms"},"359":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » include_profile_data_on_invite","id":"359","title":"include_profile_data_on_invite"},"36":{"body":"The HTTP configuration will need to be updated for Synapse to correctly record\\nclient IP addresses and generate redirect URLs while behind a reverse proxy. In homeserver.yaml set x_forwarded: true in the port 8008 section and\\nconsider setting bind_addresses: [\'127.0.0.1\'] so that the server only\\nlistens to traffic on localhost. (Do not change bind_addresses to 127.0.0.1\\nwhen using a containerized Synapse, as that will prevent it from responding\\nto proxied traffic.) Optionally, you can also set request_id_header\\nso that the server extracts and re-uses the same request ID format that the\\nreverse proxy is using.","breadcrumbs":"Configuring a Reverse Proxy » Homeserver Configuration","id":"36","title":"Homeserver Configuration"},"360":{"body":"(boolean) Use this option to include updates of other users’ profiles in sync responses, for users who share rooms.\\nFor legacy sync clients, requires MSC4429 compatibility. For sliding sync clients, requires MSC4262 compatibility. Note, profile updates via sync are currently limited to local users only.\\nThis feature is under development and should be used with caution on busy servers or servers which depend on limit_profile_requests_to_users_who_share_rooms for ensuring profile information doesn’t leak across rooms. Defaults to false. Example configuration: include_profile_updates_in_sync: true","breadcrumbs":"Configuration » Configuration Manual » include_profile_updates_in_sync","id":"360","title":"include_profile_updates_in_sync"},"361":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » allow_public_rooms_without_auth","id":"361","title":"allow_public_rooms_without_auth"},"362":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » allow_public_rooms_over_federation","id":"362","title":"allow_public_rooms_over_federation"},"363":{"body":"(string) 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”. Changed in Synapse 1.76: the default version room version was increased from 9 to 10. Changed in Synapse 1.157: the default version room version was increased from 10 to 11. Changed in Synapse 1.162: the default room version was increased from 11 to 12 Defaults to \\"12\\". Example configuration: default_room_version: \'8\'","breadcrumbs":"Configuration » Configuration Manual » default_room_version","id":"363","title":"default_room_version"},"364":{"body":"(array|null) The garbage collection threshold parameters to pass to gc.set_threshold, if defined. Defaults to null. Example configuration: gc_thresholds:\\n- 700\\n- 10\\n- 10","breadcrumbs":"Configuration » Configuration Manual » gc_thresholds","id":"364","title":"gc_thresholds"},"365":{"body":"(array) 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. Default configuration: gc_min_interval:\\n- 1s\\n- 10s\\n- 30s Example configuration: gc_min_interval:\\n- 0.5s\\n- 30s\\n- 1m","breadcrumbs":"Configuration » Configuration Manual » gc_min_interval","id":"365","title":"gc_min_interval"},"366":{"body":"(integer) Set the limit on the returned events in the timeline in the get and sync operations. A value of -1 means no upper limit. Defaults to 100. Example configuration: filter_timeline_limit: 5000","breadcrumbs":"Configuration » Configuration Manual » filter_timeline_limit","id":"366","title":"filter_timeline_limit"},"367":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » block_non_admin_invites","id":"367","title":"block_non_admin_invites"},"368":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » enable_search","id":"368","title":"enable_search"},"369":{"body":"(array) 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. Default configuration: ip_range_blacklist:\\n- 127.0.0.0/8\\n- 10.0.0.0/8\\n- 172.16.0.0/12\\n- 192.168.0.0/16\\n- 100.64.0.0/10\\n- 192.0.0.0/24\\n- 169.254.0.0/16\\n- 192.88.99.0/24\\n- 198.18.0.0/15\\n- 192.0.2.0/24\\n- 198.51.100.0/24\\n- 203.0.113.0/24\\n- 224.0.0.0/4\\n- ::1/128\\n- fe80::/10\\n- fc00::/7\\n- 2001:db8::/32\\n- ff00::/8\\n- fec0::/10","breadcrumbs":"Configuration » Configuration Manual » ip_range_blacklist","id":"369","title":"ip_range_blacklist"},"37":{"body":"NOTE: You only need one of these.","breadcrumbs":"Configuring a Reverse Proxy » Reverse-proxy configuration examples","id":"37","title":"Reverse-proxy configuration examples"},"370":{"body":"(array) 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. Defaults to []. Example configuration: ip_range_whitelist:\\n- 192.168.1.1","breadcrumbs":"Configuration » Configuration Manual » ip_range_whitelist","id":"370","title":"ip_range_whitelist"},"371":{"body":"(array) List of ports that Synapse should listen on, their purpose and their configuration. Valid resource names are: client: the client-server API (/_matrix/client). Also implies media and static. If configuring the main process, the Synapse Admin API (/_synapse/admin) is also implied. consent: user consent forms (/_matrix/consent). See here for more. federation: the server-server API (/_matrix/federation). Also implies media, keys, openid keys: the key discovery API (/_matrix/key). media: the media API (/_matrix/media). metrics: the metrics interface. See here. (Not compatible with Unix sockets) openid: OpenID authentication. See here. replication: the HTTP replication API (/_synapse/replication). See here. static: static resources under synapse/static (/_matrix/static). (Mostly useful for “fallback authentication”.) health: the health check endpoint. This endpoint is by default active for all other resources and does not have to be activated separately. This is only useful if you want to use the health endpoint explicitly on a dedicated port or for workers and containers without listener e.g. application services. Defaults to []. Options for each entry include: port (integer): The TCP port to bind to. tag (string|null): An alias for the port in the logger name. If set the tag is logged instead of the port. Default to None, is optional and only valid for listener with type: http. See the docs request log format. bind_addresses (array|null): A list of local addresses to listen on. The default is “all local interfaces”. type (string): The type of listener. Normally http, but other valid options are manhole and metrics. tls (boolean): Set to true to enable TLS for this listener. Will use the TLS key/cert specified in tls_private_key_path/tls_certificate_path. x_forwarded (boolean): Only valid for an http listener. Set to true to use the X-Forwarded-For header as the client IP. Useful when Synapse is behind a reverse-proxy. request_id_header (string|null): The header extracted from each incoming request that is used as the basis for the request ID. The request ID is used in logs and tracing to correlate and match up requests. When unset, Synapse will automatically generate sequential request IDs. This option is useful when Synapse is behind a reverse-proxy. Added in Synapse 1.68.0. resources (array): Only valid for an http listener. A list of resources to host on this port. Options for each entry include: names (array): A list of names of HTTP resources. See below for a list of valid resource names. compress (boolean): Set to true to enable gzip compression on HTTP bodies for this resource. This is currently only supported with the client, consent, metrics and federation resources. additional_resources (object): Only valid for an http listener. A map of additional endpoints which should be loaded via dynamic modules. path (string): A path and filename for a Unix socket. Make sure it is located in a directory with read and write permissions, and that it already exists (the directory will not be created). Defaults to None. Note: The use of both path and port options for the same listener is not compatible. The x_forwarded option defaults to true when using Unix sockets and can be omitted. Other options that would not make sense to use with a UNIX socket, such as bind_addresses and tls will be ignored and can be removed. Added in Synapse 1.89.0: Unix socket support mode (integer|null): The file permissions to set on the UNIX socket. Defaults to 666 if unset or null. Note: Must be set as type: http (does not support metrics and manhole). Also make sure that metrics is not included in resources -> names Added in Synapse 1.89.0: Unix socket support Example configurations: listeners:\\n- port: 8448 type: http tls: true resources: - names: - client - federation listeners:\\n- port: 8008 tls: false type: http x_forwarded: true bind_addresses: - ::1 - 127.0.0.1 resources: - names: - client - federation compress: false additional_resources: /_matrix/my/custom/endpoint: module: my_module.CustomRequestHandler config: {}\\n- port: 9000 bind_addresses: - ::1 - 127.0.0.1 type: manhole listeners:\\n- path: /run/synapse/main_public.sock type: http resources: - names: - client - federation","breadcrumbs":"Configuration » Configuration Manual » listeners","id":"371","title":"listeners"},"372":{"body":"(integer|null) Turn on the Twisted manhole service on the given port. This can also be set by the --manhole argument when starting Synapse. Defaults to null. Example configuration: manhole: 1234","breadcrumbs":"Configuration » Configuration Manual » manhole","id":"372","title":"manhole"},"373":{"body":"(object) Connection settings for the manhole. You can find more information on the manhole here. This setting has the following sub-options: username (string|null): The username for the manhole. This defaults to “matrix”. password (string|null): The password for the manhole. This defaults to “rabbithole”. ssh_priv_key_path (string|null): The private SSH key used to encrypt the manhole traffic. If left unset, then hardcoded and non-secret keys are used, which could allow traffic to be intercepted if sent over a public network. ssh_pub_key_path (string|null): The public SSH key corresponsing to ssh_priv_key_path. If left unset, a hardcoded key is used. Example configuration: manhole_settings: username: manhole password: mypassword ssh_priv_key_path: CONFDIR/id_rsa ssh_pub_key_path: CONFDIR/id_rsa.pub","breadcrumbs":"Configuration » Configuration Manual » manhole_settings","id":"373","title":"manhole_settings"},"374":{"body":"(string|null) Proxy server to use for HTTP requests.\\nFor more details, see the forward proxy documentation. There is no default for this option. Example configuration: http_proxy: http://USERNAME:PASSWORD@10.0.1.1:8080/","breadcrumbs":"Configuration » Configuration Manual » http_proxy","id":"374","title":"http_proxy"},"375":{"body":"(string|null) Proxy server to use for HTTPS requests.\\nFor more details, see the forward proxy documentation. There is no default for this option. Example configuration: https_proxy: http://USERNAME:PASSWORD@proxy.example.com:8080/","breadcrumbs":"Configuration » Configuration Manual » https_proxy","id":"375","title":"https_proxy"},"376":{"body":"(array) List of hosts, IP addresses, or IP ranges in CIDR format which should not use the proxy. Synapse will directly connect to these hosts.\\nFor more details, see the forward proxy documentation. There is no default for this option. Example configuration: no_proxy_hosts:\\n- master.hostname.example.com\\n- 10.1.0.0/16\\n- 172.30.0.0/16","breadcrumbs":"Configuration » Configuration Manual » no_proxy_hosts","id":"376","title":"no_proxy_hosts"},"377":{"body":"(object) The matrix_authentication_service setting configures integration with Matrix Authentication Service (MAS). This setting has the following sub-options: enabled (boolean): Whether or not to enable the MAS integration. If this is set to false, Synapse will use its legacy internal authentication API. Defaults to false. endpoint (string): The URL where Synapse can reach MAS. This must have the discovery and oauth resources mounted. Defaults to \\"http://localhost:8080\\". force_http2 (boolean): Force HTTP/2 over plaintext (H2C) when connecting to MAS. MAS supports this natively, but a reverse proxy between Synapse and MAS may not. Defaults to false. secret (string|null): A shared secret that will be used to authenticate requests from and to MAS. secret_path (string|null): Alternative to secret, reading the shared secret from a file. The file should be a plain text file, containing only the secret. Synapse reads the secret from the given file once at startup. Example configuration: matrix_authentication_service: enabled: true secret: someverysecuresecret endpoint: http://localhost:8080","breadcrumbs":"Configuration » Configuration Manual » matrix_authentication_service","id":"377","title":"matrix_authentication_service"},"378":{"body":"(integer) 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. Defaults to 10. Example configuration: dummy_events_threshold: 5","breadcrumbs":"Configuration » Configuration Manual » dummy_events_threshold","id":"378","title":"dummy_events_threshold"},"379":{"body":"An optional duration. If set, Synapse will run a daily background task to log out and delete any device that hasn’t been accessed for more than the specified amount of time. A value of null means devices are never pruned. Note: This task will always run on the main process, regardless of the value of run_background_tasks_on. This is due to workers currently not having the ability to delete devices. Defaults to null. Example configuration: delete_stale_devices_after: 1y","breadcrumbs":"Configuration » Configuration Manual » delete_stale_devices_after","id":"379","title":"delete_stale_devices_after"},"38":{"body":"server { listen 443 ssl; listen [::]:443 ssl; # For the federation port listen 8448 ssl default_server; listen [::]:8448 ssl default_server; server_name matrix.example.com; location ~ ^(/_matrix|/_synapse/client) { # note: do not add a path (even a single /) after the port in `proxy_pass`, # otherwise nginx will canonicalise the URI and cause signature verification # errors. proxy_pass http://localhost:8008; proxy_set_header X-Forwarded-For $remote_addr; proxy_set_header X-Forwarded-Proto $scheme; # If clients reach Synapse on a non-default port, use `$http_host` instead # so the port is kept, and include that port in `public_baseurl`. proxy_set_header Host $host; # Nginx by default only allows file uploads up to 1M in size # Increase client_max_body_size to match max_upload_size defined in homeserver.yaml client_max_body_size 50M; # Synapse responses may be chunked, which is an HTTP/1.1 feature. proxy_http_version 1.1; }\\n}","breadcrumbs":"Configuring a Reverse Proxy » nginx","id":"38","title":"nginx"},"380":{"body":"(object) 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: smtp_host (string): The hostname of the outgoing SMTP server to use. Defaults to \\"localhost\\". smtp_port (string|null): The port on the mail server for outgoing SMTP. If null or unset, 465 is used if force_tls is true, else 25. Changed in Synapse 1.64.0: the default port is now aware of force_tls. Defaults to null. smtp_user (string|null): Username for authentication to the SMTP server. Defaults to null. smtp_pass (string|null): Password for authentication to the SMTP server. Defaults to null. force_tls (boolean): By default, Synapse connects over plain text and then optionally upgrades to TLS via STARTTLS. If this option is set to true, TLS is used from the start (Implicit TLS), and the option require_transport_security is ignored. It is recommended to enable this if supported by your mail server. New in Synapse 1.64.0. Defaults to false. require_transport_security (boolean): Set to true to require TLS transport security for SMTP. By default, Synapse will connect over plain text, and will then switch to TLS via STARTTLS if the SMTP server supports it. If this option is set, Synapse will refuse to connect unless the server supports STARTTLS. Defaults to false. enable_tls (boolean): By default, if the server supports TLS, it will be used, and the server must present a certificate that is valid for tlsname. If this option is set to false, TLS will not be used. Defaults to true. tlsname (string): The domain name the SMTP server’s TLS certificate must be valid for, defaulting to smtp_host. notif_from (string|null): Defines the “From” address to use when sending emails. It must be set if email sending is enabled. The placeholder %(app)s will be replaced by the application name, which is normally set in app_name, but may be overridden by the Matrix client application. Note that the placeholder must be written %(app)s, including the trailing ‘s’. Defaults to null. app_name (string): Defines the default value for %(app)s in notif_from and email subjects. Defaults to \\"Matrix\\". enable_notifs (boolean): Set to true to allow users to receive e-mail notifications. If this is not set, users can configure e-mail notifications but will not receive them. Defaults to false. notif_for_new_users (boolean): Set to false to disable automatic subscription to email notifications for new users. Defaults to true. notif_delay_before_mail (duration): The time to wait before emailing about a notification. This gives the user a chance to view the message via push or an open client. New in Synapse 1.99.0. Defaults to \\"10m\\". client_base_url (string): Custom URL for client links within the email notifications. (This setting used to be called riot_base_url; the old name is still supported for backwards-compatibility but is now deprecated.) Defaults to \\"https://matrix.to\\". validation_token_lifetime (duration): Configures the time that a validation email will expire after sending. Defaults to \\"1h\\". invite_client_location (string|null): The web client location to direct users to during an invite. This is passed to the identity server as the org.matrix.web_client_location key. If null or unset no guidance is given to the identity server. Defaults to null. subjects (object): Subjects to use when sending emails from Synapse. The placeholder %(app)s will be replaced with the value of the app_name setting, or by a value dictated by the Matrix client application. In addition, each subject can use the following placeholders: %(person)s, which will be replaced by the displayname of the user(s) that sent the message(s), e.g. “Alice and Bob”, and %(room)s, which will be replaced by the name of the room the message(s) have been sent to, e.g. “My super room”. In addition, emails related to account administration will can use the %(server_name)s placeholder, which will be replaced by the value of the server_name setting in your Synapse configuration. This setting has the following sub-options: message_from_person_in_room (string): Subject to use to notify about one message from one or more user(s) in a room which has a name. Defaults to \\"[%(app)s] You have a message on %(app)s from %(person)s in the %(room)s room...\\". message_from_person (string): Subject to use to notify about one message from one or more user(s) in a room which doesn’t have a name. Defaults to \\"[%(app)s] You have a message on %(app)s from %(person)s...\\". messages_from_person (string): Subject to use to notify about multiple messages from one or more users in a room which doesn’t have a name. Defaults to \\"[%(app)s] You have messages on %(app)s from %(person)s...\\". messages_in_room (string): Subject to use to notify about multiple messages in a room which has a name. Defaults to \\"[%(app)s] You have messages on %(app)s in the %(room)s room...\\". messages_in_room_and_others (string): Subject to use to notify about multiple messages in multiple rooms. Defaults to \\"[%(app)s] You have messages on %(app)s in the %(room)s room and others...\\". messages_from_person_and_others (string): Subject to use to notify about multiple messages from multiple persons in multiple rooms. This is similar to the setting above except it’s used when the room in which the notification was triggered has no name. Defaults to \\"[%(app)s] You have messages on %(app)s from %(person)s and others...\\". invite_from_person_to_room (string): Subject to use to notify about an invite to a room which has a name. Defaults to \\"[%(app)s] %(person)s has invited you to join the %(room)s room on %(app)s...\\". invite_from_person (string): Subject to use to notify about an invite to a room which doesn’t have a name. Defaults to \\"[%(app)s] %(person)s has invited you to chat on %(app)s...\\". password_reset (string): Subject to use when sending a password reset email. Defaults to \\"[%(server_name)s] Password reset\\". email_validation (string): Subject to use when sending a verification email to assert an address’s ownership. Defaults to \\"[%(server_name)s] Validate your email\\". Example configuration: email: smtp_host: mail.server smtp_port: 587 smtp_user: exampleusername smtp_pass: examplepassword force_tls: true require_transport_security: true enable_tls: false tlsname: mail.server.example.com notif_from: Your Friendly %(app)s homeserver 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\'","breadcrumbs":"Configuration » Configuration Manual » email","id":"380","title":"email"},"381":{"body":"The maximum allowed duration by which sent events can be delayed, as per MSC4140. Must be a positive value if set. If null or unset, sending of delayed events is disallowed. Defaults to null. Example configuration: max_event_delay_duration: 24h","breadcrumbs":"Configuration » Configuration Manual » max_event_delay_duration","id":"381","title":"max_event_delay_duration"},"382":{"body":"(object) Configuration settings related to the user types feature. This setting has the following sub-options: default_user_type (string|null): The default user type to use for registering new users when no value has been specified. Defaults to none. Defaults to null. extra_user_types (array): Array of additional user types to allow. These are treated as real users. Defaults to []. Example configuration: user_types: default_user_type: custom extra_user_types: - custom - custom2","breadcrumbs":"Configuration » Configuration Manual » user_types","id":"382","title":"user_types"},"383":{"body":"Useful options for Synapse admins.","breadcrumbs":"Configuration » Configuration Manual » Homeserver blocking","id":"383","title":"Homeserver blocking"},"384":{"body":"(string|null) How to reach the server admin, used in ResourceLimitError. Defaults to null. Example configuration: admin_contact: mailto:admin@server.com","breadcrumbs":"Configuration » Configuration Manual » admin_contact","id":"384","title":"admin_contact"},"385":{"body":"(boolean) Blocks users from connecting to the homeserver and provides the human-readable reason given in hs_disabled_message. Defaults to false. Example configuration: hs_disabled: true","breadcrumbs":"Configuration » Configuration Manual » hs_disabled","id":"385","title":"hs_disabled"},"386":{"body":"(string) Human-readable reason why the connection was blocked. Defaults to \\"Homeserver is currently blocked\\". Example configuration: hs_disabled_message: Reason for why the HS is blocked","breadcrumbs":"Configuration » Configuration Manual » hs_disabled_message","id":"386","title":"hs_disabled_message"},"387":{"body":"(boolean) 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. If this is enabled, a value for max_mau_value must also be set. See Monthly Active Users for details on how to configure MAU. Defaults to false. Example configuration: limit_usage_by_mau: true","breadcrumbs":"Configuration » Configuration Manual » limit_usage_by_mau","id":"387","title":"limit_usage_by_mau"},"388":{"body":"(integer) 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","breadcrumbs":"Configuration » Configuration Manual » max_mau_value","id":"388","title":"max_mau_value"},"389":{"body":"(integer) 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","breadcrumbs":"Configuration » Configuration Manual » mau_trial_days","id":"389","title":"mau_trial_days"},"39":{"body":"Add New Proxy-Host - Tab Details - Domain Names: matrix.example.com - Scheme: http - Forward Hostname / IP: localhost # IP address or hostname where Synapse is hosted. Bare-metal or Container. - Forward Port: 8008 - Tab Custom locations - Add Location - Define Location: /_matrix - Scheme: http - Forward Hostname / IP: localhost # IP address or hostname where Synapse is hosted. Bare-metal or Container. - Forward Port: 8008 - Click on the gear icon to display a custom configuration field. Increase client_max_body_size to match max_upload_size defined in homeserver.yaml - Enter this in the Custom Field: client_max_body_size 50M; - Tab SSL/TLS - Choose your SSL/TLS certificate and preferred settings. - Tab Advanced - Enter this in the Custom Field. This means that port 8448 no longer needs to be opened in your Firewall. The Federation communication use now Port 443. location /.well-known/matrix/server { return 200 \'{\\"m.server\\": \\"matrix.example.com:443\\"}\'; add_header Content-Type application/json; } location /.well-known/matrix/client { return 200 \'{\\"m.homeserver\\": {\\"base_url\\": \\"https://matrix.example.com\\"}}\'; add_header Content-Type application/json; add_header \\"Access-Control-Allow-Origin\\" *; }","breadcrumbs":"Configuring a Reverse Proxy » Nginx Proxy Manager or NPMPlus","id":"39","title":"Nginx Proxy Manager or NPMPlus"},"390":{"body":"(object) The option mau_appservice_trial_days is similar to mau_trial_days, but applies a different trial number if the user was registered by an appservice. A value of 0 means no trial days are applied. Appservices not listed in this dictionary use the value of mau_trial_days instead. Defaults to {}. Example configuration: mau_appservice_trial_days: my_appservice_id: 3 another_appservice_id: 6","breadcrumbs":"Configuration » Configuration Manual » mau_appservice_trial_days","id":"390","title":"mau_appservice_trial_days"},"391":{"body":"(boolean) Limit 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. Example configuration: mau_limit_alerting: false","breadcrumbs":"Configuration » Configuration Manual » mau_limit_alerting","id":"391","title":"mau_limit_alerting"},"392":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » mau_stats_only","id":"392","title":"mau_stats_only"},"393":{"body":"(array) Sometimes the server admin will want to ensure certain accounts are never blocked by mau checking. These accounts are specified by this option. Add accounts by specifying the medium and address of the reserved threepid (3rd party identifier). Defaults to []. Options for each entry include: medium (string): Medium of the account threepid. address (string): Address of the account threepid. Example configuration: mau_limit_reserved_threepids:\\n- medium: email address: reserved_user@example.com","breadcrumbs":"Configuration » Configuration Manual » mau_limit_reserved_threepids","id":"393","title":"mau_limit_reserved_threepids"},"394":{"body":"(string|null) This option is used by phonehome stats to group together related servers. Defaults to null. Example configuration: server_context: context","breadcrumbs":"Configuration » Configuration Manual » server_context","id":"394","title":"server_context"},"395":{"body":"(object) 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. In Synapse, the complexity of a room is measured by the number of current state events in a room, divided by 500. “Current” here means the latest state, i.e. if a user joins, then leaves, then joins, that will count as 1 current m.room.member state event. This setting has the following sub-options: enabled (boolean): Whether this check is enabled. Defaults to false. complexity (number): The limit above which rooms cannot be joined. Defaults to 1.0. complexity_error (string): Override the error which is returned when the room is too complex with a custom message. Defaults to \\"Your homeserver is unable to join rooms this large or complex. Please speak to your server administrator, or upgrade your instance to join this room.\\". admins_can_join (boolean): Allow server admins to join complex rooms. Defaults to false. Example configuration: limit_remote_rooms: enabled: true complexity: 0.5 complexity_error: I can\'t let you do that, Dave. admins_can_join: true","breadcrumbs":"Configuration » Configuration Manual » limit_remote_rooms","id":"395","title":"limit_remote_rooms"},"396":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » require_membership_for_aliases","id":"396","title":"require_membership_for_aliases"},"397":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » allow_per_room_profiles","id":"397","title":"allow_per_room_profiles"},"398":{"body":"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. Defaults to null. Example configuration: max_avatar_size: 10M","breadcrumbs":"Configuration » Configuration Manual » max_avatar_size","id":"398","title":"max_avatar_size"},"399":{"body":"(array|null) 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. Defaults to null. Example configuration: allowed_avatar_mimetypes:\\n- image/png\\n- image/jpeg\\n- image/gif","breadcrumbs":"Configuration » Configuration Manual » allowed_avatar_mimetypes","id":"399","title":"allowed_avatar_mimetypes"},"4":{"body":"","breadcrumbs":"Installation » Installation Instructions","id":"4","title":"Installation Instructions"},"40":{"body":"matrix.example.com { reverse_proxy /_matrix/* localhost:8008 reverse_proxy /_synapse/client/* localhost:8008\\n} example.com:8448 { reverse_proxy /_matrix/* localhost:8008\\n} Delegation example: example.com { header /.well-known/matrix/* Content-Type application/json header /.well-known/matrix/* Access-Control-Allow-Origin * respond /.well-known/matrix/server `{\\"m.server\\": \\"matrix.example.com:443\\"}` respond /.well-known/matrix/client `{\\"m.homeserver\\":{\\"base_url\\":\\"https://matrix.example.com\\"},\\"m.identity_server\\":{\\"base_url\\":\\"https://identity.example.com\\"}}`\\n} matrix.example.com { reverse_proxy /_matrix/* localhost:8008 reverse_proxy /_synapse/client/* localhost:8008\\n}","breadcrumbs":"Configuring a Reverse Proxy » Caddy v2","id":"40","title":"Caddy v2"},"400":{"body":"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. Synapse will check whether the rentention period has concluded for redacted events every 5 minutes. Thus, even if this option is set to 0, Synapse may still take up to 5 minutes to purge redacted events from the database. Set to null to disable. Defaults to \\"7d\\". Example configuration: redaction_retention_period: 28d","breadcrumbs":"Configuration » Configuration Manual » redaction_retention_period","id":"400","title":"redaction_retention_period"},"401":{"body":"How long after an m.room.message was sent a local user is still allowed to redact it. If a local user tries to redact a m.room.message older than this period Synapse responds with 403 M_FORBIDDEN and does not redact the event. Only applies to m.room.message events redacted by local users. Redactions of other event types and redactions received over federation are unaffected. When the target of the redaction is an edit ( m.replace), the age and type are taken from the original event and not the edit. Set to null (the default) to disable, allowing events to be redacted at any time. Defaults to null. Example configuration: redaction_allowed_period: 7d","breadcrumbs":"Configuration » Configuration Manual » redaction_allowed_period","id":"401","title":"redaction_allowed_period"},"402":{"body":"How long to keep locally forgotten rooms before purging them from the DB. A value of null means it’s disabled. Defaults to null. Example configuration: forgotten_room_retention_period: 28d","breadcrumbs":"Configuration » Configuration Manual » forgotten_room_retention_period","id":"402","title":"forgotten_room_retention_period"},"403":{"body":"How long to track users’ last seen time and IPs in the database. Set to null to disable clearing out of old rows. Defaults to \\"28d\\". Example configuration: user_ips_max_age: 14d","breadcrumbs":"Configuration » Configuration Manual » user_ips_max_age","id":"403","title":"user_ips_max_age"},"404":{"body":"(boolean) 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. 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. Defaults to true. Example configuration: request_token_inhibit_3pid_errors: true","breadcrumbs":"Configuration » Configuration Manual » request_token_inhibit_3pid_errors","id":"404","title":"request_token_inhibit_3pid_errors"},"405":{"body":"(array|null) 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. Defaults to null. Example configuration: next_link_domain_whitelist: matrix.org","breadcrumbs":"Configuration » Configuration Manual » next_link_domain_whitelist","id":"405","title":"next_link_domain_whitelist"},"406":{"body":"(object) These options define templates to use when generating email or HTML page contents. See here for more information about using custom templates. This setting has the following sub-options: custom_template_directory (string|null): 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. Defaults to null. Example configuration: templates: custom_template_directory: /path/to/custom/templates/","breadcrumbs":"Configuration » Configuration Manual » templates","id":"406","title":"templates"},"407":{"body":"(object) 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. You can read more about this feature here. This setting has the following sub-options: enabled (boolean): Enforce message retention policies Defaults to false. default_policy (object): Default message retention policy. If set, Synapse will apply it to rooms that lack the m.room.retention state event. This setting has the following sub-options: min_lifetime: Minimum message retention time of the default message retention policy. Synapse doesn’t take this option into account yet. Defaults to null. max_lifetime: Maximum message retention time of the default message retention policy. Defaults to null. allowed_lifetime_min: Retention policy limit. If set, and the state of a room contains a m.room.retention event in its state which contains a min_lifetime that’s beyond this bound, Synapse will cap the room’s policy to these limits when running purge jobs. Defaults to null. allowed_lifetime_max: Retention policy limit. If set, and the state of a room contains a m.room.retention event in its state which contains a max_lifetime that’s beyond this bound, Synapse will cap the room’s policy to these limits when running purge jobs. Defaults to null. purge_jobs (array|null): Server admins can define the settings of the background jobs purging the events whose lifetime has expired under the purge_jobs section. If no configuration is provided for this option, a single job will be set up to delete expired events in every room daily. Each job’s configuration defines which range of message lifetimes the job takes care of. For example, if shortest_max_lifetime is “2d” and longest_max_lifetime is “3d”, the job will handle purging expired events in rooms whose state defines a max_lifetime that’s both higher than 2 days, and lower than or equal to 3 days. Both the minimum and the maximum value of a range are optional, e.g. a job with no shortest_max_lifetime and a longest_max_lifetime of “3d” will handle every room with a retention policy whose max_lifetime is lower than or equal to three days. The rationale for this per-job configuration is that some rooms might have a retention policy with a low max_lifetime, where history needs to be purged of outdated messages on a more frequent basis than for the rest of the rooms (e.g. every 12h), but not want that purge to be performed by a job that’s iterating over every room it knows, which could be heavy on the server. If any purge job is configured, it is strongly recommended to have at least a single job with neither shortest_max_lifetime nor longest_max_lifetime set, or one job without shortest_max_lifetime and one job without longest_max_lifetime set. Otherwise some rooms might be ignored, even if allowed_lifetime_min and allowed_lifetime_max are set, because capping a room’s policy to these values is done after the policies are retrieved from Synapse’s database (which is done using the range specified in a purge job’s configuration). Defaults to null. Options for each entry include: shortest_max_lifetime: Apply job to rooms that have a max_lifetime higher than shortest_max_lifetime. A value of null never excludes any room. longest_max_lifetime: Apply job to rooms that have a max_lifetime lower than or equal to shortest_max_lifetime. A value of null never excludes any room. interval (duration): How often to run the job. 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","breadcrumbs":"Configuration » Configuration Manual » retention","id":"407","title":"retention"},"408":{"body":"Options related to TLS.","breadcrumbs":"Configuration » Configuration Manual » TLS","id":"408","title":"TLS"},"409":{"body":"(string|null) 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. 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). Defaults to null. Example configuration: tls_certificate_path: CONFDIR/SERVERNAME.tls.crt","breadcrumbs":"Configuration » Configuration Manual » tls_certificate_path","id":"409","title":"tls_certificate_path"},"41":{"body":" SSLEngine on ServerName matrix.example.com RequestHeader set \\"X-Forwarded-Proto\\" expr=%{REQUEST_SCHEME} AllowEncodedSlashes NoDecode ProxyPreserveHost on ProxyPass /_matrix http://127.0.0.1:8008/_matrix nocanon ProxyPassReverse /_matrix http://127.0.0.1:8008/_matrix ProxyPass /_synapse/client http://127.0.0.1:8008/_synapse/client nocanon ProxyPassReverse /_synapse/client http://127.0.0.1:8008/_synapse/client\\n SSLEngine on ServerName example.com RequestHeader set \\"X-Forwarded-Proto\\" expr=%{REQUEST_SCHEME} AllowEncodedSlashes NoDecode ProxyPass /_matrix http://127.0.0.1:8008/_matrix nocanon ProxyPassReverse /_matrix http://127.0.0.1:8008/_matrix\\n NOTE: ensure the nocanon options are included. NOTE 2: It appears that Synapse is currently incompatible with the ModSecurity module for Apache ( mod_security2). If you need it enabled for other services on your web server, you can disable it for Synapse’s two VirtualHosts by including the following lines before each of the two above: SecRuleEngine off\\n NOTE 3: Missing ProxyPreserveHost on can lead to a redirect loop.","breadcrumbs":"Configuring a Reverse Proxy » Apache","id":"41","title":"Apache"},"410":{"body":"(string|null) PEM-encoded private key for TLS. Defaults to null. Example configuration: tls_private_key_path: CONFDIR/SERVERNAME.tls.key","breadcrumbs":"Configuration » Configuration Manual » tls_private_key_path","id":"410","title":"tls_private_key_path"},"411":{"body":"(boolean) Whether to verify TLS server certificates for outbound federation requests. To disable certificate verification, set the option to false. Defaults to true. Example configuration: federation_verify_certificates: false","breadcrumbs":"Configuration » Configuration Manual » federation_verify_certificates","id":"411","title":"federation_verify_certificates"},"412":{"body":"(string) The minimum TLS version that will be used for outbound federation requests. 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. Defaults to \\"1\\". Example configuration: federation_client_minimum_tls_version: \'1.2\'","breadcrumbs":"Configuration » Configuration Manual » federation_client_minimum_tls_version","id":"412","title":"federation_client_minimum_tls_version"},"413":{"body":"(array) 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_certificates is true. Defaults to []. Example configuration: federation_certificate_verification_whitelist:\\n- lon.example.com\\n- \'*.domain.com\'\\n- \'*.onion\'","breadcrumbs":"Configuration » Configuration Manual » federation_certificate_verification_whitelist","id":"413","title":"federation_certificate_verification_whitelist"},"414":{"body":"(array) 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. Defaults to []. Example configuration: federation_custom_ca_list:\\n- myCA1.pem\\n- myCA2.pem\\n- myCA3.pem","breadcrumbs":"Configuration » Configuration Manual » federation_custom_ca_list","id":"414","title":"federation_custom_ca_list"},"415":{"body":"Options related to federation.","breadcrumbs":"Configuration » Configuration Manual » Federation","id":"415","title":"Federation"},"416":{"body":"(null|array) 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 specified as an empty list ( []), federation will be denied with all servers. Specifying an empty list ( []) here is the recommended way of disabling federation. If unset or null, allows federation with all servers. Note: this does not stop a server from joining rooms that servers not on the whitelist are in. As such, this option is really only useful to establish a “private federation”, where a group of servers all whitelist each other and have the same whitelist. Defaults to null. Example configuration: federation_domain_whitelist:\\n- lon.example.com\\n- nyc.example.com\\n- syd.example.com","breadcrumbs":"Configuration » Configuration Manual » federation_domain_whitelist","id":"416","title":"federation_domain_whitelist"},"417":{"body":"(boolean) Enables an endpoint for fetching the federation whitelist config. The request method and path is GET /_synapse/client/v1/config/federation_whitelist, and the response format is: { \\"whitelist_enabled\\": true, // Whether the federation whitelist is being enforced \\"whitelist\\": [ // Which server names are allowed by the whitelist \\"example.com\\" ]\\n} If whitelist_enabled is false then the server is permitted to federate with all others. The endpoint requires authentication. Defaults to false. Example configuration: federation_whitelist_endpoint_enabled: true","breadcrumbs":"Configuration » Configuration Manual » federation_whitelist_endpoint_enabled","id":"417","title":"federation_whitelist_endpoint_enabled"},"418":{"body":"(array) 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. Defaults to []. Example configuration: federation_metrics_domains:\\n- matrix.org\\n- example.com","breadcrumbs":"Configuration » Configuration Manual » federation_metrics_domains","id":"418","title":"federation_metrics_domains"},"419":{"body":"(boolean) 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. Defaults to true. Example configuration: allow_profile_lookup_over_federation: false","breadcrumbs":"Configuration » Configuration Manual » allow_profile_lookup_over_federation","id":"419","title":"allow_profile_lookup_over_federation"},"42":{"body":"frontend https bind *:443,[::]:443 ssl crt /etc/ssl/haproxy/ strict-sni alpn h2,http/1.1 http-request set-header X-Forwarded-Proto https if { ssl_fc } http-request set-header X-Forwarded-Proto http if !{ ssl_fc } http-request set-header X-Forwarded-For %[src] # Matrix client traffic acl matrix-host hdr(host) -i matrix.example.com matrix.example.com:443 acl matrix-path path_beg /_matrix acl matrix-path path_beg /_synapse/client use_backend matrix if matrix-host matrix-path frontend matrix-federation bind *:8448,[::]:8448 ssl crt /etc/ssl/haproxy/synapse.pem alpn h2,http/1.1 http-request set-header X-Forwarded-Proto https if { ssl_fc } http-request set-header X-Forwarded-Proto http if !{ ssl_fc } http-request set-header X-Forwarded-For %[src] default_backend matrix backend matrix server matrix 127.0.0.1:8008 Example configuration, if using a UNIX socket. The configuration lines regarding the frontends do not need to be modified. backend matrix server matrix unix@/run/synapse/main_public.sock Example configuration when using a single port for both client and federation traffic. frontend https bind *:443,[::]:443 ssl crt /etc/ssl/haproxy/ strict-sni alpn h2,http/1.1 http-request set-header X-Forwarded-Proto https if { ssl_fc } http-request set-header X-Forwarded-Proto http if !{ ssl_fc } http-request set-header X-Forwarded-For %[src] acl matrix-host hdr(host) -i matrix.example.com matrix.example.com:443 acl matrix-sni ssl_fc_sni matrix.example.com acl matrix-path path_beg /_matrix acl matrix-path path_beg /_synapse/client use_backend matrix if matrix-host matrix-path use_backend matrix if matrix-sni backend matrix server matrix 127.0.0.1:8008 Delegation example: frontend https acl matrix-well-known-client-path path /.well-known/matrix/client acl matrix-well-known-server-path path /.well-known/matrix/server use_backend matrix-well-known-client if matrix-well-known-client-path use_backend matrix-well-known-server if matrix-well-known-server-path backend matrix-well-known-client http-after-response set-header Access-Control-Allow-Origin \\"*\\" http-after-response set-header Access-Control-Allow-Methods \\"GET, POST, PUT, DELETE, OPTIONS\\" http-after-response set-header Access-Control-Allow-Headers \\"Origin, X-Requested-With, Content-Type, Accept, Authorization\\" http-request return status 200 content-type application/json string \'{\\"m.homeserver\\":{\\"base_url\\":\\"https://matrix.example.com\\"},\\"m.identity_server\\":{\\"base_url\\":\\"https://identity.example.com\\"}}\' backend matrix-well-known-server http-after-response set-header Access-Control-Allow-Origin \\"*\\" http-after-response set-header Access-Control-Allow-Methods \\"GET, POST, PUT, DELETE, OPTIONS\\" http-after-response set-header Access-Control-Allow-Headers \\"Origin, X-Requested-With, Content-Type, Accept, Authorization\\" http-request return status 200 content-type application/json string \'{\\"m.server\\":\\"matrix.example.com:443\\"}\'","breadcrumbs":"Configuring a Reverse Proxy » HAProxy","id":"42","title":"HAProxy"},"420":{"body":"(boolean) Set this option to true to allow device display name lookup over federation. By default, the Federation API prevents other homeservers from obtaining the display names of any user devices on this homeserver. Defaults to false. Example configuration: allow_device_name_lookup_over_federation: true","breadcrumbs":"Configuration » Configuration Manual » allow_device_name_lookup_over_federation","id":"420","title":"allow_device_name_lookup_over_federation"},"421":{"body":"(object) The federation section defines some sub-options related to federation. The following options are related to configuring timeout and retry logic for one request, independently of the others. Short retry algorithm is used when something or someone will wait for the request to have an answer, while long retry is used for requests that happen in the background, like sending a federation transaction. destination_* options control the retry logic when communicating with a specific homeserver destination. Unlike the previous configuration options, these values apply across all requests for a given destination and the state of the backoff is stored in the database. This setting has the following sub-options: client_timeout (duration): Timeout for the federation requests. Defaults to \\"60s\\". max_short_retry_delay (duration): Maximum delay to be used for the short retry algo. Defaults to \\"2s\\". max_long_retry_delay (duration): Maximum delay to be used for the long retry algo. Defaults to \\"60s\\". max_short_retries (integer): Maximum number of retries for the short retry algo. Defaults to 3. max_long_retries (integer): Maximum number of retries for the long retry algo. Defaults to 10. destination_min_retry_interval (duration): The initial backoff, after the first request fails. Defaults to \\"10m\\". destination_retry_multiplier (integer): How much we multiply the backoff by after each subsequent fail. Defaults to 2. destination_max_retry_interval (duration): A cap on the backoff. Defaults to \\"1w\\". Example configuration: federation: client_timeout: 180s max_short_retry_delay: 7s max_long_retry_delay: 100s max_short_retries: 5 max_long_retries: 20 destination_min_retry_interval: 30s destination_retry_multiplier: 5 destination_max_retry_interval: 12h","breadcrumbs":"Configuration » Configuration Manual » federation","id":"421","title":"federation"},"422":{"body":"Options related to caching.","breadcrumbs":"Configuration » Configuration Manual » Caching","id":"422","title":"Caching"},"423":{"body":"(size) The number of events to cache in memory. Defaults to 10K. Like other caches, this is affected by caches.global_factor (see below). For example, the default is 10K and the global_factor default is 0.5. Since 10K * 0.5 is 5K then the event cache size will be 5K. The cache affected by this configuration is named as “*getEvent*”. Note that this option is not part of the caches section. Defaults to \\"10K\\". Example configuration: event_cache_size: 15K","breadcrumbs":"Configuration » Configuration Manual » event_cache_size","id":"423","title":"event_cache_size"},"424":{"body":"(object) 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. This setting has the following sub-options: global_factor (number): Controls the global cache factor, which is the default cache factor for all caches if a specific factor for that cache is not otherwise set. This can also be set by the SYNAPSE_CACHE_FACTOR environment variable. Setting by environment variable takes priority over setting through the config file. Defaults to 0.5, which will halve the size of all caches. Note that changing this value also affects the HTTP connection pool. Defaults to 0.5. per_cache_factors (object): A dictionary of cache name to cache factor for that individual cache. Overrides the global cache factor for a given cache. These can also be set through environment variables comprised of SYNAPSE_CACHE_FACTOR_ + the name of the cache in capital letters and underscores. Setting by environment variable takes priority over setting through the config file. Ex. SYNAPSE_CACHE_FACTOR_GET_USERS_WHO_SHARE_ROOM_WITH_USER=2.0 Some caches have ‘*’ and other characters that are not alphanumeric or underscores. These caches can be named with or without the special characters stripped. For example, to specify the cache factor for *stateGroupCache* via an environment variable would be SYNAPSE_CACHE_FACTOR_STATEGROUPCACHE=2.0. Defaults to {}. expire_caches (boolean): Controls whether cache entries are evicted after a specified time period. Set to false to disable this feature. Note that never expiring caches may result in excessive memory usage. Defaults to true. cache_entry_ttl (duration): If expire_caches is enabled, this flag controls how long an entry can be in a cache without having been accessed before being evicted. Defaults to \\"30m\\". sync_response_cache_duration (duration): Controls how long the results of a /sync request are cached for after a successful response is returned. A higher duration can help clients with intermittent connections, at the cost of higher memory usage. A value of zero means that sync responses are not cached. Changed in Synapse 1.62.0: The default was changed from 0 to 2m. Defaults to \\"2m\\". cache_autotuning (object): cache_autotuning and its sub-options max_cache_memory_usage, target_cache_memory_usage, and min_cache_ttl work in conjunction with each other to maintain a balance between cache memory usage and cache entry availability. You must be using jemalloc to utilize this option, and all three of the options must be specified for this feature to work. This option defaults to off, enable it by providing values for the sub-options listed below. Please note that the feature will not work and may cause unstable behavior (such as excessive emptying of caches or exceptions) if all of the values are not provided. Please see the Config Conventions for information on how to specify memory size and cache expiry durations. This setting has the following sub-options: max_cache_memory_usage: Sets a ceiling on how much memory the cache can use before caches begin to be continuously evicted. They will continue to be evicted until the memory usage drops below the target_cache_memory_usage, set in the setting below, or until the min_cache_ttl is hit. Defaults to null. target_cache_memory_usage: Sets a rough target for the desired memory usage of the caches. Defaults to null. min_cache_ttl: Sets a limit under which newer cache entries are not evicted and is only applied when caches are actively being evicted/ max_cache_memory_usage has been exceeded. This is to protect hot caches from being emptied while Synapse is evicting due to memory. Defaults to null. Example configuration: caches: global_factor: 1.0 per_cache_factors: get_users_who_share_room_with_user: 2.0 sync_response_cache_duration: 2m cache_autotuning: max_cache_memory_usage: 1024M target_cache_memory_usage: 758M min_cache_ttl: 5m","breadcrumbs":"Configuration » Configuration Manual » caches","id":"424","title":"caches"},"425":{"body":"The cache factors (i.e. caches.global_factor and caches.per_cache_factors) may be reloaded at any time by sending a SIGHUP signal to Synapse using e.g. kill -HUP [PID_OF_SYNAPSE_PROCESS] If you are running multiple workers, you must individually update the worker config file and send this signal to each worker process. If you’re using the example systemd service file in Synapse’s contrib directory, you can send a SIGHUP signal by using systemctl reload matrix-synapse.","breadcrumbs":"Configuration » Configuration Manual » Reloading cache factors","id":"425","title":"Reloading cache factors"},"426":{"body":"Config options related to database settings.","breadcrumbs":"Configuration » Configuration Manual » Database","id":"426","title":"Database"},"427":{"body":"(object) The database setting defines the database that synapse uses to store all of its data. For more information on using Synapse with Postgres, see here. This setting has the following sub-options: name (string): This option specifies the database engine to use: either sqlite3 (for SQLite) or psycopg2 (for PostgreSQL). If no name is specified Synapse will default to SQLite. Defaults to \\"sqlite3\\". txn_limit (integer): Gives the maximum number of transactions to run per connection before reconnecting. 0 means no limit. Defaults to 0. allow_unsafe_locale (boolean): This option is specific to Postgres. Under the default behavior, Synapse will refuse to start if the postgres db is set to a non-C locale. You can override this behavior (which is not recommended) by setting allow_unsafe_locale to true. Note that doing so may corrupt your database. You can find more information here and here. Defaults to false. args (object): Gives options which are passed through to the database engine, except for options starting with cp_, which are used to configure the Twisted connection pool. For a reference to valid arguments, see: for sqlite for postgres for the connection pool Example configurations: database: name: sqlite3 args: database: /path/to/homeserver.db database: name: psycopg2 txn_limit: 10000 args: user: synapse_user password: secretpassword dbname: synapse host: localhost port: 5432 cp_min: 5 cp_max: 10","breadcrumbs":"Configuration » Configuration Manual » database","id":"427","title":"database"},"428":{"body":"(object) The databases option allows specifying a mapping between certain database tables and database host details, spreading the load of a single Synapse instance across multiple database backends. This is often referred to as “database sharding”. This option is only supported for PostgreSQL database backends. Important note: This is a supported option, but is not currently used in production by the Matrix.org Foundation. Proceed with caution and always make backups. databases is a dictionary of arbitrarily-named database entries. Each entry is equivalent to the value of the database homeserver config option (see above), with the addition of a data_stores key. data_stores is an array of strings that specifies the data store(s) (a defined label for a set of tables) that should be stored on the associated database backend entry. The currently defined values for data_stores are: \\"state\\": Database that relates to state groups will be stored in this database. Specifically, that means the following tables: state_groups state_group_edges state_groups_state And the following sequences: state_groups_seq_id \\"main\\": All other database tables and sequences. All databases will end up with additional tables used for tracking database schema migrations and any pending background updates. Synapse will create these automatically on startup when checking for and/or performing database schema migrations. To migrate an existing database configuration (e.g. all tables on a single database) to a different configuration (e.g. the “main” data store on one database, and “state” on another), do the following: Take a backup of your existing database. Things can and do go wrong and database corruption is no joke! Ensure all pending database migrations have been applied and background updates have run. The simplest way to do this is to use the update_synapse_database script supplied with your Synapse installation. update_synapse_database --database-config homeserver.yaml --run-background-updates Copy over the necessary tables and sequences from one database to the other. Tables relating to database migrations, schemas, schema versions and background updates should not be copied. As an example, say that you’d like to split out the “state” data store from an existing database which currently contains all data stores. Simply copy the tables and sequences defined above for the “state” datastore from the existing database to the secondary database. As noted above, additional tables will be created in the secondary database when Synapse is started. Modify/create the databases option in your homeserver.yaml to match the desired database configuration. Start Synapse. Check that it starts up successfully and that things generally seem to be working. Drop the old tables that were copied in step 3. Only one of the options database or databases may be specified in your config, but not both. Defaults to {}. Example configuration: databases: basement_box: name: psycopg2 txn_limit: 10000 data_stores: - main args: user: synapse_user password: secretpassword dbname: synapse_main host: localhost port: 5432 cp_min: 5 cp_max: 10 my_other_database: name: psycopg2 txn_limit: 10000 data_stores: - state args: user: synapse_user password: secretpassword dbname: synapse_state host: localhost port: 5432 cp_min: 5 cp_max: 10","breadcrumbs":"Configuration » Configuration Manual » databases","id":"428","title":"databases"},"429":{"body":"Config options related to logging.","breadcrumbs":"Configuration » Configuration Manual » Logging","id":"429","title":"Logging"},"43":{"body":"table { 127.0.0.1 }\\ntable { 127.0.0.1 } http protocol \\"https\\" { tls { no tlsv1.0, ciphers \\"HIGH\\" } tls keypair \\"example.com\\" match header set \\"X-Forwarded-For\\" value \\"$REMOTE_ADDR\\" match header set \\"X-Forwarded-Proto\\" value \\"https\\" # set CORS header for .well-known/matrix/server, .well-known/matrix/client # httpd does not support setting headers, so do it here match request path \\"/.well-known/matrix/*\\" tag \\"matrix-cors\\" match response tagged \\"matrix-cors\\" header set \\"Access-Control-Allow-Origin\\" value \\"*\\" pass quick path \\"/_matrix/*\\" forward to pass quick path \\"/_synapse/client/*\\" forward to # pass on non-matrix traffic to webserver pass forward to \\n} relay \\"https_traffic\\" { listen on egress port 443 tls protocol \\"https\\" forward to port 8008 check tcp forward to port 8080 check tcp\\n} http protocol \\"matrix\\" { tls { no tlsv1.0, ciphers \\"HIGH\\" } tls keypair \\"example.com\\" block pass quick path \\"/_matrix/*\\" forward to pass quick path \\"/_synapse/client/*\\" forward to \\n} relay \\"matrix_federation\\" { listen on egress port 8448 tls protocol \\"matrix\\" forward to port 8008 check tcp\\n}","breadcrumbs":"Configuring a Reverse Proxy » Relayd","id":"43","title":"Relayd"},"430":{"body":"(string|null) This option specifies a yaml python logging config file as described here. Defaults to null. Example configuration: log_config: CONFDIR/SERVERNAME.log.config","breadcrumbs":"Configuration » Configuration Manual » log_config","id":"430","title":"log_config"},"431":{"body":"Options related to ratelimiting in Synapse. Each ratelimiting configuration is made of two parameters: per_second: number of requests a client can send per second. burst_count: number of requests a client can send before being throttled.","breadcrumbs":"Configuration » Configuration Manual » Ratelimiting","id":"431","title":"Ratelimiting"},"432":{"body":"(object) Ratelimiting settings for client messaging. This is a ratelimiting option for messages that ratelimits sending based on the account the client is using. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_message: per_second: 0.2 burst_count: 10.0 Example configuration: rc_message: per_second: 0.5 burst_count: 15.0","breadcrumbs":"Configuration » Configuration Manual » rc_message","id":"432","title":"rc_message"},"433":{"body":"(object) This option ratelimits registration requests based on the client’s IP address. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_registration: per_second: 0.17 burst_count: 3.0 Example configuration: rc_registration: per_second: 0.15 burst_count: 2.0","breadcrumbs":"Configuration » Configuration Manual » rc_registration","id":"433","title":"rc_registration"},"434":{"body":"(object) This option checks the validity of registration tokens that ratelimits requests based on the client’s IP address. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_registration_token_validity: per_second: 0.1 burst_count: 5.0 Example configuration: rc_registration_token_validity: per_second: 0.3 burst_count: 6.0","breadcrumbs":"Configuration » Configuration Manual » rc_registration_token_validity","id":"434","title":"rc_registration_token_validity"},"435":{"body":"(object) This option specifies several limits for login. This setting has the following sub-options: address (object): Ratelimits login requests based on the client’s IP address. Defaults to {\\"per_second\\": 0.003, \\"burst_count\\": 5.0}. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. account (object): Ratelimits login requests based on the account the client is attempting to log into. Defaults to {\\"per_second\\": 0.003, \\"burst_count\\": 5.0}. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. failed_attempts (object): Ratelimits login requests based on the account the client is attempting to log into, based on the amount of failed login attempts for this account. Defaults to {\\"per_second\\": 0.17, \\"burst_count\\": 3.0}. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Example configuration: rc_login: address: per_second: 0.15 burst_count: 5.0 account: per_second: 0.18 burst_count: 4.0 failed_attempts: per_second: 0.19 burst_count: 7.0","breadcrumbs":"Configuration » Configuration Manual » rc_login","id":"435","title":"rc_login"},"436":{"body":"(object) 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. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Example configuration: rc_admin_redaction: per_second: 1.0 burst_count: 50.0","breadcrumbs":"Configuration » Configuration Manual » rc_admin_redaction","id":"436","title":"rc_admin_redaction"},"437":{"body":"(object) This option allows for ratelimiting number of rooms a user can join. This setting has the following sub-options: local (object): Ratelimits when users are joining rooms the server is already in. Defaults to {\\"per_second\\": 0.1, \\"burst_count\\": 10.0}. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. remote (object): Ratelimits when users are trying to join rooms not on the server (which can be more computationally expensive than restricting locally). Defaults to {\\"per_second\\": 0.01, \\"burst_count\\": 10.0}. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Example configuration: rc_joins: local: per_second: 0.2 burst_count: 15.0 remote: per_second: 0.03 burst_count: 12.0","breadcrumbs":"Configuration » Configuration Manual » rc_joins","id":"437","title":"rc_joins"},"438":{"body":"(object) This option allows admins to ratelimit joins to a room based on the number of recent joins (local or remote) to that room. It is intended to mitigate mass-join spam waves which target multiple homeservers. Added in Synapse 1.64.0. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_joins_per_room: per_second: 1.0 burst_count: 10.0 Example configuration: rc_joins_per_room: per_second: 1.0 burst_count: 10.0","breadcrumbs":"Configuration » Configuration Manual » rc_joins_per_room","id":"438","title":"rc_joins_per_room"},"439":{"body":"(object) This option ratelimits how often a user or IP can attempt to validate a 3PID. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_3pid_validation: per_second: 0.003 burst_count: 5.0 Example configuration: rc_3pid_validation: per_second: 0.003 burst_count: 5.0","breadcrumbs":"Configuration » Configuration Manual » rc_3pid_validation","id":"439","title":"rc_3pid_validation"},"44":{"body":"server.modules = ( \\"mod_rewrite\\", \\"mod_redirect\\", \\"mod_access\\", \\"mod_setenv\\", \\"mod_openssl\\", \\"mod_proxy\\", \\"mod_accesslog\\"\\n) server.username = \\"lighttpd\\"\\nserver.groupname = \\"lighttpd\\" # We set this to \\"disable\\" and use IPv6 `[::]` explicitly below,\\n# in order to listen on all incoming IPv6 addresses.\\n#\\n# If you only want to listen on specific IPv6 addresses, set this\\n# to \\"enable\\" and specify said addresses below.\\nserver.use-ipv6 = \\"disable\\" ssl.pemfile = \\"/etc/lighttpd/cert+privkey.pem\\"\\nssl.ca-file = \\"/etc/lighttpd/fullchain.pem\\" # redirect HTTP traffic to HTTPS, same for IPv6 below\\n$SERVER[\\"socket\\"] == \\"0.0.0.0:80\\" { url.redirect = ( \\"\\" => \\"https://${url.authority.noport}${url.path}${qsa}\\" )\\n}\\n$SERVER[\\"socket\\"] == \\"0.0.0.0:443\\" { ssl.engine = \\"enable\\" }\\n$SERVER[\\"socket\\"] == \\"0.0.0.0:8448\\" { ssl.engine = \\"enable\\" }\\n$SERVER[\\"socket\\"] == \\"[::]:80\\" { url.redirect = ( \\"\\" => \\"https://${url.authority.noport}${url.path}${qsa}\\" )\\n}\\n$SERVER[\\"socket\\"] == \\"[::]:443\\" { ssl.engine = \\"enable\\" }\\n$SERVER[\\"socket\\"] == \\"[::]:8448\\" { ssl.engine = \\"enable\\" } # both lighttpd and synapse need permissions for socket r/w\\n$HTTP[\\"url\\"] =~ \\"(/_matrix|_synapse/admin|/_synapse/client)\\" { proxy.balance = \\"hash\\" proxy.server = ( \\"\\" => ( \\"backend-socket\\" => ( \\"host\\" => \\"/var/lib/synapse/main_public.sock\\", \\"port\\" => 0 ) ) ) proxy.forwarded = ( \\"for\\" => 1, \\"proto\\" => 1, \\"host\\" => 1, )\\n}\\n# protect admin access IPv6 ULA only\\n$HTTP[\\"remoteip\\"] !=\\"fd00::/8\\" { $HTTP[\\"url\\"] =~ \\"^/_synapse/admin/\\" { url.access-deny = ( \\"\\" ) }\\n} Delegation example: url.rewrite-once = ( \\"^/\\\\.well-known/matrix/client$\\" => \\"/.well-known/matrix/client.json\\", \\"^/\\\\.well-known/matrix/server$\\" => \\"/.well-known/matrix/server.json\\"\\n) # This condition intentionally matches the post-rewrite URLs.\\n$HTTP[\\"url\\"] =~ \\"^/\\\\.well-known/matrix/(client|server)\\\\.json$\\" { mimetype.assign = ( \\".json\\" => \\"application/json\\" ) setenv.set-response-header = ( \\"Access-Control-Allow-Origin\\" => \\"*\\" )\\n}","breadcrumbs":"Configuring a Reverse Proxy » lighttpd","id":"44","title":"lighttpd"},"440":{"body":"(object) This option sets ratelimiting how often invites can be sent in a room or to a specific user. Client requests that invite user(s) when creating a room will count against the rc_invites.per_room limit, whereas client requests to invite a single user to a room will count against both the rc_invites.per_user and rc_invites.per_room limits. Federation requests to invite a user will count against the rc_invites.per_user limit only, as Synapse presumes ratelimiting by room will be done by the sending server. Changed in version 1.63: added the per_issuer limit. This setting has the following sub-options: per_room (object): Applies to the room of the invitation. Defaults to {\\"per_second\\": 0.3, \\"burst_count\\": 10.0}. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. per_user (object): Applies to the receiver of the invite, rather than the sender, meaning that a rc_invite.per_user.burst_count of 5 mandates that a single user cannot receive more than a burst of 5 invites at a time. Defaults to {\\"per_second\\": 0.003, \\"burst_count\\": 5.0}. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. per_issuer (object): Applies to the issuer of the invite, meaning that a rc_invite.per_issuer.burst_count of 5 mandates that single user cannot send more than a burst of 5 invites at a time. Defaults to {\\"per_second\\": 0.3, \\"burst_count\\": 10.0}. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Example configuration: rc_invites: per_room: per_second: 0.5 burst_count: 5.0 per_user: per_second: 0.004 burst_count: 3.0 per_issuer: per_second: 0.5 burst_count: 5.0","breadcrumbs":"Configuration » Configuration Manual » rc_invites","id":"440","title":"rc_invites"},"441":{"body":"(object) 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. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_third_party_invite: per_second: 0.2 burst_count: 10.0","breadcrumbs":"Configuration » Configuration Manual » rc_third_party_invite","id":"441","title":"rc_third_party_invite"},"442":{"body":"(object) This option ratelimits creation of MXC URIs via the /_matrix/media/v1/create endpoint based on the account that’s creating the media. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_media_create: per_second: 10.0 burst_count: 50.0","breadcrumbs":"Configuration » Configuration Manual » rc_media_create","id":"442","title":"rc_media_create"},"443":{"body":"(object) Defines limits on federation requests. This setting has the following sub-options: window_size (integer): Window size in milliseconds. Defaults to 1000. sleep_limit (integer): Number of federation requests from a single server in a window before the server will delay processing the request. Defaults to 10. sleep_delay (integer): Duration in milliseconds to delay processing events from remote servers by if they go over the sleep limit. Defaults to 500. reject_limit (integer): Maximum number of concurrent federation requests allowed from a single server. Defaults to 50. concurrent (integer): Number of federation requests to concurrently process from a single server. Defaults to 3. Example configuration: rc_federation: window_size: 750 sleep_limit: 15 sleep_delay: 400 reject_limit: 40 concurrent: 5","breadcrumbs":"Configuration » Configuration Manual » rc_federation","id":"443","title":"rc_federation"},"444":{"body":"(object) This option sets ratelimiting for presence. This setting has the following sub-options: per_user (object): Sets rate limits on how often a specific users’ presence updates are evaluated. Ratelimited presence updates sent via sync are ignored, and no error is returned to the client. This option also sets the rate limit for the PUT /_matrix/client/v3/presence/{userId}/status endpoint. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_presence: per_user: per_second: 0.1 burst_count: 1.0 Example configuration: rc_presence: per_user: per_second: 0.05 burst_count: 1.0","breadcrumbs":"Configuration » Configuration Manual » rc_presence","id":"444","title":"rc_presence"},"445":{"body":"(object) Ratelimiting settings for delayed event management. This is a ratelimiting option that ratelimits attempts to restart, cancel, or view delayed events based on the sending client’s account. Attempts to create or send delayed events are ratelimited not by this setting, but by rc_message. Setting this to a high value allows clients to make delayed event management requests often (such as repeatedly restarting a delayed event with a short timeout, or restarting several different delayed events all at once) without the risk of being ratelimited. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_delayed_event_mgmt: per_second: 1.0 burst_count: 5.0 Example configuration: rc_delayed_event_mgmt: per_second: 2.0 burst_count: 20.0","breadcrumbs":"Configuration » Configuration Manual » rc_delayed_event_mgmt","id":"445","title":"rc_delayed_event_mgmt"},"446":{"body":"(object) Ratelimiting settings for reporting content.\\nThis is a ratelimiting option that ratelimits reports made by users about content they see.\\nSetting this to a high value allows users to report content quickly, possibly in duplicate. This can result in higher database usage. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_reports: per_second: 1.0 burst_count: 5.0 Example configuration: rc_reports: per_second: 2.0 burst_count: 20.0","breadcrumbs":"Configuration » Configuration Manual » rc_reports","id":"446","title":"rc_reports"},"447":{"body":"(object) Sets rate limits for how often users are able to create rooms. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_room_creation: per_second: 0.016 burst_count: 10.0 Example configuration: rc_room_creation: per_second: 1.0 burst_count: 5.0","breadcrumbs":"Configuration » Configuration Manual » rc_room_creation","id":"447","title":"rc_room_creation"},"448":{"body":"(object) This option allows admins to ratelimit searches in the user directory. Added in Synapse 1.145.0. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_user_directory: per_second: 0.016 burst_count: 200.0","breadcrumbs":"Configuration » Configuration Manual » rc_user_directory","id":"448","title":"rc_user_directory"},"449":{"body":"(object) This option allows admins to ratelimit profile lookups by clients. Requests are limited per user when the request is authenticated, otherwise per client IP address. Added in Synapse 1.162.0. This setting has the following sub-options: per_second (number): Maximum number of requests a client can send per second. burst_count (number): Maximum number of requests a client can send before being throttled. Default configuration: rc_profile: per_second: 1.0 burst_count: 500.0","breadcrumbs":"Configuration » Configuration Manual » rc_profile","id":"449","title":"rc_profile"},"45":{"body":"Synapse exposes a health check endpoint for use by reverse proxies.\\nEach configured HTTP listener has a /health endpoint which always returns\\n200 OK (and doesn’t get logged).","breadcrumbs":"Configuring a Reverse Proxy » Health check endpoint","id":"45","title":"Health check endpoint"},"450":{"body":"(integer) 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","breadcrumbs":"Configuration » Configuration Manual » federation_rr_transactions_per_room_per_second","id":"450","title":"federation_rr_transactions_per_room_per_second"},"451":{"body":"Config options related to Synapse’s media store.","breadcrumbs":"Configuration » Configuration Manual » Media Store","id":"451","title":"Media Store"},"452":{"body":"(boolean) When set to true, all subsequent media uploads will be marked as authenticated, and will not be available over legacy unauthenticated media endpoints ( /_matrix/media/(r0|v3|v1)/download and /_matrix/media/(r0|v3|v1)/thumbnail) – requests for authenticated media over these endpoints will result in a 404. All media, including authenticated media, will be available over the authenticated media endpoints _matrix/client/v1/media/download and _matrix/client/v1/media/thumbnail. Media uploaded prior to setting this option to true will still be available over the legacy endpoints. Note if the setting is switched to false after enabling, media marked as authenticated will be available over legacy endpoints. Defaults to true (previously false). In a future release of Synapse, this option will be removed and become always-on. In all cases, authenticated requests to download media will succeed, but for unauthenticated requests, this case-by-case breakdown describes whether media downloads are permitted: enable_authenticated_media = False: unauthenticated client or homeserver requesting local media: allowed unauthenticated client or homeserver requesting remote media: allowed as long as the media is in the cache, or as long as the remote homeserver does not require authentication to retrieve the media enable_authenticated_media = True: unauthenticated client or homeserver requesting local media: allowed if the media was stored on the server whilst enable_authenticated_media was False (or in a previous Synapse version where this option did not exist); otherwise denied. unauthenticated client or homeserver requesting remote media: the same as for local media; allowed if the media was stored on the server whilst enable_authenticated_media was False (or in a previous Synapse version where this option did not exist); otherwise denied. It is especially notable that media downloaded before this option existed (in older Synapse versions), or whilst this option was set to False, will perpetually be available over the legacy, unauthenticated endpoint, even after this option is set to True. This is for backwards compatibility with older clients and homeservers that do not yet support requesting authenticated media; those older clients or homeservers will not be cut off from media they can already see. Changed in Synapse 1.120: This option now defaults to True when not set, whereas before this version it defaulted to False. Defaults to true. Example configuration: enable_authenticated_media: false","breadcrumbs":"Configuration » Configuration Manual » enable_authenticated_media","id":"452","title":"enable_authenticated_media"},"453":{"body":"(boolean) Enable the media store service in the Synapse master. Set to false if you are using a separate media store worker. Defaults to true. Example configuration: enable_media_repo: false","breadcrumbs":"Configuration » Configuration Manual » enable_media_repo","id":"453","title":"enable_media_repo"},"454":{"body":"(boolean) Enable the local on-disk media storage provider. When disabled, media is stored only in configured media_storage_providers and temporary files are used for processing. Warning: If this option is set to false and no media_storage_providers are configured, all media requests will return 404 errors as there will be no storage backend available. Defaults to true. Example configuration: enable_local_media_storage: false","breadcrumbs":"Configuration » Configuration Manual » enable_local_media_storage","id":"454","title":"enable_local_media_storage"},"455":{"body":"(string) Directory where uploaded images and attachments are stored. Defaults to \\"media_store\\". Example configuration: media_store_path: DATADIR/media_store","breadcrumbs":"Configuration » Configuration Manual » media_store_path","id":"455","title":"media_store_path"},"456":{"body":"(integer) How many pending media uploads can a given user have? A pending media upload is a created MXC URI that (a) is not expired (the unused_expires_at timestamp has not passed) and (b) the media has not yet been uploaded for. Defaults to 5. Example configuration: max_pending_media_uploads: 5","breadcrumbs":"Configuration » Configuration Manual » max_pending_media_uploads","id":"456","title":"max_pending_media_uploads"},"457":{"body":"(duration) How long to wait in milliseconds before expiring created media IDs. Defaults to \\"24h\\". Example configuration: unused_expiration_time: 1h","breadcrumbs":"Configuration » Configuration Manual » unused_expiration_time","id":"457","title":"unused_expiration_time"},"458":{"body":"(array) Media storage providers allow media to be stored in different locations. Defaults to []. Options for each entry include: module (string): Type of resource, e.g. file_system. store_local (boolean): Whether to store newly uploaded local files. store_remote (boolean): Whether to store newly downloaded local files. store_synchronous (boolean): Whether to wait for successful storage for local uploads. config (object): Sets a path to the resource through the directory option. This setting has the following sub-options: directory (string): Path to the resource. Example configuration: media_storage_providers:\\n- module: file_system store_local: false store_remote: false store_synchronous: false config: directory: /mnt/some/other/directory","breadcrumbs":"Configuration » Configuration Manual » media_storage_providers","id":"458","title":"media_storage_providers"},"459":{"body":"(byte 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. Notably Nginx has a small max body size by default. See here for more on using a reverse proxy with Synapse. Defaults to \\"50M\\". Example configuration: max_upload_size: 60M","breadcrumbs":"Configuration » Configuration Manual » max_upload_size","id":"459","title":"max_upload_size"},"46":{"body":"Endpoints for administering your Synapse instance are placed under /_synapse/admin. These require authentication through an access token of an\\nadmin user. However as access to these endpoints grants the caller a lot of power,\\nwe do not recommend exposing them to the public internet without good reason.","breadcrumbs":"Configuring a Reverse Proxy » Synapse administration endpoints","id":"46","title":"Synapse administration endpoints"},"460":{"body":"(array) A list of media upload limits defining how much data a given user can upload in a given time period.\\nThese limits are applied in addition to the max_upload_size limit above (which applies to individual uploads). An empty list means no limits are applied. These settings can be overridden using the get_media_upload_limits_for_user module API callback. Defaults to []. Options for each entry include: time_period (duration): The time period over which the limit applies. Required. max_size (byte size): Amount of data that can be uploaded in the time period by the user. Required. info_uri (string): URI returned to the client for where the user can find information about the upload limit and how users can reduce their upload usage or request an upload limit increase. Optional. If not set, Synapse serves a built-in page (customisable via the media_upload_limit_exceeded.html template) and uses its URL instead. can_upgrade (boolean): Value returned to the client for whether the limit can be increased. Defaults to false. Example configuration: media_upload_limits:\\n- time_period: 1h max_size: 100M info_uri: https://example.com/quota#hour\\n- time_period: 1w max_size: 500M info_uri: https://example.com/quota can_upgrade: true","breadcrumbs":"Configuration » Configuration Manual » media_upload_limits","id":"460","title":"media_upload_limits"},"461":{"body":"(byte size) Maximum number of pixels that will be thumbnailed. Defaults to \\"32M\\". Example configuration: max_image_pixels: 35M","breadcrumbs":"Configuration » Configuration Manual » max_image_pixels","id":"461","title":"max_image_pixels"},"462":{"body":"(byte size) Remote media downloads are ratelimited using a leaky bucket algorithm, where a given “bucket” is keyed to the IP address of the requester when requesting remote media downloads. This configuration option sets the size of the bucket against which the size in bytes of downloads are penalized – if the bucket is full, i.e. a given number of bytes have already been downloaded, further downloads will be denied until the bucket drains. See also remote_media_download_per_second which determines the rate at which the “bucket” is emptied and thus has available space to authorize new requests. Defaults to \\"500MiB\\". Example configuration: remote_media_download_burst_count: 200M","breadcrumbs":"Configuration » Configuration Manual » remote_media_download_burst_count","id":"462","title":"remote_media_download_burst_count"},"463":{"body":"(byte size) Works in conjunction with remote_media_download_burst_count to ratelimit remote media downloads – this configuration option determines the rate at which the “bucket” (see above) leaks in bytes per second. As requests are made to download remote media, the size of those requests in bytes is added to the bucket, and once the bucket has reached it’s capacity, no more requests will be allowed until a number of bytes has “drained” from the bucket. This setting determines the rate at which bytes drain from the bucket, with the practical effect that the larger the number, the faster the bucket leaks, allowing for more bytes downloaded over a shorter period of time. Defaults to 87KiB per second. See also remote_media_download_burst_count. Defaults to \\"87KiB\\". Example configuration: remote_media_download_per_second: 40K","breadcrumbs":"Configuration » Configuration Manual » remote_media_download_per_second","id":"463","title":"remote_media_download_per_second"},"464":{"body":"(array) A list of domains to never download media from. Media from these domains that is already downloaded will not be deleted, but will be inaccessible to users. This option does not affect admin APIs trying to download/operate on media. This will not prevent the listed domains from accessing media themselves. It simply prevents users on this server from downloading media originating from the listed servers. This will have no effect on media originating from the local server. This only affects media downloaded from other Matrix servers, to control URL previews see url_preview_ip_range_blacklist or url_preview_url_blacklist. Defaults to []. Example configuration: prevent_media_downloads_from:\\n- evil.example.org\\n- evil2.example.org","breadcrumbs":"Configuration » Configuration Manual » prevent_media_downloads_from","id":"464","title":"prevent_media_downloads_from"},"465":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » dynamic_thumbnails","id":"465","title":"dynamic_thumbnails"},"466":{"body":"(array) List of thumbnails to precalculate when an image is uploaded. Options for each entry include: width (integer): Width of the generated thumbnail. height (integer): Height of the generated thumbnail. method (string): Method to fit the thumbnail dimensions. Current options are crop and scale. Default configuration: thumbnail_sizes:\\n- width: 32 height: 32 method: crop\\n- width: 96 height: 96 method: crop\\n- width: 320 height: 240 method: scale\\n- width: 640 height: 480 method: scale\\n- width: 800 height: 600 method: scale","breadcrumbs":"Configuration » Configuration Manual » thumbnail_sizes","id":"466","title":"thumbnail_sizes"},"467":{"body":"(object) Controls whether local media and entries in the remote media cache (media that is downloaded from other homeservers) should be removed under certain conditions, typically for the purpose of saving space. Purging media files will be the carried out by the media worker (that is, the worker that has the enable_media_repo homeserver config option set to true). This may be the main process. The media_retention.local_media_lifetime and media_retention.remote_media_lifetime config options control whether media will be purged if it has not been accessed in a given amount of time. Note that media is “accessed” when loaded in a room in a client, or otherwise downloaded by a local or remote user. If the media has never been accessed, the media’s creation time is used instead. Both thumbnails and the original media will be removed. If either of these options are unset, then media of that type will not be purged. Local or cached remote media that has been quarantined will not be deleted. Similarly, local media that has been marked as protected from quarantine will not be deleted. This setting has the following sub-options: local_media_lifetime: Duration without access to a local media resource after which it will be purged. If the media has never been accessed, the media’s creation time is used instead. Both thumbnails and the original media will be removed. If unset or null, local media will not be purged. Defaults to null. remote_media_lifetime: Duration without access to a remote media resource after which it will be purged. If the media has never been accessed, the media’s creation time is used instead. Both thumbnails and the original media will be removed. If unset or null, remote media will not be purged. Defaults to null. Example configuration: media_retention: local_media_lifetime: 90d remote_media_lifetime: 14d","breadcrumbs":"Configuration » Configuration Manual » media_retention","id":"467","title":"media_retention"},"468":{"body":"(boolean) This setting determines whether the preview URL API is enabled. Set to true to enable. If enabled you must specify a url_preview_ip_range_blacklist blacklist. Defaults to false. Example configuration: url_preview_enabled: true","breadcrumbs":"Configuration » Configuration Manual » url_preview_enabled","id":"468","title":"url_preview_enabled"},"469":{"body":"(array|null) 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. Defaults to null. Example configuration: url_preview_ip_range_blacklist:\\n- 127.0.0.0/8\\n- 10.0.0.0/8\\n- 172.16.0.0/12\\n- 192.168.0.0/16\\n- 100.64.0.0/10\\n- 192.0.0.0/24\\n- 169.254.0.0/16\\n- 192.88.99.0/24\\n- 198.18.0.0/15\\n- 192.0.2.0/24\\n- 198.51.100.0/24\\n- 203.0.113.0/24\\n- 224.0.0.0/4\\n- ::1/128\\n- fe80::/10\\n- fc00::/7\\n- 2001:db8::/32\\n- ff00::/8\\n- fec0::/10","breadcrumbs":"Configuration » Configuration Manual » url_preview_ip_range_blacklist","id":"469","title":"url_preview_ip_range_blacklist"},"47":{"body":"You can use Synapse with a forward or outbound proxy. An example of when\\nthis is necessary is in corporate environments behind a DMZ (demilitarized zone).\\nSynapse supports routing outbound HTTP(S) requests via a proxy. Only HTTP(S)\\nproxy is supported, not SOCKS proxy or anything else.","breadcrumbs":"Configuring a Forward/Outbound Proxy » Using a forward proxy with Synapse","id":"47","title":"Using a forward proxy with Synapse"},"470":{"body":"(array) 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 []. Example configuration: url_preview_ip_range_whitelist:\\n- 192.168.1.1","breadcrumbs":"Configuration » Configuration Manual » url_preview_ip_range_whitelist","id":"470","title":"url_preview_ip_range_whitelist"},"471":{"body":"(array) Optional list of URL matches that the URL preview spider is denied from accessing. This is a usability feature, not a security one. 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. Applications that perform redirects or serve different content when detecting that Synapse is accessing them can also bypass the blacklist. This is more useful if you know there is an entire shape of URL that you know that you do not want Synapse to preview. 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: username netloc scheme path 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. Defaults to []. Example configuration: url_preview_url_blacklist:\\n- username: \'*\'\\n- netloc: google.com\\n- netloc: \'*.google.com\'\\n- scheme: http\\n- netloc: www.acme.com path: /foo\\n- netloc: ^[0-9]+.[0-9]+.[0-9]+.[0-9]+$","breadcrumbs":"Configuration » Configuration Manual » url_preview_url_blacklist","id":"471","title":"url_preview_url_blacklist"},"472":{"body":"(byte size) The largest allowed URL preview spidering size in bytes. Defaults to \\"10M\\". Example configuration: max_spider_size: 8M","breadcrumbs":"Configuration » Configuration Manual » max_spider_size","id":"472","title":"max_spider_size"},"473":{"body":"(array) 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. Default configuration: url_preview_accept_language:\\n- en Example configuration: url_preview_accept_language:\\n- en-UK\\n- en-US;q=0.9\\n- fr;q=0.8\\n- \'*;q=0.7\'","breadcrumbs":"Configuration » Configuration Manual » url_preview_accept_language","id":"473","title":"url_preview_accept_language"},"474":{"body":"(object) 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. This setting has the following sub-options: disable_default_providers (boolean): Do not use Synapse’s default list of oEmbed providers. Defaults to false. additional_providers (array): Additional files with oEmbed configuration (each should be in the form of providers.json). Defaults to []. Example configuration: oembed: disable_default_providers: true additional_providers: - oembed/my_providers.json","breadcrumbs":"Configuration » Configuration Manual » oembed","id":"474","title":"oembed"},"475":{"body":"See here for full details on setting up captcha.","breadcrumbs":"Configuration » Configuration Manual » Captcha","id":"475","title":"Captcha"},"476":{"body":"(string|null) This homeserver’s ReCAPTCHA public key. Must be specified if enable_registration_captcha is enabled. Defaults to null. Example configuration: recaptcha_public_key: YOUR_PUBLIC_KEY","breadcrumbs":"Configuration » Configuration Manual » recaptcha_public_key","id":"476","title":"recaptcha_public_key"},"477":{"body":"(string|null) An alternative to recaptcha_public_key: allows the public key to be specified in an external file. The file should be a plain text file, containing only the public key. Synapse reads the public key from the given file once at startup. Added in Synapse 1.135.0. Defaults to null. Example configuration: recaptcha_public_key_path: /path/to/key/file","breadcrumbs":"Configuration » Configuration Manual » recaptcha_public_key_path","id":"477","title":"recaptcha_public_key_path"},"478":{"body":"(string|null) This homeserver’s ReCAPTCHA private key. Must be specified if enable_registration_captcha is enabled. Defaults to null. Example configuration: recaptcha_private_key: YOUR_PRIVATE_KEY","breadcrumbs":"Configuration » Configuration Manual » recaptcha_private_key","id":"478","title":"recaptcha_private_key"},"479":{"body":"(string|null) An alternative to recaptcha_private_key: allows the private key to be specified in an external file. The file should be a plain text file, containing only the private key. Synapse reads the private key from the given file once at startup. Added in Synapse 1.135.0. Defaults to null. Example configuration: recaptcha_private_key_path: /path/to/key/file","breadcrumbs":"Configuration » Configuration Manual » recaptcha_private_key_path","id":"479","title":"recaptcha_private_key_path"},"48":{"body":"The proxy settings can be configured in the homeserver configuration file via http_proxy, https_proxy, and no_proxy_hosts. homeserver.yaml example: http_proxy: http://USERNAME:PASSWORD@10.0.1.1:8080/\\nhttps_proxy: http://USERNAME:PASSWORD@proxy.example.com:8080/\\nno_proxy_hosts: - master.hostname.example.com - 10.1.0.0/16 - 172.30.0.0/16 The proxy settings can also be configured via the http_proxy, https_proxy, no_proxy environment variables. The environment variable is not case sensitive. http_proxy: Proxy server to use for HTTP requests. https_proxy: Proxy server to use for HTTPS requests. no_proxy: Comma-separated list of hosts, IP addresses, or IP ranges in CIDR\\nformat which should not use the proxy. Synapse will directly connect to these hosts. The http_proxy and https_proxy environment variables have the form: [scheme://][:@][:] Supported schemes are http:// and https://. The default scheme is http://\\nfor compatibility reasons; it is recommended to set a scheme. If scheme is set\\nto https:// the connection uses TLS between Synapse and the proxy. NOTE: Synapse validates the certificates. If the certificate is not\\nvalid, then the connection is dropped. Default port if not given is 1080. Username and password are optional and will be used to authenticate against\\nthe proxy. Examples HTTP_PROXY=http://USERNAME:PASSWORD@10.0.1.1:8080/ HTTPS_PROXY=http://USERNAME:PASSWORD@proxy.example.com:8080/ NO_PROXY=master.hostname.example.com,10.1.0.0/16,172.30.0.0/16 NOTE:\\nSynapse does not apply the IP blacklist to connections through the proxy (since\\nthe DNS resolution is done by the proxy). It is expected that the proxy or firewall\\nwill apply blacklisting of IP addresses.","breadcrumbs":"Configuring a Forward/Outbound Proxy » Configure","id":"48","title":"Configure"},"480":{"body":"(boolean) Set to true to require users to complete a CAPTCHA test when registering an account. Requires a valid ReCaptcha public/private key. Note that enable_registration must also be set to allow account registration. Defaults to false. Example configuration: enable_registration_captcha: true","breadcrumbs":"Configuration » Configuration Manual » enable_registration_captcha","id":"480","title":"enable_registration_captcha"},"481":{"body":"(string) 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","breadcrumbs":"Configuration » Configuration Manual » recaptcha_siteverify_api","id":"481","title":"recaptcha_siteverify_api"},"482":{"body":"Options related to adding a TURN server to Synapse.","breadcrumbs":"Configuration » Configuration Manual » TURN","id":"482","title":"TURN"},"483":{"body":"(array) The public URIs of the TURN server to give to clients. Defaults to []. Example configuration: turn_uris:\\n- turn:example.org","breadcrumbs":"Configuration » Configuration Manual » turn_uris","id":"483","title":"turn_uris"},"484":{"body":"(string|null) The shared secret used to compute passwords for the TURN server. Defaults to null. Example configuration: turn_shared_secret: YOUR_SHARED_SECRET","breadcrumbs":"Configuration » Configuration Manual » turn_shared_secret","id":"484","title":"turn_shared_secret"},"485":{"body":"(string|null) An alternative to turn_shared_secret: allows the shared secret to be specified in an external file. The file should be a plain text file, containing only the shared secret. Synapse reads the shared secret from the given file once at startup. Added in Synapse 1.116.0. Defaults to null. Example configuration: turn_shared_secret_path: /path/to/secrets/file","breadcrumbs":"Configuration » Configuration Manual » turn_shared_secret_path","id":"485","title":"turn_shared_secret_path"},"486":{"body":"(string|null) TURN server username if not using a token. Defaults to null. Example configuration: turn_username: TURNSERVER_USERNAME","breadcrumbs":"Configuration » Configuration Manual » turn_username","id":"486","title":"turn_username"},"487":{"body":"(string|null) TURN server password if not using a token. Defaults to null. Example configuration: turn_password: TURNSERVER_PASSWORD","breadcrumbs":"Configuration » Configuration Manual » turn_password","id":"487","title":"turn_password"},"488":{"body":"(duration) How long generated TURN credentials last. Defaults to \\"1h\\". Example configuration: turn_user_lifetime: 2h","breadcrumbs":"Configuration » Configuration Manual » turn_user_lifetime","id":"488","title":"turn_user_lifetime"},"489":{"body":"(boolean) Whether guests should be allowed to use the TURN server. If false, 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). Defaults to true. Example configuration: turn_allow_guests: false","breadcrumbs":"Configuration » Configuration Manual » turn_allow_guests","id":"489","title":"turn_allow_guests"},"49":{"body":"The proxy will be used for: push url previews phone-home stats recaptcha validation CAS auth validation OpenID Connect (OIDC) Outbound federation Federation (checking public key revocation) Fetching public keys of other servers Downloading remote media It will not be used for: Application Services Matrix Identity servers In worker configurations connections between workers connections from workers to Redis","breadcrumbs":"Configuring a Forward/Outbound Proxy » Connection types","id":"49","title":"Connection types"},"490":{"body":"(object) Options related to MatrixRTC. Defaults to {}. This setting has the following sub-options: transports (array): A list of transport types and arguments to use for MatrixRTC connections. Defaults to []. Options for each entry include: type (string): The type of transport to use to connect to the selective forwarding unit (SFU). url (string): The WebSocket URL of the LiveKit SFU. If type is “livekit”, either this or livekit_service_url is required. Clients that support url will use the Client-Server API to (indirectly) interact with the LiveKit authorization service. The service needs to be set up as an application service in order to support these endpoints. See https://github.com/element-hq/lk-jwt-service for further details. livekit_service_url (string): Deprecated. The HTTP URL of the LiveKit authorization service. If type is “livekit”, either this or url is required. Clients that don’t support url will use livekit_service_url to directly interact with the LiveKit authorization service. This mode of operation is deprecated and should only be used for backwards compatibility. Example configuration: matrix_rtc: transports: - type: livekit url: wss://livekit.example.com livekit_service_url: https://matrix-rtc.example.com/livekit/jwt","breadcrumbs":"Configuration » Configuration Manual » matrix_rtc","id":"490","title":"matrix_rtc"},"491":{"body":"Registration can be rate-limited using the parameters in the Ratelimiting section of this manual.","breadcrumbs":"Configuration » Configuration Manual » Registration","id":"491","title":"Registration"},"492":{"body":"(boolean) Enable registration for new users. It is highly recommended that if you enable registration, you set one or more or the following options, to avoid abuse of your server by “bots”: enable_registration_captcha registrations_require_3pid registration_requires_token (In order to enable registration without any verification, you must also set enable_registration_without_verification.) Note that even if this setting is disabled, new accounts can still be created via the admin API if registration_shared_secret is set. Defaults to false. Example configuration: enable_registration: true","breadcrumbs":"Configuration » Configuration Manual » enable_registration","id":"492","title":"enable_registration"},"493":{"body":"(boolean) 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. Has no effect unless enable_registration is also enabled. Defaults to false. Example configuration: enable_registration_without_verification: true","breadcrumbs":"Configuration » Configuration Manual » enable_registration_without_verification","id":"493","title":"enable_registration_without_verification"},"494":{"body":"(array) If this is set, users must provide all of the specified types of 3PID when registering an account. Note that enable_registration must also be set to allow account registration. Defaults to []. Example configuration: registrations_require_3pid:\\n- email\\n- msisdn","breadcrumbs":"Configuration » Configuration Manual » registrations_require_3pid","id":"494","title":"registrations_require_3pid"},"495":{"body":"(boolean) Explicitly disable asking for MSISDNs from the registration flow (overrides registrations_require_3pid if MSISDNs are set as required). Defaults to false. Example configuration: disable_msisdn_registration: true","breadcrumbs":"Configuration » Configuration Manual » disable_msisdn_registration","id":"495","title":"disable_msisdn_registration"},"496":{"body":"(array|null) 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. pattern is a Perl-like regular expression. More information about 3PIDs, allowed medium types and their address syntax can be found in the Matrix spec. Defaults to null. Options for each entry include: medium (string): The medium for which to allow 3PID association. pattern (string): A Perl-like regular expression allowing association of a 3PID to a local account if it matches the given format. Example configuration: allowed_local_3pids:\\n- medium: email pattern: ^[^@]+@matrix\\\\.org$\\n- medium: email pattern: ^[^@]+@vector\\\\.im$\\n- medium: msisdn pattern: ^44\\\\d{10}$","breadcrumbs":"Configuration » Configuration Manual » allowed_local_3pids","id":"496","title":"allowed_local_3pids"},"497":{"body":"(boolean) Enable 3PIDs lookup requests to identity servers from this server. Defaults to true. Example configuration: enable_3pid_lookup: false","breadcrumbs":"Configuration » Configuration Manual » enable_3pid_lookup","id":"497","title":"enable_3pid_lookup"},"498":{"body":"(boolean) Require users to submit a token during registration. Tokens can be managed using the admin API. Disabling this option will not delete any tokens previously generated. Note that enable_registration must also be set to allow account registration. Defaults to false. Example configuration: registration_requires_token: true","breadcrumbs":"Configuration » Configuration Manual » registration_requires_token","id":"498","title":"registration_requires_token"},"499":{"body":"(string|null) If set, allows registration of standard or admin accounts by anyone who has the shared secret, even if enable_registration is not set. This is primarily intended for use with the register_new_matrix_user script (see Registering a user); however, the interface is documented. Replacing an existing registration_shared_secret with a new one requires users of the Shared-Secret Registration API to start using the new secret for requesting any further one-time nonces. ⚠️ Warning – The additional consequences of replacing macaroon_secret_key will apply in case it delegates to registration_shared_secret. See also registration_shared_secret_path. Defaults to null. Example configuration: registration_shared_secret: ","breadcrumbs":"Configuration » Configuration Manual » registration_shared_secret","id":"499","title":"registration_shared_secret"},"5":{"body":"It is important to choose the name for your server before you install Synapse,\\nbecause it cannot be changed later. The server name determines the “domain” part of user-ids for users on your\\nserver: these will all be of the format @user:my.domain.name. It also\\ndetermines how other matrix servers will reach yours for federation. For a test configuration, set this to the hostname of your server. For a more\\nproduction-ready setup, you will probably want to specify your domain\\n( example.com) rather than a matrix-specific hostname here (in the same way\\nthat your email address is probably user@example.com rather than user@email.example.com) - but doing so may require more advanced setup: see Setting up Federation. ⚠️ Before setting up Synapse please consult the security page for\\nbest practices. ⚠️","breadcrumbs":"Installation » Choosing your server name","id":"5","title":"Choosing your server name"},"50":{"body":"If a proxy server is used with TLS (HTTPS) and no connections are established,\\nit is most likely due to the proxy’s certificates. To test this, the validation\\nin Synapse can be deactivated. NOTE: This has an impact on security and is for testing purposes only! To deactivate the certificate validation, the following setting must be added to\\nyour homeserver.yaml. use_insecure_ssl_client_just_for_testing_do_not_use: true","breadcrumbs":"Configuring a Forward/Outbound Proxy » Troubleshooting","id":"50","title":"Troubleshooting"},"500":{"body":"(string|null) An alternative to registration_shared_secret: allows the shared secret to be specified in an external file. The file should be a plain text file, containing only the shared secret. If this file does not exist, Synapse will create a new shared secret on startup and store it in this file. Added in Synapse 1.67.0. Defaults to null. Example configuration: registration_shared_secret_path: /path/to/secrets/file","breadcrumbs":"Configuration » Configuration Manual » registration_shared_secret_path","id":"500","title":"registration_shared_secret_path"},"501":{"body":"(integer) 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. Defaults to 12. Example configuration: bcrypt_rounds: 14","breadcrumbs":"Configuration » Configuration Manual » bcrypt_rounds","id":"501","title":"bcrypt_rounds"},"502":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » allow_guest_access","id":"502","title":"allow_guest_access"},"503":{"body":"(string|null) 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.) Defaults to null. Example configuration: default_identity_server: https://matrix.org","breadcrumbs":"Configuration » Configuration Manual » default_identity_server","id":"503","title":"default_identity_server"},"504":{"body":"(object) Delegate verification of phone numbers to an identity server. When a user wishes to add a phone number to their account, we need to verify that they actually own that phone number, which requires sending them a text message (SMS). Currently Synapse does not support sending those texts itself and instead delegates the task to an identity server. The base URI for the identity server to be used is specified by the account_threepid_delegates.msisdn option. If this is left unspecified, Synapse will not allow users to add phone numbers to their account. (Servers handling the these requests must answer the /requestToken endpoints defined by the Matrix Identity Service API specification.) Deprecated in Synapse 1.64.0: The email option is deprecated. Removed in Synapse 1.66.0: The email option has been removed. If present, Synapse will report a configuration error on startup. Defaults to {}. This setting has the following sub-options: msisdn (string|null): Identity server base URI for MSISDN (phone numbers). See above. Example configuration: account_threepid_delegates: msisdn: http://localhost:8090","breadcrumbs":"Configuration » Configuration Manual » account_threepid_delegates","id":"504","title":"account_threepid_delegates"},"505":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » enable_set_displayname","id":"505","title":"enable_set_displayname"},"506":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » enable_set_avatar_url","id":"506","title":"enable_set_avatar_url"},"507":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » enable_3pid_changes","id":"507","title":"enable_3pid_changes"},"508":{"body":"(array) 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. Invite-only rooms can also be auto-joined when setting auto_join_mxid_localpart to a user who’s part of the invite-only rooms. As Spaces are just rooms under the hood, Space aliases may also be used. Defaults to []. Example configuration: auto_join_rooms:\\n- \'#exampleroom:example.com\'\\n- \'#anotherexampleroom:example.com\'","breadcrumbs":"Configuration » Configuration Manual » auto_join_rooms","id":"508","title":"auto_join_rooms"},"509":{"body":"(boolean) 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. This option will not create Spaces. 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","breadcrumbs":"Configuration » Configuration Manual » autocreate_auto_join_rooms","id":"509","title":"autocreate_auto_join_rooms"},"51":{"body":"This document explains how to enable VoIP relaying on your homeserver with\\nTURN. The synapse Matrix homeserver supports integration with TURN server via the TURN server REST API. This\\nallows the homeserver to generate credentials that are valid for use on the\\nTURN server through the use of a secret shared between the homeserver and the\\nTURN server. This documentation provides two TURN server configuration examples: coturn eturnal","breadcrumbs":"Configuring a Turn Server » Overview","id":"51","title":"Overview"},"510":{"body":"(boolean) Whether the rooms listed 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. If true, the room will be joinable from other servers. If false, users from other homeservers are prevented from joining these rooms. Defaults to true. Example configuration: autocreate_auto_join_rooms_federated: false","breadcrumbs":"Configuration » Configuration Manual » autocreate_auto_join_rooms_federated","id":"510","title":"autocreate_auto_join_rooms_federated"},"511":{"body":"(string) 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: “public_chat”: the room is joinable by anyone, including federated servers if autocreate_auto_join_rooms_federated is true (the default). “private_chat”: an invitation is required to join these rooms. “trusted_private_chat”: an invitation is required to join this room and the invitee is assigned a power level of 100 upon joining the room. Each preset will set up a room in the same manner as if it were provided as the preset parameter when calling the POST /_matrix/client/v3/createRoom Client-Server API endpoint. 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","breadcrumbs":"Configuration » Configuration Manual » autocreate_auto_join_room_preset","id":"511","title":"autocreate_auto_join_room_preset"},"512":{"body":"(string|null) 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. Defaults to null. Example configuration: auto_join_mxid_localpart: system","breadcrumbs":"Configuration » Configuration Manual » auto_join_mxid_localpart","id":"512","title":"auto_join_mxid_localpart"},"513":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » auto_join_rooms_for_guests","id":"513","title":"auto_join_rooms_for_guests"},"514":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » inhibit_user_in_use_error","id":"514","title":"inhibit_user_in_use_error"},"515":{"body":"(boolean) Whether users are allowed to register with a underscore-prefixed localpart. By default, AppServices use prefixes like _example to namespace their associated ghost users. If turned on, this may result in clashes or confusion. Useful when provisioning users from an external identity provider. Defaults to false. Example configuration: allow_underscore_prefixed_registration: true","breadcrumbs":"Configuration » Configuration Manual » allow_underscore_prefixed_registration","id":"515","title":"allow_underscore_prefixed_registration"},"516":{"body":"Config options related to user session management.","breadcrumbs":"Configuration » Configuration Manual » User session management","id":"516","title":"User session management"},"517":{"body":"(duration) 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. Defaults to \\"infinity\\". Example configuration: session_lifetime: 24h","breadcrumbs":"Configuration » Configuration Manual » session_lifetime","id":"517","title":"session_lifetime"},"518":{"body":"(duration) 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. Defaults to \\"5m\\". Example configuration: refreshable_access_token_lifetime: 10m","breadcrumbs":"Configuration » Configuration Manual » refreshable_access_token_lifetime","id":"518","title":"refreshable_access_token_lifetime"},"519":{"body":"(duration) 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. Defaults to \\"infinity\\". Example configuration: refresh_token_lifetime: 24h","breadcrumbs":"Configuration » Configuration Manual » refresh_token_lifetime","id":"519","title":"refresh_token_lifetime"},"52":{"body":"For TURN relaying to work, the TURN service must be hosted on a server/endpoint with a public IP. Hosting TURN behind NAT requires port forwarding and for the NAT gateway to have a public IP.\\nHowever, even with appropriate configuration, NAT is known to cause issues and to often not work. Afterwards, the homeserver needs some further configuration.","breadcrumbs":"Configuring a Turn Server » Requirements","id":"52","title":"Requirements"},"520":{"body":"(duration) 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. Defaults to \\"infinity\\". Example configuration: nonrefreshable_access_token_lifetime: 24h","breadcrumbs":"Configuration » Configuration Manual » nonrefreshable_access_token_lifetime","id":"520","title":"nonrefreshable_access_token_lifetime"},"521":{"body":"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, adding a 3PID, and minting additional login tokens). Use the session_timeout sub-option here to change the time allowed for credential validation. Defaults to 0. Example configuration: ui_auth: session_timeout: 15s","breadcrumbs":"Configuration » Configuration Manual » ui_auth","id":"521","title":"ui_auth"},"522":{"body":"(object) Matrix supports the ability of an existing session to mint a login token for another client. Synapse disables this by default as it has security ramifications – a malicious client could use the mechanism to spawn more than one session. This setting has the following sub-options: enabled (boolean): Enable login via existing session. Defaults to false. require_ui_auth (boolean): Require user-interactive authentication. Defaults to true. token_timeout (duration): Duration of time the generated token is valid. Defaults to \\"5m\\". Example configuration: login_via_existing_session: enabled: true require_ui_auth: false token_timeout: 5m","breadcrumbs":"Configuration » Configuration Manual » login_via_existing_session","id":"522","title":"login_via_existing_session"},"523":{"body":"Config options related to metrics.","breadcrumbs":"Configuration » Configuration Manual » Metrics","id":"523","title":"Metrics"},"524":{"body":"(boolean) Set to true to enable collection and rendering of performance metrics. Defaults to false. Example configuration: enable_metrics: true","breadcrumbs":"Configuration » Configuration Manual » enable_metrics","id":"524","title":"enable_metrics"},"525":{"body":"(object) Use this option to enable sentry integration. Provide the DSN assigned to you by sentry with the dsn setting. An optional environment field can be used to specify an environment. This allows for log maintenance based on different environments, ensuring better organization and analysis. 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. This setting has the following sub-options: dsn (string|null): The DSN assigned by sentry. If unset or null, sentry integration is disabled. Defaults to null. environment (string|null): Sentry environment. Defaults to null. Example configuration: sentry: environment: production dsn: \'...\'","breadcrumbs":"Configuration » Configuration Manual » sentry","id":"525","title":"sentry"},"526":{"body":"(object) 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. This setting has the following sub-options: known_servers (boolean): 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. Defaults to false. Example configuration: metrics_flags: known_servers: true","breadcrumbs":"Configuration » Configuration Manual » metrics_flags","id":"526","title":"metrics_flags"},"527":{"body":"(boolean) Whether or not to report homeserver usage statistics. This is originally set when generating the config. Set this option to true or false to change the current behavior. See Reporting Homeserver Usage Statistics for information on what data is reported. Statistics will be reported 5 minutes after Synapse starts, and then every 3 hours after that. Defaults to false. Example configuration: report_stats: true","breadcrumbs":"Configuration » Configuration Manual » report_stats","id":"527","title":"report_stats"},"528":{"body":"(string) The endpoint to report 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","breadcrumbs":"Configuration » Configuration Manual » report_stats_endpoint","id":"528","title":"report_stats_endpoint"},"529":{"body":"Config settings related to the client/server API.","breadcrumbs":"Configuration » Configuration Manual » API Configuration","id":"529","title":"API Configuration"},"53":{"body":"Your homeserver configuration file needs the following extra keys: turn_uris turn_shared_secret turn_user_lifetime turn_allow_guests As an example, here is the relevant section of the config file for matrix.org. The turn_uris are appropriate for TURN servers listening on the default ports, with no TLS. turn_uris: [ \\"turn:turn.matrix.org?transport=udp\\", \\"turn:turn.matrix.org?transport=tcp\\" ]\\nturn_shared_secret: \\"n0t4ctuAllymatr1Xd0TorgSshar3d5ecret4obvIousreAsons\\"\\nturn_user_lifetime: 86400000\\nturn_allow_guests: true After updating the homeserver configuration, you must restart synapse: If you use synctl: # Depending on how Synapse is installed, synctl may already be on\\n# your PATH. If not, you may need to activate a virtual environment.\\nsynctl restart If you use systemd: systemctl restart matrix-synapse.service … and then reload any clients (or wait an hour for them to refresh their\\nsettings).","breadcrumbs":"Configuring a Turn Server » Synapse setup","id":"53","title":"Synapse setup"},"530":{"body":"(object) This setting controls the state that is shared with users upon receiving an invite to a room, or in reply to a knock on a room. By default, the following state events are shared with users: m.room.join_rules m.room.canonical_alias m.room.avatar m.room.encryption m.room.name m.room.create m.room.topic Changed in Synapse 1.74: admins can filter the events in prejoin state based on their state key. This setting has the following sub-options: disable_default_event_types (boolean): Set to true to disable the above defaults. If this is enabled, only the event types listed in additional_event_types are shared. Defaults to false. additional_event_types (array): A list of additional state events to include in the events to be shared. By default, this list is empty (so only the default event types are shared). Each entry in this list should be either a single string or a list of two strings. A standalone string t represents all events with type t (i.e. with no restrictions on state keys). A pair of strings [t, s] represents a single event with type t and state key s. The same type can appear in two entries with different state keys: in this situation, both state keys are included in prejoin state. Defaults to []. Example configuration: room_prejoin_state: disable_default_event_types: false additional_event_types: - org.example.custom.event.typeA - - org.example.custom.event.typeB - foo - - org.example.custom.event.typeC - bar - - org.example.custom.event.typeC - baz","breadcrumbs":"Configuration » Configuration Manual » room_prejoin_state","id":"530","title":"room_prejoin_state"},"531":{"body":"(boolean) 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.) Defaults to false. Example configuration: track_puppeted_user_ips: true","breadcrumbs":"Configuration » Configuration Manual » track_puppeted_user_ips","id":"531","title":"track_puppeted_user_ips"},"532":{"body":"(array) A list of application service config files to use. Defaults to []. Example configuration: app_service_config_files:\\n- app_service_1.yaml\\n- app_service_2.yaml","breadcrumbs":"Configuration » Configuration Manual » app_service_config_files","id":"532","title":"app_service_config_files"},"533":{"body":"(boolean) Set to true to enable tracking of application service IP addresses. Implicitly enables MAU tracking for application service users. Defaults to false. Example configuration: track_appservice_user_ips: true","breadcrumbs":"Configuration » Configuration Manual » track_appservice_user_ips","id":"533","title":"track_appservice_user_ips"},"534":{"body":"(boolean) Whether to send the application service access tokens via the access_token query parameter per older versions of the Matrix specification. Defaults to false. Set to true to enable sending access tokens via a query parameter. Enabling this option is considered insecure and is not recommended. Defaults to false. Example configuration: use_appservice_legacy_authorization: true","breadcrumbs":"Configuration » Configuration Manual » use_appservice_legacy_authorization","id":"534","title":"use_appservice_legacy_authorization"},"535":{"body":"(string|null) A secret which is used to sign access token for guest users, short-term login token used during SSO logins (OIDC or SAML2) and token used for unsubscribing from email notifications. If none is specified, the registration_shared_secret is used, if one is given; otherwise, a secret key is derived from the signing key. ⚠️ Warning – Replacing an existing macaroon_secret_key with a new one will lead to invalidation of access tokens for all guest users. It will also break unsubscribe links in emails sent before the change. An unlucky user might encounter a broken SSO login flow and would have to start again. Defaults to null. Example configuration: macaroon_secret_key: ","breadcrumbs":"Configuration » Configuration Manual » macaroon_secret_key","id":"535","title":"macaroon_secret_key"},"536":{"body":"(string|null) An alternative to macaroon_secret_key: allows the secret key to be specified in an external file. The file should be a plain text file, containing only the secret key. Synapse reads the secret key from the given file once at startup. Added in Synapse 1.121.0. Defaults to null. Example configuration: macaroon_secret_key_path: /path/to/secrets/file","breadcrumbs":"Configuration » Configuration Manual » macaroon_secret_key_path","id":"536","title":"macaroon_secret_key_path"},"537":{"body":"(string|null) 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. Replacing an existing form_secret with a new one might break the user consent page for an unlucky user and require them to reopen the page from a new link. Defaults to null. Example configuration: form_secret: ","breadcrumbs":"Configuration » Configuration Manual » form_secret","id":"537","title":"form_secret"},"538":{"body":"(string|null) An alternative to form_secret: allows the secret to be specified in an external file. The file should be a plain text file, containing only the secret. Synapse reads the secret from the given file once at startup. Added in Synapse 1.126.0. Defaults to null. Example configuration: form_secret_path: /path/to/secrets/file","breadcrumbs":"Configuration » Configuration Manual » form_secret_path","id":"538","title":"form_secret_path"},"539":{"body":"Config options relating to signing keys.","breadcrumbs":"Configuration » Configuration Manual » Signing Keys","id":"539","title":"Signing Keys"},"54":{"body":"The normal symptoms of a misconfigured TURN server are that calls between\\ndevices on different networks ring, but get stuck at “call\\nconnecting”. Unfortunately, troubleshooting this can be tricky. Here are a few things to try: Check that you have opened your firewall to allow TCP and UDP traffic to the\\nTURN ports (normally 3478 and 5349). Check that you have opened your firewall to allow UDP traffic to the UDP\\nrelay ports (49152-65535 by default). Try disabling TLS/DTLS listeners and enable only its (unencrypted)\\nTCP/UDP listeners. (This will only leave signaling traffic unencrypted;\\nvoice & video WebRTC traffic is always encrypted.) Some WebRTC implementations (notably, that of Google Chrome) appear to get\\nconfused by TURN servers which are reachable over IPv6 (this appears to be\\nan unexpected side-effect of its handling of multiple IP addresses as\\ndefined by draft-ietf-rtcweb-ip-handling). Try removing any AAAA records for your TURN server, so that it is only\\nreachable over IPv4. If your TURN server is behind NAT: double-check that your NAT gateway is correctly forwarding all TURN\\nports (normally 3478 & 5349 for TCP & UDP TURN traffic, and 49152-65535 for the UDP\\nrelay) to the NAT-internal address of your TURN server. If advertising\\nboth IPv4 and IPv6 external addresses via the external-ip option, ensure\\nthat the NAT is forwarding both IPv4 and IPv6 traffic to the IPv4 and IPv6\\ninternal addresses of your TURN server. When in doubt, remove AAAA records\\nfor your TURN server and specify only an IPv4 address as your external-ip. ensure that your TURN server uses the NAT gateway as its default route. Enable more verbose logging, in coturn via the verbose setting: verbose or with eturnal with the shell command eturnalctl loglevel debug or in the configuration file (the service needs to reload for it to become effective): ## Logging configuration: log_level: debug … and then see if there are any clues in its logs. If you are using a browser-based client under Chrome, check chrome://webrtc-internals/ for insights into the internals of the\\nnegotiation. On Firefox, check the “Connection Log” on about:webrtc. (Understanding the output is beyond the scope of this document!) You can test your Matrix homeserver TURN setup with https://test.voip.librepush.net/.\\nNote that this test is not fully reliable yet, so don’t be discouraged if\\nthe test fails. Here is the github repo of the\\nsource of the tester, where you can file bug reports. There is a WebRTC test tool at https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice/. To\\nuse it, you will need a username/password for your TURN server. You can\\neither: look for the GET /_matrix/client/r0/voip/turnServer request made by a\\nmatrix client to your homeserver in your browser’s network inspector. In\\nthe response you should see username and password. Or: Use the following shell commands for coturn: secret=staticAuthSecretHere u=$((`date +%s` + 3600)):test\\np=$(echo -n $u | openssl dgst -hmac $secret -sha1 -binary | base64)\\necho -e \\"username: $u\\\\npassword: $p\\" or for eturnal eturnalctl credentials Or ( coturn only): Temporarily configure coturn to accept a static\\nusername/password. To do this, comment out use-auth-secret and static-auth-secret and add the following: lt-cred-mech\\nuser=username:password Note: these settings will not take effect unless use-auth-secret\\nand static-auth-secret are disabled. Restart coturn after changing the configuration file. Remember to restore the original settings to go back to testing with\\nMatrix clients! If the TURN server is working correctly, you should see at least one relay\\nentry in the results.","breadcrumbs":"Configuring a Turn Server » Troubleshooting","id":"54","title":"Troubleshooting"},"540":{"body":"(string|null) Path to the signing key to sign events and federation requests with. New in Synapse 1.67: If this file does not exist, Synapse will create a new signing key on startup and store it in this file. Defaults to null. Example configuration: signing_key_path: CONFDIR/SERVERNAME.signing.key","breadcrumbs":"Configuration » Configuration Manual » signing_key_path","id":"540","title":"signing_key_path"},"541":{"body":"(object) The keys that the server used to sign messages with but won’t use to sign new messages. It is possible to build an entry from an old signing.key file using the export_signing_key script which is provided with synapse. If you have lost the private key file, you can ask another server you trust to tell you the public keys it has seen from your server. To fetch the keys from matrix.org, try something like: curl https://matrix-federation.matrix.org/_matrix/key/v2/query/myserver.example.com | jq \'.server_keys | map(.verify_keys) | add\' Defaults to {}. Example configuration: old_signing_keys: ed25519:id: key: base64string expired_ts: 123456789123","breadcrumbs":"Configuration » Configuration Manual » old_signing_keys","id":"541","title":"old_signing_keys"},"542":{"body":"(duration) 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","breadcrumbs":"Configuration » Configuration Manual » key_refresh_interval","id":"542","title":"key_refresh_interval"},"543":{"body":"(array) 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 supersedes 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. If the use of a trusted key server has to be deactivated, e.g. in a private federation or for privacy reasons, this can be realised by setting an empty array ( trusted_key_servers: []). Then Synapse will request the keys directly from the server that owns the keys. If Synapse does not get keys directly from the server, the events of this server will be rejected. Default configuration: trusted_key_servers:\\n- server_name: matrix.org Example configurations: trusted_key_servers:\\n- server_name: my_trusted_server.example.com verify_keys: ed25519:auto: abcdefghijklmnopqrstuvwxyzabcdefghijklmopqr\\n- server_name: my_other_trusted_server.example.com trusted_key_servers:\\n- server_name: matrix.org","breadcrumbs":"Configuration » Configuration Manual » trusted_key_servers","id":"543","title":"trusted_key_servers"},"544":{"body":"(boolean) Set the following to true to disable the warning that is emitted when the trusted_key_servers include “matrix.org”. See above. Defaults to false. Example configuration: suppress_key_server_warning: true","breadcrumbs":"Configuration » Configuration Manual » suppress_key_server_warning","id":"544","title":"suppress_key_server_warning"},"545":{"body":"(string|null) 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. Defaults to null. Example configuration: key_server_signing_keys_path: key_server_signing_keys.key","breadcrumbs":"Configuration » Configuration Manual » key_server_signing_keys_path","id":"545","title":"key_server_signing_keys_path"},"546":{"body":"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: enable_registration password_config.enabled","breadcrumbs":"Configuration » Configuration Manual » Single sign-on integration","id":"546","title":"Single sign-on integration"},"547":{"body":"(object) 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. Once SAML support is enabled, a metadata file will be exposed at https://:/_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://:/_synapse/client/saml2/authn_response. This setting has the following sub-options: idp_name (string): A user-facing name for this identity provider, which is used to offer the user a choice of login mechanisms. idp_icon (string|null): An optional icon for this identity provider, which is presented by clients and Synapse’s own IdP picker page. If given, must be an MXC URI of the format mxc:///. (An easy way to obtain such an MXC URI is to upload an image to an (unencrypted) room and then copy the URL from the source of the event.) idp_brand: An optional brand for this identity provider, allowing clients to style the login flow according to the identity provider in question. See the spec for possible options here. sp_config (object|null): Configuration for the pysaml2 Service Provider. See pysaml2 docs for format of config. Default values will be used for the entityid and service settings, so it is not normally necessary to specify them unless you need to override them. Here are a few useful sub-options for configuring pysaml: metadata: Point this to the IdP’s metadata. You must provide either a local file via the local attribute or (preferably) a URL via the remote attribute. accepted_time_diff: 3: Allowed clock difference in seconds between the homeserver and IdP. Defaults to 0. service: By default, the user has to go to our login page first. If you’d like to allow IdP-initiated login, set allow_unsolicited to true under sp in the service section. Defaults to null. config_path (string|null): Specify a separate pysaml2 configuration file. Defaults to null. saml_session_lifetime (duration): The lifetime of a SAML session. This defines how long a user has to complete the authentication process, if allow_unsolicited is unset. Defaults to \\"15m\\". user_mapping_provider (object): Using this option, an external module can be provided as a custom solution to mapping attributes returned from a saml provider onto a matrix user. This setting has the following sub-options: module (string): The custom module’s class. config (object): Custom configuration values for the module. Use the values provided in the example if you are using the built-in user_mapping_provider, or provide your own config values for a custom class if you are using one. This section will be passed as a Python dictionary to the module’s parse_config method. The built-in provider takes the following two options: mxid_source_attribute: The SAML attribute (after mapping via the attribute maps) to use to derive the Matrix ID from. It is “uid” by default. Note: This used to be configured by the saml2_config.mxid_source_attribute option. If that is still defined, its value will be used instead. mxid_mapping: The mapping system to use for mapping the saml attribute onto a matrix ID. Options include: hexencode (which maps unpermitted characters to =xx) and dotreplace (which replaces unpermitted characters with .). The default is hexencode. Note: This used to be configured by the saml2_config.mxid_mapping option. If that is still defined, its value will be used instead. grandfathered_mxid_source_attribute (string): In previous versions of synapse, the mapping from SAML attribute to MXID was always calculated dynamically rather than stored in a table. For backwards-compatibility, we will look for user_ids matching such a pattern before creating a new account. This setting controls the SAML attribute which will be used for this backwards-compatibility lookup. Typically it should be “uid”, but if the attribute maps are changed, it may be necessary to change it. Defaults to \\"uid\\". attribute_requirements (array): It is possible to configure Synapse to only allow logins if SAML attributes match particular values. The requirements can be listed under attribute_requirements as shown in the example. All of the listed attributes must match for the login to be permitted. Values can be specified in a one_of list to allow multiple values for an attribute. Options for each entry include: attribute (string): SAML attribute for which to allow logins. value (string): Value the SAML attribute must match. one_of (array): List of values the SAML attribute must all match. idp_entityid (string|null): If the metadata XML contains multiple IdP entities then the idp_entityid option must be set to the entity to redirect users to. Most deployments only have a single IdP entity and so should omit this option. Defaults to null. 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 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: config: mxid_source_attribute: displayName mxid_mapping: dotreplace grandfathered_mxid_source_attribute: upn attribute_requirements: - attribute: userGroup value: staff - attribute: department one_of: - sales - admins idp_entityid: https://our_idp/entityid","breadcrumbs":"Configuration » Configuration Manual » saml2_config","id":"547","title":"saml2_config"},"548":{"body":"(array) 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.) 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 one_of: [\\"Stephensson\\", \\"Smith\\"] - attribute: groups value: \\"admin\\" # If `value` or `one_of` are not specified, the attribute only needs # to exist, regardless of value. - attribute: picture attribute is a required field, while value and one_of are optional. 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 either “Stephensson” or “Smith”, but the groups claim MUST contain “admin”. Defaults to []. Options for each entry include: idp_id (string): A unique identifier for this identity provider. Used internally by Synapse; should be a single word such as “github”. Note that, if this is changed, users authenticating via that provider will no longer be recognised as the same user! (Use “oidc” here if you are migrating from an old oidc_config configuration.) idp_name (string): A user-facing name for this identity provider, which is used to offer the user a choice of login mechanisms. idp_icon (string): An optional icon for this identity provider, which is presented by clients and Synapse’s own IdP picker page. If given, must be an MXC URI of the format mxc:///. (An easy way to obtain such an MXC URI is to upload an image to an (unencrypted) room and then copy the URL from the source of the event.) idp_brand (string): An optional brand for this identity provider, allowing clients to style the login flow according to the identity provider in question. See the spec for possible options here. discover (boolean): Set to false to disable the use of the OIDC discovery mechanism to discover endpoints. Defaults to true. issuer (string): Required. The OIDC issuer. Used to validate tokens and (if discovery is enabled) to discover the provider’s endpoints. client_id (string): Required. OAuth2 client id to use. client_secret (string|null): OAuth2 client secret to use. May be omitted if client_secret_jwt_key is given, or if client_auth_method is none. Must be omitted if client_secret_path is specified. client_secret_path (string|null): Path to the OAuth2 client secret to use. With that it’s not necessary to leak secrets into the config file itself. Mutually exclusive with client_secret. Can be omitted if client_secret_jwt_key is specified. Added in Synapse 1.91.0. client_secret_jwt_key (object|null): Alternative to client_secret: details of a key used to create a JSON Web Token to be used as an OAuth2 client secret. This setting has the following sub-options: key (string|null): A pem-encoded signing key. Must be a suitable key for the algorithm specified. Required unless key_file is given. key_file (string|null): Path to the file containing a pem-encoded signing key. Required unless key is given. jwt_header (object): Dictionary giving properties to include in the JWT header. Must include the key alg. This setting has the following sub-options: alg (string): Algorithm used to sign the JWT, such as ES256, using the JWA identifiers in RFC7518. jwt_payload (object): Optional dictionary giving properties to include in the JWT payload. Normally this should include an iss key. client_auth_method (string|null): Auth method to use when exchanging the token. Valid values are client_secret_basic (default), client_secret_post and none. pkce_method (string|null): Whether to use proof key for code exchange when requesting and exchanging the token. Valid values are: auto, always, or never. Defaults to auto, which uses PKCE if supported during metadata discovery. Set to always to force enable PKCE or never to force disable PKCE. id_token_signing_alg_values_supported (array): List of the JWS signing algorithms ( alg values) that are supported for signing the id_token. This is not required if discovery is disabled. We default to supporting RS256 in the downstream usage if no algorithms are configured here or in the discovery document. According to the spec, the algorithm \\"RS256\\" MUST be included. The absolute rigid approach would be to reject this provider as non-compliant if it’s not included but we simply allow whatever and see what happens (you’re the one that configured the value and cooperating with the identity provider). The alg value \\"none\\" MAY be supported but can only be used if the Authorization Endpoint does not include id_token in the response_type (ex. /authorize?response_type=code where none can apply, /authorize?response_type=code%20id_token where none can’t apply) (such as when using the Authorization Code Flow). scopes (array|null): List of scopes to request. This should normally include the “openid” scope. Defaults to [\\"openid\\"]. authorization_endpoint (string): The OAuth2 authorization endpoint. Required if provider discovery is disabled. token_endpoint (string): The OAuth2 token endpoint. Required if provider discovery is disabled. userinfo_endpoint (string): The OIDC userinfo endpoint. Required if discovery is disabled and the “openid” scope is not requested. jwks_uri (string): URI where to fetch the JWKS. Required if discovery is disabled and the “openid” scope is used. skip_verification (boolean): Set to true to skip metadata verification. Use this if you are connecting to a provider that is not OpenID Connect compliant. Defaults to false. Avoid this in production. user_profile_method (string|null): Whether to fetch the user profile from the userinfo endpoint, or to rely on the data returned in the id_token from the token_endpoint. Valid values are: auto or userinfo_endpoint. Defaults to auto, which uses the userinfo endpoint if openid is not included in scopes. Set to userinfo_endpoint to always use the userinfo endpoint. redirect_uri (string|null): An optional string, that if set will override the redirect_uri parameter sent in the requests to the authorization and token endpoints. Useful if you want to redirect the client to another endpoint as part of the OIDC login. Be aware that the client must then call Synapse’s OIDC callback URL ( /_synapse/client/oidc/callback) manually afterwards. Must be a valid URL including scheme and path. additional_authorization_parameters (object): String to string dictionary that will be passed as additional parameters to the authorization grant URL. passthrough_authorization_parameters (array): List of parameters that will be passed through from the redirect endpoint to the authorization grant URL. allow_existing_users (boolean): Set to true to allow a user logging in via OIDC to match a pre-existing account instead of failing. This could be used if switching from password logins to OIDC. Defaults to false. enable_registration (boolean): Set to false to disable automatic registration of new users. This allows the OIDC SSO flow to be limited to sign in only, rather than automatically registering users that have a valid SSO login but do not have a pre-registered account. Defaults to true. user_mapping_provider (object): Configuration for how attributes returned from a OIDC provider are mapped onto a matrix user. When rendering, the Jinja2 templates are given a user variable, which is set to the claims returned by the UserInfo Endpoint and/or in the ID Token. This setting has the following sub-options: module (string): The class name of a custom mapping module. Default is synapse.handlers.oidc.JinjaOidcMappingProvider. See OpenID Mapping Providers for information on implementing a custom mapping provider. config (object): Configuration for the mapping provider module. This section will be passed as a Python dictionary to the user mapping provider module’s parse_config method. For the default provider, the following settings are available: subject_template: Jinja2 template for a unique identifier for the user. Defaults to {{ user.sub }}, which OpenID Connect compliant providers should provide. This replaces and overrides subject_claim. subject_claim: name of the claim containing a unique identifier for the user. Defaults to sub, which OpenID Connect compliant providers should provide. Deprecated in Synapse v1.75.0. picture_template: Jinja2 template for an url for the user’s profile picture. Defaults to {{ user.picture }}, which OpenID Connect compliant providers should provide and has to refer to a direct image file such as PNG, JPEG, or GIF image file. This replaces and overrides picture_claim. Currently only supported in monolithic (single-process) server configurations where the media repository runs within the Synapse process. picture_claim: name of the claim containing an url for the user’s profile picture. Defaults to “picture”, which OpenID Connect compliant providers should provide and has to refer to a direct image file such as PNG, JPEG, or GIF image file. Currently only supported in monolithic (single-process) server configurations where the media repository runs within the Synapse process. Deprecated in Synapse v1.75.0. localpart_template: Jinja2 template for the localpart of the MXID. If this is not set, the user will be prompted to choose their own username (see the documentation for the sso_auth_account_details.html template). This template can use the localpart_from_email filter. confirm_localpart: Whether to prompt the user to validate (or change) the generated localpart (see the documentation for the “sso_auth_account_details.html” template), instead of registering the account right away. display_name_template: Jinja2 template for the display name to set on first login. If unset, no displayname will be set. email_template: Jinja2 template for the email address of the user. If unset, no email address will be added to the account. extra_attributes: a map of Jinja2 templates for extra attributes to send back to the client during login. Note that these are non-standard and clients will ignore them without modifications. backchannel_logout_enabled (boolean): Set to true to process OIDC Back-Channel Logout notifications. Those notifications are expected to be received on /_synapse/client/oidc/backchannel_logout. Defaults to false. backchannel_logout_ignore_sub (boolean): By default, the OIDC Back-Channel Logout feature checks that the sub claim matches the subject claim received during login. This check can be disabled by setting this to true. Defaults to false. You might want to disable this if the subject_claim returned by the mapping provider is not sub. Example configuration: oidc_providers:\\n- 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 additional_authorization_parameters: acr_values: 2fa passthrough_authorization_parameters: - login_hint skip_verification: true enable_registration: 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","breadcrumbs":"Configuration » Configuration Manual » oidc_providers","id":"548","title":"oidc_providers"},"549":{"body":"(object) Enable Central Authentication Service (CAS) for registration and login. This setting has the following sub-options: enabled (boolean): Set this to true to enable authorization against a CAS server. Defaults to false. idp_name (string): A user-facing name for this identity provider, which is used to offer the user a choice of login mechanisms. idp_icon (string|null): An optional icon for this identity provider, which is presented by clients and Synapse’s own IdP picker page. If given, must be an MXC URI of the format mxc:///. (An easy way to obtain such an MXC URI is to upload an image to an (unencrypted) room and then copy the URL from the source of the event.) Defaults to null. idp_brand (string|null): An optional brand for this identity provider, allowing clients to style the login flow according to the identity provider in question. See the spec for possible options here. Defaults to null. server_url (string): The URL of the CAS authorization endpoint. protocol_version (integer|null): The CAS protocol version. (Version 3 is required if you want to use required_attributes). Defaults to null. displayname_attribute (string|null): The attribute of the CAS response to use as the display name. If no name is given here, no displayname will be set. Defaults to null. required_attributes (object): It is possible to configure Synapse to only allow logins if CAS attributes match particular values. All of the keys given below must exist and the values must match the given value. Alternately if the given value is None then any value is allowed (the attribute just must exist). All of the listed attributes must match for the login to be permitted. Defaults to {}. enable_registration (boolean): Set to false to disable automatic registration of new users. This allows the CAS SSO flow to be limited to sign in only, rather than automatically registering users that have a valid SSO login but do not have a pre-registered account. Defaults to true. allow_numeric_ids (boolean): Set to true allow numeric user IDs. This allows CAS SSO flow to provide user IDs composed of numbers only. These identifiers will be prefixed by the letter “u” by default. The prefix can be configured using the numeric_ids_prefix option. Be careful to choose the prefix correctly to avoid any possible conflicts (e.g. user 1234 becomes u1234 when a user u1234 already exists). Defaults to false. numeric_ids_prefix (string): The prefix you wish to add in front of a numeric user ID when the allow_numeric_ids option is set to true. Only alphanumeric characters are allowed. Added in Synapse 1.93.0. Defaults to \\"u\\". Example configuration: cas_config: enabled: true server_url: https://cas-server.com protocol_version: 3 displayname_attribute: name required_attributes: userGroup: staff department: None enable_registration: true allow_numeric_ids: true numeric_ids_prefix: numericuser","breadcrumbs":"Configuration » Configuration Manual » cas_config","id":"549","title":"cas_config"},"55":{"body":"The following sections describe how to install coturn (which implements the TURN REST API).","breadcrumbs":"Configuring a Turn Server » coturn TURN server » coturn TURN server","id":"55","title":"coturn TURN server"},"550":{"body":"(object) 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. This setting has the following sub-options: client_whitelist (array|null): A list of client URLs which are whitelisted so that the user does not have to confirm giving access to their account to the URL. Any client whose URL starts with an entry in the following list will not be subject to an additional confirmation step after the SSO login is completed. WARNING: An entry such as “https://my.client” is insecure, because it will also match “https://my.client.evil.site”, exposing your users to phishing attacks from evil.site. To avoid this, include a slash after the hostname: “https://my.client/”. The login fallback page (used by clients that don’t natively support the required login flows) is whitelisted in addition to any URLs in this list. By default, this list contains only the login fallback page. Defaults to null. update_profile_information (boolean): Use this setting to keep a user’s profile fields in sync with information from the identity provider. Fields are checked on every SSO login, and are updated if necessary. Note that enabling this option will override user profile information, regardless of whether users have opted-out of syncing that information when first signing in. Fields that will be synced: displayname picture - only if Synapse media repository is running in the main\\nprocess (i.e. not workerized) and media is stored locally Defaults to false. Example configuration: sso: client_whitelist: - https://riot.im/develop - https://my.custom.client/ update_profile_information: true","breadcrumbs":"Configuration » Configuration Manual » sso","id":"550","title":"sso"},"551":{"body":"(object) 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. This setting has the following sub-options: enabled (boolean): Set to true to enable authorization using JSON web tokens. Defaults to false. secret (string): This is either the private shared secret or the public key used to decode the contents of the JSON web token. Required if enabled is set to true. algorithm (string): The algorithm used to sign (or HMAC) the JSON web token. Supported algorithms are listed here (section JWS). Required if enabled is set to true. subject_claim (string|null): Name of the claim containing a unique identifier for the user. Defaults to \\"sub\\". display_name_claim (string|null): Name of the claim containing the display name for the user. If provided, the display name will be set to the value of this claim upon first login. Defaults to null. issuer (string|null): The issuer to validate the “iss” claim against. If provided the “iss” claim will be required and validated for all JSON web tokens. Defaults to null. audiences (array|null): A list of audiences to validate the “aud” claim against. If provided the “aud” claim will be required and validated for all JSON web tokens. Note that if the “aud” claim is included in a JSON web token then validation will fail without configuring audiences. Defaults to null. Example configuration: jwt_config: enabled: true secret: provided-by-your-issuer algorithm: provided-by-your-issuer subject_claim: name_of_claim display_name_claim: name_of_claim issuer: provided-by-your-issuer audiences: - provided-by-your-issuer","breadcrumbs":"Configuration » Configuration Manual » jwt_config","id":"551","title":"jwt_config"},"552":{"body":"(object) Use this setting to enable password-based logins. This setting has the following sub-options: enabled (boolean|string): Set to false to disable password authentication. Set to only_for_reauth to allow users with existing passwords to use them to reauthenticate (not log in), whilst preventing new users from setting passwords. Defaults to true. localdb_enabled (boolean): Set to false to disable authentication against the local password database. This is ignored if enabled is false, and is only useful if you have other password_providers. Defaults to true. pepper (string|null): A secret random string that will be appended to user’s passwords before they are hashed. This improves the security of short passwords. DO NOT CHANGE THIS AFTER INITIAL SETUP! Defaults to null. policy (object): Define and enforce a password policy, such as minimum lengths for passwords, etc. This is an implementation of MSC2000. This setting has the following sub-options: enabled (boolean): Set to true to enable. Defaults to false. minimum_length (integer): Minimum accepted length for a password. Defaults to 0. require_digit (boolean): Whether a password must contain at least one digit. Defaults to false. require_symbol (boolean): Whether a password must contain at least one symbol. A symbol is any character that’s not a number or a letter. Defaults to false. require_lowercase (boolean): Whether a password must contain at least one lowercase letter. Defaults to false. require_uppercase (boolean): Whether a password must contain at least one uppercase letter. Defaults to false. 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","breadcrumbs":"Configuration » Configuration Manual » password_config","id":"552","title":"password_config"},"553":{"body":"Configuration settings related to push notifications.","breadcrumbs":"Configuration » Configuration Manual » Push","id":"553","title":"Push"},"554":{"body":"(object) This setting defines options for push notifications. This setting has the following sub-options: enabled (boolean): Enables or disables push notification calculation. Note, disabling this will also stop unread counts being calculated for rooms. This mode of operation is intended for homeservers which may only have bots or appservice users connected, or are otherwise not interested in push/unread counters. Defaults to true. include_content (boolean): Clients requesting push notifications can either have the body of the message sent in the notification poke along with other details like the sender, or just the event ID and room ID ( event_id_only). If clients choose to have the body sent, this option controls whether the notification request includes the content of the event (other details like the sender are still included). If event_id_only is enabled, it has no effect. For modern Android devices the notification content will still appear because it is loaded by the app. iPhone, however will send a notification saying only that a message arrived and who it came from. Set to false to only include the event ID and room ID in push notification payloads. Defaults to true. group_unread_count_by_room (boolean): When a push notification is received, an unread count is also sent. This number can either be calculated as the number of unread messages for the user, or the number of rooms the user has unread messages in. If true, push clients will see the number of rooms with unread messages in them. Set to false to instead send the number of unread messages. Defaults to true. jitter_delay (duration): Delays push notifications by a random amount up to the given duration. Useful for mitigating timing attacks. Optional. Added in Synapse 1.84.0. Defaults to \\"0s\\". Example configuration: push: enabled: true include_content: false group_unread_count_by_room: false jitter_delay: 10s","breadcrumbs":"Configuration » Configuration Manual » push","id":"554","title":"push"},"555":{"body":"(object) Options for push rules This setting has the following sub-options: limits (object): Limits on the size of push rules that users can have This setting has the following sub-options: rule_count (integer): This is the total number of push rules that each user can have. Power users may expect to have one push rule per room. Defaults to 10000. rule_id_length (integer): This is the maximum length of a push rule ID, in bytes. Push rule IDs need to be allowed to be at least as long as a room ID (which are limited to 255 bytes per specification)\\nIt’s recommended to leave this option as it is. We expect to remove this option if/when the specification standardises on a limit. Defaults to 300. rule_size (integer): This is the maximum size of a push rule’s body, in bytes.\\nThe exact mechanism for calculating this size is currently an implementation detail, subject to change. This limit should be treated as a coarse sanity limit rather than something to fine-tune.\\nIt’s recommended to leave this option as it is. We expect to remove this option if/when the specification standardises on a limit and a mechanism for calculating it. Defaults to 1024.","breadcrumbs":"Configuration » Configuration Manual » push_rules","id":"555","title":"push_rules"},"556":{"body":"Config options relating to rooms.","breadcrumbs":"Configuration » Configuration Manual » Rooms","id":"556","title":"Rooms"},"557":{"body":"(string) Controls whether locally-created rooms should be end-to-end encrypted by default. Possible options are “all”, “invite”, and “off”. They are defined as: “all”: any locally-created room “invite”: any room created with the private_chat or trusted_private_chat room creation presets “off”: this option will take no effect Note that this option will only affect rooms created after it is set. It will also not affect rooms created by other servers. A client may supply its own m.room.encryption event in the initial_state of its /createRoom request. If that event is valid (it specifies an algorithm as a string), it takes precedence and this option will not overwrite it, allowing the client to, for example, choose a different encryption algorithm. An empty or otherwise invalid m.room.encryption event does not disable forced encryption: the default will still be applied on top of it. Defaults to \\"off\\". Example configuration: encryption_enabled_by_default_for_room_type: invite","breadcrumbs":"Configuration » Configuration Manual » encryption_enabled_by_default_for_room_type","id":"557","title":"encryption_enabled_by_default_for_room_type"},"558":{"body":"(object) This setting defines options related to the user directory. This setting has the following sub-options: enabled (boolean): Defines whether users can search the user directory. If false then empty responses are returned to all queries. Warning: While the homeserver may determine which subset of users are searched, the Matrix specification requires homeservers to include (at minimum) users visible in public rooms and users sharing a room with the requester. Using false improves performance but violates this requirement. Defaults to true. search_all_users (boolean): Defines whether to search all users visible to your homeserver at the time the search is performed. If set to true, will return all users known to the homeserver matching the search query. If false, search results will only contain users visible in public rooms and users sharing a room with the requester. NB. If you set this to true, and the last time the user_directory search indexes were (re)built was before Synapse 1.44, you’ll have to rebuild the indexes in order to search through all known users. These indexes are built the first time Synapse starts; admins can manually trigger a rebuild via the API following the instructions for running background updates, set to true to return search results containing all known users, even if that user does not share a room with the requester. Defaults to false. prefer_local_users (boolean): Defines whether to prefer local users in search query results. If set to true, local users are more likely to appear above remote users when searching the user directory. Defaults to false. exclude_remote_users (boolean): If set to true, the search will only return local users. Defaults to false. show_locked_users (boolean): Defines whether to show locked users in search query results. Defaults to false. Example configuration: user_directory: enabled: false search_all_users: true prefer_local_users: true exclude_remote_users: false show_locked_users: true","breadcrumbs":"Configuration » Configuration Manual » user_directory","id":"558","title":"user_directory"},"559":{"body":"(object) 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. This setting has the following sub-options: template_dir (string): Gives the location of the templates for the HTML forms. This directory should contain one subdirectory per language (eg, en, fr), and each language directory should contain the policy document (named as .html) and a success page (success.html). version (number): Specifies the “current” version of the policy document. It defines the version to be served by the consent resource if there is no v parameter. server_notice_content (object): If enabled, will send a user a “Server Notice” asking them to consent to the privacy policy. The server_notices section must also be configured for this to work. Notices will not be sent to guest users unless send_server_notice_to_guests is set to true. This setting has the following sub-options: msgtype (string): Message type of the notice event. body (string): Message template for the server notice event body. send_server_notice_to_guests (boolean): Send server notices to guest users, too. Defaults to false. block_events_error (string|null): If set, will block any attempts to send events until the user consents to the privacy policy. The value of the setting is used as the text of the error. Defaults to null. require_at_registration (boolean): If enabled, will add a step to the registration process, similar to how captcha works. Users will be required to accept the policy before their account is created. policy_name (string): Human-readable name of the privacy policy. Defaults to \\"Privacy Policy\\". 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","breadcrumbs":"Configuration » Configuration Manual » user_consent","id":"559","title":"user_consent"},"56":{"body":"","breadcrumbs":"Configuring a Turn Server » coturn TURN server » coturn setup","id":"56","title":"coturn setup"},"560":{"body":"(object) Settings for local room and user statistics collection. See here for more. This setting has the following sub-options: enabled (boolean): Set to false to disable room and user statistics. Note that doing so may cause certain features (such as the room directory) not to work correctly. Defaults to true. Example configuration: stats: enabled: false","breadcrumbs":"Configuration » Configuration Manual » stats","id":"560","title":"stats"},"561":{"body":"(object) 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. Note that the name, topic and avatar of existing server notice rooms will only be updated when a new notice event is sent. This setting has the following sub-options: system_mxid_display_name (string): Display name of the “notices” user. Defaults to \\"Notices\\". system_mxid_avatar_url (string|null): Avatar for the “notices” user. Defaults to null. room_name (string): Room name of the server notices room. Defaults to \\"Server Notices\\". room_avatar_url (string|null): Room avatar to use for server notice rooms. If set to the empty string \\"\\", notice rooms will not be given an avatar. Added in Synapse 1.99.0. Defaults to null. room_topic (string|null): Topic to use for server notice rooms. If set to the empty string \\"\\", notice rooms will not be given a topic. Defaults to the empty string. Added in Synapse 1.99.0. Defaults to null. auto_join (boolean): If true, the user will be automatically joined to the room instead of being invited. Added in Synapse 1.98.0. Defaults to false. Example configuration: server_notices: system_mxid_localpart: notices system_mxid_display_name: Server Notices system_mxid_avatar_url: mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ room_name: Server Notices room_avatar_url: mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ room_topic: Room used by your server admin to notice you of important information auto_join: true","breadcrumbs":"Configuration » Configuration Manual » server_notices","id":"561","title":"server_notices"},"562":{"body":"(boolean) 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","breadcrumbs":"Configuration » Configuration Manual » enable_room_list_search","id":"562","title":"enable_room_list_search"},"563":{"body":"(array|null) The alias_creation_rules option allows server admins to prevent unwanted alias creation on this server. This setting is an optional list of 0 or more rules. By default, no list is provided, meaning that all alias creations are permitted. Otherwise, requests to create aliases are matched against each rule in order. The first rule that matches decides if the request is allowed or denied. If no rule matches, the request is denied. In particular, this means that configuring an empty list of rules will deny every alias creation request. Each of the glob patterns is optional, defaulting to * (“match anything”). Note that the patterns match against fully qualified IDs, e.g. against @alice:example.com, #room:example.com and !abcdefghijk:example.com instead of alice, room and abcedgghijk. Each rule is a YAML object containing four fields, each of which is an optional string Defaults to null. Options for each entry include: user_id (string|null): Glob pattern that matches against the creator of the alias. alias (string|null): Glob pattern that matches against the alias being created. room_id (string|null): Glob pattern that matches against the room ID the alias is being pointed at. action (string): Either allow or deny. What to do with the request if the rule matches. Defaults to allow. Example configurations: alias_creation_rules: null alias_creation_rules:\\n- action: allow alias_creation_rules: [] alias_creation_rules:\\n- action: deny alias_creation_rules:\\n- user_id: \'@bad_user:example.com\' action: deny\\n- action: allow alias_creation_rules:\\n- room_id: \'!forbiddenRoom:example.com\' action: deny\\n- action: allow","breadcrumbs":"Configuration » Configuration Manual » alias_creation_rules","id":"563","title":"alias_creation_rules"},"564":{"body":"(array|null) The room_list_publication_rules option allows server admins to prevent unwanted entries from being published in the public room list. The format of this option is the same as that for alias_creation_rules: an optional list of 0 or more rules. By default, no list is provided, meaning that no one may publish to the room list (except server admins). Otherwise, requests to publish a room are matched against each rule in order. The first rule that matches decides if the request is allowed or denied. If no rule matches, the request is denied. In particular, this means that configuring an empty list of rules will deny every alias creation request. Requests to create a public (public as in published to the room directory) room which violates the configured rules will result in the room being created but not published to the room directory. Each of the glob patterns is optional, defaulting to * (“match anything”). Note that the patterns match against fully qualified IDs, e.g. against @alice:example.com, #room:example.com and !abcdefghijk:example.com instead of alice, room and abcedgghijk. Each rule is a YAML object containing four fields, each of which is an optional string. Changed in Synapse 1.126.0: The default was changed to deny publishing to the room list by default Defaults to null. Options for each entry include: user_id (string|null): Glob pattern that matches against the user publishing the room. alias (string|null): Glob pattern that matches against one of published room’s aliases. If the room has no aliases, the alias match fails unless alias is unspecified or *. If the room has exactly one alias, the alias match succeeds if the alias pattern matches that alias. If the room has two or more aliases, the alias match succeeds if the pattern matches at least one of the aliases. room_id (string|null): Glob pattern that matches against the room ID of the room being published. action (string): Either allow or deny. What to do with the request if the rule matches. Defaults to allow. Example configurations: room_list_publication_rules: null room_list_publication_rules:\\n- action: deny room_list_publication_rules: [] room_list_publication_rules:\\n- action: allow room_list_publication_rules:\\n- user_id: \'@bad_user:example.com\' action: deny\\n- action: allow room_list_publication_rules:\\n- room_id: \'!forbiddenRoom:example.com\' action: deny\\n- action: allow room_list_publication_rules:\\n- alias: \'#*potato*:example.com\' action: deny\\n- action: allow","breadcrumbs":"Configuration » Configuration Manual » room_list_publication_rules","id":"564","title":"room_list_publication_rules"},"565":{"body":"(object) The default_power_level_content_override option controls the default power levels for rooms. Useful if you know that your users need special permissions in rooms that they create (e.g. to send particular types of state events without needing an elevated power level). This takes the same shape as the power_level_content_override parameter in the /createRoom API, but is applied before that parameter. Note that each key provided inside a preset (for example events in the example below) will overwrite all existing defaults inside that key. So in Example #1, newly-created private_chat rooms will have no rules for any event types except com.example.foo. The default power levels for each preset are: \\"m.room.name\\": 50\\n\\"m.room.power_levels\\": 100\\n\\"m.room.history_visibility\\": 100\\n\\"m.room.canonical_alias\\": 50\\n\\"m.room.avatar\\": 50\\n\\"m.room.tombstone\\": 100 (150 if MSC4289 is used)\\n\\"m.room.server_acl\\": 100\\n\\"m.room.encryption\\": 100 In Example #2 the default power-levels for a preset are maintained, but the power level for a new key is set. Defaults to {}. Example configurations: default_power_level_content_override: private_chat: events: com.example.foo: 0 trusted_private_chat: null public_chat: null default_power_level_content_override: private_chat: events: com.example.foo: 0 m.room.name: 50 m.room.power_levels: 100 m.room.history_visibility: 100 m.room.canonical_alias: 50 m.room.avatar: 50 m.room.tombstone: 100 m.room.server_acl: 100 m.room.encryption: 100 trusted_private_chat: null public_chat: null","breadcrumbs":"Configuration » Configuration Manual » default_power_level_content_override","id":"565","title":"default_power_level_content_override"},"566":{"body":"(boolean) Set to true to automatically forget rooms for users when they leave them, either normally or via a kick or ban. Defaults to false. Example configuration: forget_rooms_on_leave: true","breadcrumbs":"Configuration » Configuration Manual » forget_rooms_on_leave","id":"566","title":"forget_rooms_on_leave"},"567":{"body":"(array) A list of rooms to exclude from sync responses. This is useful for server administrators wishing to group users into a room without these users being able to see it from their client. Defaults to []. Example configuration: exclude_rooms_from_sync:\\n- \'!foo:example.com\'","breadcrumbs":"Configuration » Configuration Manual » exclude_rooms_from_sync","id":"567","title":"exclude_rooms_from_sync"},"568":{"body":"(array) A list of rooms to exclude from presence updates. Presence will not be routed between two users solely because they share one of these rooms. Users who also share a non-excluded room continue to exchange presence as normal. Defaults to []. Example configuration: exclude_rooms_from_presence:\\n- \'!foo:example.com\'","breadcrumbs":"Configuration » Configuration Manual » exclude_rooms_from_presence","id":"568","title":"exclude_rooms_from_presence"},"569":{"body":"Configuration options related to Opentracing support.","breadcrumbs":"Configuration » Configuration Manual » Opentracing","id":"569","title":"Opentracing"},"57":{"body":"The TURN daemon coturn is available from a variety of sources such as native package managers, or installation from source. Debian and Ubuntu based distributions Just install the debian package: sudo apt install coturn This will install and start a systemd service called coturn. Source installation Download the latest release from github. Unpack it and cd into the directory. Configure it: ./configure You may need to install libevent2: if so, you should do so in\\nthe way recommended by your operating system. You can ignore\\nwarnings about lack of database support: a database is unnecessary\\nfor this purpose. Build and install it: make\\nsudo make install","breadcrumbs":"Configuring a Turn Server » coturn TURN server » Initial installation","id":"57","title":"Initial installation"},"570":{"body":"(object) 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). This setting has the following sub-options: enabled (boolean): Whether tracing is enabled. Set to true to enable. Defaults to false. homeserver_whitelist (array): The list of homeservers we wish to send and receive span contexts and span baggage. See here for more. This is a list of regexes which are matched against the server_name of the homeserver. If the list is empty, no servers are matched. Defaults to []. force_tracing_for_users (array): A list of the matrix IDs of users whose requests will always be traced, even if the tracing system would otherwise drop the traces due to probabilistic sampling. Defaults to []. jaeger_config (object): Jaeger can be configured to sample traces at different rates. All configuration options provided by Jaeger can be set here. Jaeger’s configuration is mostly related to trace sampling which is documented here. Defaults to {}. 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","breadcrumbs":"Configuration » Configuration Manual » opentracing","id":"570","title":"opentracing"},"571":{"body":"Configuration options related to workers which belong in the main config file (usually called homeserver.yaml). A Synapse deployment can scale horizontally by running multiple Synapse processes called workers. Incoming requests are distributed between workers to handle higher loads. Some workers are privileged and can accept requests from other workers. As a result, the worker configuration is divided into two parts. The first part (in this section of the manual) defines which shardable tasks are delegated to privileged workers. This allows unprivileged workers to make requests to a privileged worker to act on their behalf. The second part controls the behaviour of individual workers in isolation. For guidance on setting up workers, see the worker documentation.","breadcrumbs":"Configuration » Configuration Manual » Coordinating workers","id":"571","title":"Coordinating workers"},"572":{"body":"(string|null) A shared secret used by the replication APIs on the main process to authenticate HTTP requests from workers. If unset or null, traffic between the workers and the main process is not authenticated. Replacing an existing worker_replication_secret with a new one will break communication with all workers that have not yet updated their secret. Defaults to null. Example configuration: worker_replication_secret: secret_secret","breadcrumbs":"Configuration » Configuration Manual » worker_replication_secret","id":"572","title":"worker_replication_secret"},"573":{"body":"(string|null) An alternative to worker_replication_secret: allows the secret to be specified in an external file. The file should be a plain text file, containing only the secret. Synapse reads the secret from the given file once at startup. Added in Synapse 1.126.0. Defaults to null. Example configuration: worker_replication_secret_path: /path/to/secrets/file","breadcrumbs":"Configuration » Configuration Manual » worker_replication_secret_path","id":"573","title":"worker_replication_secret_path"},"574":{"body":"(boolean) Unnecessary to set if using pusher_instances with generic_workers. Controls sending of push notifications on the main process. Set to false if using a pusher worker. Defaults to true. Example configuration: start_pushers: false","breadcrumbs":"Configuration » Configuration Manual » start_pushers","id":"574","title":"start_pushers"},"575":{"body":"(array) It is possible to scale the processes that handle sending push notifications to sygnal and email by running a generic_worker and adding it’s worker_name to a pusher_instances map. Doing so will remove handling of this function from the main process. Multiple workers can be added to this map, in which case the work is balanced across them. Ensure the main process and all pusher workers are restarted after changing this option. Defaults to []. Example configurations: pusher_instances:\\n- pusher_worker1 pusher_instances:\\n- pusher_worker1\\n- pusher_worker2","breadcrumbs":"Configuration » Configuration Manual » pusher_instances","id":"575","title":"pusher_instances"},"576":{"body":"(boolean) Unnecessary to set if using federation_sender_instances with generic_workers. 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","breadcrumbs":"Configuration » Configuration Manual » send_federation","id":"576","title":"send_federation"},"577":{"body":"(array) It is possible to scale the processes that handle sending outbound federation requests by running a generic_worker and adding it’s worker_name to a federation_sender_instances map. Doing so will remove handling of this function from the main process. Multiple workers can be added to this map, in which case the work is balanced across them. The way that the load balancing works is any outbound federation request will be assigned to a federation sender worker based on the hash of the destination server name. This means that all requests being sent to the same destination will be processed by the same worker instance. Multiple federation_sender_instances are useful if there is a federation with multiple servers. This configuration setting must be shared between all workers handling federation sending, 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). Defaults to []. Example configurations: federation_sender_instances:\\n- federation_sender1 federation_sender_instances:\\n- federation_sender1\\n- federation_sender2","breadcrumbs":"Configuration » Configuration Manual » federation_sender_instances","id":"577","title":"federation_sender_instances"},"578":{"body":"(object) When using workers this should be a map from worker_name to the HTTP replication listener of the worker, if configured, and to the main process. Each worker declared under stream_writers and outbound_federation_restricted_to needs a HTTP replication listener, and that listener should be included in the instance_map. The main process also needs an entry on the instance_map, and it should be listed under main if even one other worker exists. Ensure the port matches with what is declared inside the listener block for a replication listener. Defaults to {}. Example configurations: instance_map: main: host: localhost port: 8030 worker1: host: localhost port: 8034 other: host: localhost port: 8035 tls: true instance_map: main: path: /run/synapse/main_replication.sock worker1: path: /run/synapse/worker1_replication.sock","breadcrumbs":"Configuration » Configuration Manual » instance_map","id":"578","title":"instance_map"},"579":{"body":"(object) Experimental: When using workers you can define which workers should handle writing to streams such as event persistence and typing notifications. Any worker specified here must also be in the instance_map. See the list of available streams in the worker documentation. Defaults to {}. This setting has the following sub-options: events (string): Name of a worker assigned to the events stream. typing (string): Name of a worker assigned to the typing stream. to_device (string): Name of a worker assigned to the to_device stream. account_data (string): Name of a worker assigned to the account_data stream. receipts (string): Name of a worker assigned to the receipts stream. presence (string): Name of a worker assigned to the presence stream. push_rules (string): Name of a worker assigned to the push_rules stream. device_lists (string): Name of a worker assigned to the device_lists stream. Example configuration: stream_writers: events: worker1 typing: worker1","breadcrumbs":"Configuration » Configuration Manual » stream_writers","id":"579","title":"stream_writers"},"58":{"body":"Create or edit the config file in /etc/turnserver.conf. The relevant\\nlines, with example values, are: use-auth-secret\\nstatic-auth-secret=[your secret key here]\\nrealm=turn.myserver.org See turnserver.conf for explanations of the options. One way to generate\\nthe static-auth-secret is with pwgen: pwgen -s 64 1 A realm must be specified, but its value is somewhat arbitrary. (It is\\nsent to clients as part of the authentication flow.) It is conventional to\\nset it to be your server name. You will most likely want to configure coturn to write logs somewhere. The\\neasiest way is normally to send them to the syslog: syslog (in which case, the logs will be available via journalctl -u coturn on a\\nsystemd system). Alternatively, coturn can be configured to write to a\\nlogfile - check the example config file supplied with coturn. Consider your security settings. TURN lets users request a relay which will\\nconnect to arbitrary IP addresses and ports. The following configuration is\\nsuggested as a minimum starting point: # VoIP traffic is all UDP. There is no reason to let users connect to arbitrary TCP endpoints via the relay.\\nno-tcp-relay # don\'t let the relay ever try to connect to private IP address ranges within your network (if any)\\n# given the turn server is likely behind your firewall, remember to include any privileged public IPs too.\\ndenied-peer-ip=10.0.0.0-10.255.255.255\\ndenied-peer-ip=192.168.0.0-192.168.255.255\\ndenied-peer-ip=172.16.0.0-172.31.255.255 # recommended additional local peers to block, to mitigate external access to internal services.\\n# https://www.enablesecurity.com/blog/slack-webrtc-turn-compromise-and-bug-bounty/#how-to-fix-an-open-turn-relay-to-address-this-vulnerability\\n# https://www.enablesecurity.com/blog/cve-2020-26262-bypass-of-coturns-access-control-protection/#further-concerns-what-else\\nno-multicast-peers\\ndenied-peer-ip=0.0.0.0-0.255.255.255\\ndenied-peer-ip=100.64.0.0-100.127.255.255\\ndenied-peer-ip=127.0.0.0-127.255.255.255\\ndenied-peer-ip=169.254.0.0-169.254.255.255\\ndenied-peer-ip=192.0.0.0-192.0.0.255\\ndenied-peer-ip=192.0.2.0-192.0.2.255\\ndenied-peer-ip=192.88.99.0-192.88.99.255\\ndenied-peer-ip=198.18.0.0-198.19.255.255\\ndenied-peer-ip=198.51.100.0-198.51.100.255\\ndenied-peer-ip=203.0.113.0-203.0.113.255\\ndenied-peer-ip=240.0.0.0-255.255.255.255\\ndenied-peer-ip=::1\\ndenied-peer-ip=64:ff9b::-64:ff9b::ffff:ffff\\ndenied-peer-ip=::ffff:0.0.0.0-::ffff:255.255.255.255\\ndenied-peer-ip=100::-100::ffff:ffff:ffff:ffff\\ndenied-peer-ip=2001::-2001:1ff:ffff:ffff:ffff:ffff:ffff:ffff\\ndenied-peer-ip=2002::-2002:ffff:ffff:ffff:ffff:ffff:ffff:ffff\\ndenied-peer-ip=fc00::-fdff:ffff:ffff:ffff:ffff:ffff:ffff:ffff\\ndenied-peer-ip=fe80::-febf:ffff:ffff:ffff:ffff:ffff:ffff:ffff # special case the turn server itself so that client->TURN->TURN->client flows work\\n# this should be one of the turn server\'s listening IPs\\nallowed-peer-ip=10.0.0.1 # consider whether you want to limit the quota of relayed streams per user (or total) to avoid risk of DoS.\\nuser-quota=12 # 4 streams per video call, so 12 streams = 3 simultaneous relayed calls per user.\\ntotal-quota=1200 Also consider supporting TLS/DTLS. To do this, add the following settings\\nto turnserver.conf: # TLS certificates, including intermediate certs.\\n# For Let\'s Encrypt certificates, use `fullchain.pem` here.\\ncert=/path/to/fullchain.pem # TLS private key file\\npkey=/path/to/privkey.pem # Ensure the configuration lines that disable TLS/DTLS are commented-out or removed\\n#no-tls\\n#no-dtls In this case, replace the turn: schemes in the turn_uris settings below\\nwith turns:. We recommend that you only try to set up TLS/DTLS once you have set up a\\nbasic installation and got it working. NB: If your TLS certificate was provided by Let’s Encrypt, TLS/DTLS will\\nnot work with any Matrix client that uses Chromium’s WebRTC library. This\\ncurrently includes Element Android & iOS; for more details, see their respective issues as well as the underlying WebRTC issue.\\nConsider using a ZeroSSL certificate for your TURN server as a working alternative. Ensure your firewall allows traffic into the TURN server on the ports\\nyou’ve configured it to listen on (By default: 3478 and 5349 for TURN\\ntraffic (remember to allow both TCP and UDP traffic), and ports 49152-65535\\nfor the UDP relay.) If your TURN server is behind NAT, the NAT gateway must have an external,\\npublicly-reachable IP address. You must configure coturn to advertise that\\naddress to connecting clients: external-ip=EXTERNAL_NAT_IPv4_ADDRESS You may optionally limit the TURN server to listen only on the local\\naddress that is mapped by NAT to the external address: listening-ip=INTERNAL_TURNSERVER_IPv4_ADDRESS If your NAT gateway is reachable over both IPv4 and IPv6, you may\\nconfigure coturn to advertise each available address: external-ip=EXTERNAL_NAT_IPv4_ADDRESS\\nexternal-ip=EXTERNAL_NAT_IPv6_ADDRESS When advertising an external IPv6 address, ensure that the firewall and\\nnetwork settings of the system running your TURN server are configured to\\naccept IPv6 traffic, and that the TURN server is listening on the local\\nIPv6 address that is mapped by NAT to the external IPv6 address. (Re)start the turn server: If you used the Debian package (or have set up a systemd unit yourself): sudo systemctl restart coturn If you built from source: /usr/local/bin/turnserver -o","breadcrumbs":"Configuring a Turn Server » coturn TURN server » Configuration","id":"58","title":"Configuration"},"580":{"body":"(array) You can restrict outbound federation traffic to only go through a specific subset of workers including the Secure Border Gateway (SBG). Any worker specified here (including the SBG) must also be in the instance_map. worker_replication_secret must also be configured to authorize inter-worker communication. Also see the worker documentation for more info. Added in Synapse 1.89.0. Defaults to []. Example configuration: outbound_federation_restricted_to:\\n- federation_sender1\\n- federation_sender2","breadcrumbs":"Configuration » Configuration Manual » outbound_federation_restricted_to","id":"580","title":"outbound_federation_restricted_to"},"581":{"body":"(string|null) The worker that is used to run background tasks (e.g. cleaning up expired data). If not provided this defaults to the main process. Defaults to null. Example configuration: run_background_tasks_on: worker1","breadcrumbs":"Configuration » Configuration Manual » run_background_tasks_on","id":"581","title":"run_background_tasks_on"},"582":{"body":"(object) Configuration for the task scheduler. This setting has the following sub-options: max_concurrent_tasks (integer): The maximum number of tasks that can run concurrently in the task scheduler. Setting this too high may swamp the database connection pool. Defaults to 5. Example configuration: task_scheduler: max_concurrent_tasks: 5","breadcrumbs":"Configuration » Configuration Manual » task_scheduler","id":"582","title":"task_scheduler"},"583":{"body":"(string|null) The worker that is used to update the user directory. If not provided this defaults to the main process. Added in Synapse 1.59.0. Defaults to null. Example configuration: update_user_directory_from_worker: worker1","breadcrumbs":"Configuration » Configuration Manual » update_user_directory_from_worker","id":"583","title":"update_user_directory_from_worker"},"584":{"body":"(string|null) The worker that is used to send output traffic to Application Services. If not provided this defaults to the main process. Added in Synapse 1.59.0. Defaults to null. Example configuration: notify_appservices_from_worker: worker1","breadcrumbs":"Configuration » Configuration Manual » notify_appservices_from_worker","id":"584","title":"notify_appservices_from_worker"},"585":{"body":"(string|null) The worker that is used to run background tasks for media repository. If running multiple media repositories you must configure a single instance to run the background tasks. If not provided this defaults to the main process or your single media_repository worker. Added in Synapse 1.16.0. Defaults to null. Example configuration: media_instance_running_background_jobs: worker1","breadcrumbs":"Configuration » Configuration Manual » media_instance_running_background_jobs","id":"585","title":"media_instance_running_background_jobs"},"586":{"body":"(object) Configuration for Redis when using workers. This must be enabled when using workers. Added in Synapse 1.78.0. Changed in Synapse 1.84.0: Added use_tls, certificate_file, private_key_file, ca_file and ca_path attributes Changed in Synapse 1.85.0: Added path option to use a local Unix socket Changed in Synapse 1.116.0: Added password_path Changed in Synapse 1.162.0: Added username This setting has the following sub-options: enabled (boolean): Whether to use Redis support. Defaults to false. host (string): Optional host to use to connect to Redis. Defaults to \\"localhost\\". port (integer): Optional port to use to connect to Redis. Defaults to 6379. path (string): The full path to a local Unix socket file. If this is used, host and port are ignored. Defaults to \\"/tmp/redis.sock\\". username (string|null): Optional username if configured on the Redis instance (Redis 6+ ACL authentication). Requires password (or password_path) to also be set. Defaults to null. password (string|null): Optional password if configured on the Redis instance. Defaults to null. password_path (string|null): Alternative to password, reading the password from an external file. The file should be a plain text file, containing only the password. Synapse reads the password from the given file once at startup. Defaults to null. dbid (string|null): Optional redis dbid if needs to connect to specific redis logical db. Defaults to null. use_tls (boolean): Whether to use a TLS connection. Defaults to false. certificate_file (string|null): Optional path to the certificate file. Defaults to null. private_key_file (string|null): Optional path to the private key file. Defaults to null. ca_file (string|null): Optional path to the CA certificate file. Use this one or ca_path Defaults to null. ca_path (string|null): Optional path to the folder containing the CA certificate file. Use this one or ca_file Defaults to null. Example configuration: redis: enabled: true host: localhost port: 6379 username: password_path: dbid: ","breadcrumbs":"Configuration » Configuration Manual » redis","id":"586","title":"redis"},"587":{"body":"These options configure an individual worker, in its worker configuration file. They should be not be provided when configuring the main process. Note also the configuration above for coordinating a cluster of workers. For guidance on setting up workers, see the worker documentation.","breadcrumbs":"Configuration » Configuration Manual » Individual worker configuration","id":"587","title":"Individual worker configuration"},"588":{"body":"(string) The type of worker. The currently available worker applications are listed in worker documentation. The most common worker is the synapse.app.generic_worker. There is no default for this option. Example configuration: worker_app: synapse.app.generic_worker","breadcrumbs":"Configuration » Configuration Manual » worker_app","id":"588","title":"worker_app"},"589":{"body":"(string) A unique name for the worker. The worker needs a name to be addressed in further parameters and identification in log files. We strongly recommend giving each worker a unique worker_name. There is no default for this option. Example configuration: worker_name: generic_worker1","breadcrumbs":"Configuration » Configuration Manual » worker_name","id":"589","title":"worker_name"},"59":{"body":"The following sections describe how to install eturnal\\n(which implements the TURN REST API).","breadcrumbs":"Configuring a Turn Server » eturnal TURN server » eturnal TURN server","id":"59","title":"eturnal TURN server"},"590":{"body":"(array) A worker can handle HTTP requests. To do so, a worker_listeners option must be declared, in the same way as the listeners option in the shared config. Workers declared in stream_writers and instance_map will need to include a replication listener here, in order to accept internal HTTP requests from other workers. Example #2 is using UNIX sockets with a replication listener. Defaults to []. Example configurations: worker_listeners:\\n- type: http port: 8083 resources: - names: - client - federation worker_listeners:\\n- type: http path: /run/synapse/worker_replication.sock resources: - names: - replication\\n- type: http path: /run/synapse/worker_public.sock resources: - names: - client - federation","breadcrumbs":"Configuration » Configuration Manual » worker_listeners","id":"590","title":"worker_listeners"},"591":{"body":"(integer|null) A worker may have a listener for manhole. It allows server administrators to access a Python shell on the worker. The example below is a short form for worker_listeners: - port: 9000 bind_addresses: [\'127.0.0.1\'] type: manhole It needs also an additional manhole_settings configuration. Defaults to null. Example configuration: worker_manhole: 9000","breadcrumbs":"Configuration » Configuration Manual » worker_manhole","id":"591","title":"worker_manhole"},"592":{"body":"(boolean) Specifies whether the worker should be started as a daemon process. If Synapse is being managed by systemd, this option must be omitted or set to false. Defaults to false. Example configuration: worker_daemonize: true","breadcrumbs":"Configuration » Configuration Manual » worker_daemonize","id":"592","title":"worker_daemonize"},"593":{"body":"(string|null) When running a worker as a daemon, we need a place to store the PID of the worker. This option defines the location of that “pid file”. This option is required if worker_daemonize is true and ignored otherwise. See also the pid_file option option for the main Synapse process. Defaults to null. Example configuration: worker_pid_file: DATADIR/generic_worker1.pid","breadcrumbs":"Configuration » Configuration Manual » worker_pid_file","id":"593","title":"worker_pid_file"},"594":{"body":"(string|null) This option specifies a yaml python logging config file as described here. See also the log_config option option for the main Synapse process. Defaults to null. Example configuration: worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml","breadcrumbs":"Configuration » Configuration Manual » worker_log_config","id":"594","title":"worker_log_config"},"595":{"body":"Configuration settings related to background updates.","breadcrumbs":"Configuration » Configuration Manual » Background Updates","id":"595","title":"Background Updates"},"596":{"body":"(object) 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: background_update_duration_ms (integer): How long in milliseconds to run a batch of background updates for. Defaults to 100. sleep_enabled (boolean): Whether to sleep between updates. Defaults to true. sleep_duration_ms (integer): If sleeping between updates, how long in milliseconds to sleep for. Defaults to 1000. min_batch_size (integer): Minimum size a batch of background updates can be. Must be greater than 0. Defaults to 1. default_batch_size (integer): The batch size to use for the first iteration of a new background update. Defaults to 100. Example configuration: background_updates: background_update_duration_ms: 500 sleep_enabled: false sleep_duration_ms: 300 min_batch_size: 10 default_batch_size: 50","breadcrumbs":"Configuration » Configuration Manual » background_updates","id":"596","title":"background_updates"},"597":{"body":"Configuration settings related to automatically accepting invites.","breadcrumbs":"Configuration » Configuration Manual » Auto Accept Invites","id":"597","title":"Auto Accept Invites"},"598":{"body":"(object) Automatically accepting invites controls whether users are presented with an invite request or if they are instead automatically joined to a room when receiving an invite. Set the enabled sub-option to true to enable auto-accepting invites. NOTE: Care should be taken not to enable this setting if the synapse_auto_accept_invite module is enabled and installed. The two modules will compete to perform the same task and may result in undesired behaviour. For example, multiple join events could be generated from a single invite. This setting has the following sub-options: enabled (boolean): Whether to run the auto-accept invites logic. Defaults to false. only_for_direct_messages (boolean): Whether invites should be automatically accepted for all room types, or only for direct messages. Defaults to false. only_from_local_users (boolean): Whether to only automatically accept invites from users on this homeserver. Defaults to false. worker_to_run_on (string|null): Which worker to run this module on. This must match the “worker_name”. If not set or null, invites will be accepted on the main process. Defaults to null. Example configuration: auto_accept_invites: enabled: true only_for_direct_messages: true only_from_local_users: true worker_to_run_on: worker_1","breadcrumbs":"Configuration » Configuration Manual » auto_accept_invites","id":"598","title":"auto_accept_invites"},"599":{"body":"Below is a sample homeserver configuration file. The homeserver configuration file\\ncan be tweaked to change the behaviour of your homeserver. A restart of the server is\\ngenerally required to apply any changes made to this file. Note that the contents below are not intended to be copied and used as the basis for\\na real homeserver.yaml. Instead, if you are starting from scratch, please generate\\na fresh config using Synapse by following the instructions in Installation. Documentation for all configuration options can be found in the Configuration Manual. # This file is maintained as an up-to-date snapshot of the default\\n# homeserver.yaml configuration generated by Synapse. You can find a\\n# complete accounting of possible configuration options at\\n# https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html\\n#\\n# It is *not* intended to be copied and used as the basis for a real\\n# homeserver.yaml. Instead, if you are starting from scratch, please generate\\n# a fresh config using Synapse by following the instructions in\\n# https://element-hq.github.io/synapse/latest/setup/installation.html.\\n#\\n################################################################################ # Configuration file for Synapse.\\n#\\n# This is a YAML file: see [1] for a quick introduction. Note in particular\\n# that *indentation is important*: all the elements of a list or dictionary\\n# should have the same indentation.\\n#\\n# [1] https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html\\n#\\n# For more information on how to configure Synapse, including a complete accounting of\\n# each option, go to docs/usage/configuration/config_documentation.md or\\n# https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html\\nserver_name: \\"SERVERNAME\\"\\npid_file: DATADIR/homeserver.pid\\nlisteners: - bind_addresses: - ::1 - 127.0.0.1 port: 8008 resources: - compress: false names: - client - federation tls: false type: http x_forwarded: true\\ndatabase: name: sqlite3 args: database: DATADIR/homeserver.db\\nlog_config: \\"CONFDIR/SERVERNAME.log.config\\"\\nmedia_store_path: DATADIR/media_store\\nsigning_key_path: \\"CONFDIR/SERVERNAME.signing.key\\"\\ntrusted_key_servers: - server_name: \\"matrix.org\\"","breadcrumbs":"Configuration » Homeserver Sample Config File » Homeserver Sample Configuration File","id":"599","title":"Homeserver Sample Configuration File"},"6":{"body":"Note: Synapse uses a number of platform dependencies such as Python and PostgreSQL,\\nand aims to follow supported upstream versions. See the deprecation\\npolicy for more details.","breadcrumbs":"Installation » Installing Synapse","id":"6","title":"Installing Synapse"},"60":{"body":"","breadcrumbs":"Configuring a Turn Server » eturnal TURN server » eturnal setup","id":"60","title":"eturnal setup"},"600":{"body":"Below is a sample logging configuration file. This file can be tweaked to control how your\\nhomeserver will output logs. The value of the log_config option in your homeserver config\\nshould be the path to this file. To apply changes made to this file, send Synapse a SIGHUP signal (or, if using systemd, run systemctl reload on the Synapse service). Note that a default logging configuration (shown below) is created automatically alongside\\nthe homeserver config when following the installation instructions.\\nIt should be named .log.config by default. Hint: If you’re looking for a guide on what each of the fields in the “Processed request” log lines mean,\\nsee Request log format. If you use systemd.journal.JournalHandler in your own logging config, ensure systemd-python is installed in Synapse’s runtime environment. # Log configuration for Synapse.\\n#\\n# This is a YAML file containing a standard Python logging configuration\\n# dictionary. See [1] for details on the valid settings.\\n#\\n# Synapse also supports structured logging for machine readable logs which can\\n# be ingested by ELK stacks. See [2] for details.\\n#\\n# [1]: https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema\\n# [2]: https://element-hq.github.io/synapse/latest/structured_logging.html version: 1 formatters: precise: format: \'%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s - %(message)s\' handlers: file: class: logging.handlers.TimedRotatingFileHandler formatter: precise filename: /var/log/matrix-synapse/homeserver.log when: midnight backupCount: 3 # Does not include the current log file. encoding: utf8 # Default to buffering writes to log file for efficiency. # WARNING/ERROR logs will still be flushed immediately, but there will be a # delay (of up to `period` seconds, or until the buffer is full with # `capacity` messages) before INFO/DEBUG logs get written. buffer: class: synapse.logging.handlers.PeriodicallyFlushingMemoryHandler target: file # The capacity is the maximum number of log lines that are buffered # before being written to disk. Increasing this will lead to better # performance, at the expensive of it taking longer for log lines to # be written to disk. # This parameter is required. capacity: 10 # Logs with a level at or above the flush level will cause the buffer to # be flushed immediately. # Default value: 40 (ERROR) # Other values: 50 (CRITICAL), 30 (WARNING), 20 (INFO), 10 (DEBUG) flushLevel: 30 # Flush immediately for WARNING logs and higher # The period of time, in seconds, between forced flushes. # Messages will not be delayed for longer than this time. # Default value: 5 seconds period: 5 # A handler that writes logs to stderr. Unused by default, but can be used # instead of \\"buffer\\" and \\"file\\" in the logger handlers. console: class: logging.StreamHandler formatter: precise loggers: synapse.storage.SQL: # beware: increasing this to DEBUG will make synapse log sensitive # information such as access tokens. level: INFO root: level: INFO # Write logs to the `buffer` handler, which will buffer them together in memory, # then write them to a file. # # Replace \\"buffer\\" with \\"console\\" to log to stderr instead. # handlers: [buffer] disable_existing_loggers: false","breadcrumbs":"Configuration » Logging Sample Config File » Logging Sample Configuration File","id":"600","title":"Logging Sample Configuration File"},"601":{"body":"A structured logging system can be useful when your logs are destined for a\\nmachine to parse and process. By maintaining its machine-readable characteristics,\\nit enables more efficient searching and aggregations when consumed by software\\nsuch as the ELK stack. Synapse’s structured logging system is configured via the file that Synapse’s log_config config option points to. The file should include a formatter which\\nuses the synapse.logging.TerseJsonFormatter class included with Synapse and a\\nhandler which uses the above formatter. There is also a synapse.logging.JsonFormatter option which does not include\\na timestamp in the resulting JSON. This is useful if the log ingester adds its\\nown timestamp. A structured logging configuration looks similar to the following: version: 1 formatters: structured: class: synapse.logging.TerseJsonFormatter handlers: file: class: logging.handlers.TimedRotatingFileHandler formatter: structured filename: /path/to/my/logs/homeserver.log when: midnight backupCount: 3 # Does not include the current log file. encoding: utf8 loggers: synapse: level: INFO handlers: [file] synapse.storage.SQL: level: WARNING The above logging config will set Synapse as ‘INFO’ logging level by default,\\nwith the SQL layer at ‘WARNING’, and will log to a file, stored as JSON. It is also possible to configure Synapse to log to a remote endpoint by using the synapse.logging.RemoteHandler class included with Synapse. It takes the\\nfollowing arguments: host: Hostname or IP address of the log aggregator. port: Numerical port to contact on the host. maximum_buffer: (Optional, defaults to 1000) The maximum buffer size to allow. A remote structured logging configuration looks similar to the following: version: 1 formatters: structured: class: synapse.logging.TerseJsonFormatter handlers: remote: class: synapse.logging.RemoteHandler formatter: structured host: 10.1.2.3 port: 9999 loggers: synapse: level: INFO handlers: [remote] synapse.storage.SQL: level: WARNING The above logging config will set Synapse as ‘INFO’ logging level by default,\\nwith the SQL layer at ‘WARNING’, and will log JSON formatted messages to a\\nremote endpoint at 10.1.2.3:9999.","breadcrumbs":"Configuration » Structured Logging » Structured Logging","id":"601","title":"Structured Logging"},"602":{"body":"When running Synapse on GKE, use synapse.logging.GcpJsonFormatter. It outputs\\nJSON to stdout with a severity field that Google Cloud Logging maps to the\\ncorrect per-entry severity. Without this, GKE assigns ERROR to everything\\nwritten to stderr regardless of the actual Python log level. Example output: {\\"severity\\":\\"INFO\\",\\"message\\":\\"Processed request: 3.481sec 200 GET /sync\\",\\"logger\\":\\"synapse.access.http.8008\\",\\"time\\":\\"2026-05-12T13:40:37.829Z\\"} Configuration: version: 1\\ndisable_existing_loggers: false formatters: gcp_json: class: synapse.logging.GcpJsonFormatter handlers: console: class: logging.StreamHandler formatter: gcp_json stream: ext://sys.stdout loggers: synapse.storage.SQL: level: WARNING twisted: handlers: [console] propagate: false root: level: INFO handlers: [console]","breadcrumbs":"Configuration » Structured Logging » Google Cloud Logging (GKE)","id":"602","title":"Google Cloud Logging (GKE)"},"603":{"body":"Synapse uses parametrised templates to generate the content of emails it sends and\\nwebpages it shows to users. By default, Synapse will use the templates listed here.\\nServer admins can configure an additional directory for Synapse to look for templates\\nin, allowing them to specify custom templates: templates: custom_template_directory: /path/to/custom/templates/ If this setting is not set, or the files named below are not found within the directory,\\ndefault templates from within the Synapse package will be used. Templates that are given variables when being rendered are rendered using Jinja 2.\\nTemplates rendered by Jinja 2 can also access two functions on top of the functions\\nalready available as part of Jinja 2: format_ts(value: int, format: str) -> str Formats a timestamp in milliseconds. Example: reason.last_sent_ts|format_ts(\\"%c\\") mxc_to_http(value: str, width: int, height: int, resize_method: str = \\"crop\\") -> str Turns a mxc:// URL for media content into an HTTP(S) one using the homeserver’s public_baseurl configuration setting as the URL’s base. Example: message.sender_avatar_url|mxc_to_http(32,32) localpart_from_email(address: str) -> str Returns the local part of an email address (e.g. alice in alice@example.com). Example: user.email_address|localpart_from_email","breadcrumbs":"Configuration » Templates » Templates","id":"603","title":"Templates"},"604":{"body":"Below are the templates Synapse will look for when generating the content of an email: notif_mail.html and notif_mail.txt: The contents of email notifications of missed\\nevents.\\nWhen rendering, this template is given the following variables: user_display_name: the display name for the user receiving the notification unsubscribe_link: the link users can click to unsubscribe from email notifications summary_text: a summary of the notification(s). The text used can be customised\\nby configuring the various settings in the email.subjects section of the\\nconfiguration file. rooms: a list of rooms containing events to include in the email. Each element is\\nan object with the following attributes: title: a human-readable name for the room hash: a hash of the ID of the room invite: a boolean, which is True if the room is an invite the user hasn’t\\naccepted yet, False otherwise notifs: a list of events, or an empty list if invite is True. Each element\\nis an object with the following attributes: link: a matrix.to link to the event ts: the time in milliseconds at which the event was received messages: a list of messages containing one message before the event, the\\nmessage in the event, and one message after the event. Each element is an\\nobject with the following attributes: event_type: the type of the event is_historical: a boolean, which is False if the message is the one\\nthat triggered the notification, True otherwise id: the ID of the event ts: the time in milliseconds at which the event was sent sender_name: the display name for the event’s sender sender_avatar_url: the avatar URL (as a mxc:// URL) for the event’s\\nsender sender_hash: a hash of the user ID of the sender msgtype: the type of the message body_text_html: html representation of the message body_text_plain: plaintext representation of the message image_url: mxc url of an image, when “msgtype” is “m.image” link: a matrix.to link to the room avator_url: url to the room’s avator reason: information on the event that triggered the email to be sent. It’s an\\nobject with the following attributes: room_id: the ID of the room the event was sent in room_name: a human-readable name for the room the event was sent in now: the current time in milliseconds received_at: the time in milliseconds at which the event was received delay_before_mail_ms: the amount of time in milliseconds Synapse always waits\\nbefore ever emailing about a notification (to give the user a chance to respond\\nto other push or notice the window) last_sent_ts: the time in milliseconds at which a notification was last sent\\nfor an event in this room throttle_ms: the minimum amount of time in milliseconds between two\\nnotifications can be sent for this room password_reset.html and password_reset.txt: The contents of password reset emails\\nsent by the homeserver.\\nWhen rendering, these templates are given a link variable which contains the link the\\nuser must click in order to reset their password. registration.html and registration.txt: The contents of address verification emails\\nsent during registration.\\nWhen rendering, these templates are given a link variable which contains the link the\\nuser must click in order to validate their email address. add_threepid.html and add_threepid.txt: The contents of address verification emails\\nsent when an address is added to a Matrix account.\\nWhen rendering, these templates are given a link variable which contains the link the\\nuser must click in order to validate their email address.","breadcrumbs":"Configuration » Templates » Email templates","id":"604","title":"Email templates"},"605":{"body":"Below are the templates Synapse will look for when generating pages related to\\nregistration and password reset: password_reset_confirmation.html: An HTML page that a user will see when they follow\\nthe link in the password reset email. The user will be asked to confirm the action\\nbefore their password is reset.\\nWhen rendering, this template is given the following variables: sid: the session ID for the password reset token: the token for the password reset client_secret: the client secret for the password reset password_reset_success.html and password_reset_failure.html: HTML pages for success\\nand failure that a user will see when they confirm the password reset flow using the\\npage above.\\nWhen rendering, password_reset_success.html is given no variable, and password_reset_failure.html is given a failure_reason, which contains the reason\\nfor the password reset failure. registration_success.html and registration_failure.html: HTML pages for success and\\nfailure that a user will see when they follow the link in an address verification email\\nsent during registration.\\nWhen rendering, registration_success.html is given no variable, and registration_failure.html is given a failure_reason, which contains the reason\\nfor the registration failure. add_threepid_success.html and add_threepid_failure.html: HTML pages for success and\\nfailure that a user will see when they follow the link in an address verification email\\nsent when an address is added to a Matrix account.\\nWhen rendering, add_threepid_success.html is given no variable, and add_threepid_failure.html is given a failure_reason, which contains the reason\\nfor the registration failure.","breadcrumbs":"Configuration » Templates » HTML page templates for registration and password reset","id":"605","title":"HTML page templates for registration and password reset"},"606":{"body":"Below are the templates Synapse will look for when generating pages related to SSO: sso_login_idp_picker.html: HTML page to prompt the user to choose an\\nIdentity Provider during login.\\nThis is only used if multiple SSO Identity Providers are configured.\\nWhen rendering, this template is given the following variables: redirect_url: the URL that the user will be redirected to after\\nlogin. server_name: the homeserver’s name. providers: a list of available Identity Providers. Each element is\\nan object with the following attributes: idp_id: unique identifier for the IdP idp_name: user-facing name for the IdP idp_icon: if specified in the IdP config, an MXC URI for an icon\\nfor the IdP idp_brand: if specified in the IdP config, a textual identifier\\nfor the brand of the IdP\\nThe rendered HTML page should contain a form which submits its results\\nback as a GET request, with the following query parameters: redirectUrl: the client redirect URI (ie, the redirect_url passed\\nto the template) idp: the ‘idp_id’ of the chosen IDP. sso_auth_account_details.html: HTML page to prompt new users to enter a\\nuserid and confirm other details. This is only shown if the\\nSSO implementation (with any user_mapping_provider) does not return\\na localpart.\\nWhen rendering, this template is given the following variables: server_name: the homeserver’s name. idp: details of the SSO Identity Provider that the user logged in\\nwith: an object with the following attributes: idp_id: unique identifier for the IdP idp_name: user-facing name for the IdP idp_icon: if specified in the IdP config, an MXC URI for an icon\\nfor the IdP idp_brand: if specified in the IdP config, a textual identifier\\nfor the brand of the IdP user_attributes: an object containing details about the user that\\nwe received from the IdP. May have the following attributes: display_name: the user’s display name emails: a list of email addresses localpart: the local part of the Matrix user ID to register,\\nif localpart_template is set in the mapping provider configuration (empty\\nstring if not)\\nThe template should render a form which submits the following fields: username: the localpart of the user’s chosen user id sso_new_user_consent.html: HTML page allowing the user to consent to the\\nserver’s terms and conditions. This is only shown for new users, and only if user_consent.require_at_registration is set.\\nWhen rendering, this template is given the following variables: server_name: the homeserver’s name. user_id: the user’s matrix proposed ID. user_profile.display_name: the user’s proposed display name, if any. consent_version: the version of the terms that the user will be\\nshown terms_url: a link to the page showing the terms.\\nThe template should render a form which submits the following fields: accepted_version: the version of the terms accepted by the user\\n(ie, ‘consent_version’ from the input variables). sso_redirect_confirm.html: HTML page for a confirmation step before redirecting back\\nto the client with the login token.\\nWhen rendering, this template is given the following variables: redirect_url: the URL the user is about to be redirected to. display_url: the same as redirect_url, but with the query\\nparameters stripped. The intention is to have a\\nhuman-readable URL to show to users, not to use it as\\nthe final address to redirect to. server_name: the homeserver’s name. new_user: a boolean indicating whether this is the user’s first time\\nlogging in. user_id: the user’s matrix ID. user_profile.avatar_url: an MXC URI for the user’s avatar, if any. None if the user has not set an avatar. user_profile.display_name: the user’s display name. None if the user\\nhas not set a display name. sso_auth_confirm.html: HTML page which notifies the user that they are authenticating\\nto confirm an operation on their account during the user interactive authentication\\nprocess.\\nWhen rendering, this template is given the following variables: redirect_url: the URL the user is about to be redirected to. description: the operation which the user is being asked to confirm idp: details of the Identity Provider that we will use to confirm\\nthe user’s identity: an object with the following attributes: idp_id: unique identifier for the IdP idp_name: user-facing name for the IdP idp_icon: if specified in the IdP config, an MXC URI for an icon\\nfor the IdP idp_brand: if specified in the IdP config, a textual identifier\\nfor the brand of the IdP sso_auth_success.html: HTML page shown after a successful user interactive\\nauthentication session.\\nNote that this page must include the JavaScript which notifies of a successful\\nauthentication (see https://matrix.org/docs/spec/client_server/r0.6.0#fallback).\\nThis template has no additional variables. sso_auth_bad_user.html: HTML page shown after a user-interactive authentication\\nsession which does not map correctly onto the expected user.\\nWhen rendering, this template is given the following variables: server_name: the homeserver’s name. user_id_to_verify: the MXID of the user that we are trying to\\nvalidate. sso_account_deactivated.html: HTML page shown during single sign-on if a deactivated\\nuser (according to Synapse’s database) attempts to login.\\nThis template has no additional variables. sso_error.html: HTML page to display to users if something goes wrong during the\\nOpenID Connect authentication process.\\nWhen rendering, this template is given two variables: error: the technical name of the error error_description: a human-readable message for the error","breadcrumbs":"Configuration » Templates » HTML page templates for Single Sign-On (SSO)","id":"606","title":"HTML page templates for Single Sign-On (SSO)"},"607":{"body":"Synapse supports multiple methods of authenticating users, either out-of-the-box or through custom pluggable\\nauthentication modules. Included in Synapse is support for authenticating users via: A username and password. An email address and password. Single Sign-On through the SAML, Open ID Connect or CAS protocols. JSON Web Tokens. An administrator’s shared secret. Synapse can additionally be extended to support custom authentication schemes through optional “password auth provider”\\nmodules.","breadcrumbs":"Configuration » User Authentication » User Authentication","id":"607","title":"User Authentication"},"608":{"body":"Synapse supports single sign-on through the SAML, Open ID Connect or CAS protocols.\\nLDAP and other login methods are supported through first and third-party password\\nauth provider modules.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » Single Sign-On","id":"608","title":"Single Sign-On"},"609":{"body":"Synapse can be configured to use an OpenID Connect Provider (OP) for\\nauthentication, instead of its own local password database. Any OP should work with Synapse, as long as it supports the authorization code\\nflow. There are a few options for that: start a local OP. Synapse has been tested with Hydra and Dex. Note that for an OP to work, it should be served under a\\nsecure (HTTPS) origin. A certificate signed with a self-signed, locally\\ntrusted CA should work. In that case, start Synapse with a SSL_CERT_FILE\\nenvironment variable set to the path of the CA. set up a SaaS OP, like Google, Auth0 or Okta. Synapse has been tested with Auth0 and Google. It may also be possible to use other OAuth2 providers which provide the authorization code grant type,\\nsuch as Github.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Configuring Synapse to authenticate against an OpenID Connect provider","id":"609","title":"Configuring Synapse to authenticate against an OpenID Connect provider"},"61":{"body":"The eturnal TURN server implementation is available from a variety of sources\\nsuch as native package managers, binary packages, installation from source or container image. They are\\nall described here. Quick-Test instructions in a Linux Shell\\nor with Docker\\nare available as well.","breadcrumbs":"Configuring a Turn Server » eturnal TURN server » Initial installation","id":"61","title":"Initial installation"},"610":{"body":"The OpenID integration in Synapse uses the authlib library, which must be installed\\nas follows: The relevant libraries are included in the Docker images and Debian packages\\nprovided by matrix.org so no further action is needed. If you installed Synapse into a virtualenv, run /path/to/env/bin/pip install matrix-synapse[oidc] to install the necessary dependencies. For other installation mechanisms, see the documentation provided by the\\nmaintainer. To enable the OpenID integration, you should then add a section to the oidc_providers\\nsetting in your configuration file.\\nSee the configuration manual for some sample settings, as well as\\nthe text below for example configurations for specific providers. For setups using .well-known delegation, make sure public_baseurl is set\\nappropriately. If unset, Synapse defaults to https:/// which is used in\\nthe OIDC callback URL.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Preparing Synapse","id":"610","title":"Preparing Synapse"},"611":{"body":"Synapse supports receiving OpenID Connect Back-Channel Logout notifications. This lets the OpenID Connect Provider notify Synapse when a user logs out, so that Synapse can end that user session.\\nThis feature can be enabled by setting the backchannel_logout_enabled property to true in the provider configuration, and setting the following URL as destination for Back-Channel Logout notifications in your OpenID Connect Provider: [synapse public baseurl]/_synapse/client/oidc/backchannel_logout","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » OIDC Back-Channel Logout","id":"611","title":"OIDC Back-Channel Logout"},"612":{"body":"Here are a few configs for providers that should work with Synapse.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Sample configs","id":"612","title":"Sample configs"},"613":{"body":"Azure AD can act as an OpenID Connect Provider. Register a new application under App registrations in the Azure AD management console. The RedirectURI for your\\napplication should point to your matrix server: [synapse public baseurl]/_synapse/client/oidc/callback Go to Certificates & secrets and register a new client secret. Make note of your\\nDirectory (tenant) ID as it will be used in the Azure links.\\nEdit your Synapse config file and change the oidc_config section: oidc_providers: - idp_id: microsoft idp_name: Microsoft issuer: \\"https://login.microsoftonline.com//v2.0\\" client_id: \\"\\" client_secret: \\"\\" scopes: [\\"openid\\", \\"profile\\"] authorization_endpoint: \\"https://login.microsoftonline.com//oauth2/v2.0/authorize\\" token_endpoint: \\"https://login.microsoftonline.com//oauth2/v2.0/token\\" userinfo_endpoint: \\"https://graph.microsoft.com/oidc/userinfo\\" user_mapping_provider: config: localpart_template: \\"{{ user.preferred_username.split(\'@\')[0] }}\\" display_name_template: \\"{{ user.name }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Microsoft Azure Active Directory","id":"613","title":"Microsoft Azure Active Directory"},"614":{"body":"Configuring “Sign in with Apple” (SiWA) requires an Apple Developer account. You will need to create a new “Services ID” for SiWA, and create and download a\\nprivate key with “SiWA” enabled. As well as the private key file, you will need: Client ID: the “identifier” you gave the “Services ID” Team ID: a 10-character ID associated with your developer account. Key ID: the 10-character identifier for the key. Apple’s developer documentation\\nhas more information on setting up SiWA. The synapse config will look like this: - idp_id: apple idp_name: Apple issuer: \\"https://appleid.apple.com\\" client_id: \\"your-client-id\\" # Set to the \\"identifier\\" for your \\"ServicesID\\" client_auth_method: \\"client_secret_post\\" client_secret_jwt_key: key_file: \\"/path/to/AuthKey_KEYIDCODE.p8\\" # point to your key file jwt_header: alg: ES256 kid: \\"KEYIDCODE\\" # Set to the 10-char Key ID jwt_payload: iss: TEAMIDCODE # Set to the 10-char Team ID scopes: [\\"name\\", \\"email\\", \\"openid\\"] authorization_endpoint: https://appleid.apple.com/auth/authorize?response_mode=form_post user_mapping_provider: config: email_template: \\"{{ user.email }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Apple","id":"614","title":"Apple"},"615":{"body":"Auth0 is a hosted SaaS IdP solution. Create a regular web application for Synapse Set the Allowed Callback URLs to [synapse public baseurl]/_synapse/client/oidc/callback Add a rule with any name to add the preferred_username claim.\\n(See https://auth0.com/docs/customize/rules/create-rules for more information on how to create rules.) Code sample ```js\\nfunction addPersistenceAttribute(user, context, callback) { user.user_metadata = user.user_metadata || {}; user.user_metadata.preferred_username = user.user_metadata.preferred_username || user.user_id; context.idToken.preferred_username = user.user_metadata.preferred_username; auth0.users.updateUserMetadata(user.user_id, user.user_metadata) .then(function(){ callback(null, user, context); }) .catch(function(err){ callback(err); });\\n}\\n``` Synapse config: oidc_providers: - idp_id: auth0 idp_name: Auth0 issuer: \\"https://your-tier.eu.auth0.com/\\" # TO BE FILLED client_id: \\"your-client-id\\" # TO BE FILLED client_secret: \\"your-client-secret\\" # TO BE FILLED scopes: [\\"openid\\", \\"profile\\"] user_mapping_provider: config: localpart_template: \\"{{ user.preferred_username }}\\" display_name_template: \\"{{ user.name }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Auth0","id":"615","title":"Auth0"},"616":{"body":"Authentik is an open-source IdP solution. Create a provider in Authentik, with type OAuth2/OpenID. The parameters are: Client Type: Confidential JWT Algorithm: RS256 Scopes: OpenID, Email and Profile RSA Key: Select any available key Redirect URIs: [synapse public baseurl]/_synapse/client/oidc/callback Create an application for synapse in Authentik and link it to the provider. Note the slug of your application, Client ID and Client Secret. Note: RSA keys must be used for signing for Authentik, ECC keys do not work.\\nNote: The provider must have a signing key set and must not use an encryption key. Synapse config: oidc_providers: - idp_id: authentik idp_name: authentik discover: true issuer: \\"https://your.authentik.example.org/application/o/your-app-slug/\\" # TO BE FILLED: domain and slug client_id: \\"your client id\\" # TO BE FILLED client_secret: \\"your client secret\\" # TO BE FILLED scopes: - \\"openid\\" - \\"profile\\" - \\"email\\" user_mapping_provider: config: localpart_template: \\"{{ user.preferred_username }}\\" display_name_template: \\"{{ user.preferred_username|capitalize }}\\" # TO BE FILLED: If your users have names in Authentik and you want those in Synapse, this should be replaced with user.name|capitalize.\\n[...]\\njwt_config: enabled: true secret: \\"your client secret\\" # TO BE FILLED (same as `client_secret` above) algorithm: \\"RS256\\" # (...other fields)","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Authentik","id":"616","title":"Authentik"},"617":{"body":"Dex is a simple, open-source OpenID Connect Provider.\\nAlthough it is designed to help building a full-blown provider with an\\nexternal database, it can be configured with static passwords in a config file. Follow the Getting Started guide\\nto install Dex. Edit examples/config-dev.yaml config file from the Dex repo to add a client: staticClients:\\n- id: synapse secret: secret redirectURIs: - \'[synapse public baseurl]/_synapse/client/oidc/callback\' name: \'Synapse\' Run with dex serve examples/config-dev.yaml. Synapse config: oidc_providers: - idp_id: dex idp_name: \\"My Dex server\\" skip_verification: true # This is needed as Dex is served on an insecure endpoint issuer: \\"http://127.0.0.1:5556/dex\\" client_id: \\"synapse\\" client_secret: \\"secret\\" scopes: [\\"openid\\", \\"profile\\"] user_mapping_provider: config: localpart_template: \\"{{ user.name }}\\" display_name_template: \\"{{ user.name|capitalize }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Dex","id":"617","title":"Dex"},"618":{"body":"django-oauth-toolkit is a\\nDjango application providing out of the box all the endpoints, data and logic\\nneeded to add OAuth2 capabilities to your Django projects. It supports OpenID Connect too. Configuration on Django’s side: Add an application: https://example.com/admin/oauth2_provider/application/add/ and choose parameters like this: Redirect uris: https://synapse.example.com/_synapse/client/oidc/callback Client type: Confidential Authorization grant type: Authorization code Algorithm: HMAC with SHA-2 256 You can customize the claims Django gives to synapse (optional): Code sample class CustomOAuth2Validator(OAuth2Validator): def get_additional_claims(self, request): return { \\"sub\\": request.user.email, \\"email\\": request.user.email, \\"first_name\\": request.user.first_name, \\"last_name\\": request.user.last_name, } Your synapse config is then: oidc_providers: - idp_id: django_example idp_name: \\"Django Example\\" issuer: \\"https://example.com/o/\\" client_id: \\"your-client-id\\" # CHANGE ME client_secret: \\"your-client-secret\\" # CHANGE ME scopes: [\\"openid\\"] user_profile_method: \\"userinfo_endpoint\\" # needed because oauth-toolkit does not include user information in the authorization response user_mapping_provider: config: localpart_template: \\"{{ user.email.split(\'@\')[0] }}\\" display_name_template: \\"{{ user.first_name }} {{ user.last_name }}\\" email_template: \\"{{ user.email }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Django OAuth Toolkit","id":"618","title":"Django OAuth Toolkit"},"619":{"body":"You will need a Facebook developer account. You can register for one here. On the apps page of the developer\\nconsole, “Create App”, and choose “Build Connected Experiences”. Once the app is created, add “Facebook Login” and choose “Web”. You don’t\\nneed to go through the whole form here. In the left-hand menu, open “Products”/“Facebook Login”/“Settings”. Add [synapse public baseurl]/_synapse/client/oidc/callback as an OAuth Redirect\\nURL. In the left-hand menu, open “Settings/Basic”. Here you can copy the “App ID”\\nand “App Secret” for use below. Synapse config: - idp_id: facebook idp_name: Facebook idp_brand: \\"facebook\\" # optional: styling hint for clients discover: false issuer: \\"https://www.facebook.com\\" client_id: \\"your-client-id\\" # TO BE FILLED client_secret: \\"your-client-secret\\" # TO BE FILLED scopes: [\\"openid\\", \\"email\\"] authorization_endpoint: \\"https://facebook.com/dialog/oauth\\" token_endpoint: \\"https://graph.facebook.com/v9.0/oauth/access_token\\" jwks_uri: \\"https://www.facebook.com/.well-known/oauth/openid/jwks/\\" user_mapping_provider: config: display_name_template: \\"{{ user.name }}\\" email_template: \\"{{ user.email }}\\" Relevant documents: Manually Build a Login Flow Using Facebook’s Graph API Reference to the User endpoint Facebook do have an OIDC discovery endpoint,\\nbut it has a response_types_supported which excludes “code” (which we rely on, and\\nis even mentioned in their documentation),\\nso we have to disable discovery and configure the URIs manually.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Facebook","id":"619","title":"Facebook"},"62":{"body":"After installation, eturnal usually ships a default configuration file\\nhere: /etc/eturnal.yml (and, if not found there, there is a backup file here: /opt/eturnal/etc/eturnal.yml). It uses the (indentation-sensitive!) YAML\\nformat. The file contains further explanations. Here are some hints how to configure eturnal on your host machine\\nor when using e.g. Docker.\\nYou may also further deep dive into the reference documentation. eturnal runs out of the box with the default configuration. To enable TURN and\\nto integrate it with your homeserver, some aspects in eturnal’s default configuration file\\nmust be edited: Homeserver’s turn_shared_secret\\nand eturnal’s shared secret for authentication Both need to have the same value. Uncomment and adjust this line in eturnal’s\\nconfiguration file: secret: \\"long-and-cryptic\\" # Shared secret, CHANGE THIS. One way to generate a secret is with pwgen: pwgen -s 64 1 Public IP address If your TURN server is behind NAT, the NAT gateway must have an external,\\npublicly-reachable IP address. eturnal tries to autodetect the public IP address,\\nhowever, it may also be configured by uncommenting and adjusting this line, so eturnal advertises that address to connecting clients: relay_ipv4_addr: \\"203.0.113.4\\" # The server\'s public IPv4 address. If your NAT gateway is reachable over both IPv4 and IPv6, you may\\nconfigure eturnal to advertise each available address: relay_ipv4_addr: \\"203.0.113.4\\" # The server\'s public IPv4 address.\\nrelay_ipv6_addr: \\"2001:db8::4\\" # The server\'s public IPv6 address (optional). When advertising an external IPv6 address, ensure that the firewall and\\nnetwork settings of the system running your TURN server are configured to\\naccept IPv6 traffic, and that the TURN server is listening on the local\\nIPv6 address that is mapped by NAT to the external IPv6 address. Logging If eturnal was started by systemd, log files are written into the /var/log/eturnal directory by default. In order to log to the journal\\ninstead, the log_dir option can be set to stdout in the configuration file. Security considerations Consider your security settings. TURN lets users request a relay which will\\nconnect to arbitrary IP addresses and ports. The following configuration is\\nsuggested as a minimum starting point, see also the official documentation: ## Reject TURN relaying from/to the following addresses/networks:\\nblacklist: # This is the default blacklist. - \\"127.0.0.0/8\\" # IPv4 loopback. - \\"::1\\" # IPv6 loopback. - recommended # Expands to a number of networks recommended to be # blocked, but includes private networks. Those # would have to be \'whitelist\'ed if eturnal serves # local clients/peers within such networks. To whitelist IP addresses or specific (private) networks, you need to add a\\nwhitelist part into the configuration file, e.g.: whitelist: - \\"192.168.0.0/16\\" - \\"203.0.113.113\\" - \\"2001:db8::/64\\" The more specific, the better. TURNS (TURN via TLS/DTLS) Also consider supporting TLS/DTLS. To do this, adjust the following settings\\nin the eturnal.yml configuration file (TLS parts should not be commented anymore): listen: - ip: \\"::\\" port: 3478 transport: udp - ip: \\"::\\" port: 3478 transport: tcp - ip: \\"::\\" port: 5349 transport: tls ## TLS certificate/key files (must be readable by \'eturnal\' user!):\\ntls_crt_file: /etc/eturnal/tls/crt.pem\\ntls_key_file: /etc/eturnal/tls/key.pem In this case, replace the turn: schemes in homeserver’s turn_uris settings\\nwith turns:. More is described here. We recommend that you only try to set up TLS/DTLS once you have set up a\\nbasic installation and got it working. NB: If your TLS certificate was provided by Let’s Encrypt, TLS/DTLS will\\nnot work with any Matrix client that uses Chromium’s WebRTC library. This\\ncurrently includes Element Android & iOS; for more details, see their respective issues as well as the underlying WebRTC issue.\\nConsider using a ZeroSSL certificate for your TURN server as a working alternative. Firewall Ensure your firewall allows traffic into the TURN server on the ports\\nyou’ve configured it to listen on (By default: 3478 and 5349 for TURN\\ntraffic (remember to allow both TCP and UDP traffic), and ports 49152-65535\\nfor the UDP relay.) Reload/ restarting eturnal Changes in the configuration file require eturnal to reload/ restart, this\\ncan be achieved by: eturnalctl reload eturnal performs a configuration check before actually reloading/ restarting\\nand provides hints, if something is not correctly configured.","breadcrumbs":"Configuring a Turn Server » eturnal TURN server » Configuration","id":"62","title":"Configuration"},"620":{"body":"Forgejo is a fork of Gitea that can act as an OAuth2 provider. The implementation of OAuth2 is improved compared to Gitea, as it provides a correctly defined subject_claim and scopes. Synapse config: oidc_providers: - idp_id: forgejo idp_name: Forgejo discover: false issuer: \\"https://your-forgejo.com/\\" client_id: \\"your-client-id\\" # TO BE FILLED client_secret: \\"your-client-secret\\" # TO BE FILLED client_auth_method: client_secret_post scopes: [\\"openid\\", \\"profile\\", \\"email\\", \\"groups\\"] authorization_endpoint: \\"https://your-forgejo.com/login/oauth/authorize\\" token_endpoint: \\"https://your-forgejo.com/login/oauth/access_token\\" userinfo_endpoint: \\"https://your-forgejo.com/api/v1/user\\" user_mapping_provider: config: subject_claim: \\"sub\\" picture_claim: \\"picture\\" localpart_template: \\"{{ user.preferred_username }}\\" display_name_template: \\"{{ user.name }}\\" email_template: \\"{{ user.email }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Forgejo","id":"620","title":"Forgejo"},"621":{"body":"GitHub is a bit special as it is not an OpenID Connect compliant provider, but\\njust a regular OAuth2 provider. The /user API endpoint\\ncan be used to retrieve information on the authenticated user. As the Synapse\\nlogin mechanism needs an attribute to uniquely identify users, and that endpoint\\ndoes not return a sub property, an alternative subject_claim has to be set. Create a new OAuth application: https://github.com/settings/applications/new. Set the callback URL to [synapse public baseurl]/_synapse/client/oidc/callback. Synapse config: oidc_providers: - idp_id: github idp_name: Github idp_brand: \\"github\\" # optional: styling hint for clients discover: false issuer: \\"https://github.com/\\" client_id: \\"your-client-id\\" # TO BE FILLED client_secret: \\"your-client-secret\\" # TO BE FILLED authorization_endpoint: \\"https://github.com/login/oauth/authorize\\" token_endpoint: \\"https://github.com/login/oauth/access_token\\" userinfo_endpoint: \\"https://api.github.com/user\\" scopes: [\\"read:user\\"] user_mapping_provider: config: subject_claim: \\"id\\" localpart_template: \\"{{ user.login }}\\" display_name_template: \\"{{ user.name }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » GitHub","id":"621","title":"GitHub"},"622":{"body":"Create a new application. Add the read_user and openid scopes. Add this Callback URL: [synapse public baseurl]/_synapse/client/oidc/callback Synapse config: oidc_providers: - idp_id: gitlab idp_name: Gitlab idp_brand: \\"gitlab\\" # optional: styling hint for clients issuer: \\"https://gitlab.com/\\" client_id: \\"your-client-id\\" # TO BE FILLED client_secret: \\"your-client-secret\\" # TO BE FILLED client_auth_method: \\"client_secret_post\\" scopes: [\\"openid\\", \\"read_user\\"] user_profile_method: \\"userinfo_endpoint\\" user_mapping_provider: config: localpart_template: \'{{ user.nickname }}\' display_name_template: \'{{ user.name }}\'","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » GitLab","id":"622","title":"GitLab"},"623":{"body":"Gitea is, like Github, not an OpenID provider, but just an OAuth2 provider. The /user API endpoint\\ncan be used to retrieve information on the authenticated user. As the Synapse\\nlogin mechanism needs an attribute to uniquely identify users, and that endpoint\\ndoes not return a sub property, an alternative subject_claim has to be set. Create a new application. Add this Callback URL: [synapse public baseurl]/_synapse/client/oidc/callback Synapse config: oidc_providers: - idp_id: gitea idp_name: Gitea discover: false issuer: \\"https://your-gitea.com/\\" client_id: \\"your-client-id\\" # TO BE FILLED client_secret: \\"your-client-secret\\" # TO BE FILLED client_auth_method: client_secret_post scopes: [] # Gitea doesn\'t support Scopes authorization_endpoint: \\"https://your-gitea.com/login/oauth/authorize\\" token_endpoint: \\"https://your-gitea.com/login/oauth/access_token\\" userinfo_endpoint: \\"https://your-gitea.com/api/v1/user\\" user_mapping_provider: config: subject_claim: \\"id\\" localpart_template: \\"{{ user.login }}\\" display_name_template: \\"{{ user.full_name }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Gitea","id":"623","title":"Gitea"},"624":{"body":"Google is an OpenID certified authentication and authorisation provider. Set up a project in the Google API Console (see documentation). Add an “OAuth Client ID” for a Web Application under “Credentials”. Copy the Client ID and Client Secret, and add the following to your synapse config: oidc_providers: - idp_id: google idp_name: Google idp_brand: \\"google\\" # optional: styling hint for clients issuer: \\"https://accounts.google.com/\\" client_id: \\"your-client-id\\" # TO BE FILLED client_secret: \\"your-client-secret\\" # TO BE FILLED scopes: [\\"openid\\", \\"profile\\", \\"email\\"] # email is optional, read below user_mapping_provider: config: localpart_template: \\"{{ user.given_name|lower }}\\" display_name_template: \\"{{ user.name }}\\" email_template: \\"{{ user.email }}\\" # needs \\"email\\" in scopes above Back in the Google console, add this Authorized redirect URI: [synapse public baseurl]/_synapse/client/oidc/callback.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Google","id":"624","title":"Google"},"625":{"body":"Keycloak is an opensource IdP maintained by Red Hat. Keycloak supports OIDC Back-Channel Logout, which sends logout notification to Synapse, so that Synapse users get logged out when they log out from Keycloak.\\nThis can be optionally enabled by setting backchannel_logout_enabled to true in the Synapse configuration, and by setting the “Backchannel Logout URL” in Keycloak. Follow the Getting Started Guide to install Keycloak and set up a realm. Click Clients in the sidebar and click Create Fill in the fields as below: Field Value Client ID synapse Client Protocol openid-connect Click Save Fill in the fields as below: Field Value Client ID synapse Enabled On Client Protocol openid-connect Access Type confidential Valid Redirect URIs [synapse public baseurl]/_synapse/client/oidc/callback Backchannel Logout URL (optional) [synapse public baseurl]/_synapse/client/oidc/backchannel_logout Backchannel Logout Session Required (optional) On Click Save On the Credentials tab, update the fields: Field Value Client Authenticator Client ID and Secret Click Regenerate Secret Copy Secret oidc_providers: - idp_id: keycloak idp_name: \\"My KeyCloak server\\" issuer: \\"https://127.0.0.1:8443/realms/{realm_name}\\" client_id: \\"synapse\\" client_secret: \\"copy secret generated from above\\" scopes: [\\"openid\\", \\"profile\\"] user_mapping_provider: config: localpart_template: \\"{{ user.preferred_username }}\\" display_name_template: \\"{{ user.name }}\\" backchannel_logout_enabled: true # Optional","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Keycloak","id":"625","title":"Keycloak"},"626":{"body":"LemonLDAP::NG is an open-source IdP solution. Create an OpenID Connect Relying Parties in LemonLDAP::NG The parameters are: Client ID under the basic menu of the new Relying Parties ( Options > Basic > Client ID) Client secret ( Options > Basic > Client secret) JWT Algorithm: RS256 within the security menu of the new Relying Parties\\n( Options > Security > ID Token signature algorithm and Options > Security > Access Token signature algorithm) Scopes: OpenID, Email and Profile Force claims into id_token\\n( Options > Advanced > Force claims to be returned in ID Token) Allowed redirection addresses for login ( Options > Basic > Allowed redirection addresses for login ) : [synapse public baseurl]/_synapse/client/oidc/callback Synapse config: oidc_providers: - idp_id: lemonldap idp_name: lemonldap discover: true issuer: \\"https://auth.example.org/\\" # TO BE FILLED: replace with your domain client_id: \\"your client id\\" # TO BE FILLED client_secret: \\"your client secret\\" # TO BE FILLED scopes: - \\"openid\\" - \\"profile\\" - \\"email\\" user_mapping_provider: config: localpart_template: \\"{{ user.preferred_username }}}\\" # TO BE FILLED: If your users have names in LemonLDAP::NG and you want those in Synapse, this should be replaced with user.name|capitalize or any valid filter. display_name_template: \\"{{ user.preferred_username|capitalize }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » LemonLDAP","id":"626","title":"LemonLDAP"},"627":{"body":"Mastodon instances provide an OAuth API, allowing those instances to be used as a single sign-on provider for Synapse. The first step is to register Synapse as an application with your Mastodon instance, using the Create an application API (see also here). There are several ways to do this, but in the example below we are using CURL. This example assumes that: the Mastodon instance website URL is https://your.mastodon.instance.url, and Synapse will be registered as an app named my_synapse_app. Send the following request, substituting the value of synapse_public_baseurl from your Synapse installation. curl -d \\"client_name=my_synapse_app&redirect_uris=https://[synapse_public_baseurl]/_synapse/client/oidc/callback\\" -X POST https://your.mastodon.instance.url/api/v1/apps You should receive a response similar to the following. Make sure to save it. {\\"client_id\\":\\"someclientid_123\\",\\"client_secret\\":\\"someclientsecret_123\\",\\"id\\":\\"12345\\",\\"name\\":\\"my_synapse_app\\",\\"redirect_uri\\":\\"https://[synapse_public_baseurl]/_synapse/client/oidc/callback\\",\\"website\\":null,\\"vapid_key\\":\\"somerandomvapidkey_123\\"} As the Synapse login mechanism needs an attribute to uniquely identify users, and Mastodon’s endpoint does not return a sub property, an alternative subject_template has to be set. Your Synapse configuration should include the following: oidc_providers: - idp_id: my_mastodon idp_name: \\"Mastodon Instance Example\\" discover: false issuer: \\"https://your.mastodon.instance.url/@admin\\" client_id: \\"someclientid_123\\" client_secret: \\"someclientsecret_123\\" authorization_endpoint: \\"https://your.mastodon.instance.url/oauth/authorize\\" token_endpoint: \\"https://your.mastodon.instance.url/oauth/token\\" userinfo_endpoint: \\"https://your.mastodon.instance.url/api/v1/accounts/verify_credentials\\" scopes: [\\"read\\"] user_mapping_provider: config: subject_template: \\"{{ user.id }}\\" localpart_template: \\"{{ user.username }}\\" display_name_template: \\"{{ user.display_name }}\\" Note that the fields client_id and client_secret are taken from the CURL response above.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Mastodon","id":"627","title":"Mastodon"},"628":{"body":"Pocket ID is a simple OIDC provider that allows users to authenticate with their passkeys. Go to OIDC Clients Click on Add OIDC Client Add a name, for example Synapse Add \\"https://auth.example.org/_synapse/client/oidc/callback to Callback URLs # Replace auth.example.org with your domain Click on Save Note down your Client ID and Client secret, these will be used later Synapse config: oidc_providers: - idp_id: pocket_id idp_name: Pocket ID issuer: \\"https://auth.example.org/\\" # Replace with your domain client_id: \\"your-client-id\\" # Replace with the \\"Client ID\\" you noted down before client_secret: \\"your-client-secret\\" # Replace with the \\"Client secret\\" you noted down before scopes: [\\"openid\\", \\"profile\\"] user_mapping_provider: config: localpart_template: \\"{{ user.preferred_username }}\\" display_name_template: \\"{{ user.name }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Pocket ID","id":"628","title":"Pocket ID"},"629":{"body":"Shibboleth is an open Standard IdP solution widely used by Universities. Shibboleth needs the OIDC Plugin installed and working correctly. Create a new config on the IdP Side, ensure that the client_id and client_secret\\nare randomly generated data. { \\"client_id\\": \\"SOME-CLIENT-ID\\", \\"client_secret\\": \\"SOME-SUPER-SECRET-SECRET\\", \\"response_types\\": [\\"code\\"], \\"grant_types\\": [\\"authorization_code\\"], \\"scope\\": \\"openid profile email\\", \\"redirect_uris\\": [\\"https://[synapse public baseurl]/_synapse/client/oidc/callback\\"]\\n} Synapse config: oidc_providers: # Shibboleth IDP # - idp_id: shibboleth idp_name: \\"Shibboleth Login\\" discover: true issuer: \\"https://YOUR-IDP-URL.TLD\\" client_id: \\"YOUR_CLIENT_ID\\" client_secret: \\"YOUR-CLIENT-SECRECT-FROM-YOUR-IDP\\" scopes: [\\"openid\\", \\"profile\\", \\"email\\"] allow_existing_users: true user_profile_method: \\"userinfo_endpoint\\" user_mapping_provider: config: subject_claim: \\"sub\\" localpart_template: \\"{{ user.sub.split(\'@\')[0] }}\\" display_name_template: \\"{{ user.name }}\\" email_template: \\"{{ user.email }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Shibboleth with OIDC Plugin","id":"629","title":"Shibboleth with OIDC Plugin"},"63":{"body":"eturnal offers a handy operations script\\nwhich can be called e.g. to check, whether the service is up, to restart the service,\\nto query how many active sessions exist, to change logging behaviour and so on. Hint: If eturnalctl is not part of your $PATH, consider either sym-linking it (e.g. ´ln -s /opt/eturnal/bin/eturnalctl /usr/local/bin/eturnalctl´) or call it from the default eturnal directory directly: e.g. /opt/eturnal/bin/eturnalctl info","breadcrumbs":"Configuring a Turn Server » eturnal TURN server » eturnalctl opterations script","id":"63","title":"eturnalctl opterations script"},"630":{"body":"Setup a developer account on Twitch Obtain the OAuth 2.0 credentials by creating an app Add this OAuth Redirect URL: [synapse public baseurl]/_synapse/client/oidc/callback Synapse config: oidc_providers: - idp_id: twitch idp_name: Twitch issuer: \\"https://id.twitch.tv/oauth2/\\" client_id: \\"your-client-id\\" # TO BE FILLED client_secret: \\"your-client-secret\\" # TO BE FILLED client_auth_method: \\"client_secret_post\\" user_mapping_provider: config: localpart_template: \\"{{ user.preferred_username }}\\" display_name_template: \\"{{ user.name }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Twitch","id":"630","title":"Twitch"},"631":{"body":"Using Twitter as an identity provider requires using Synapse 1.75.0 or later. Setup a developer account on Twitter Create a project & app. Enable user authentication and under “Type of App” choose “Web App, Automated App or Bot”. Under “App info” set the callback URL to [synapse public baseurl]/_synapse/client/oidc/callback. Obtain the OAuth 2.0 credentials under the “Keys and tokens” tab, copy the “OAuth 2.0 Client ID and Client Secret” Synapse config: oidc_providers: - idp_id: twitter idp_name: Twitter idp_brand: \\"twitter\\" # optional: styling hint for clients discover: false # Twitter is not OpenID compliant. issuer: \\"https://twitter.com/\\" client_id: \\"your-client-id\\" # TO BE FILLED client_secret: \\"your-client-secret\\" # TO BE FILLED pkce_method: \\"always\\" # offline.access providers refresh tokens, tweet.read and users.read needed for userinfo request. scopes: [\\"offline.access\\", \\"tweet.read\\", \\"users.read\\"] authorization_endpoint: https://twitter.com/i/oauth2/authorize token_endpoint: https://api.twitter.com/2/oauth2/token userinfo_endpoint: https://api.twitter.com/2/users/me?user.fields=profile_image_url user_mapping_provider: config: subject_template: \\"{{ user.data.id }}\\" localpart_template: \\"{{ user.data.username }}\\" display_name_template: \\"{{ user.data.name }}\\" picture_template: \\"{{ user.data.profile_image_url }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Twitter","id":"631","title":"Twitter"},"632":{"body":"Install OpenID Connect Provider extension in your XWiki instance. Synapse config: oidc_providers: - idp_id: xwiki idp_name: \\"XWiki\\" issuer: \\"https://myxwikihost/xwiki/oidc/\\" client_id: \\"your-client-id\\" # TO BE FILLED client_auth_method: none scopes: [\\"openid\\", \\"profile\\"] user_profile_method: \\"userinfo_endpoint\\" user_mapping_provider: config: localpart_template: \\"{{ user.preferred_username }}\\" display_name_template: \\"{{ user.name }}\\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » XWiki","id":"632","title":"XWiki"},"633":{"body":"Synapse supports authenticating users via the Security Assertion\\nMarkup Language\\n(SAML) protocol natively. Please see the saml2_config and sso sections of the Synapse configuration\\nfile for more details.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » SAML » SAML","id":"633","title":"SAML"},"634":{"body":"Synapse supports authenticating users via the Central Authentication\\nService protocol\\n(CAS) natively. Please see the cas_config and sso\\nsections of the configuration manual for more details.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » CAS » CAS","id":"634","title":"CAS"},"635":{"body":"A mapping provider is a Python class (loaded via a Python module) that\\nworks out how to map attributes of a SSO response to Matrix-specific\\nuser attributes. Details such as user ID localpart, displayname, and even avatar\\nURLs are all things that can be mapped from talking to a SSO service. As an example, a SSO service may return the email address\\n“john.smith@example.com” for a user, whereas Synapse will need to figure out how\\nto turn that into a displayname when creating a Matrix user for this individual.\\nIt may choose John Smith, or Smith, John [Example.com] or any number of\\nvariations. As each Synapse configuration may want something different, this is\\nwhere SSO mapping providers come into play. SSO mapping providers are currently supported for OpenID and SAML SSO\\nconfigurations. Please see the details below for how to implement your own. It is up to the mapping provider whether the user should be assigned a predefined\\nMatrix ID based on the SSO attributes, or if the user should be allowed to\\nchoose their own username. In the first case - where users are automatically allocated a Matrix ID - it is\\nthe responsibility of the mapping provider to normalise the SSO attributes and\\nmap them to a valid Matrix ID. The specification for Matrix\\nIDs has some\\ninformation about what is considered valid. If the mapping provider does not assign a Matrix ID, then Synapse will\\nautomatically serve an HTML page allowing the user to pick their own username. External mapping providers are provided to Synapse in the form of an external\\nPython module. You can retrieve this module from PyPI or elsewhere,\\nbut it must be importable via Synapse (e.g. it must be in the same virtualenv\\nas Synapse). The Synapse config is then modified to point to the mapping provider\\n(and optionally provide additional configuration for it).","breadcrumbs":"Configuration » User Authentication » Single-Sign On » SSO Mapping Providers » SSO Mapping Providers","id":"635","title":"SSO Mapping Providers"},"636":{"body":"The OpenID mapping provider can be customized by editing the oidc_providers.user_mapping_provider.module\\nconfig option. oidc_providers.user_mapping_provider.config allows you to provide custom\\nconfiguration options to the module. Check with the module’s documentation for\\nwhat options it provides (if any). The options listed by default are for the\\nuser mapping provider built in to Synapse. If using a custom module, you should\\ncomment these options out and use those specified by the module instead.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » SSO Mapping Providers » OpenID Mapping Providers","id":"636","title":"OpenID Mapping Providers"},"637":{"body":"A custom mapping provider must specify the following methods: def __init__(self, parsed_config, module_api) Arguments: parsed_config - A configuration object that is the return value of the parse_config method. You should set any configuration options needed by\\nthe module here. module_api - a synapse.module_api.ModuleApi object which provides the\\nstable API available for extension modules. def parse_config(config) This method should have the @staticmethod decoration. Arguments: config - A dict representing the parsed content of the oidc_providers.user_mapping_provider.config homeserver config option.\\nRuns on homeserver startup. Providers should extract and validate\\nany option values they need here. Whatever is returned will be passed back to the user mapping provider module’s __init__ method during construction. def get_remote_user_id(self, userinfo) Arguments: userinfo - A authlib.oidc.core.claims.UserInfo object to extract user\\ninformation from. This method must return a string, which is the unique, immutable identifier\\nfor the user. Commonly the sub claim of the response. async def map_user_attributes(self, userinfo, token, failures) This method must be async. Arguments: userinfo - An authlib.oidc.core.claims.UserInfo\\nobject to extract user information from. token - A dictionary which includes information necessary to make\\nfurther requests to the OpenID provider. failures - An int that represents the amount of times the returned\\nmxid localpart mapping has failed. This should be used\\nto create a deduplicated mxid localpart which should be\\nreturned instead. For example, if this method returns john.doe as the value of localpart in the returned\\ndict, and that is already taken on the homeserver, this\\nmethod will be called again with the same parameters but\\nwith failures=1. The method should then return a different localpart value, such as john.doe1. Returns a dictionary with two keys: localpart: A string, used to generate the Matrix ID. If this is None, the user is prompted to pick their own username. This is only used\\nduring a user’s first login. Once a localpart has been associated with a\\nremote user ID (see get_remote_user_id) it cannot be updated. confirm_localpart: A boolean. If set to True, when a localpart\\nstring is returned from this method, Synapse will prompt the user to\\neither accept this localpart or pick their own username. Otherwise this\\noption has no effect. If omitted, defaults to False. display_name: An optional string, the display name for the user. picture: An optional string, the avatar url for the user. emails: A list of strings, the email address(es) to associate with\\nthis user. If omitted, defaults to an empty list. async def get_extra_attributes(self, userinfo, token) This method must be async. Arguments: userinfo - A authlib.oidc.core.claims.UserInfo object to extract user\\ninformation from. token - A dictionary which includes information necessary to make\\nfurther requests to the OpenID provider. Returns a dictionary that is suitable to be serialized to JSON. This\\nwill be returned as part of the response during a successful login. Note that care should be taken to not overwrite any of the parameters\\nusually returned as part of the login response.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » SSO Mapping Providers » Building a Custom OpenID Mapping Provider","id":"637","title":"Building a Custom OpenID Mapping Provider"},"638":{"body":"Synapse has a built-in OpenID mapping provider if a custom provider isn’t\\nspecified in the config. It is located at synapse.handlers.oidc.JinjaOidcMappingProvider.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » SSO Mapping Providers » Default OpenID Mapping Provider","id":"638","title":"Default OpenID Mapping Provider"},"639":{"body":"The SAML mapping provider can be customized by editing the saml2_config.user_mapping_provider.module\\nconfig option. saml2_config.user_mapping_provider.config allows you to provide custom\\nconfiguration options to the module. Check with the module’s documentation for\\nwhat options it provides (if any). The options listed by default are for the\\nuser mapping provider built in to Synapse. If using a custom module, you should\\ncomment these options out and use those specified by the module instead.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » SSO Mapping Providers » SAML Mapping Providers","id":"639","title":"SAML Mapping Providers"},"64":{"body":"In the following documentation, we use the term server_name to refer to that setting\\nin your homeserver configuration file. It appears at the ends of user ids, and tells\\nother homeservers where they can find your server. By default, other homeservers will expect to be able to reach yours via\\nyour server_name, on port 8448. For example, if you set your server_name\\nto example.com (so that your user names look like @user:example.com),\\nother servers will try to connect to yours at https://example.com:8448/. Delegation is a Matrix feature allowing a homeserver admin to retain a server_name of example.com so that user IDs, room aliases, etc continue\\nto look like *:example.com, whilst having federation traffic routed\\nto a different server and/or port (e.g. synapse.example.com:443).","breadcrumbs":"Delegation » Delegation of incoming federation traffic","id":"64","title":"Delegation of incoming federation traffic"},"640":{"body":"A custom mapping provider must specify the following methods: def __init__(self, parsed_config, module_api) Arguments: parsed_config - A configuration object that is the return value of the parse_config method. You should set any configuration options needed by\\nthe module here. module_api - a synapse.module_api.ModuleApi object which provides the\\nstable API available for extension modules. def parse_config(config) This method should have the @staticmethod decoration. Arguments: config - A dict representing the parsed content of the saml_config.user_mapping_provider.config homeserver config option.\\nRuns on homeserver startup. Providers should extract and validate\\nany option values they need here. Whatever is returned will be passed back to the user mapping provider module’s __init__ method during construction. def get_saml_attributes(config) This method should have the @staticmethod decoration. Arguments: config - A object resulting from a call to parse_config. Returns a tuple of two sets. The first set equates to the SAML auth\\nresponse attributes that are required for the module to function, whereas\\nthe second set consists of those attributes which can be used if available,\\nbut are not necessary. def get_remote_user_id(self, saml_response, client_redirect_url) Arguments: saml_response - A saml2.response.AuthnResponse object to extract user\\ninformation from. client_redirect_url - A string, the URL that the client will be\\nredirected to. This method must return a string, which is the unique, immutable identifier\\nfor the user. Commonly the uid claim of the response. def saml_response_to_user_attributes(self, saml_response, failures, client_redirect_url) Arguments: saml_response - A saml2.response.AuthnResponse object to extract user\\ninformation from. failures - An int that represents the amount of times the returned\\nmxid localpart mapping has failed. This should be used\\nto create a deduplicated mxid localpart which should be\\nreturned instead. For example, if this method returns john.doe as the value of mxid_localpart in the returned\\ndict, and that is already taken on the homeserver, this\\nmethod will be called again with the same parameters but\\nwith failures=1. The method should then return a different mxid_localpart value, such as john.doe1. client_redirect_url - A string, the URL that the client will be\\nredirected to. This method must return a dictionary, which will then be used by Synapse\\nto build a new user. The following keys are allowed: mxid_localpart - A string, the mxid localpart of the new user. If this is None, the user is prompted to pick their own username. This is only used\\nduring a user’s first login. Once a localpart has been associated with a\\nremote user ID (see get_remote_user_id) it cannot be updated. displayname - The displayname of the new user. If not provided, will default to\\nthe value of mxid_localpart. emails - A list of emails for the new user. If not provided, will\\ndefault to an empty list. Alternatively it can raise a synapse.api.errors.RedirectException to\\nredirect the user to another page. This is useful to prompt the user for\\nadditional information, e.g. if you want them to provide their own username.\\nIt is the responsibility of the mapping provider to either redirect back\\nto client_redirect_url (including any additional information) or to\\ncomplete registration using methods from the ModuleApi.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » SSO Mapping Providers » Building a Custom SAML Mapping Provider","id":"640","title":"Building a Custom SAML Mapping Provider"},"641":{"body":"Synapse has a built-in SAML mapping provider if a custom provider isn’t\\nspecified in the config. It is located at synapse.handlers.saml.DefaultSamlMappingProvider.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » SSO Mapping Providers » Default SAML Mapping Provider","id":"641","title":"Default SAML Mapping Provider"},"642":{"body":"This page of the Synapse documentation is now deprecated. For up to date\\ndocumentation on setting up or writing a password auth provider module, please see this page. Password auth providers offer a way for server administrators to\\nintegrate their Synapse installation with an existing authentication\\nsystem. A password auth provider is a Python class which is dynamically loaded\\ninto Synapse, and provides a number of methods by which it can integrate\\nwith the authentication system. This document serves as a reference for those looking to implement their\\nown password auth providers. Additionally, here is a list of known\\npassword auth provider module implementations: matrix-synapse-ldap3 matrix-synapse-shared-secret-auth matrix-synapse-rest-password-provider","breadcrumbs":"Configuration » User Authentication » Password Auth Providers » » Password auth provider modules","id":"642","title":"Password auth provider modules"},"643":{"body":"Password auth provider classes must provide the following methods: parse_config(config)\\nThis method is passed the config object for this module from the\\nhomeserver configuration file. It should perform any appropriate sanity checks on the provided\\nconfiguration, and return an object which is then passed into __init__. This method should have the @staticmethod decoration. __init__(self, config, account_handler) The constructor is passed the config object returned by parse_config, and a synapse.module_api.ModuleApi object which\\nallows the password provider to check if accounts exist and/or create\\nnew ones.","breadcrumbs":"Configuration » User Authentication » Password Auth Providers » » Required methods","id":"643","title":"Required methods"},"644":{"body":"Password auth provider classes may optionally provide the following methods: get_db_schema_files(self) This method, if implemented, should return an Iterable of (name, stream) pairs of database schema files. Each file is applied\\nin turn at initialisation, and a record is then made in the database\\nso that it is not re-applied on the next start. get_supported_login_types(self) This method, if implemented, should return a dict mapping from a\\nlogin type identifier (such as m.login.password) to an iterable\\ngiving the fields which must be provided by the user in the submission\\nto the /login API.\\nThese fields are passed in the login_dict dictionary to check_auth. For example, if a password auth provider wants to implement a custom\\nlogin type of com.example.custom_login, where the client is expected\\nto pass the fields secret1 and secret2, the provider should\\nimplement this method and return the following dict: {\\"com.example.custom_login\\": (\\"secret1\\", \\"secret2\\")} check_auth(self, username, login_type, login_dict) This method does the real work. If implemented, it\\nwill be called for each login attempt where the login type matches one\\nof the keys returned by get_supported_login_types. It is passed the (possibly unqualified) user field provided by the client,\\nthe login type, and a dictionary of login secrets passed by the\\nclient. The method should return an Awaitable object, which resolves\\nto the canonical @localpart:domain user ID if authentication is\\nsuccessful, and None if not. Alternatively, the Awaitable can resolve to a (str, func) tuple, in\\nwhich case the second field is a callback which will be called with\\nthe result from the /login call (including access_token, device_id, etc.) check_3pid_auth(self, medium, address, password) This method, if implemented, is called when a user attempts to\\nregister or log in with a third party identifier, such as email. It is\\npassed the medium (ex. “email”), an address (ex.\\n“ jdoe@example.com”) and the user’s password. The method should return an Awaitable object, which resolves\\nto a str containing the user’s (canonical) User id if\\nauthentication was successful, and None if not. As with check_auth, the Awaitable may alternatively resolve to a (user_id, callback) tuple. check_password(self, user_id, password) This method provides a simpler interface than get_supported_login_types and check_auth for password auth\\nproviders that just want to provide a mechanism for validating m.login.password logins. If implemented, it will be called to check logins with an m.login.password login type. It is passed a qualified @localpart:domain user id, and the password provided by the user. The method should return an Awaitable object, which resolves\\nto True if authentication is successful, and False if not. on_logged_out(self, user_id, device_id, access_token) This method, if implemented, is called when a user logs out. It is\\npassed the qualified user ID, the ID of the deactivated device (if\\nany: access tokens are occasionally created without an associated\\ndevice ID), and the (now deactivated) access token. It may return an Awaitable object; the logout request will\\nwait for the Awaitable to complete, but the result is ignored.","breadcrumbs":"Configuration » User Authentication » Password Auth Providers » » Optional methods","id":"644","title":"Optional methods"},"645":{"body":"Synapse comes with a non-standard login type to support JSON Web Tokens. In general the\\ndocumentation for the login endpoint\\nis still valid (and the mechanism works similarly to the token based login). To log in using a JSON Web Token, clients should submit a /login request as\\nfollows: { \\"type\\": \\"org.matrix.login.jwt\\", \\"token\\": \\"\\"\\n} The token field should include the JSON web token with the following claims: A claim that encodes the local part of the user ID is required. By default,\\nthe sub (subject) claim is used, or a custom claim can be set in the\\nconfiguration file. The expiration time ( exp), not before time ( nbf), and issued at ( iat)\\nclaims are optional, but validated if present. The issuer ( iss) claim is optional, but required and validated if configured. The audience ( aud) claim is optional, but required and validated if configured.\\nProviding the audience claim when not configured will cause validation to fail. In the case that the token is not valid, the homeserver must respond with 403 Forbidden and an error code of M_FORBIDDEN. As with other login types, there are additional fields (e.g. device_id and initial_device_display_name) which can be included in the above request.","breadcrumbs":"Configuration » User Authentication » JSON Web Tokens » JWT Login Type","id":"645","title":"JWT Login Type"},"646":{"body":"The JSON Web Token integration in Synapse uses the Authlib library, which must be installed\\nas follows: The relevant libraries are included in the Docker images and Debian packages\\nprovided by matrix.org so no further action is needed. If you installed Synapse into a virtualenv, run /path/to/env/bin/pip install synapse[jwt] to install the necessary dependencies. For other installation mechanisms, see the documentation provided by the\\nmaintainer. To enable the JSON web token integration, you should then add a jwt_config option\\nto your configuration file. See the configuration manual for some\\nsample settings.","breadcrumbs":"Configuration » User Authentication » JSON Web Tokens » Preparing Synapse","id":"646","title":"Preparing Synapse"},"647":{"body":"Although JSON Web Tokens are typically generated from an external server, the\\nexample below uses a locally generated JWT. Configure Synapse with JWT logins, note that this example uses a pre-shared\\nsecret and an algorithm of HS256: jwt_config: enabled: true secret: \\"my-secret-token\\" algorithm: \\"HS256\\" Generate a JSON web token: You can use the following short Python snippet to generate a JWT\\nprotected by an HMAC.\\nTake care that the secret and the algorithm given in the header match\\nthe entries from jwt_config above. from authlib.jose import jwt header = {\\"alg\\": \\"HS256\\"}\\npayload = {\\"sub\\": \\"user1\\", \\"aud\\": [\\"audience\\"]}\\nsecret = \\"my-secret-token\\"\\nresult = jwt.encode(header, payload, secret)\\nprint(result.decode(\\"ascii\\")) Query for the login types and ensure org.matrix.login.jwt is there: curl http://localhost:8080/_matrix/client/r0/login Login used the generated JSON web token from above: $ curl http://localhost:8082/_matrix/client/r0/login -X POST \\\\ --data \'{\\"type\\":\\"org.matrix.login.jwt\\",\\"token\\":\\"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0LXVzZXIifQ.Ag71GT8v01UO3w80aqRPTeuVPBIBZkYhNTJJ-_-zQIc\\"}\'\\n{ \\"access_token\\": \\"\\", \\"device_id\\": \\"ACBDEFGHI\\", \\"home_server\\": \\"localhost:8080\\", \\"user_id\\": \\"@test-user:localhost:8480\\"\\n} You should now be able to use the returned access token to query the client API.","breadcrumbs":"Configuration » User Authentication » JSON Web Tokens » How to test JWT as a developer","id":"647","title":"How to test JWT as a developer"},"648":{"body":"Synapse supports refresh tokens since version 1.49 (some earlier versions had support for an earlier, experimental draft of MSC2918 which is not compatible).","breadcrumbs":"Configuration » User Authentication » Refresh Tokens » Refresh Tokens","id":"648","title":"Refresh Tokens"},"649":{"body":"Synapse users’ sessions are identified by access tokens; access tokens are\\nissued to users on login. Each session gets a unique access token which identifies\\nit; the access token must be kept secret as it grants access to the user’s account. Traditionally, these access tokens were eternally valid (at least until the user\\nexplicitly chose to log out). In some cases, it may be desirable for these access tokens to expire so that the\\npotential damage caused by leaking an access token is reduced.\\nOn the other hand, forcing a user to re-authenticate (log in again) often might\\nbe too much of an inconvenience. Refresh tokens are a mechanism to avoid some of this inconvenience whilst\\nstill getting most of the benefits of short access token lifetimes.\\nRefresh tokens are also a concept present in OAuth 2 — further reading is available here. When refresh tokens are in use, both an access token and a refresh token will be\\nissued to users on login. The access token will expire after a predetermined amount\\nof time, but otherwise works in the same way as before. When the access token is\\nclose to expiring (or has expired), the user’s client should present the homeserver\\n(Synapse) with the refresh token. The homeserver will then generate a new access token and refresh token for the user\\nand return them. The old refresh token is invalidated and can not be used again*. Finally, refresh tokens also make it possible for sessions to be logged out if they\\nare inactive for too long, before the session naturally ends; see the configuration\\nguide below. *To prevent issues if clients lose connection half-way through refreshing a token,\\nthe refresh token is only invalidated once the new access token has been used at\\nleast once. For all intents and purposes, the above simplification is sufficient.","breadcrumbs":"Configuration » User Authentication » Refresh Tokens » Background and motivation","id":"649","title":"Background and motivation"},"65":{"body":"To use this method, you need to be able to configure the server at https:// to serve a file at https:///.well-known/matrix/server. There are two ways to do this, shown below. Note that the .well-known file is hosted on the default port for https (port 443).","breadcrumbs":"Delegation » .well-known delegation","id":"65","title":".well-known delegation"},"650":{"body":"There are some caveats: If a third party gets both your access token and refresh token, they will be able to\\ncontinue to enjoy access to your session. This is still an improvement because you (the user) will notice when your\\nsession expires and you’re not able to use your refresh token.\\nThat would be a giveaway that someone else has compromised your session.\\nYou would be able to log in again and terminate that session.\\nPreviously (with long-lived access tokens), a third party that has your access\\ntoken could go undetected for a very long time. Clients need to implement support for refresh tokens in order for them to be a\\nuseful mechanism. It is up to homeserver administrators if they want to issue long-lived access\\ntokens to clients not implementing refresh tokens. For compatibility, it is likely that they should, at least until client support\\nis widespread. Users with clients that support refresh tokens will still benefit from the\\nadded security; it’s not possible to downgrade a session to using long-lived\\naccess tokens so this effectively gives users the choice. In a closed environment where all users use known clients, this may not be\\nan issue as the homeserver administrator can know if the clients have refresh\\ntoken support. In that case, the non-refreshable access token lifetime\\nmay be set to a short duration so that a similar level of security is provided.","breadcrumbs":"Configuration » User Authentication » Refresh Tokens » Caveats","id":"650","title":"Caveats"},"651":{"body":"The following configuration options, in the registration section, are related: session_lifetime: maximum length of a session, even if it’s refreshed.\\nIn other words, the client must log in again after this time period.\\nIn most cases, this can be unset (infinite) or set to a long time (years or months). refreshable_access_token_lifetime: lifetime of access tokens that are created\\nby clients supporting refresh tokens.\\nThis should be short; a good value might be 5 minutes ( 5m). nonrefreshable_access_token_lifetime: lifetime of access tokens that are created\\nby clients which don’t support refresh tokens.\\nMake this short if you want to effectively force use of refresh tokens.\\nMake this long if you don’t want to inconvenience users of clients which don’t\\nsupport refresh tokens (by forcing them to frequently re-authenticate using\\nlogin credentials). refresh_token_lifetime: lifetime of refresh tokens.\\nIn other words, the client must refresh within this time period to maintain its session.\\nUnless you want to log inactive sessions out, it is often fine to use a long\\nvalue here or even leave it unset (infinite).\\nBeware that making it too short will inconvenience clients that do not connect\\nvery often, including mobile clients and clients of infrequent users (by making\\nit more difficult for them to refresh in time, which may force them to need to\\nre-authenticate using login credentials). Note: All four options above only apply when tokens are created (by logging in or refreshing).\\nChanges to these settings do not apply retroactively.","breadcrumbs":"Configuration » User Authentication » Refresh Tokens » Configuration Guide","id":"651","title":"Configuration Guide"},"652":{"body":"If you’d like to force sessions to be logged out upon inactivity, you can enable\\nrefreshable access token expiry and refresh token expiry. This works because a client must refresh at least once within a period of refresh_token_lifetime in order to maintain valid credentials to access the\\naccount. (It’s suggested that refresh_token_lifetime should be longer than refreshable_access_token_lifetime and this section assumes that to be the case\\nfor simplicity.) Note: this will only affect sessions using refresh tokens. You may wish to\\nset a short nonrefreshable_access_token_lifetime to prevent this being bypassed\\nby clients that do not support refresh tokens. Choosing values that guarantee permitting some inactivity It may be desirable to permit some short periods of inactivity, for example to\\naccommodate brief outages in client connectivity. The following model aims to provide guidance for choosing refresh_token_lifetime\\nand refreshable_access_token_lifetime to satisfy requirements of the form: inactivity longer than L MUST cause the session to be logged out; and inactivity shorter than S MUST NOT cause the session to be logged out. This model makes the weakest assumption that all active clients will refresh as\\nneeded to maintain an active access token, but no sooner. In reality, clients may refresh more often than this model assumes, but the\\nabove requirements will still hold. To satisfy the above model, refresh_token_lifetime should be set to L; and refreshable_access_token_lifetime should be set to L - S.","breadcrumbs":"Configuration » User Authentication » Refresh Tokens » Using refresh token expiry to log out inactive sessions","id":"652","title":"Using refresh token expiry to log out inactive sessions"},"653":{"body":"A captcha can be enabled on your homeserver to help prevent bots from registering\\naccounts. Synapse currently uses Google’s reCAPTCHA service which requires API keys\\nfrom Google.","breadcrumbs":"Configuration » Registration Captcha » Overview","id":"653","title":"Overview"},"654":{"body":"Create a new site at https://www.google.com/recaptcha/admin/create Set the label to anything you want Set the type to reCAPTCHA v2 using the “I’m not a robot” Checkbox option.\\nThis is the only type of captcha that works with Synapse. Add the public hostname for your server, as set in public_baseurl\\nin homeserver.yaml, to the list of authorized domains. If you have not set public_baseurl, use server_name. Agree to the terms of service and submit. Copy your site key and secret key and add them to your homeserver.yaml\\nconfiguration file recaptcha_public_key: YOUR_SITE_KEY\\nrecaptcha_private_key: YOUR_SECRET_KEY Enable the CAPTCHA for new registrations enable_registration_captcha: true Go to the settings page for the CAPTCHA you just created Uncheck the “Verify the origin of reCAPTCHA solutions” checkbox so that the\\ncaptcha can be displayed in any client. If you do not disable this option then you\\nmust specify the domains of every client that is allowed to display the CAPTCHA.","breadcrumbs":"Configuration » Registration Captcha » Getting API keys","id":"654","title":"Getting API keys"},"655":{"body":"The reCAPTCHA API requires that the IP address of the user who solved the\\nCAPTCHA is sent. If the client is connecting through a proxy or load balancer,\\nit may be required to use the X-Forwarded-For (XFF) header instead of the origin\\nIP address. This can be configured using the x_forwarded directive in the\\nlisteners section of the homeserver.yaml configuration file.","breadcrumbs":"Configuration » Registration Captcha » Configuring IP used for auth","id":"655","title":"Configuring IP used for auth"},"656":{"body":"The registration of new application services depends on the homeserver used.\\nIn synapse, you need to create a new configuration file for your AS and add it\\nto the list specified under the app_service_config_files config\\noption in your synapse config. For example: app_service_config_files:\\n- /home/matrix/.synapse/.yaml The format of the AS configuration file is as follows: id: \\nurl: \\nhs_token: \\nsender_localpart: \\nnamespaces: users: # List of users we\'re interested in - exclusive: regex: group_id: - ... aliases: [] # List of aliases we\'re interested in rooms: [] # List of room ids we\'re interested in exclusive: If enabled, only this application service is allowed to register users in its namespace(s). group_id: All users of this application service are dynamically joined to this group. This is useful for e.g user organisation or flairs. See the spec for further details on how application services work.","breadcrumbs":"Configuration » Application Services » Registering an Application Service","id":"656","title":"Registering an Application Service"},"657":{"body":"‘Server Notices’ are a new feature introduced in Synapse 0.30. They provide a\\nchannel whereby server administrators can send messages to users on the server. They are used as part of communication of the server polices (see Consent Tracking), however the intention is that\\nthey may also find a use for features such as “Message of the day”. This is a feature specific to Synapse, but it uses standard Matrix\\ncommunication mechanisms, so should work with any Matrix client.","breadcrumbs":"Configuration » Server Notices » Server Notices","id":"657","title":"Server Notices"},"658":{"body":"When the user is first sent a server notice, they will get an invitation to a\\nroom (typically called ‘Server Notices’, though this is configurable in homeserver.yaml). They will be unable to reject this invitation -\\nattempts to do so will receive an error. Once they accept the invitation, they will see the notice message in the room\\nhistory; it will appear to have come from the ‘server notices user’ (see\\nbelow). The user is prevented from sending any messages in this room by the power\\nlevels. Having joined the room, the user can leave the room if they want. Subsequent\\nserver notices will then cause a new room to be created.","breadcrumbs":"Configuration » Server Notices » User experience","id":"658","title":"User experience"},"659":{"body":"Server notices come from a specific user id on the server. Server\\nadministrators are free to choose the user id - something like server is\\nsuggested, meaning the notices will come from @server:. Once the Server Notices user is configured, that\\nuser id becomes a special, privileged user, so administrators should ensure\\nthat it is not already allocated. In order to support server notices, it is necessary to add some configuration\\nto the homeserver.yaml file. In particular, you should add a server_notices\\nsection, which should look like this: server_notices: system_mxid_localpart: server system_mxid_display_name: \\"Server Notices\\" system_mxid_avatar_url: \\"mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ\\" room_name: \\"Server Notices\\" room_avatar_url: \\"mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ\\" room_topic: \\"Room used by your server admin to notice you of important information\\" auto_join: true The only compulsory setting is system_mxid_localpart, which defines the user\\nid of the Server Notices user, as above. room_name defines the name of the\\nroom which will be created, room_avatar_url its avatar and room_topic its topic. system_mxid_display_name and system_mxid_avatar_url can be used to set the\\ndisplayname and avatar of the Server Notices user. auto_join will autojoin users to the notices room instead of sending an invite.","breadcrumbs":"Configuration » Server Notices » Synapse configuration","id":"659","title":"Synapse configuration"},"66":{"body":"For maximum flexibility, you need to configure an external server such as nginx, Apache\\nor HAProxy to serve the https:///.well-known/matrix/server file. Setting\\nup such a server is out of the scope of this documentation, but note that it is often\\npossible to configure your reverse proxy for this. The URL https:///.well-known/matrix/server should be configured\\nreturn a JSON structure containing the key m.server like this: { \\"m.server\\": \\"[:]\\"\\n} In our example (where we want federation traffic to be routed to https://synapse.example.com, on port 443), this would mean that https://example.com/.well-known/matrix/server should return: { \\"m.server\\": \\"synapse.example.com:443\\"\\n} Note, specifying a port is optional. If no port is specified, then it defaults\\nto 8448.","breadcrumbs":"Delegation » External server","id":"66","title":"External server"},"660":{"body":"To send server notices to users you can use the admin_api.","breadcrumbs":"Configuration » Server Notices » Sending notices","id":"660","title":"Sending notices"},"661":{"body":"Synapse 0.30 introduces support for tracking whether users have agreed to the\\nterms and conditions set by the administrator of a server - and blocking access\\nto the server until they have. There are several parts to this functionality; each requires some specific\\nconfiguration in homeserver.yaml to be enabled. Note that various parts of the configuration and this document refer to the\\n“privacy policy”: agreement with a privacy policy is one particular use of this\\nfeature, but of course administrators can specify other terms and conditions\\nunrelated to “privacy” per se.","breadcrumbs":"Configuration » Consent Tracking » Support in Synapse for tracking agreement to server terms and conditions","id":"661","title":"Support in Synapse for tracking agreement to server terms and conditions"},"662":{"body":"Synapse can be configured to serve the user a simple policy form with an\\n“accept” button. Clicking “Accept” records the user’s acceptance in the\\ndatabase and shows a success page. To enable this, first create templates for the policy and success pages.\\nThese should be stored on the local filesystem. These templates use the Jinja2 templating language,\\nand docs/privacy_policy_templates\\ngives examples of the sort of thing that can be done. Note that the templates must be stored under a name giving the language of the\\ntemplate - currently this must always be en (for “English”);\\ninternationalisation support is intended for the future. The template for the policy itself should be versioned and named according to\\nthe version: for example 1.0.html. The version of the policy which the user\\nhas agreed to is stored in the database. Once the templates are in place, make the following changes to homeserver.yaml: Add a user_consent section, which should look like: user_consent: template_dir: privacy_policy_templates version: 1.0 template_dir points to the directory containing the policy\\ntemplates. version defines the version of the policy which will be served\\nto the user. In the example above, Synapse will serve privacy_policy_templates/en/1.0.html. Add a form_secret setting at the top level: form_secret: \\"\\" This should be set to an arbitrary secret string (try pwgen -y 30 to\\ngenerate suitable secrets). More on what this is used for below. Add consent wherever the client resource is currently enabled in the listeners configuration. For example: listeners: - port: 8008 resources: - names: - client - consent Finally, ensure that jinja2 is installed. If you are using a virtualenv, this\\nshould be a matter of pip install Jinja2. On debian, try apt-get install python-jinja2. Once this is complete, and the server has been restarted, try visiting https:///_matrix/consent. If correctly configured, this should give\\nan error “Missing string query parameter ‘u’”. It is now possible to manually\\nconstruct URIs where users can give their consent.","breadcrumbs":"Configuration » Consent Tracking » Collecting policy agreement from a user","id":"662","title":"Collecting policy agreement from a user"},"663":{"body":"Add the following to your configuration: user_consent: require_at_registration: true policy_name: \\"Privacy Policy\\" # or whatever you\'d like to call the policy In your consent templates, make use of the public_version variable to\\nsee if an unauthenticated user is viewing the page. This is typically\\nwrapped around the form that would be used to actually agree to the document: {% if not public_version %} \\n{% endif %} Restart Synapse to apply the changes. Visiting https:///_matrix/consent should now give you a view of the privacy\\ndocument. This is what users will be able to see when registering for accounts.","breadcrumbs":"Configuration » Consent Tracking » Enabling consent tracking at registration","id":"663","title":"Enabling consent tracking at registration"},"664":{"body":"It may be useful to manually construct the “consent URI” for a given user - for\\ninstance, in order to send them an email asking them to consent. To do this,\\ntake the base https:///_matrix/consent URL and add the following\\nquery parameters: u: the user id of the user. This can either be a full MXID\\n( @user:server.com) or just the localpart ( user). h: hex-encoded HMAC-SHA256 of u using the form_secret as a key. It is\\npossible to calculate this on the commandline with something like: echo -n \'\' | openssl sha256 -hmac \'\' This should result in a URI which looks something like: https:///_matrix/consent?u=&h=68a152465a4d.... Note that not providing a u parameter will be interpreted as wanting to view\\nthe document from an unauthenticated perspective, such as prior to registration.\\nTherefore, the h parameter is not required in this scenario. To enable this\\nbehaviour, set require_at_registration to true in your user_consent config.","breadcrumbs":"Configuration » Consent Tracking » Constructing the consent URI","id":"664","title":"Constructing the consent URI"},"665":{"body":"It is possible to configure Synapse to send a server\\nnotice to anybody who has not yet agreed to the current\\nversion of the policy. To do so: ensure that the consent resource is configured, as in the previous section ensure that server notices are configured, as in the server notice documentation. Add server_notice_content under user_consent in homeserver.yaml. For\\nexample: user_consent: server_notice_content: msgtype: m.text body: >- Please give your consent to the privacy policy at %(consent_uri)s. Synapse automatically replaces the placeholder %(consent_uri)s with the\\nconsent uri for that user. ensure that public_baseurl is set in homeserver.yaml, and gives the base\\nURI that clients use to connect to the server. (It is used to construct consent_uri in the server notice.)","breadcrumbs":"Configuration » Consent Tracking » Sending users a server notice asking them to agree to the policy","id":"665","title":"Sending users a server notice asking them to agree to the policy"},"666":{"body":"Synapse can be configured to block any attempts to join rooms or send messages\\nuntil the user has given their agreement to the policy. (Joining the server\\nnotices room is exempted from this). To enable this, add block_events_error under user_consent. For example: user_consent: block_events_error: >- You can\'t send any messages until you consent to the privacy policy at %(consent_uri)s. Synapse automatically replaces the placeholder %(consent_uri)s with the\\nconsent uri for that user. ensure that public_baseurl is set in homeserver.yaml, and gives the base\\nURI that clients use to connect to the server. (It is used to construct consent_uri in the error.)","breadcrumbs":"Configuration » Consent Tracking » Blocking users from using the server until they agree to the policy","id":"666","title":"Blocking users from using the server until they agree to the policy"},"667":{"body":"The user directory is maintained based on users that are ‘visible’ to the homeserver -\\ni.e. ones which are local to the server and ones which any local user shares a\\nroom with. The directory info is stored in various tables, which can sometimes get out of\\nsync (although this is considered a bug). If this happens, for now the\\nsolution to fix it is to use the admin API\\nand execute the job regenerate_directory. This should then start a background task to\\nflush the current tables and regenerate the directory. Depending on the size\\nof your homeserver (number of users and rooms) this can take a while.","breadcrumbs":"Configuration » User Directory » User Directory API Implementation","id":"667","title":"User Directory API Implementation"},"668":{"body":"There are five relevant tables that collectively form the “user directory”.\\nThree of them track a list of all known users. The last two (collectively called\\nthe “search tables”) track which users are visible to each other. From all of these tables we exclude three types of local user: support users appservice users deactivated users A description of each table follows: user_directory. This contains the user ID, display name and avatar of each user. Because there is only one directory entry per user, it is important that it\\nonly contain publicly visible information. Otherwise, this will leak the\\nnickname or avatar used in a private room. Indexed on rooms. Indexed on users. user_directory_search. To be joined to user_directory. It contains an extra\\ncolumn that enables full text search based on user IDs and display names.\\nDifferent schemas for SQLite and Postgres are used. Indexed on the full text search data. Indexed on users. user_directory_stream_pos. When the initial background update to populate\\nthe directory is complete, we record a stream position here. This indicates\\nthat synapse should now listen for room changes and incrementally update\\nthe directory where necessary. (See stream positions.) users_in_public_rooms. Contains associations between users and the public\\nrooms they’re in. Used to determine which users are in public rooms and should\\nbe publicly visible in the directory. Both local and remote users are tracked. users_who_share_private_rooms. Rows are triples (L, M, room id) where L\\nis a local user and M is a local or remote user. L and M should be\\ndifferent, but this isn’t enforced by a constraint. Note that if two local users share a room then there will be two entries: (user1, user2, !room_id) and (user2, user1, !room_id).","breadcrumbs":"Configuration » User Directory » Data model","id":"668","title":"Data model"},"669":{"body":"The exact way user search works can be tweaked via some server-level configuration options. The information is not repeated here, but the options are mentioned below.","breadcrumbs":"Configuration » User Directory » Configuration options","id":"669","title":"Configuration options"},"67":{"body":"If you are able to set up your domain so that https:// is routed to\\nSynapse (i.e., the only change needed is to direct federation traffic to port 443\\ninstead of port 8448), then it is possible to configure Synapse to serve a suitable .well-known/matrix/server file. To do so, add the following to your homeserver.yaml\\nfile: serve_server_wellknown: true Note: this only works if https:// is routed to Synapse, so is\\ngenerally not suitable if Synapse is hosted at a subdomain such as https://synapse.example.com.","breadcrumbs":"Delegation » Serving a .well-known/matrix/server file with Synapse","id":"67","title":"Serving a .well-known/matrix/server file with Synapse"},"670":{"body":"If search_all_users is false, then results are limited to users who: Are found in the users_in_public_rooms table, or Are found in the users_who_share_private_rooms where L is the requesting\\nuser and M is the search result. Otherwise, if search_all_users is true, no such limits are placed and all\\nusers known to the server (matching the search query) will be returned. By default, locked users are not returned. If show_locked_users is true then\\nno filtering on the locked status of a user is done. The user provided search term is lowercased and normalized using NFKC,\\nthis treats the string as case-insensitive, canonicalizes different forms of the\\nsame text, and maps some “roughly equivalent” characters together. The search term is then split into segments using the icu_segmenter\\nRust crate. This crate ships with its\\nown dictionary and Long Short Term-Memory (LSTM) machine learning models\\nper-language to segment words. Read more in the crate’s\\ndocumentation. The queries for PostgreSQL and SQLite are detailed below, but their overall goal\\nis to find matching users, preferring users who are “real” (e.g. not bots,\\nnot deactivated). It is assumed that real users will have a display name and\\navatar set.","breadcrumbs":"Configuration » User Directory » Search algorithm","id":"670","title":"Search algorithm"},"671":{"body":"The above words are then transformed into two queries: “exact” which matches the parsed words exactly (using to_tsquery); “prefix” which matches the parsed words as prefixes (using to_tsquery). Results are composed of all rows in the user_directory_search table whose information\\nmatches one (or both) of these queries. Results are ordered by calculating a weighted\\nscore for each result, higher scores are returned first: 4x if a user ID exists. 1.2x if the user has a display name set. 1.2x if the user has an avatar set. 0x-3x by the full text search results using the ts_rank_cd function\\nagainst the “exact” search query; this has four variables with the following weightings: D: 0.1 for the user ID’s domain C: 0.1 for unused B: 0.9 for the user’s display name (or an empty string if it is not set) A: 0.1 for the user ID’s localpart 0x-1x by the full text search results using the ts_rank_cd function against the\\n“prefix” search query. (Using the same weightings as above.) If prefer_local_users is true, then 2x if the user is local to the homeserver. Note that ts_rank_cd returns a weight between 0 and 1. The initial weighting of\\nall results is 1.","breadcrumbs":"Configuration » User Directory » PostgreSQL","id":"671","title":"PostgreSQL"},"672":{"body":"Results are composed of all rows in the user_directory_search whose information\\nmatches the query. Results are ordered by the following information, with each\\nsubsequent column used as a tiebreaker, for each result: By the rank\\nof the full text search results using the matchinfo function. Higher\\nranks are returned first. If prefer_local_users is true, then users local to the homeserver are\\nreturned first. Users with a display name set are returned first. Users with an avatar set are returned first.","breadcrumbs":"Configuration » User Directory » SQLite","id":"672","title":"SQLite"},"673":{"body":"Synapse admins can enable support for message retention policies on\\ntheir homeserver. Message retention policies exist at a room level,\\nfollow the semantics described in MSC1763,\\nand allow server and room admins to configure how long messages should\\nbe kept in a homeserver’s database before being purged from it. Please note that, as this feature isn’t part of the Matrix\\nspecification yet, the use of m.room.retention events for per-room\\nretention policies is to be considered as experimental. However, the use\\nof a default message retention policy is considered a stable feature\\nin Synapse. A message retention policy is mainly defined by its max_lifetime\\nparameter, which defines how long a message can be kept around after\\nit was sent to the room. If a room doesn’t have a message retention\\npolicy, and there’s no default one for a given server, then no message\\nsent in that room is ever purged on that server. MSC1763 also specifies semantics for a min_lifetime parameter which\\ndefines the amount of time after which an event can get purged (after\\nit was sent to the room), but Synapse doesn’t currently support it\\nbeyond registering it. Both max_lifetime and min_lifetime are optional parameters. Note that message retention policies don’t apply to state events. Once an event reaches its expiry date (defined as the time it was sent\\nplus the value for max_lifetime in the room), two things happen: Synapse stops serving the event to clients via any endpoint. The message gets picked up by the next purge job (see the “Purge jobs”\\nsection) and is removed from Synapse’s database. Since purge jobs don’t run continuously, this means that an event might\\nstay in a server’s database for longer than the value for max_lifetime\\nin the room would allow, though hidden from clients. Similarly, if a server (with support for message retention policies\\nenabled) receives from another server an event that should have been\\npurged according to its room’s policy, then the receiving server will\\nprocess and store that event until it’s picked up by the next purge job,\\nthough it will always hide it from clients. Synapse requires at least one message in each room, so it will never\\ndelete the last message in a room. It will, however, hide it from\\nclients.","breadcrumbs":"Configuration » Message Retention Policies » Message retention policies","id":"673","title":"Message retention policies"},"674":{"body":"Support for this feature can be enabled and configured by adding the retention option in the Synapse configuration file (see configuration manual). To enable support for message retention policies, set the setting enabled in this section to true.","breadcrumbs":"Configuration » Message Retention Policies » Server configuration","id":"674","title":"Server configuration"},"675":{"body":"A default message retention policy is a policy defined in Synapse’s\\nconfiguration that is used by Synapse for every room that doesn’t have a\\nmessage retention policy configured in its state. This allows server\\nadmins to ensure that messages are never kept indefinitely in a server’s\\ndatabase. A default policy can be defined as such, by adding the retention option in\\nthe configuration file and adding these sub-options: default_policy: min_lifetime: 1d max_lifetime: 1y Here, min_lifetime and max_lifetime have the same meaning and level\\nof support as previously described. They can be expressed either as a\\nduration (using the units s (seconds), m (minutes), h (hours), d (days), w (weeks) and y (years)) or as a number of milliseconds.","breadcrumbs":"Configuration » Message Retention Policies » Default policy","id":"675","title":"Default policy"},"676":{"body":"Purge jobs are the jobs that Synapse runs in the background to purge\\nexpired events from the database. They are only run if support for\\nmessage retention policies is enabled in the server’s configuration. If\\nno configuration for purge jobs is configured by the server admin,\\nSynapse will use a default configuration, which is described here in the configuration manual. Some server admins might want a finer control on when events are removed\\ndepending on an event’s room’s policy. This can be done by setting the purge_jobs sub-section in the retention section of the configuration\\nfile. An example of such configuration could be: purge_jobs: - longest_max_lifetime: 3d interval: 12h - shortest_max_lifetime: 3d longest_max_lifetime: 1w interval: 1d - shortest_max_lifetime: 1w interval: 2d In this example, we define three jobs: one that runs twice a day (every 12 hours) and purges events in rooms\\nwhich policy’s max_lifetime is lower or equal to 3 days. one that runs once a day and purges events in rooms which policy’s max_lifetime is between 3 days and a week. one that runs once every 2 days and purges events in rooms which\\npolicy’s max_lifetime is greater than a week. Note that this example is tailored to show different configurations and\\nfeatures slightly more jobs than is probably necessary (in practice, a\\nserver admin would probably consider it better to replace the two last\\njobs with one that runs once a day and handles rooms which\\npolicy’s max_lifetime is greater than 3 days). Keep in mind, when configuring these jobs, that a purge job can become\\nquite heavy on the server if it targets many rooms, therefore prefer\\nhaving jobs with a low interval that target a limited set of rooms. Also\\nmake sure to include a job with no minimum and one with no maximum to\\nmake sure your configuration handles every policy. As previously mentioned in this documentation, while a purge job that\\nruns e.g. every day means that an expired event might stay in the\\ndatabase for up to a day after its expiry, Synapse hides expired events\\nfrom clients as soon as they expire, so the event is not visible to\\nlocal users between its expiry date and the moment it gets purged from\\nthe server’s database.","breadcrumbs":"Configuration » Message Retention Policies » Purge jobs","id":"676","title":"Purge jobs"},"677":{"body":"Server admins can set limits on the values of max_lifetime to use when\\npurging old events in a room. These limits can be defined under the retention option in the configuration file: allowed_lifetime_min: 1d\\nallowed_lifetime_max: 1y The limits are considered when running purge jobs. If necessary, the\\neffective value of max_lifetime will be brought between allowed_lifetime_min and allowed_lifetime_max (inclusive).\\nThis means that, if the value of max_lifetime defined in the room’s state\\nis lower than allowed_lifetime_min, the value of allowed_lifetime_min\\nwill be used instead. Likewise, if the value of max_lifetime is higher\\nthan allowed_lifetime_max, the value of allowed_lifetime_max will be\\nused instead. In the example above, we ensure Synapse never deletes events that are less\\nthan one day old, and that it always deletes events that are over a year\\nold. If a default policy is set, and its max_lifetime value is lower than allowed_lifetime_min or higher than allowed_lifetime_max, the same\\nprocess applies. Both parameters are optional; if one is omitted Synapse won’t use it to\\nadjust the effective value of max_lifetime. Like other settings in this section, these parameters can be expressed\\neither as a duration or as a number of milliseconds.","breadcrumbs":"Configuration » Message Retention Policies » Lifetime limits","id":"677","title":"Lifetime limits"},"678":{"body":"To configure a room’s message retention policy, a room’s admin or\\nmoderator needs to send a state event in that room with the type m.room.retention and the following content: { \\"max_lifetime\\": ...\\n} In this event’s content, the max_lifetime parameter has the same\\nmeaning as previously described, and needs to be expressed in\\nmilliseconds. The event’s content can also include a min_lifetime\\nparameter, which has the same meaning and limited support as previously\\ndescribed. Note that over every server in the room, only the ones with support for\\nmessage retention policies will actually remove expired events. This\\nsupport is currently not enabled by default in Synapse.","breadcrumbs":"Configuration » Message Retention Policies » Room configuration","id":"678","title":"Room configuration"},"679":{"body":"While purge jobs actually delete data from the database, the disk space\\nused by the database might not decrease immediately on the database’s\\nhost. However, even though the database engine won’t free up the disk\\nspace, it will start writing new data into where the purged data was. If you want to reclaim the freed disk space anyway and return it to the\\noperating system, the server admin needs to run VACUUM FULL; (or VACUUM; for SQLite databases) on Synapse’s database (see the related PostgreSQL documentation).","breadcrumbs":"Configuration » Message Retention Policies » Note on reclaiming disk space","id":"679","title":"Note on reclaiming disk space"},"68":{"body":"It is also possible to do delegation using a SRV DNS record. However, that is generally\\nnot recommended, as it can be difficult to configure the TLS certificates correctly in\\nthis case, and it offers little advantage over .well-known delegation. Please keep in mind that server delegation is a function of server-server communication,\\nand as such using SRV DNS records will not cover use cases involving client-server comms.\\nThis means setting global client settings (such as a Jitsi endpoint, or disabling\\ncreating new rooms as encrypted by default, etc) will still require that you serve a file\\nfrom the https:///.well-known/ endpoints defined in the spec! If you are\\nconsidering using SRV DNS delegation to avoid serving files from this endpoint, consider\\nthe impact that you will not be able to change those client-based default values globally,\\nand will be relegated to the featureset of the configuration of each individual client. However, if you really need it, you can find some documentation on what such a\\nrecord should look like and how Synapse will use it in the Matrix\\nspecification.","breadcrumbs":"Delegation » SRV DNS record delegation","id":"68","title":"SRV DNS record delegation"},"680":{"body":"Synapse supports extending its functionality by configuring external modules. Note: When using third-party modules, you effectively allow someone else to run\\ncustom code on your Synapse homeserver. Server admins are encouraged to verify the\\nprovenance of the modules they use on their homeserver and make sure the modules aren’t\\nrunning malicious code on their instance.","breadcrumbs":"Configuration » Pluggable Modules » Modules","id":"680","title":"Modules"},"681":{"body":"To use a module on Synapse, add it to the modules section of the configuration file: modules: - module: my_super_module.MySuperClass config: do_thing: true - module: my_other_super_module.SomeClass config: {} Each module is defined by a path to a Python class as well as a configuration. This\\ninformation for a given module should be available in the module’s own documentation.","breadcrumbs":"Configuration » Pluggable Modules » Using modules","id":"681","title":"Using modules"},"682":{"body":"The order in which modules are listed in this section is important. When processing an\\naction that can be handled by several modules, Synapse will always prioritise the module\\nthat appears first (i.e. is the highest in the list). This means: If several modules register the same callback, the callback registered by the module\\nthat appears first is used. If several modules try to register a handler for the same HTTP path, only the handler\\nregistered by the module that appears first is used. Handlers registered by the other\\nmodule(s) are ignored and Synapse will log a warning message about them. Note that Synapse doesn’t allow multiple modules implementing authentication checkers via\\nthe password auth provider feature for the same login type with different fields. If this\\nhappens, Synapse will refuse to start.","breadcrumbs":"Configuration » Pluggable Modules » Using multiple modules","id":"682","title":"Using multiple modules"},"683":{"body":"We are currently in the process of migrating module interfaces to this system. While some\\ninterfaces might be compatible with it, others still require configuring modules in\\nanother part of Synapse’s configuration file. Currently, only the following pre-existing interfaces are compatible with this new system: spam checker third-party rules presence router password auth providers","breadcrumbs":"Configuration » Pluggable Modules » Current status","id":"683","title":"Current status"},"684":{"body":"A module is a Python class that uses Synapse’s module API to interact with the\\nhomeserver. It can register callbacks that Synapse will call on specific operations, as\\nwell as web resources to attach to Synapse’s web server. When instantiated, a module is given its parsed configuration as well as an instance of\\nthe synapse.module_api.ModuleApi class. The configuration is a dictionary, and is\\neither the output of the module’s parse_config static method (see below), or the\\nconfiguration associated with the module in Synapse’s configuration file. See the documentation for the ModuleApi class here.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Writing a module","id":"684","title":"Writing a module"},"685":{"body":"If Synapse is running with other modules configured, the order each module appears in\\nwithin the modules section of the Synapse configuration file might restrict what it can\\nor cannot register. See this section for more\\ninformation. On top of the rules listed in the link above, if a callback returns a value that should\\ncause the current operation to fail (e.g. if a callback checking an event returns with a\\nvalue that should cause the event to be denied), Synapse will fail the operation and\\nignore any subsequent callbacks that should have been run after this one. The documentation for each callback mentions how Synapse behaves when\\nmultiple modules implement it.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » When Synapse runs with several modules configured","id":"685","title":"When Synapse runs with several modules configured"},"686":{"body":"A module can implement the following static method: @staticmethod\\ndef parse_config(config: dict) -> Any This method is given a dictionary resulting from parsing the YAML configuration for the\\nmodule. It may modify it (for example by parsing durations expressed as strings (e.g.\\n“5d”) into milliseconds, etc.), and return the modified dictionary. It may also verify\\nthat the configuration is correct, and raise an instance of synapse.module_api.errors.ConfigError if not.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Handling the module’s configuration","id":"686","title":"Handling the module’s configuration"},"687":{"body":"Modules can register web resources onto Synapse’s web server using the following module\\nAPI method: def ModuleApi.register_web_resource(path: str, resource: IResource) -> None The path is the full absolute path to register the resource at. For example, if you\\nregister a resource for the path /_synapse/client/my_super_module/say_hello, Synapse\\nwill serve it at http(s)://[HS_URL]/_synapse/client/my_super_module/say_hello. Note\\nthat Synapse does not allow registering resources for several sub-paths in the /_matrix\\nnamespace (such as anything under /_matrix/client for example). It is strongly\\nrecommended that modules register their web resources under the /_synapse/client\\nnamespace. The provided resource is a Python class that implements Twisted’s IResource\\ninterface (such as Resource). Only one resource can be registered for a given path. If several modules attempt to\\nregister a resource for the same path, the module that appears first in Synapse’s\\nconfiguration file takes priority. Modules must register their web resources in their __init__ method.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Registering a web resource","id":"687","title":"Registering a web resource"},"688":{"body":"Modules can use Synapse’s module API to register callbacks. Callbacks are functions that\\nSynapse will call when performing specific actions. Callbacks must be asynchronous (unless\\nspecified otherwise), and are split in categories. A single module may implement callbacks\\nfrom multiple categories, and is under no obligation to implement all callbacks from the\\ncategories it registers callbacks for. Modules can register callbacks using one of the module API’s register_[...]_callbacks\\nmethods. The callback functions are passed to these methods as keyword arguments, with\\nthe callback name as the argument name and the function as its value. A register_[...]_callbacks method exists for each category. Callbacks for each category can be found on their respective page of the Synapse documentation website.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Registering a callback","id":"688","title":"Registering a callback"},"689":{"body":"Added in Synapse 1.74.0. Modules can leverage Synapse’s caching tools to manage their own cached functions. This\\ncan be helpful for modules that need to repeatedly request the same data from the database\\nor a remote service. Functions that need to be wrapped with a cache need to be decorated with a @cached()\\ndecorator (which can be imported from synapse.module_api) and registered with the ModuleApi.register_cached_function\\nAPI when initialising the module. If the module needs to invalidate an entry in a cache,\\nit needs to use the ModuleApi.invalidate_cache\\nAPI, with the function to invalidate the cache of and the key(s) of the entry to\\ninvalidate. Below is an example of a simple module using a cached function: from typing import Any\\nfrom synapse.module_api import cached, ModuleApi class MyModule: def __init__(self, config: Any, api: ModuleApi): self.api = api # Register the cached function so Synapse knows how to correctly invalidate # entries for it. self.api.register_cached_function(self.get_user_from_id) @cached() async def get_department_for_user(self, user_id: str) -> str: \\"\\"\\"A function with a cache.\\"\\"\\" # Request a department from an external service. return await self.http_client.get_json( \\"https://int.example.com/users\\", {\\"user_id\\": user_id) )[\\"department\\"] async def do_something_with_users(self) -> None: \\"\\"\\"Calls the cached function and then invalidates an entry in its cache.\\"\\"\\" user_id = \\"@alice:example.com\\" # Get the user. Since get_department_for_user is wrapped with a cache, # the return value for this user_id will be cached. department = await self.get_department_for_user(user_id) # Do something with `department`... # Let\'s say something has changed with our user, and the entry we have for # them in the cache is out of date, so we want to invalidate it. await self.api.invalidate_cache(self.get_department_for_user, (user_id,)) See the cached docstring for more details.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Caching","id":"689","title":"Caching"},"69":{"body":"","breadcrumbs":"Delegation » Delegation FAQ","id":"69","title":"Delegation FAQ"},"690":{"body":"Spam checker callbacks allow module developers to implement spam mitigation actions for\\nSynapse instances. Spam checker callbacks can be registered using the module API’s register_spam_checker_callbacks method.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » Spam checker callbacks","id":"690","title":"Spam checker callbacks"},"691":{"body":"The available spam checker callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » Callbacks","id":"691","title":"Callbacks"},"692":{"body":"First introduced in Synapse v1.37.0 Changed in Synapse v1.60.0: synapse.module_api.NOT_SPAM and synapse.module_api.errors.Codes can be returned by this callback. Returning a boolean or a string is now deprecated. async def check_event_for_spam(event: \\"synapse.module_api.EventBase\\") -> Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\", str, bool] Called when receiving an event from a client or via federation. The callback must return one of: synapse.module_api.NOT_SPAM, to allow the operation. Other callbacks may still\\ndecide to reject it. synapse.module_api.errors.Codes to reject the operation with an error code. In case\\nof doubt, synapse.module_api.errors.Codes.FORBIDDEN is a good error code. (deprecated) a non- Codes str to reject the operation and specify an error message. Note that clients\\ntypically will not localize the error message to the user’s preferred locale. (deprecated) False, which is the same as returning synapse.module_api.NOT_SPAM. (deprecated) True, which is the same as returning synapse.module_api.errors.Codes.FORBIDDEN. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one.\\nThe value of the first callback that does not return synapse.module_api.NOT_SPAM will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » check_event_for_spam","id":"692","title":"check_event_for_spam"},"693":{"body":"First introduced in Synapse v1.37.0 Changed in Synapse v1.61.0: synapse.module_api.NOT_SPAM and synapse.module_api.errors.Codes can be returned by this callback. Returning a boolean is now deprecated. async def user_may_join_room(user: str, room: str, is_invited: bool) -> Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\", bool] Called when a user is trying to join a room. The user is represented by their Matrix user ID (e.g. @alice:example.com) and the room is represented by its Matrix ID (e.g. !room:example.com). The module is also given a boolean to indicate whether the user\\ncurrently has a pending invite in the room. This callback isn’t called if the join is performed by a server administrator, or in the\\ncontext of a room creation. The callback must return one of: synapse.module_api.NOT_SPAM, to allow the operation. Other callbacks may still\\ndecide to reject it. synapse.module_api.errors.Codes to reject the operation with an error code. In case\\nof doubt, synapse.module_api.errors.Codes.FORBIDDEN is a good error code. (deprecated) False, which is the same as returning synapse.module_api.NOT_SPAM. (deprecated) True, which is the same as returning synapse.module_api.errors.Codes.FORBIDDEN. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one.\\nThe value of the first callback that does not return synapse.module_api.NOT_SPAM will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_join_room","id":"693","title":"user_may_join_room"},"694":{"body":"First introduced in Synapse v1.37.0 Changed in Synapse v1.62.0: synapse.module_api.NOT_SPAM and synapse.module_api.errors.Codes can be returned by this callback. Returning a boolean is now deprecated. async def user_may_invite(inviter: str, invitee: str, room_id: str) -> Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\", bool] Called when processing an invitation, both when one is created locally or when\\nreceiving an invite over federation. Both inviter and invitee are represented by\\ntheir Matrix user ID (e.g. @alice:example.com). Note that federated invites will call federated_user_may_invite before this callback. The callback must return one of: synapse.module_api.NOT_SPAM, to allow the operation. Other callbacks may still\\ndecide to reject it. synapse.module_api.errors.Codes to reject the operation with an error code. In case\\nof doubt, synapse.module_api.errors.Codes.FORBIDDEN is a good error code. (deprecated) False, which is the same as returning synapse.module_api.NOT_SPAM. (deprecated) True, which is the same as returning synapse.module_api.errors.Codes.FORBIDDEN. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one.\\nThe value of the first callback that does not return synapse.module_api.NOT_SPAM will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_invite","id":"694","title":"user_may_invite"},"695":{"body":"First introduced in Synapse v1.133.0 async def federated_user_may_invite(event: \\"synapse.events.EventBase\\") -> Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\", bool] Called when processing an invitation received over federation. Unlike user_may_invite,\\nthis callback receives the entire event, including any stripped state in the unsigned\\nsection, not just the room and user IDs. The callback must return one of: synapse.module_api.NOT_SPAM, to allow the operation. Other callbacks may still\\ndecide to reject it. synapse.module_api.errors.Codes to reject the operation with an error code. In case\\nof doubt, synapse.module_api.errors.Codes.FORBIDDEN is a good error code. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one.\\nThe value of the first callback that does not return synapse.module_api.NOT_SPAM will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback. If all of the callbacks return synapse.module_api.NOT_SPAM, Synapse will also fall\\nthrough to the user_may_invite callback before approving the invite.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » federated_user_may_invite","id":"695","title":"federated_user_may_invite"},"696":{"body":"First introduced in Synapse v1.45.0 Changed in Synapse v1.62.0: synapse.module_api.NOT_SPAM and synapse.module_api.errors.Codes can be returned by this callback. Returning a boolean is now deprecated. async def user_may_send_3pid_invite( inviter: str, medium: str, address: str, room_id: str,\\n) -> Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\", bool] Called when processing an invitation using a third-party identifier (also called a 3PID,\\ne.g. an email address or a phone number). It is only called when a 3PID invite is created\\nlocally - not when one is received in a room over federation. If the 3PID is already associated\\nwith a Matrix ID, the spam check will go through the user_may_invite callback instead. The inviter is represented by their Matrix user ID (e.g. @alice:example.com), and the\\ninvitee is represented by its medium (e.g. “email”) and its address\\n(e.g. alice@example.com). See the Matrix specification\\nfor more information regarding third-party identifiers. For example, a call to this callback to send an invitation to the email address alice@example.com would look like this: await user_may_send_3pid_invite( \\"@bob:example.com\\", # The inviter\'s user ID \\"email\\", # The medium of the 3PID to invite \\"alice@example.com\\", # The address of the 3PID to invite \\"!some_room:example.com\\", # The ID of the room to send the invite into\\n) Note: If the third-party identifier is already associated with a matrix user ID, user_may_invite will be used instead. The callback must return one of: synapse.module_api.NOT_SPAM, to allow the operation. Other callbacks may still\\ndecide to reject it. synapse.module_api.errors.Codes to reject the operation with an error code. In case\\nof doubt, synapse.module_api.errors.Codes.FORBIDDEN is a good error code. (deprecated) False, which is the same as returning synapse.module_api.NOT_SPAM. (deprecated) True, which is the same as returning synapse.module_api.errors.Codes.FORBIDDEN. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one.\\nThe value of the first callback that does not return synapse.module_api.NOT_SPAM will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_send_3pid_invite","id":"696","title":"user_may_send_3pid_invite"},"697":{"body":"First introduced in Synapse v1.37.0 Changed in Synapse v1.62.0: synapse.module_api.NOT_SPAM and synapse.module_api.errors.Codes can be returned by this callback. Returning a boolean is now deprecated. Changed in Synapse v1.132.0: Added the room_config argument. Callbacks that only expect a single user_id argument are still supported. async def user_may_create_room(user_id: str, room_config: synapse.module_api.JsonDict) -> Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\", bool] Called when processing a room creation or room upgrade request. The arguments passed to this callback are: user_id: The Matrix user ID of the user (e.g. @alice:example.com). room_config: The contents of the body of the /createRoom request as a dictionary.\\nFor a room upgrade request it is a synthesised subset of what an equivalent /createRoom request would have looked like. Specifically, it contains the creation_content (linking to the previous room) and initial_state (containing a\\nsubset of the state of the previous room). The callback must return one of: synapse.module_api.NOT_SPAM, to allow the operation. Other callbacks may still\\ndecide to reject it. synapse.module_api.errors.Codes to reject the operation with an error code. In case\\nof doubt, synapse.module_api.errors.Codes.FORBIDDEN is a good error code. (deprecated) False, which is the same as returning synapse.module_api.NOT_SPAM. (deprecated) True, which is the same as returning synapse.module_api.errors.Codes.FORBIDDEN. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one.\\nThe value of the first callback that does not return synapse.module_api.NOT_SPAM will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_create_room","id":"697","title":"user_may_create_room"},"698":{"body":"First introduced in Synapse v1.37.0 Changed in Synapse v1.62.0: synapse.module_api.NOT_SPAM and synapse.module_api.errors.Codes can be returned by this callback. Returning a boolean is now deprecated. async def user_may_create_room_alias(user_id: str, room_alias: \\"synapse.module_api.RoomAlias\\") -> Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\", bool] Called when trying to associate an alias with an existing room. The callback must return one of: synapse.module_api.NOT_SPAM, to allow the operation. Other callbacks may still\\ndecide to reject it. synapse.module_api.errors.Codes to reject the operation with an error code. In case\\nof doubt, synapse.module_api.errors.Codes.FORBIDDEN is a good error code. (deprecated) False, which is the same as returning synapse.module_api.NOT_SPAM. (deprecated) True, which is the same as returning synapse.module_api.errors.Codes.FORBIDDEN. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one.\\nThe value of the first callback that does not return synapse.module_api.NOT_SPAM will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_create_room_alias","id":"698","title":"user_may_create_room_alias"},"699":{"body":"First introduced in Synapse v1.37.0 Changed in Synapse v1.62.0: synapse.module_api.NOT_SPAM and synapse.module_api.errors.Codes can be returned by this callback. Returning a boolean is now deprecated. async def user_may_publish_room(user_id: str, room_id: str) -> Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\", bool] Called when trying to publish a room to the homeserver’s public rooms directory. The callback must return one of: synapse.module_api.NOT_SPAM, to allow the operation. Other callbacks may still\\ndecide to reject it. synapse.module_api.errors.Codes to reject the operation with an error code. In case\\nof doubt, synapse.module_api.errors.Codes.FORBIDDEN is a good error code. (deprecated) False, which is the same as returning synapse.module_api.NOT_SPAM. (deprecated) True, which is the same as returning synapse.module_api.errors.Codes.FORBIDDEN. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one.\\nThe value of the first callback that does not return synapse.module_api.NOT_SPAM will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_publish_room","id":"699","title":"user_may_publish_room"},"7":{"body":"Prebuilt packages are available for a number of platforms. These are recommended\\nfor most users. Docker images and Ansible playbooks There is an official synapse image available at https://hub.docker.com/r/matrixdotorg/synapse or at ghcr.io/element-hq/synapse\\nwhich can be used with the docker-compose file available at contrib/docker.\\nFurther information on this including configuration options is available in the README\\non hub.docker.com. Alternatively, Andreas Peters (previously Silvio Fricke) has contributed a\\nDockerfile to automate a synapse server in a single Docker image, at https://hub.docker.com/r/avhost/docker-matrix/tags/ Slavi Pantaleev has created an Ansible playbook,\\nwhich installs the official Docker image of Matrix Synapse\\nalong with many other Matrix-related services (Postgres database, Element, coturn,\\nma1sd, SSL support, etc.).\\nFor more details, see https://github.com/spantaleev/matrix-docker-ansible-deploy Debian/Ubuntu Matrix.org packages Matrix.org provides Debian/Ubuntu packages of Synapse, for the amd64\\narchitecture via https://packages.matrix.org/debian/. To install the latest release: sudo apt install -y lsb-release wget apt-transport-https\\nsudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg\\necho \\"deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main\\" | sudo tee /etc/apt/sources.list.d/matrix-org.list\\nsudo apt update\\nsudo apt install matrix-synapse-py3 Packages are also published for release candidates. To enable the prerelease\\nchannel, add prerelease to the sources.list line. For example: sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg\\necho \\"deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main prerelease\\" | sudo tee /etc/apt/sources.list.d/matrix-org.list\\nsudo apt update\\nsudo apt install matrix-synapse-py3 The fingerprint of the repository signing key (as shown by gpg /usr/share/keyrings/matrix-org-archive-keyring.gpg) is AAF9AE843A7584B5A3E4CD2BCF45A512DE2DA058. When installing with Debian packages, you might prefer to place files in /etc/matrix-synapse/conf.d/ to override your configuration without editing\\nthe main configuration file at /etc/matrix-synapse/homeserver.yaml.\\nBy doing that, you won’t be asked if you want to replace your configuration\\nfile when you upgrade the Debian package to a later version. Downstream Debian packages Andrej Shadura maintains a matrix-synapse package in\\nthe Debian repositories.\\nFor forky (14) and sid (rolling release), it can be installed simply with: sudo apt install matrix-synapse The downstream Debian matrix-synapse package is not available for trixie (13) and older. Consider using the Matrix.org packages (above). Downstream Ubuntu packages We do not recommend using the packages in the default Ubuntu repository\\nat this time, as they are old and suffer from known security vulnerabilities.\\nThe latest version of Synapse can be installed from our repository. Fedora Synapse is in the Fedora repositories as matrix-synapse: sudo dnf install matrix-synapse Additionally, Oleg Girko provides Fedora RPMs at https://obs.infoserver.lv/project/monitor/matrix-synapse OpenSUSE Synapse is in the OpenSUSE repositories as matrix-synapse: sudo zypper install matrix-synapse SUSE Linux Enterprise Server Unofficial package are built for SLES 15 in the openSUSE:Backports:SLE-15 repository at https://download.opensuse.org/repositories/openSUSE:/Backports:/SLE-15/standard/ ArchLinux The quickest way to get up and running with ArchLinux is probably with the package provided by ArchLinux https://archlinux.org/packages/extra/x86_64/matrix-synapse/, which should pull in most of\\nthe necessary dependencies. pip may be outdated (6.0.7-1 and needs to be upgraded to 6.0.8-1 ): sudo pip install --upgrade pip If you encounter an error with lib bcrypt causing an Wrong ELF Class:\\nELFCLASS32 (x64 Systems), you may need to reinstall py-bcrypt to correctly\\ncompile it under the right architecture. (This should not be needed if\\ninstalling under virtualenv): sudo pip uninstall py-bcrypt\\nsudo pip install py-bcrypt Alpine Linux Jahway603 maintains Synapse packages for Alpine Linux in the community repository. Install with: sudo apk add synapse Void Linux Synapse can be found in the void repositories as ‘synapse’: xbps-install -Su\\nxbps-install -S synapse FreeBSD Synapse can be installed via FreeBSD Ports or Packages contributed by Brendan Molloy from: Ports: cd /usr/ports/net-im/py-matrix-synapse && make install clean Packages: pkg install py38-matrix-synapse OpenBSD As of OpenBSD 6.7 Synapse is available as a pre-compiled binary. The filesystem\\nunderlying the homeserver directory (defaults to /var/synapse) has to be\\nmounted with wxallowed (cf. mount(8)), so creating a separate filesystem\\nand mounting it to /var/synapse should be taken into consideration. Installing Synapse: doas pkg_add synapse NixOS Robin Lambertz has packaged Synapse for NixOS at: https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/matrix/synapse.nix","breadcrumbs":"Installation » Prebuilt packages","id":"7","title":"Prebuilt packages"},"70":{"body":"If your homeserver’s APIs are accessible on the default federation port (8448)\\nand the domain your server_name points to, you do not need any delegation. For instance, if you registered example.com and pointed its DNS A record at a\\nfresh server, you could install Synapse on that host, giving it a server_name\\nof example.com, and once a reverse proxy has been set up to proxy all requests\\nsent to the port 8448 and serve TLS certificates for example.com, you\\nwouldn’t need any delegation set up. However, if your homeserver’s APIs aren’t accessible on port 8448 and on the\\ndomain server_name points to, you will need to let other servers know how to\\nfind it using delegation.","breadcrumbs":"Delegation » When do I need delegation?","id":"70","title":"When do I need delegation?"},"700":{"body":"First introduced in Synapse v1.132.0 async def user_may_send_state_event(user_id: str, room_id: str, event_type: str, state_key: str, content: JsonDict) -> Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\"] Caution: This callback is currently experimental . The method signature or behaviour\\nmay change without notice. Called when processing a request to send state events to a room. The arguments passed to this callback are: user_id: The Matrix user ID of the user (e.g. @alice:example.com) sending the state event. room_id: The ID of the room that the requested state event is being sent to. event_type: The requested type of event. state_key: The requested state key. content: The requested event contents. The callback must return one of: synapse.module_api.NOT_SPAM, to allow the operation. Other callbacks may still\\ndecide to reject it. synapse.module_api.errors.Codes to reject the operation with an error code. In case\\nof doubt, synapse.module_api.errors.Codes.FORBIDDEN is a good error code. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one.\\nThe value of the first callback that does not return synapse.module_api.NOT_SPAM will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_send_state_event","id":"700","title":"user_may_send_state_event"},"701":{"body":"First introduced in Synapse v1.37.0 async def check_username_for_spam(user_profile: synapse.module_api.UserProfile, requester_id: str) -> bool Called when computing search results in the user directory. The module must return a bool indicating whether the given user should be excluded from user directory\\nsearches. Return True to indicate that the user is spammy and exclude them from\\nsearch results; otherwise return False. The profile is represented as a dictionary with the following keys: user_id: str. The Matrix ID for this user. display_name: str | None. The user’s display name, or None if this user\\nhas not set a display name. avatar_url: str | None. The mxc:// URL to the user’s avatar, or None\\nif this user has not set an avatar. The module is given a copy of the original dictionary, so modifying it from within the\\nmodule cannot modify a user’s profile when included in user directory search results. The requester_id parameter is the ID of the user that called the user directory API. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns False, Synapse falls through to the next one. The value of the first\\ncallback that does not return False will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » check_username_for_spam","id":"701","title":"check_username_for_spam"},"702":{"body":"First introduced in Synapse v1.37.0 async def check_registration_for_spam( email_threepid: dict | None, username: str | None, request_info: Collection[Tuple[str, str]], auth_provider_id: str | None = None,\\n) -> \\"synapse.spam_checker_api.RegistrationBehaviour\\" Called when registering a new user. The module must return a RegistrationBehaviour\\nindicating whether the registration can go through or must be denied, or whether the user\\nmay be allowed to register but will be shadow banned. The arguments passed to this callback are: email_threepid: The email address used for registering, if any. username: The username the user would like to register. Can be None, meaning that\\nSynapse will generate one later. request_info: A collection of tuples, which first item is a user agent, and which\\nsecond item is an IP address. These user agents and IP addresses are the ones that were\\nused during the registration process. auth_provider_id: The identifier of the SSO authentication provider, if any. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns RegistrationBehaviour.ALLOW, Synapse falls through to the next one.\\nThe value of the first callback that does not return RegistrationBehaviour.ALLOW will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » check_registration_for_spam","id":"702","title":"check_registration_for_spam"},"703":{"body":"First introduced in Synapse v1.37.0 Changed in Synapse v1.62.0: synapse.module_api.NOT_SPAM and synapse.module_api.errors.Codes can be returned by this callback. Returning a boolean is now deprecated. async def check_media_file_for_spam( file_wrapper: \\"synapse.media.media_storage.ReadableFileWrapper\\", file_info: \\"synapse.media._base.FileInfo\\",\\n) -> Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\", bool] Called when storing a local or remote file. The callback must return one of: synapse.module_api.NOT_SPAM, to allow the operation. Other callbacks may still\\ndecide to reject it. synapse.module_api.errors.Codes to reject the operation with an error code. In case\\nof doubt, synapse.module_api.errors.Codes.FORBIDDEN is a good error code. (deprecated) False, which is the same as returning synapse.module_api.NOT_SPAM. (deprecated) True, which is the same as returning synapse.module_api.errors.Codes.FORBIDDEN. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one.\\nThe value of the first callback that does not return synapse.module_api.NOT_SPAM will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » check_media_file_for_spam","id":"703","title":"check_media_file_for_spam"},"704":{"body":"First introduced in Synapse v1.60.0 async def should_drop_federated_event(event: \\"synapse.events.EventBase\\") -> bool Called when checking whether a remote server can federate an event with us. Returning True from this function will silently drop a federated event and split-brain our view\\nof a room’s DAG, and thus you shouldn’t use this callback unless you know what you are\\ndoing. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns False, Synapse falls through to the next one. The value of the first\\ncallback that does not return False will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback. Note that this check is applied to federation invites as of Synapse v1.130.0.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » should_drop_federated_event","id":"704","title":"should_drop_federated_event"},"705":{"body":"First introduced in Synapse v1.87.0 async def check_login_for_spam( user_id: str, device_id: str | None, initial_display_name: str | None, request_info: Collection[tuple[str | None, str]], auth_provider_id: str | None = None,\\n) -> Union[\\"synapse.module_api.NOT_SPAM\\", \\"synapse.module_api.errors.Codes\\"] Called when a user logs in. The arguments passed to this callback are: user_id: The user ID the user is logging in with device_id: The device ID the user is re-logging into. initial_display_name: The device display name, if any. request_info: A collection of tuples, which first item is a user agent, and which\\nsecond item is an IP address. These user agents and IP addresses are the ones that were\\nused during the login process. auth_provider_id: The identifier of the SSO authentication provider, if any. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one.\\nThe value of the first callback that does not return synapse.module_api.NOT_SPAM will\\nbe used. If this happens, Synapse will not call any of the subsequent implementations of\\nthis callback. Note: This will not be called when a user registers.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » check_login_for_spam","id":"705","title":"check_login_for_spam"},"706":{"body":"The example below is a module that implements the spam checker callback check_event_for_spam to deny any message sent by users whose Matrix user IDs are\\nmentioned in a configured list, and registers a web resource to the path /_synapse/client/list_spam_checker/is_evil that returns a JSON object indicating\\nwhether the provided user appears in that list. import json\\nfrom typing import Union from twisted.web.resource import Resource\\nfrom twisted.web.server import Request from synapse.module_api import ModuleApi class IsUserEvilResource(Resource): def __init__(self, config): super(IsUserEvilResource, self).__init__() self.evil_users = config.get(\\"evil_users\\") or [] def render_GET(self, request: Request): user = request.args.get(b\\"user\\")[0].decode() request.setHeader(b\\"Content-Type\\", b\\"application/json\\") return json.dumps({\\"evil\\": user in self.evil_users}).encode() class ListSpamChecker: def __init__(self, config: dict, api: ModuleApi): self.api = api self.evil_users = config.get(\\"evil_users\\") or [] self.api.register_spam_checker_callbacks( check_event_for_spam=self.check_event_for_spam, ) self.api.register_web_resource( path=\\"/_synapse/client/list_spam_checker/is_evil\\", resource=IsUserEvilResource(config), ) async def check_event_for_spam(self, event: \\"synapse.events.EventBase\\") -> Literal[\\"NOT_SPAM\\"] | Codes: if event.sender in self.evil_users: return Codes.FORBIDDEN else: return synapse.module_api.NOT_SPAM","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » Example","id":"706","title":"Example"},"707":{"body":"Third party rules callbacks allow module developers to add extra checks to verify the\\nvalidity of incoming events. Third party event rules callbacks can be registered using\\nthe module API’s register_third_party_rules_callbacks method.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » Third party rules callbacks","id":"707","title":"Third party rules callbacks"},"708":{"body":"The available third party rules callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » Callbacks","id":"708","title":"Callbacks"},"709":{"body":"First introduced in Synapse v1.39.0 async def check_event_allowed( event: \\"synapse.events.EventBase\\", state_events: \\"synapse.types.StateMap\\",\\n) -> tuple[bool, dict | None] This callback is very experimental and can and will break without notice. Module developers\\nare encouraged to implement check_event_for_spam from the spam checker category instead. Called when processing any incoming event, with the event and a StateMap\\nrepresenting the current state of the room the event is being sent into. A StateMap is\\na dictionary that maps tuples containing an event type and a state key to the\\ncorresponding state event. For example retrieving the room’s m.room.create event from\\nthe state_events argument would look like this: state_events.get((\\"m.room.create\\", \\"\\")).\\nThe module must return a boolean indicating whether the event can be allowed. Note that this callback function processes incoming events coming via federation\\ntraffic (on top of client traffic). This means denying an event might cause the local\\ncopy of the room’s history to diverge from that of remote servers. This may cause\\nfederation issues in the room. It is strongly recommended to only deny events using this\\ncallback function if the sender is a local user, or in a private federation in which all\\nservers are using the same module, with the same configuration. If the boolean returned by the module is True, it may also tell Synapse to replace the\\nevent with new data by returning the new event’s data as a dictionary. In order to do\\nthat, it is recommended the module calls event.get_dict() to get the current event as a\\ndictionary, and modify the returned dictionary accordingly. If check_event_allowed raises an exception, the module is assumed to have failed.\\nThe event will not be accepted but is not treated as explicitly rejected, either.\\nAn HTTP request causing the module check will likely result in a 500 Internal\\nServer Error. When the boolean returned by the module is False, the event is rejected.\\n(Module developers should not use exceptions for rejection.) Note that replacing the event only works for events sent by local users, not for events\\nreceived over federation. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns True, Synapse falls through to the next one. The value of the first\\ncallback that does not return True will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » check_event_allowed","id":"709","title":"check_event_allowed"},"71":{"body":"Generally, using a reverse proxy for both the federation and client traffic is a good\\nidea, since it saves handling TLS traffic in Synapse. See the reverse proxy documentation for information on setting up a\\nreverse proxy.","breadcrumbs":"Delegation » Should I use a reverse proxy for federation traffic?","id":"71","title":"Should I use a reverse proxy for federation traffic?"},"710":{"body":"First introduced in Synapse v1.39.0 async def on_create_room( requester: \\"synapse.types.Requester\\", request_content: dict, is_requester_admin: bool,\\n) -> None Called when processing a room creation request, with the Requester object for the user\\nperforming the request, a dictionary representing the room creation request’s JSON body\\n(see the spec\\nfor a list of possible parameters), and a boolean indicating whether the user performing\\nthe request is a server admin. Modules can modify the request_content (by e.g. adding events to its initial_state),\\nor deny the room’s creation by raising a module_api.errors.SynapseError. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns without raising an exception, Synapse falls through to the next one. The\\nroom creation will be forbidden as soon as one of the callbacks raises an exception. If\\nthis happens, Synapse will not call any of the subsequent implementations of this\\ncallback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » on_create_room","id":"710","title":"on_create_room"},"711":{"body":"First introduced in Synapse v1.39.0 async def check_threepid_can_be_invited( medium: str, address: str, state_events: \\"synapse.types.StateMap\\",\\n) -> bool: Called when processing an invite via a third-party identifier (i.e. email or phone number).\\nThe module must return a boolean indicating whether the invite can go through. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns True, Synapse falls through to the next one. The value of the first\\ncallback that does not return True will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » check_threepid_can_be_invited","id":"711","title":"check_threepid_can_be_invited"},"712":{"body":"First introduced in Synapse v1.39.0 async def check_visibility_can_be_modified( room_id: str, state_events: \\"synapse.types.StateMap\\", new_visibility: str,\\n) -> bool: Called when changing the visibility of a room in the local public room directory. The\\nvisibility is a string that’s either “public” or “private”. The module must return a\\nboolean indicating whether the change can go through. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns True, Synapse falls through to the next one. The value of the first\\ncallback that does not return True will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » check_visibility_can_be_modified","id":"712","title":"check_visibility_can_be_modified"},"713":{"body":"First introduced in Synapse v1.47.0 async def on_new_event( event: \\"synapse.events.EventBase\\", state_events: \\"synapse.types.StateMap\\",\\n) -> None: Called after sending an event into a room. The module is passed the event, as well\\nas the state of the room after the event. This means that if the event is a state event,\\nit will be included in this state. The state map may not be complete if Synapse hasn’t yet loaded the full state\\nof the room. This can happen for events in rooms that were just joined from\\na remote server. Note that this callback is called when the event has already been processed and stored\\ninto the room, which means this callback cannot be used to deny persisting the event. To\\ndeny an incoming event, see check_event_for_spam instead. For any given event, this callback will be called on every worker process, even if that worker will not end up\\nacting on that event. This callback will not be called for events that are marked as rejected. If multiple modules implement this callback, Synapse runs them all in order.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » on_new_event","id":"713","title":"on_new_event"},"714":{"body":"First introduced in Synapse v1.55.0 async def check_can_shutdown_room( user_id: str, room_id: str,\\n) -> bool: Called when an admin user requests the shutdown of a room. The module must return a\\nboolean indicating whether the shutdown can go through. If the callback returns False,\\nthe shutdown will not proceed and the caller will see a M_FORBIDDEN error. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns True, Synapse falls through to the next one. The value of the first\\ncallback that does not return True will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » check_can_shutdown_room","id":"714","title":"check_can_shutdown_room"},"715":{"body":"First introduced in Synapse v1.55.0 async def check_can_deactivate_user( user_id: str, by_admin: bool,\\n) -> bool: Called when the deactivation of a user is requested. User deactivation can be\\nperformed by an admin or the user themselves, so developers are encouraged to check the\\nrequester when implementing this callback. The module must return a\\nboolean indicating whether the deactivation can go through. If the callback returns False,\\nthe deactivation will not proceed and the caller will see a M_FORBIDDEN error. The module is passed two parameters, user_id which is the ID of the user being deactivated, and by_admin which is True if the request is made by a serve admin, and False otherwise. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns True, Synapse falls through to the next one. The value of the first\\ncallback that does not return True will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » check_can_deactivate_user","id":"715","title":"check_can_deactivate_user"},"716":{"body":"First introduced in Synapse v1.54.0 async def on_profile_update( user_id: str, new_profile: \\"synapse.module_api.ProfileInfo\\", by_admin: bool, deactivation: bool,\\n) -> None: Called after updating a local user’s profile. The update can be triggered either by the\\nuser themselves or a server admin. The update can also be triggered by a user being\\ndeactivated (in which case their display name is set to an empty string ( \\"\\") and the\\navatar URL is set to None). The module is passed the Matrix ID of the user whose profile\\nhas been updated, their new profile, as well as a by_admin boolean that is True if the\\nupdate was triggered by a server admin (and False otherwise), and a deactivated\\nboolean that is True if the update is a result of the user being deactivated. Note that the by_admin boolean is also True if the profile change happens as a result\\nof the user logging in through Single Sign-On, or if a server admin updates their own\\nprofile. Per-room profile changes do not trigger this callback to be called. Synapse administrators\\nwishing this callback to be called on every profile change are encouraged to disable\\nper-room profiles globally using the allow_per_room_profiles configuration setting in\\nSynapse’s configuration file.\\nThis callback is not called when registering a user, even when setting it through the get_displayname_for_registration\\nmodule callback. If multiple modules implement this callback, Synapse runs them all in order.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » on_profile_update","id":"716","title":"on_profile_update"},"717":{"body":"First introduced in Synapse v1.54.0 async def on_user_deactivation_status_changed( user_id: str, deactivated: bool, by_admin: bool\\n) -> None: Called after deactivating a local user, or reactivating them through the admin API. The\\ndeactivation can be triggered either by the user themselves or a server admin. The module\\nis passed the Matrix ID of the user whose status is changed, as well as a deactivated\\nboolean that is True if the user is being deactivated and False if they’re being\\nreactivated, and a by_admin boolean that is True if the deactivation was triggered by\\na server admin (and False otherwise). This latter by_admin boolean is always True\\nif the user is being reactivated, as this operation can only be performed through the\\nadmin API. If multiple modules implement this callback, Synapse runs them all in order.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » on_user_deactivation_status_changed","id":"717","title":"on_user_deactivation_status_changed"},"718":{"body":"First introduced in Synapse v1.56.0 This callback is deprecated in favour of the on_add_user_third_party_identifier callback, which\\nfeatures the same functionality. The only difference is in name. async def on_threepid_bind(user_id: str, medium: str, address: str) -> None: Called after creating an association between a local user and a third-party identifier\\n(email address, phone number). The module is given the Matrix ID of the user the\\nassociation is for, as well as the medium ( email or msisdn) and address of the\\nthird-party identifier. Note that this callback is not called after a successful association on an identity\\nserver. If multiple modules implement this callback, Synapse runs them all in order.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » on_threepid_bind","id":"718","title":"on_threepid_bind"},"719":{"body":"First introduced in Synapse v1.79.0 async def on_add_user_third_party_identifier(user_id: str, medium: str, address: str) -> None: Called after successfully creating an association between a user and a third-party identifier\\n(email address, phone number). The module is given the Matrix ID of the user the\\nassociation is for, as well as the medium ( email or msisdn) and address of the\\nthird-party identifier (i.e. an email address). Note that this callback is not called if a user attempts to bind their third-party identifier\\nto an identity server (via a call to POST /_matrix/client/v3/account/3pid/bind). If multiple modules implement this callback, Synapse runs them all in order.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » on_add_user_third_party_identifier","id":"719","title":"on_add_user_third_party_identifier"},"72":{"body":"Before upgrading check if any special steps are required to upgrade from\\nthe version you currently have installed to the current version of\\nSynapse. The extra instructions that may be required are listed later in\\nthis document. Check that your versions of Python and PostgreSQL are still\\nsupported. Synapse follows upstream lifecycles for Python and PostgreSQL, and removes support for versions\\nwhich are no longer maintained. The website https://endoflife.date also offers convenient\\nsummaries. If Synapse was installed using prebuilt packages,\\nyou will need to follow the normal process for upgrading those packages. If Synapse was installed using pip then upgrade to the latest\\nversion by running: pip install --upgrade matrix-synapse If Synapse was installed from source, then: Obtain the latest version of the source code. Git users can run git pull to do this. If you’re running Synapse in a virtualenv, make sure to activate it before\\nupgrading. For example, if Synapse is installed in a virtualenv in ~/synapse/env then\\nrun: source ~/synapse/env/bin/activate\\npip install --upgrade . Include any relevant extras between square brackets, e.g. pip install --upgrade \\".[postgres,oidc]\\". If you’re using poetry to manage a Synapse installation, run: poetry install Include any relevant extras with --extras, e.g. poetry install --extras postgres --extras oidc.\\nIt’s probably easiest to run poetry install --extras all. Restart Synapse: synctl restart To check whether your update was successful, you can check the running\\nserver version with: # you may need to replace \'localhost:8008\' if synapse is not configured\\n# to listen on port 8008. curl http://localhost:8008/_synapse/admin/v1/server_version","breadcrumbs":"Upgrading between Synapse Versions » Upgrading Synapse","id":"72","title":"Upgrading Synapse"},"720":{"body":"First introduced in Synapse v1.79.0 async def on_remove_user_third_party_identifier(user_id: str, medium: str, address: str) -> None: Called after successfully removing an association between a user and a third-party identifier\\n(email address, phone number). The module is given the Matrix ID of the user the\\nassociation is for, as well as the medium ( email or msisdn) and address of the\\nthird-party identifier (i.e. an email address). Note that this callback is not called if a user attempts to unbind their third-party\\nidentifier from an identity server (via a call to POST /_matrix/client/v3/account/3pid/unbind). If multiple modules implement this callback, Synapse runs them all in order.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » on_remove_user_third_party_identifier","id":"720","title":"on_remove_user_third_party_identifier"},"721":{"body":"The example below is a module that implements the third-party rules callback check_event_allowed to censor incoming messages as dictated by a third-party service. from typing import Optional, Tuple from synapse.module_api import ModuleApi _DEFAULT_CENSOR_ENDPOINT = \\"https://my-internal-service.local/censor-event\\" class EventCensorer: def __init__(self, config: dict, api: ModuleApi): self.api = api self._endpoint = config.get(\\"endpoint\\", _DEFAULT_CENSOR_ENDPOINT) self.api.register_third_party_rules_callbacks( check_event_allowed=self.check_event_allowed, ) async def check_event_allowed( self, event: \\"synapse.events.EventBase\\", state_events: \\"synapse.types.StateMap\\", ) -> Tuple[bool, dict | None]: event_dict = event.get_dict() new_event_content = await self.api.http_client.post_json_get_json( uri=self._endpoint, post_json=event_dict, ) event_dict[\\"content\\"] = new_event_content return event_dict","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » Example","id":"721","title":"Example"},"722":{"body":"Presence router callbacks allow module developers to define additional users\\nwhich receive presence updates from local users. The additional users\\ncan be local or remote. For example, it could be used to direct all of @alice:example.com (a local user)’s\\npresence updates to @bob:matrix.org (a remote user), even though they don’t share a\\nroom. (Note that those presence updates might not make it to @bob:matrix.org’s client\\nunless a similar presence router is running on that homeserver.) Presence router callbacks can be registered using the module API’s register_presence_router_callbacks method.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Presence router callbacks » Presence router callbacks","id":"722","title":"Presence router callbacks"},"723":{"body":"The available presence router callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Presence router callbacks » Callbacks","id":"723","title":"Callbacks"},"724":{"body":"First introduced in Synapse v1.42.0 async def get_users_for_states( state_updates: Iterable[\\"synapse.api.UserPresenceState\\"],\\n) -> dict[str, set[\\"synapse.api.UserPresenceState\\"]] Requires get_interested_users to also be registered Called when processing updates to the presence state of one or more users. This callback can\\nbe used to instruct the server to forward that presence state to specific users. The module\\nmust return a dictionary that maps from Matrix user IDs (which can be local or remote) to the UserPresenceState changes that they should be forwarded. Synapse will then attempt to send the specified presence updates to each user when possible. If multiple modules implement this callback, Synapse merges all the dictionaries returned\\nby the callbacks. If multiple callbacks return a dictionary containing the same key,\\nSynapse concatenates the sets associated with this key from each dictionary.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Presence router callbacks » get_users_for_states","id":"724","title":"get_users_for_states"},"725":{"body":"First introduced in Synapse v1.42.0 async def get_interested_users( user_id: str\\n) -> set[str] | \\"synapse.module_api.PRESENCE_ALL_USERS\\" Requires get_users_for_states to also be registered Called when determining which users someone should be able to see the presence state of. This\\ncallback should return complementary results to get_users_for_state or the presence information\\nmay not be properly forwarded. The callback is given the Matrix user ID for a local user that is requesting presence data and\\nshould return the Matrix user IDs of the users whose presence state they are allowed to\\nquery. The returned users can be local or remote. Alternatively the callback can return synapse.module_api.PRESENCE_ALL_USERS\\nto indicate that the user should receive updates from all known users. If multiple modules implement this callback, they will be considered in order. Synapse\\ncalls each callback one by one, and use a concatenation of all the sets returned by the\\ncallbacks. If one callback returns synapse.module_api.PRESENCE_ALL_USERS, Synapse uses\\nthis value instead. If this happens, Synapse does not call any of the subsequent\\nimplementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Presence router callbacks » get_interested_users","id":"725","title":"get_interested_users"},"726":{"body":"The example below is a module that implements both presence router callbacks, and ensures\\nthat @alice:example.org receives all presence updates from @bob:example.com and @charlie:somewhere.org, regardless of whether Alice shares a room with any of them. from typing import Iterable from synapse.module_api import ModuleApi class CustomPresenceRouter: def __init__(self, config: dict, api: ModuleApi): self.api = api self.api.register_presence_router_callbacks( get_users_for_states=self.get_users_for_states, get_interested_users=self.get_interested_users, ) async def get_users_for_states( self, state_updates: Iterable[\\"synapse.api.UserPresenceState\\"], ) -> dict[str, set[\\"synapse.api.UserPresenceState\\"]]: res = {} for update in state_updates: if ( update.user_id == \\"@bob:example.com\\" or update.user_id == \\"@charlie:somewhere.org\\" ): res.setdefault(\\"@alice:example.com\\", set()).add(update) return res async def get_interested_users( self, user_id: str, ) -> set[str] | \\"synapse.module_api.PRESENCE_ALL_USERS\\": if user_id == \\"@alice:example.com\\": return {\\"@bob:example.com\\", \\"@charlie:somewhere.org\\"} return set()","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Presence router callbacks » Example","id":"726","title":"Example"},"727":{"body":"Account validity callbacks allow module developers to add extra steps to verify the\\nvalidity on an account, i.e. see if a user can be granted access to their account on the\\nSynapse instance. Account validity callbacks can be registered using the module API’s register_account_validity_callbacks method. The available account validity callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Account validity callbacks » Account validity callbacks","id":"727","title":"Account validity callbacks"},"728":{"body":"First introduced in Synapse v1.39.0 async def is_user_expired(user: str) -> bool | None Called when processing any authenticated request (except for logout requests). The module\\ncan return a bool to indicate whether the user has expired and should be locked out of\\ntheir account, or None if the module wasn’t able to figure it out. The user is\\nrepresented by their Matrix user ID (e.g. @alice:example.com). If the module returns True, the current request will be denied with the error code ORG_MATRIX_EXPIRED_ACCOUNT and the HTTP status code 403. Note that this doesn’t\\ninvalidate the user’s access token. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns None, Synapse falls through to the next one. The value of the first\\ncallback that does not return None will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Account validity callbacks » is_user_expired","id":"728","title":"is_user_expired"},"729":{"body":"First introduced in Synapse v1.39.0 async def on_user_registration(user: str) -> None Called after successfully registering a user, in case the module needs to perform extra\\noperations to keep track of them. (e.g. add them to a database table). The user is\\nrepresented by their Matrix user ID. If multiple modules implement this callback, Synapse runs them all in order.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Account validity callbacks » on_user_registration","id":"729","title":"on_user_registration"},"73":{"body":"Rolling back to previous releases can be difficult, due to database\\nschema changes between releases. Where we have been able to test the\\nrollback process, this will be noted below. In general, you will need to undo any changes made during the upgrade\\nprocess, for example: pip: source env/bin/activate\\n# replace `1.3.0` accordingly:\\npip install matrix-synapse==1.3.0 Debian: # replace `1.3.0` and `stretch` accordingly:\\nwget https://packages.matrix.org/debian/pool/main/m/matrix-synapse-py3/matrix-synapse-py3_1.3.0+stretch1_amd64.deb\\ndpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb Generally Synapse database schemas are compatible across multiple versions, but once\\na version of Synapse is deployed you may not be able to roll back automatically.\\nThe following table gives the version ranges and the earliest version they can\\nbe rolled back to. E.g. Synapse versions v1.58.0 through v1.61.1 can be rolled\\nback safely to v1.57.0, but starting with v1.62.0 it is only safe to roll back to\\nv1.61.0. Versions Compatible version v1.0.0 – v1.2.1 v1.0.0 v1.3.0 – v1.8.0 v1.3.0 v1.9.0 – v1.12.4 v1.9.0 v1.13.0 – v1.25.0 v1.13.0 v1.26.0 – v1.44.0 v1.26.0 v1.45.0 – v1.47.1 v1.38.0 v1.48.0 – v1.51.0 v1.39.0 v1.52.0 – v1.57.1 v1.49.0 v1.58.0 – v1.61.1 v1.57.0 v1.62.0 – v1.63.1 v1.61.0 v1.64.0 – v1.69.0 v1.62.0 v1.70.0 – v1.82.0 v1.68.0 v1.83.0 – v1.84.1 v1.77.0 v1.85.0 – v1.91.2 v1.83.0 v1.92.0 – v1.97.0 v1.90.0 v1.98.0 – v1.105.0 v1.96.0 v1.105.1 – v1.164.1 v1.100.0","breadcrumbs":"Upgrading between Synapse Versions » Rolling back to older versions","id":"73","title":"Rolling back to older versions"},"730":{"body":"First introduced in Synapse v1.98.0 async def on_user_login(user_id: str, auth_provider_type: str, auth_provider_id: str) -> None Called after successfully login or registration of a user for cases when module needs to perform extra operations after auth.\\nrepresented by their Matrix user ID. If multiple modules implement this callback, Synapse runs them all in order.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Account validity callbacks » on_user_login","id":"730","title":"on_user_login"},"731":{"body":"Password auth providers offer a way for server administrators to integrate\\ntheir Synapse installation with an external authentication system. The callbacks can be\\nregistered by using the Module API’s register_password_auth_provider_callbacks method.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » Password auth provider callbacks","id":"731","title":"Password auth provider callbacks"},"732":{"body":"","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » Callbacks","id":"732","title":"Callbacks"},"733":{"body":"First introduced in Synapse v1.46.0 auth_checkers: Dict[Tuple[str, Tuple[str, ...]], Callable] A dict mapping from tuples of a login type identifier (such as m.login.password) and a\\ntuple of field names (such as (\\"password\\", \\"secret_thing\\")) to authentication checking\\ncallbacks, which should be of the following form: async def check_auth( user: str, login_type: str, login_dict: \\"synapse.module_api.JsonDict\\",\\n) -> tuple[str, Callable[[\\"synapse.module_api.LoginResponse\\"], Awaitable[None]] | None] | None The login type and field names should be provided by the user in the\\nrequest to the /login API. The Matrix specification\\ndefines some types, however user defined ones are also allowed. The callback is passed the user field provided by the client (which might not be in @username:server form), the login type, and a dictionary of login secrets passed by\\nthe client. If the authentication is successful, the module must return the user’s Matrix ID (e.g. @alice:example.com) and optionally a callback to be called with the response to the /login request. If the module doesn’t wish to return a callback, it must return None\\ninstead. If the authentication is unsuccessful, the module must return None. Note that the user is not automatically registered, the register_user(..) method of\\nthe module API can be used to lazily create users. If multiple modules register an auth checker for the same login type but with different\\nfields, Synapse will refuse to start. If multiple modules register an auth checker for the same login type with the same fields,\\nthen the callbacks will be executed in order, until one returns a Matrix User ID (and\\noptionally a callback). In that case, the return value of that callback will be accepted\\nand subsequent callbacks will not be fired. If every callback returns None, then the\\nauthentication fails.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » auth_checkers","id":"733","title":"auth_checkers"},"734":{"body":"First introduced in Synapse v1.46.0 async def check_3pid_auth( medium: str, address: str, password: str,\\n) -> tuple[str, Callable[[\\"synapse.module_api.LoginResponse\\"], Awaitable[None]] | None] Called when a user attempts to register or log in with a third party identifier,\\nsuch as email. It is passed the medium (eg. email), an address (eg. jdoe@example.com)\\nand the user’s password. If the authentication is successful, the module must return the user’s Matrix ID (e.g. @alice:example.com) and optionally a callback to be called with the response to the /login request.\\nIf the module doesn’t wish to return a callback, it must return None instead. If the authentication is unsuccessful, the module must return None. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns None, Synapse falls through to the next one. The value of the first\\ncallback that does not return None will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback. If every callback returns None,\\nthe authentication is denied.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » check_3pid_auth","id":"734","title":"check_3pid_auth"},"735":{"body":"First introduced in Synapse v1.46.0 async def on_logged_out( user_id: str, device_id: str | None, access_token: str\\n) -> None Called during a logout request for a user. It is passed the qualified user ID, the ID of the\\ndeactivated device (if any: access tokens are occasionally created without an associated\\ndevice ID), and the (now deactivated) access token. Deleting the related pushers is done after calling on_logged_out, so you can rely on them\\nto still be present. If multiple modules implement this callback, Synapse runs them all in order.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » on_logged_out","id":"735","title":"on_logged_out"},"736":{"body":"First introduced in Synapse v1.52.0 async def get_username_for_registration( uia_results: Dict[str, Any], params: Dict[str, Any],\\n) -> str | None Called when registering a new user. The module can return a username to set for the user\\nbeing registered by returning it as a string, or None if it doesn’t wish to force a\\nusername for this user. If a username is returned, it will be used as the local part of a\\nuser’s full Matrix ID (e.g. it’s alice in @alice:example.com). This callback is called once User-Interactive Authentication\\nhas been completed by the user. It is not called when registering a user via SSO. It is\\npassed two dictionaries, which include the information that the user has provided during\\nthe registration process. The first dictionary contains the results of the User-Interactive Authentication\\nflow followed by the user. Its keys are the identifiers of every step involved in the flow,\\nassociated with either a boolean value indicating whether the step was correctly completed,\\nor additional information (e.g. email address, phone number…). A list of most existing\\nidentifiers can be found in the Matrix specification.\\nHere’s an example featuring all currently supported keys: { \\"m.login.dummy\\": True, # Dummy authentication \\"m.login.terms\\": True, # User has accepted the terms of service for the homeserver \\"m.login.recaptcha\\": True, # User has completed the recaptcha challenge \\"m.login.email.identity\\": { # User has provided and verified an email address \\"medium\\": \\"email\\", \\"address\\": \\"alice@example.com\\", \\"validated_at\\": 1642701357084, }, \\"m.login.msisdn\\": { # User has provided and verified a phone number \\"medium\\": \\"msisdn\\", \\"address\\": \\"33123456789\\", \\"validated_at\\": 1642701357084, }, \\"m.login.registration_token\\": \\"sometoken\\", # User has registered through a registration token\\n} The second dictionary contains the parameters provided by the user’s client in the request\\nto /_matrix/client/v3/register. See the Matrix specification\\nfor a complete list of these parameters. If the module cannot, or does not wish to, generate a username for this user, it must\\nreturn None. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns None, Synapse falls through to the next one. The value of the first\\ncallback that does not return None will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback. If every callback returns None,\\nthe username provided by the user is used, if any (otherwise one is automatically\\ngenerated).","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » get_username_for_registration","id":"736","title":"get_username_for_registration"},"737":{"body":"First introduced in Synapse v1.54.0 async def get_displayname_for_registration( uia_results: Dict[str, Any], params: Dict[str, Any],\\n) -> str | None Called when registering a new user. The module can return a display name to set for the\\nuser being registered by returning it as a string, or None if it doesn’t wish to force a\\ndisplay name for this user. This callback is called once User-Interactive Authentication\\nhas been completed by the user. It is not called when registering a user via SSO. It is\\npassed two dictionaries, which include the information that the user has provided during\\nthe registration process. These dictionaries are identical to the ones passed to get_username_for_registration, so refer to the\\ndocumentation of this callback for more information about them. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns None, Synapse falls through to the next one. The value of the first\\ncallback that does not return None will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback. If every callback returns None,\\nthe username will be used (e.g. alice if the user being registered is @alice:example.com).","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » get_displayname_for_registration","id":"737","title":"get_displayname_for_registration"},"738":{"body":"First introduced in Synapse v1.53.0 async def is_3pid_allowed(self, medium: str, address: str, registration: bool) -> bool Called when attempting to bind a third-party identifier (i.e. an email address or a phone\\nnumber). The module is given the medium of the third-party identifier (which is email if\\nthe identifier is an email address, or msisdn if the identifier is a phone number) and\\nits address, as well as a boolean indicating whether the attempt to bind is happening as\\npart of registering a new user. The module must return a boolean indicating whether the\\nidentifier can be allowed to be bound to an account on the local homeserver. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns True, Synapse falls through to the next one. The value of the first\\ncallback that does not return True will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » is_3pid_allowed","id":"738","title":"is_3pid_allowed"},"739":{"body":"The example module below implements authentication checkers for two different login types: my.login.type Expects a my_field field to be sent to /login Is checked by the method: self.check_my_login m.login.password (defined in the spec) Expects a password field to be sent to /login Is checked by the method: self.check_pass from typing import Awaitable, Callable, Optional, Tuple import synapse\\nfrom synapse import module_api class MyAuthProvider: def __init__(self, config: dict, api: module_api): self.api = api self.credentials = { \\"bob\\": \\"building\\", \\"@scoop:matrix.org\\": \\"digging\\", } api.register_password_auth_provider_callbacks( auth_checkers={ (\\"my.login_type\\", (\\"my_field\\",)): self.check_my_login, (\\"m.login.password\\", (\\"password\\",)): self.check_pass, }, ) async def check_my_login( self, username: str, login_type: str, login_dict: \\"synapse.module_api.JsonDict\\", ) -> tuple[str, Callable[[\\"synapse.module_api.LoginResponse\\"], Awaitable[None]] | None] | None: if login_type != \\"my.login_type\\": return None if self.credentials.get(username) == login_dict.get(\\"my_field\\"): return (self.api.get_qualified_user_id(username), None) async def check_pass( self, username: str, login_type: str, login_dict: \\"synapse.module_api.JsonDict\\", ) -> tuple[str, Callable[[\\"synapse.module_api.LoginResponse\\"], Awaitable[None]] | None] | None: if login_type != \\"m.login.password\\": return None if self.credentials.get(username) == login_dict.get(\\"password\\"): return (self.api.get_qualified_user_id(username), None)","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » Example","id":"739","title":"Example"},"74":{"body":"You need to read all of the upgrade notes for each version between your current\\nversion and the latest so that you can update your dependencies, environment,\\nconfig files, etc. if necessary. But you do not need to perform an\\nupgrade to each individual version that was missed. We do not have a list of which versions must be installed. Instead, we recommend\\nthat you upgrade through each incompatible database schema version, which would\\ngive you the ability to roll back the maximum number of versions should anything\\ngo wrong. See Rolling back to older versions\\nabove. Additionally, new versions of Synapse will occasionally run database migrations\\nand background updates to update the database. Synapse will not start until\\ndatabase migrations are complete. You should wait until background updates from\\neach upgrade are complete before moving on to the next upgrade, to avoid\\nstacking them up. You can monitor the currently running background updates with the Admin API.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading from a very old version","id":"74","title":"Upgrading from a very old version"},"740":{"body":"Background update controller callbacks allow module developers to control (e.g. rate-limit)\\nhow database background updates are run. A database background update is an operation\\nSynapse runs on its database in the background after it starts. It’s usually used to run\\ndatabase operations that would take too long if they were run at the same time as schema\\nupdates (which are run on startup) and delay Synapse’s startup too much: populating a\\ntable with a big amount of data, adding an index on a big table, deleting superfluous data,\\netc. Background update controller callbacks can be registered using the module API’s register_background_update_controller_callbacks method. Only the first module (in order\\nof appearance in Synapse’s configuration file) calling this method can register background\\nupdate controller callbacks, subsequent calls are ignored. The available background update controller callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Background update controller callbacks » Background update controller callbacks","id":"740","title":"Background update controller callbacks"},"741":{"body":"First introduced in Synapse v1.49.0 def on_update(update_name: str, database_name: str, one_shot: bool) -> AsyncContextManager[int] Called when about to do an iteration of a background update. The module is given the name\\nof the update, the name of the database, and a flag to indicate whether the background\\nupdate will happen in one go and may take a long time (e.g. creating indices). If this last\\nargument is set to False, the update will be run in batches. The module must return an async context manager. It will be entered before Synapse runs a\\nbackground update; this should return the desired duration of the iteration, in\\nmilliseconds. The context manager will be exited when the iteration completes. Note that the duration\\nreturned by the context manager is a target, and an iteration may take substantially longer\\nor shorter. If the one_shot flag is set to True, the duration returned is ignored. Note: Unlike most module callbacks in Synapse, this one is synchronous. This is\\nbecause asynchronous operations are expected to be run by the async context manager. This callback is required when registering any other background update controller callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Background update controller callbacks » on_update","id":"741","title":"on_update"},"742":{"body":"First introduced in Synapse v1.49.0 async def default_batch_size(update_name: str, database_name: str) -> int Called before the first iteration of a background update, with the name of the update and\\nof the database. The module must return the number of elements to process in this first\\niteration. If this callback is not defined, Synapse will use a default value of 100.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Background update controller callbacks » default_batch_size","id":"742","title":"default_batch_size"},"743":{"body":"First introduced in Synapse v1.49.0 async def min_batch_size(update_name: str, database_name: str) -> int Called before running a new batch for a background update, with the name of the update and\\nof the database. The module must return an integer representing the minimum number of\\nelements to process in this iteration. This number must be at least 1, and is used to\\nensure that progress is always made. If this callback is not defined, Synapse will use a default value of 100.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Background update controller callbacks » min_batch_size","id":"743","title":"min_batch_size"},"744":{"body":"Account data callbacks allow module developers to react to changes of the account data\\nof local users. Account data callbacks can be registered using the module API’s register_account_data_callbacks method.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Account data callbacks » Account data callbacks","id":"744","title":"Account data callbacks"},"745":{"body":"The available account data callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Account data callbacks » Callbacks","id":"745","title":"Callbacks"},"746":{"body":"First introduced in Synapse v1.57.0 async def on_account_data_updated( user_id: str, room_id: str | None, account_data_type: str, content: \\"synapse.module_api.JsonDict\\",\\n) -> None: Called after user’s account data has been updated. The module is given the\\nMatrix ID of the user whose account data is changing, the room ID the data is associated\\nwith, the type associated with the change, as well as the new content. If the account\\ndata is not associated with a specific room, then the room ID is None. This callback is triggered when new account data is added or when the data associated with\\na given type (and optionally room) changes. This includes deletion, since in Matrix,\\ndeleting account data consists of replacing the data associated with a given type\\n(and optionally room) with an empty dictionary ( {}). Note that this doesn’t trigger when changing the tags associated with a room, as these are\\nprocessed separately by Synapse. If multiple modules implement this callback, Synapse runs them all in order.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Account data callbacks » on_account_data_updated","id":"746","title":"on_account_data_updated"},"747":{"body":"The example below is a module that implements the on_account_data_updated callback, and\\nsends an event to an audit room when a user changes their account data. import json\\nimport attr\\nfrom typing import Any, Dict, Optional from synapse.module_api import JsonDict, ModuleApi\\nfrom synapse.module_api.errors import ConfigError @attr.s(auto_attribs=True)\\nclass CustomAccountDataConfig: audit_room: str sender: str class CustomAccountDataModule: def __init__(self, config: CustomAccountDataConfig, api: ModuleApi): self.api = api self.config = config self.api.register_account_data_callbacks( on_account_data_updated=self.log_new_account_data, ) @staticmethod def parse_config(config: Dict[str, Any]) -> CustomAccountDataConfig: def check_in_config(param: str): if param not in config: raise ConfigError(f\\"\'{param}\' is required\\") check_in_config(\\"audit_room\\") check_in_config(\\"sender\\") return CustomAccountDataConfig( audit_room=config[\\"audit_room\\"], sender=config[\\"sender\\"], ) async def log_new_account_data( self, user_id: str, room_id: str | None, account_data_type: str, content: JsonDict, ) -> None: content_raw = json.dumps(content) msg_content = f\\"{user_id} has changed their account data for type {account_data_type} to: {content_raw}\\" if room_id is not None: msg_content += f\\" (in room {room_id})\\" await self.api.create_and_send_event_into_room( { \\"room_id\\": self.config.audit_room, \\"sender\\": self.config.sender, \\"type\\": \\"m.room.message\\", \\"content\\": { \\"msgtype\\": \\"m.text\\", \\"body\\": msg_content } } )","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Account data callbacks » Example","id":"747","title":"Example"},"748":{"body":"First introduced in Synapse v1.96.0 This callback allows modules to add extra fields to the unsigned section of\\nevents when they get sent down to clients. These get called every time an event is to be sent to clients, so care should\\nbe taken to ensure with respect to performance.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Add extra fields to client events unsigned section callbacks » Add extra fields to client events unsigned section callbacks","id":"748","title":"Add extra fields to client events unsigned section callbacks"},"749":{"body":"To register the callback, use register_add_extra_fields_to_unsigned_client_event_callbacks on the ModuleApi. The callback should be of the form async def add_field_to_unsigned( event: EventBase,\\n) -> JsonDict: where the extra fields to add to the event’s unsigned section is returned.\\n(Modules must not attempt to modify the event directly). This cannot be used to alter the “core” fields in the unsigned section emitted\\nby Synapse itself. If multiple such callbacks try to add the same field to an event’s unsigned\\nsection, the last-registered callback wins.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Add extra fields to client events unsigned section callbacks » API","id":"749","title":"API"},"75":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.164.0","id":"75","title":"Upgrading to v1.164.0"},"750":{"body":"Federation callbacks can be registered using the module API’s register_federation_callbacks method.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Federation callbacks » Federation callbacks","id":"750","title":"Federation callbacks"},"751":{"body":"The available federation callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Federation callbacks » Callbacks","id":"751","title":"Callbacks"},"752":{"body":"First introduced in Synapse v1.158.0 async def on_event_delivered_over_federation( event: FederationEventDeliveryEvent,\\n) -> None: Called when an event has been delivered over federation.\\nSee FederationEventDeliveryEvent for detailed information available on the event. Note that depending on the specific method, delivery may not have\\nactually been acknowledged by the other homeserver.\\nSee FederatedEventDeliveryMethod for details on which cases imply acknowledgment. Modules should anticipate more methods being added to the FederatedEventDeliveryMethod enum\\nover time (it is non-exhaustive). Only methods that deliver full, signed PDUs are included in this mechanism.\\nSome notable examples of excluded endpoints: /send_knock is excluded as it only returns unsigned ‘stripped state’. /timestamp_to_event is excluded as it only returns event IDs, not events themselves. If multiple modules implement this callback, Synapse runs them all in order.\\nExceptions are logged and otherwise ignored. Performance note: Registering this hook causes a performance (caching) optimisation on the\\nFederation /state endpoint to be bypassed.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Federation callbacks » on_event_delivered_over_federation","id":"752","title":"on_event_delivered_over_federation"},"753":{"body":"Media repository callbacks allow module developers to customise the behaviour of the\\nmedia repository on a per user basis. Media repository callbacks can be registered\\nusing the module API’s register_media_repository_callbacks method. The available media repository callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Media repository callbacks » Media repository callbacks","id":"753","title":"Media repository callbacks"},"754":{"body":"First introduced in Synapse v1.132.0 async def get_media_config_for_user(user_id: str) -> JsonDict | None Caution: This callback is currently experimental . The method signature or behaviour\\nmay change without notice. Called when processing a request from a client for the media config endpoint. The arguments passed to this callback are: user_id: The Matrix user ID of the user (e.g. @alice:example.com) making the request. If the callback returns a dictionary then it will be used as the body of the response to the\\nclient. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns None, Synapse falls through to the next one. The value of the first\\ncallback that does not return None will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback. If no module returns a non- None value then the default media config will be returned.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Media repository callbacks » get_media_config_for_user","id":"754","title":"get_media_config_for_user"},"755":{"body":"First introduced in Synapse v1.132.0 async def is_user_allowed_to_upload_media_of_size(user_id: str, size: int) -> bool Caution: This callback is currently experimental . The method signature or behaviour\\nmay change without notice. Called before media is accepted for upload from a user, in case the module needs to\\nenforce a different limit for the particular user. The arguments passed to this callback are: user_id: The Matrix user ID of the user (e.g. @alice:example.com) making the request. size: The size in bytes of media that is being requested to upload. If the module returns False, the current request will be denied with the error code M_TOO_LARGE and the HTTP status code 413. If multiple modules implement this callback, they will be considered in order. If a callback\\nreturns True, Synapse falls through to the next one. The value of the first callback that\\nreturns False will be used. If this happens, Synapse will not call any of the subsequent\\nimplementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Media repository callbacks » is_user_allowed_to_upload_media_of_size","id":"755","title":"is_user_allowed_to_upload_media_of_size"},"756":{"body":"First introduced in Synapse v1.139.0 async def get_media_upload_limits_for_user(user_id: str, size: int) -> list[synapse.module_api.MediaUploadLimit] | None Caution: This callback is currently experimental. The method signature or behaviour\\nmay change without notice. Called when processing a request to store content in the media repository. This can be used to dynamically override\\nthe media upload limits configuration. The arguments passed to this callback are: user_id: The Matrix user ID of the user (e.g. @alice:example.com) making the request. If the callback returns a list then it will be used as the limits instead of those in the configuration (if any). If an empty list is returned then no limits are applied ( warning: users will be able\\nto upload as much data as they desire). If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns None, Synapse falls through to the next one. The value of the first\\ncallback that does not return None will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback. If there are no registered modules, or if all modules return None, then\\nthe default media upload limits configuration\\nwill be used.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Media repository callbacks » get_media_upload_limits_for_user","id":"756","title":"get_media_upload_limits_for_user"},"757":{"body":"First introduced in Synapse v1.139.0 async def on_media_upload_limit_exceeded(user_id: str, limit: synapse.module_api.MediaUploadLimit, sent_bytes: int, attempted_bytes: int) -> None Caution: This callback is currently experimental. The method signature or behaviour\\nmay change without notice. Called when a user attempts to upload media that would exceed a configured media upload limit. This could be used to inform the user that they have reached a media upload limit through\\nsome external method. The arguments passed to this callback are: user_id: The Matrix user ID of the user (e.g. @alice:example.com) making the request. limit: The synapse.module_api.MediaUploadLimit representing the limit that was reached. sent_bytes: The number of bytes already sent during the period of the limit. attempted_bytes: The number of bytes that the user attempted to send.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Media repository callbacks » on_media_upload_limit_exceeded","id":"757","title":"on_media_upload_limit_exceeded"},"758":{"body":"Ratelimit callbacks allow module developers to override ratelimit settings dynamically whilst\\nSynapse is running. Ratelimit callbacks can be registered using the module API’s register_ratelimit_callbacks method. The available ratelimit callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Ratelimit callbacks » Ratelimit callbacks","id":"758","title":"Ratelimit callbacks"},"759":{"body":"First introduced in Synapse v1.132.0 async def get_ratelimit_override_for_user(user: str, limiter_name: str) -> synapse.module_api.RatelimitOverride | None Caution: This callback is currently experimental . The method signature or behaviour\\nmay change without notice. Called when constructing a ratelimiter of a particular type for a user. The module can\\nreturn a messages_per_second and burst_count to be used, or None if\\nthe default settings are adequate. The user is represented by their Matrix user ID\\n(e.g. @alice:example.com). The limiter name is usually taken from the RatelimitSettings key\\nvalue. The limiters that are currently supported are: rc_invites.per_room rc_invites.per_user rc_invites.per_issuer The RatelimitOverride return type has the following fields: per_second: float. The number of actions that can be performed in a second. 0.0 means that ratelimiting is disabled. burst_count: int. The number of actions that can be performed before being limited. If multiple modules implement this callback, they will be considered in order. If a\\ncallback returns None, Synapse falls through to the next one. The value of the first\\ncallback that does not return None will be used. If this happens, Synapse will not call\\nany of the subsequent implementations of this callback. If no module returns a non- None value\\nthen the default settings will be used.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Ratelimit callbacks » get_ratelimit_override_for_user","id":"759","title":"get_ratelimit_override_for_user"},"76":{"body":"The minimum supported Python version has been increased from v3.10 to v3.11.\\nYou will need Python 3.11+ to run Synapse v1.164.0. If you use current versions of the matrixorg/synapse\\nDocker images, no action is required.","breadcrumbs":"Upgrading between Synapse Versions » Python 3.11+ is now required","id":"76","title":"Python 3.11+ is now required"},"760":{"body":"In order to port a module that uses Synapse’s old module interface, its author needs to: ensure the module’s callbacks are all asynchronous. register their callbacks using one or more of the register_[...]_callbacks methods\\nfrom the ModuleApi class in the module’s __init__ method (see this section\\nfor more info). Additionally, if the module is packaged with an additional web resource, the module\\nshould register this resource in its __init__ method using the register_web_resource\\nmethod from the ModuleApi class (see this section for\\nmore info). There is no longer a get_db_schema_files callback provided for password auth provider modules. Any\\nchanges to the database should now be made by the module using the module API class. The module’s author should also update any example in the module’s configuration to only\\nuse the new modules section in Synapse’s configuration file (see this section\\nfor more info).","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Porting a legacy module to the new interface » Porting an existing module that uses the old interface","id":"760","title":"Porting an existing module that uses the old interface"},"761":{"body":"For small instances it is recommended to run Synapse in the default monolith mode.\\nFor larger instances where performance is a concern it can be helpful to split\\nout functionality into multiple separate python processes. These processes are\\ncalled ‘workers’, and are (eventually) intended to scale horizontally\\nindependently. Synapse’s worker support is under active development and subject to change as\\nwe attempt to rapidly scale ever larger Synapse instances. However we are\\ndocumenting it here to help admins needing a highly scalable Synapse instance\\nsimilar to the one running matrix.org. All processes continue to share the same database instance, and as such,\\nworkers only work with PostgreSQL-based Synapse deployments. SQLite should only\\nbe used for demo purposes and any admin considering workers should already be\\nrunning PostgreSQL. See also Matrix.org blog post\\nfor a higher level overview.","breadcrumbs":"Configuration » Workers » Scaling synapse via workers","id":"761","title":"Scaling synapse via workers"},"762":{"body":"The processes communicate with each other via a Synapse-specific protocol called\\n‘replication’ (analogous to MySQL- or Postgres-style database replication) which\\nfeeds streams of newly written data between processes so they can be kept in\\nsync with the database state. When configured to do so, Synapse uses a Redis pub/sub channel to send the replication\\nstream between all configured Synapse processes. Additionally, processes may\\nmake HTTP requests to each other, primarily for operations which need to wait\\nfor a reply ─ such as sending an event. All the workers and the main process connect to Redis, which relays replication\\ncommands between processes. If Redis support is enabled Synapse will use it as a shared cache, as well as a\\npub/sub mechanism. See the Architectural diagram section at the end for\\na visualisation of what this looks like.","breadcrumbs":"Configuration » Workers » Main process/worker communication","id":"762","title":"Main process/worker communication"},"763":{"body":"A Redis server is required to manage the communication between the processes.\\nThe Redis server should be installed following the normal procedure for your\\ndistribution (e.g. apt install redis-server on Debian). It is safe to use an\\nexisting Redis deployment if you have one. Once installed, check that Redis is running and accessible from the host running\\nSynapse, for example by executing echo PING | nc -q1 localhost 6379 and seeing\\na response of +PONG. The appropriate dependencies must also be installed for Synapse. If using a\\nvirtualenv, these can be installed with: pip install \\"matrix-synapse[redis]\\" Note that these dependencies are included when Synapse is installed with pip install matrix-synapse[all]. They are also included in the Debian\\npackages and in the Docker\\nimages. To make effective use of the workers, you will need to configure an HTTP\\nreverse-proxy such as nginx or haproxy, which will direct incoming requests to\\nthe correct worker, or to the main synapse instance. See the reverse proxy documentation for information on setting up a reverse\\nproxy. When using workers, each worker process has its own configuration file which\\ncontains settings specific to that worker, such as the HTTP listener that it\\nprovides (if any), logging configuration, etc. Normally, the worker processes are configured to read from a shared\\nconfiguration file as well as the worker-specific configuration files. This\\nmakes it easier to keep common configuration settings synchronised across all\\nthe processes. The main process is somewhat special in this respect: it does not normally\\nneed its own configuration file and can take all of its configuration from the\\nshared configuration file.","breadcrumbs":"Configuration » Workers » Setting up workers","id":"763","title":"Setting up workers"},"764":{"body":"Normally, only a few changes are needed to make an existing configuration\\nfile suitable for use with workers: First, you need to enable an “HTTP replication listener”\\nfor the main process Secondly, you need to enable redis-based replication You will need to add an instance_map\\nwith the main process defined, as well as the relevant connection information from\\nit’s HTTP replication listener (defined in step 1 above). Note that the host defined is the address the worker needs to look for the main\\nprocess at, not necessarily the same address that is bound to. If you are using Unix sockets for the replication resource, make sure to\\nuse a path to the socket file instead of a port. Optionally, a shared secret\\ncan be used to authenticate HTTP traffic between workers. For example: # extend the existing `listeners` section. This defines the ports that the\\n# main process will listen on.\\nlisteners: # The HTTP replication port - port: 9093 bind_address: \'127.0.0.1\' type: http resources: - names: [replication] # Add a random shared secret to authenticate traffic.\\nworker_replication_secret: \\"\\" redis: enabled: true # For additional Redis configuration options (TLS, authentication, etc.), # see the Synapse configuration documentation: # https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#redis instance_map: main: host: \'localhost\' port: 9093 See the configuration manual\\nfor the full documentation of each option. Under no circumstances should the replication listener be exposed to the\\npublic internet; replication traffic is: always unencrypted unauthenticated, unless worker_replication_secret\\nis configured","breadcrumbs":"Configuration » Workers » Shared configuration","id":"764","title":"Shared configuration"},"765":{"body":"In the config file for each worker, you must specify: The type of worker ( worker_app).\\nThe currently available worker applications are listed below. A unique name for the worker ( worker_name). If handling HTTP requests, a worker_listeners option\\nwith an http listener. Synapse 1.72 and older: if handling the ^/_matrix/client/v3/keys/upload endpoint, the HTTP URI for\\nthe main process ( worker_main_http_uri). This config option is no longer required and is ignored when running Synapse 1.73 and newer. For example: worker_app: synapse.app.generic_worker\\nworker_name: generic_worker1 worker_listeners: - type: http port: 8083 x_forwarded: true resources: - names: [client, federation] worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml …is a full configuration for a generic worker instance, which will expose a\\nplain HTTP endpoint on port 8083 separately serving various endpoints, e.g. /sync, which are listed below. Obviously you should configure your reverse-proxy to route the relevant\\nendpoints to the worker ( localhost:8083 in the above example).","breadcrumbs":"Configuration » Workers » Worker configuration","id":"765","title":"Worker configuration"},"766":{"body":"Finally, you need to start your worker processes. This can be done with either synctl or your distribution’s preferred service manager such as systemd. We\\nrecommend the use of systemd where available: for information on setting up systemd to start synapse workers, see Systemd with Workers. To use synctl, see Using synctl with Workers.","breadcrumbs":"Configuration » Workers » Running Synapse with workers","id":"766","title":"Running Synapse with workers"},"767":{"body":"The following applies to Synapse installations that have been installed from source using poetry. You can start the main Synapse process with Poetry by running the following command: poetry run synapse_homeserver --config-path [your homeserver.yaml] For worker setups, you can run the following command poetry run synapse_worker --config-path [your homeserver.yaml] --config-path [your worker.yaml]","breadcrumbs":"Configuration » Workers » Start Synapse with Poetry","id":"767","title":"Start Synapse with Poetry"},"768":{"body":"","breadcrumbs":"Configuration » Workers » Available worker applications","id":"768","title":"Available worker applications"},"769":{"body":"This worker can handle API requests matching the following regular expressions.\\nThese endpoints can be routed to any worker. If a worker is set up to handle a\\nstream then, for maximum efficiency, additional endpoints should be routed to that\\nworker: refer to the stream writers section below for further\\ninformation. # Sync requests\\n^/_matrix/client/(r0|v3)/sync$\\n^/_matrix/client/(api/v1|r0|v3)/events$\\n^/_matrix/client/(api/v1|r0|v3)/initialSync$\\n^/_matrix/client/(api/v1|r0|v3)/rooms/[^/]+/initialSync$ # Federation requests\\n^/_matrix/federation/v1/version$\\n^/_matrix/federation/v1/event/\\n^/_matrix/federation/v1/state/\\n^/_matrix/federation/v1/state_ids/\\n^/_matrix/federation/v1/backfill/\\n^/_matrix/federation/v1/get_missing_events/\\n^/_matrix/federation/v1/publicRooms\\n^/_matrix/federation/v1/query/\\n^/_matrix/federation/v1/make_join/\\n^/_matrix/federation/v1/make_leave/\\n^/_matrix/federation/(v1|v2)/send_join/\\n^/_matrix/federation/(v1|v2)/send_leave/\\n^/_matrix/federation/v1/make_knock/\\n^/_matrix/federation/v1/send_knock/\\n^/_matrix/federation/(v1|v2)/invite/\\n^/_matrix/federation/v1/event_auth/\\n^/_matrix/federation/v1/timestamp_to_event/\\n^/_matrix/federation/v1/exchange_third_party_invite/\\n^/_matrix/federation/v1/user/devices/\\n^/_matrix/key/v2/query\\n^/_matrix/federation/v1/hierarchy/ # Inbound federation transaction request\\n^/_matrix/federation/v1/send/ # Client API requests\\n^/_matrix/client/(api/v1|r0|v3|unstable)/createRoom$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/publicRooms$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/joined_members$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/context/.*$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/members$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/state$\\n^/_matrix/client/v1/rooms/.*/hierarchy$\\n^/_matrix/client/(v1|unstable)/rooms/.*/relations/\\n^/_matrix/client/v1/rooms/.*/threads$\\n^/_matrix/client/unstable/im.nheko.summary/summary/.*$\\n^/_matrix/client/v1/room_summary/.*$\\n^/_matrix/client/(r0|v3|unstable)/account/3pid$\\n^/_matrix/client/(r0|v3|unstable)/account/whoami$\\n^/_matrix/client/(r0|v3|unstable)/account/deactivate$\\n^/_matrix/client/(r0|v3)/delete_devices$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/devices(/|$)\\n^/_matrix/client/versions$\\n^/_matrix/client/(v1|unstable/org.matrix.msc2965)/auth_metadata$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/voip/turnServer$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/event/\\n^/_matrix/client/(api/v1|r0|v3|unstable)/joined_rooms$\\n^/_matrix/client/v1/rooms/.*/timestamp_to_event$\\n^/_matrix/client/(api/v1|r0|v3|unstable/.*)/rooms/.*/aliases\\n^/_matrix/client/(api/v1|r0|v3|unstable)/search$\\n^/_matrix/client/(r0|v3|unstable)/user/.*/filter(/|$)\\n^/_matrix/client/(api/v1|r0|v3|unstable)/directory/room/.*$\\n^/_matrix/client/(r0|v3|unstable)/capabilities$\\n^/_matrix/client/(r0|v3|unstable)/notifications$ # Admin API requests\\n^/_synapse/admin/v1/rooms/[^/]+$ # Encryption requests\\n^/_matrix/client/(r0|v3|unstable)/keys/query$\\n^/_matrix/client/(r0|v3|unstable)/keys/changes$\\n^/_matrix/client/(r0|v3|unstable)/keys/claim$\\n^/_matrix/client/(r0|v3|unstable)/room_keys/\\n^/_matrix/client/(r0|v3|unstable)/keys/upload\\n^/_matrix/client/(api/v1|r0|v3|unstable)/keys/device_signing/upload$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/keys/signatures/upload$ # Registration/login requests\\n^/_matrix/client/(api/v1|r0|v3|unstable)/login$\\n^/_matrix/client/(r0|v3|unstable)/register$\\n^/_matrix/client/(r0|v3|unstable)/register/available$\\n^/_matrix/client/v1/register/m.login.registration_token/validity$\\n^/_matrix/client/(r0|v3|unstable)/password_policy$ # Event sending requests\\n^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/redact\\n^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/send\\n^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/state/\\n^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/(join|invite|leave|ban|unban|kick)$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/join/\\n^/_matrix/client/(api/v1|r0|v3|unstable)/knock/\\n^/_matrix/client/(api/v1|r0|v3|unstable)/profile/ # User directory search requests\\n^/_matrix/client/(r0|v3|unstable)/user_directory/search$ # Unstable MSC4140 support (delayed event scheduling & management)\\n^/_matrix/client/unstable/org.matrix.msc4140/rooms/.*/delayed_event/\\n^/_matrix/client/unstable/org.matrix.msc4140/delayed_events(/[^/]+(/restart)?)?$ # Stabilised Delegated Authentication support (`matrix_authentication_service.enabled: true`)\\n^/_synapse/mas/ Additionally, the following REST endpoints can be handled for GET requests: # Push rules requests\\n^/_matrix/client/(api/v1|r0|v3|unstable)/pushrules/ # Account data requests\\n^/_matrix/client/(r0|v3|unstable)/.*/tags\\n^/_matrix/client/(r0|v3|unstable)/.*/account_data # Presence requests\\n^/_matrix/client/(api/v1|r0|v3|unstable)/presence/ # Admin API requests\\n^/_synapse/admin/v2/users/[^/]+$ Pagination requests can also be handled, but all requests for a given\\nroom must be routed to the same instance. Additionally, care must be taken to\\nensure that the purge history admin API is not used while pagination requests\\nfor the room are in flight: ^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/messages$ Additionally, the following endpoints should be included if Synapse is configured\\nto use SSO (you only need to include the ones for whichever SSO provider you’re\\nusing) and delegated authentication isn’t enabled: # for all SSO providers\\n^/_matrix/client/(api/v1|r0|v3|unstable)/login/sso/redirect\\n^/_synapse/client/pick_idp$\\n^/_synapse/client/pick_username\\n^/_synapse/client/new_user_consent$\\n^/_synapse/client/sso_register$ # OpenID Connect requests.\\n^/_synapse/client/oidc/callback$ # SAML requests.\\n^/_synapse/client/saml2/authn_response$ # CAS requests.\\n^/_matrix/client/(api/v1|r0|v3|unstable)/login/cas/ticket$ Ensure that all SSO logins go to a single process.\\nFor multiple workers not handling the SSO endpoints properly, see #7530 and #9427. Note that a HTTP listener\\nwith client and federation resources must be configured in the worker_listeners\\noption in the worker config. Load balancing It is possible to run multiple instances of this worker app, with incoming requests\\nbeing load-balanced between them by the reverse-proxy. However, different endpoints\\nhave different characteristics and so admins\\nmay wish to run multiple groups of workers handling different endpoints so that\\nload balancing can be done in different ways. For /sync and /initialSync requests it will be more efficient if all\\nrequests from a particular user are routed to a single instance. This can\\nbe done in reverse proxy by extracting username part from the users access token. Admins may additionally wish to separate out /sync\\nrequests that have a since query parameter from those that don’t (and /initialSync), as requests that don’t are known as “initial sync” that happens\\nwhen a user logs in on a new device and can be very resource intensive, so\\nisolating these requests will stop them from interfering with other users ongoing\\nsyncs. Example nginx configuration snippet that handles the cases above. This is just an\\nexample and probably requires some changes according to your particular setup: # Choose sync worker based on the existence of \\"since\\" query parameter\\nmap $arg_since $sync { default synapse_sync; \'\' synapse_initial_sync;\\n} # Extract username from access token passed as URL parameter\\nmap $arg_access_token $accesstoken_from_urlparam { # Defaults to just passing back the whole accesstoken default $arg_access_token; # Try to extract username part from accesstoken URL parameter \\"~syt_(?.*?)_.*\\" $username;\\n} # Extract username from access token passed as authorization header\\nmap $http_authorization $mxid_localpart { # Defaults to just passing back the whole accesstoken default $http_authorization; # Try to extract username part from accesstoken header \\"~Bearer syt_(?.*?)_.*\\" $username; # if no authorization-header exist, try mapper for URL parameter \\"access_token\\" \\"\\" $accesstoken_from_urlparam;\\n} upstream synapse_initial_sync { # Use the username mapper result for hash key hash $mxid_localpart consistent; server 127.0.0.1:8016; server 127.0.0.1:8036;\\n} upstream synapse_sync { # Use the username mapper result for hash key hash $mxid_localpart consistent; server 127.0.0.1:8013; server 127.0.0.1:8037; server 127.0.0.1:8038; server 127.0.0.1:8039;\\n} # Sync initial/normal\\nlocation ~ ^/_matrix/client/(r0|v3)/sync$ { proxy_pass http://$sync;\\n} # Normal sync\\nlocation ~ ^/_matrix/client/(api/v1|r0|v3)/events$ { proxy_pass http://synapse_sync;\\n} # Initial_sync\\nlocation ~ ^/_matrix/client/(api/v1|r0|v3)/initialSync$ { proxy_pass http://synapse_initial_sync;\\n}\\nlocation ~ ^/_matrix/client/(api/v1|r0|v3)/rooms/[^/]+/initialSync$ { proxy_pass http://synapse_initial_sync;\\n} Federation and client requests can be balanced via simple round robin. The inbound federation transaction request ^/_matrix/federation/v1/send/\\nshould be balanced by source IP so that transactions from the same remote server\\ngo to the same process. Registration/login requests can be handled separately purely to help ensure that\\nunexpected load doesn’t affect new logins and sign ups. Finally, event sending requests can be balanced by the room ID in the URI (or\\nthe full URI, or even just round robin), the room ID is the path component after /rooms/. If there is a large bridge connected that is sending or may send lots\\nof events, then a dedicated set of workers can be provisioned to limit the\\neffects of bursts of events from that bridge on events sent by normal users. Stream writers Additionally, the writing of specific streams (such as events) can be moved off\\nof the main process to a particular worker. To enable this, the worker must have: An HTTP replication listener configured, Have a worker_name\\nand be listed in the instance_map\\nconfig. Have the main process declared on the instance_map as well. Note: The same worker can handle multiple streams, but unless otherwise documented,\\neach stream can only have a single writer. For example, to move event persistence off to a dedicated worker, the shared\\nconfiguration would include: instance_map: main: host: localhost port: 8030 event_persister1: host: localhost port: 8034 stream_writers: events: event_persister1 An example for a stream writer instance: worker_app: synapse.app.generic_worker\\nworker_name: event_persister1 worker_listeners: - type: http port: 8034 resources: - names: [replication] # Enable listener if this stream writer handles endpoints for the `typing` or # `to_device` streams. Uses a different port to the `replication` listener to # avoid exposing the `replication` listener publicly. # #- type: http # port: 8035 # x_forwarded: true # resources: # - names: [client] worker_log_config: /etc/matrix-synapse/event-persister-log.yaml Some of the streams have associated endpoints which, for maximum efficiency, should\\nbe routed to the workers handling that stream. See below for the currently supported\\nstreams and the endpoints associated with them: The events stream The events stream experimentally supports having multiple writer workers, where load\\nis sharded between them by room ID. Each writer is called an event persister. They are\\nresponsible for receiving new events, linking them to those already in the room DAG, persisting them to the DB, and finally updating the events stream. Because load is sharded in this way, you must restart all worker instances when\\nadding or removing event persisters. An event_persister should not be mistaken for an event_creator.\\nAn event_creator listens for requests from clients to create new events and does\\nso. It will then pass those events over HTTP replication to any configured event\\npersisters (or the main process if none are configured). Note that event_creators and event_persisters are implemented using the same synapse.app.generic_worker. An example stream_writers\\nconfiguration with multiple writers: stream_writers: events: - event_persister1 - event_persister2 The typing stream The following endpoints should be routed directly to the worker configured as\\nthe stream writer for the typing stream: ^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/typing The to_device stream The following endpoints should be routed directly to the worker configured as\\nthe stream writer for the to_device stream: ^/_matrix/client/(r0|v3|unstable)/sendToDevice/ The account_data stream The following endpoints should be routed directly to the worker configured as\\nthe stream writer for the account_data stream: ^/_matrix/client/(r0|v3|unstable)/.*/tags\\n^/_matrix/client/(r0|v3|unstable)/.*/account_data The receipts stream The receipts stream supports multiple writers. The following endpoints\\ncan be handled by any worker, but should be routed directly to one of the workers\\nconfigured as stream writer for the receipts stream: ^/_matrix/client/(r0|v3|unstable)/rooms/.*/receipt\\n^/_matrix/client/(r0|v3|unstable)/rooms/.*/read_markers The presence stream The following endpoints should be routed directly to the worker configured as\\nthe stream writer for the presence stream: ^/_matrix/client/(api/v1|r0|v3|unstable)/presence/ The push_rules stream The following endpoints should be routed directly to the worker configured as\\nthe stream writer for the push_rules stream: ^/_matrix/client/(api/v1|r0|v3|unstable)/pushrules/ The device_lists stream The device_lists stream supports multiple writers. The following endpoints\\ncan be handled by any worker, but should be routed directly to one of the workers\\nconfigured as stream writer for the device_lists stream: ^/_matrix/client/(r0|v3)/delete_devices$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/devices(/|$)\\n^/_matrix/client/(r0|v3|unstable)/keys/upload\\n^/_matrix/client/(api/v1|r0|v3|unstable)/keys/device_signing/upload$\\n^/_matrix/client/(api/v1|r0|v3|unstable)/keys/signatures/upload$ The quarantined_media_changes stream The quarantined_media_changes stream supports multiple writers. The following endpoints\\nmust be routed directly to one of the workers configured as stream writer for the quarantined_media_changes stream (which must also be able to run the media\\nrepository, as these endpoints are only registered on media-capable workers): ^/_synapse/admin/v1/quarantine_media/.*$\\n^/_synapse/admin/v1/room/.*/media/quarantine$\\n^/_synapse/admin/v1/user/.*/media/quarantine$\\n^/_synapse/admin/v1/media/quarantine/.*$\\n^/_synapse/admin/v1/media/unquarantine/.*$ Restrict outbound federation traffic to a specific set of workers The outbound_federation_restricted_to\\nconfiguration is useful to make sure outbound federation traffic only goes through a\\nspecified subset of workers. This allows you to set more strict access controls (like a\\nfirewall) for all workers and only allow the federation_sender’s to contact the\\noutside world. instance_map: main: host: localhost port: 8030 federation_sender1: host: localhost port: 8034 outbound_federation_restricted_to: - federation_sender1 worker_replication_secret: \\"secret_secret\\" Background tasks There is also support for moving background tasks to a separate\\nworker. Background tasks are run periodically or started via replication. Exactly\\nwhich tasks are configured to run depends on your Synapse configuration (e.g. if\\nstats is enabled). This worker doesn’t handle any REST endpoints itself. To enable this, the worker must have a unique worker_name\\nand can be configured to run background tasks. For example, to move background tasks\\nto a dedicated worker, the shared configuration would include: run_background_tasks_on: background_worker You might also wish to investigate the update_user_directory_from_worker and media_instance_running_background_jobs settings. An example for a dedicated background worker instance: worker_app: synapse.app.generic_worker\\nworker_name: background_worker worker_log_config: /etc/matrix-synapse/background-worker-log.yaml Updating the User Directory You can designate one generic worker to update the user directory. Specify its name in the shared configuration\\nas follows: update_user_directory_from_worker: worker_name This work cannot be load-balanced; please ensure the main process is restarted\\nafter setting this option in the shared configuration! User directory updates allow REST endpoints matching the following regular\\nexpressions to work: ^/_matrix/client/(r0|v3|unstable)/user_directory/search$ The above endpoints can be routed to any worker, though you may choose to route\\nit to the chosen user directory worker. This style of configuration supersedes the legacy synapse.app.user_dir\\nworker application type. Notifying Application Services You can designate one generic worker to send output traffic to Application Services.\\nDoesn’t handle any REST endpoints itself, but you should specify its name in the shared configuration\\nas follows: notify_appservices_from_worker: worker_name This work cannot be load-balanced; please ensure the main process is restarted\\nafter setting this option in the shared configuration! This style of configuration supersedes the legacy synapse.app.appservice\\nworker application type. Push Notifications You can designate generic workers to send push notifications to\\na push gateway such as sygnal and email. This will stop the main process sending push notifications. The workers responsible for sending push notifications can be defined using the pusher_instances\\noption. For example: pusher_instances: - pusher_worker1 - pusher_worker2 Multiple workers can be added to this map, in which case the work is balanced\\nacross them. Ensure the main process and all pusher workers are restarted after changing\\nthis option. These workers don’t need to accept incoming HTTP requests to send push notifications,\\nso no additional reverse proxy configuration is required for pusher workers. This style of configuration supersedes the legacy synapse.app.pusher\\nworker application type.","breadcrumbs":"Configuration » Workers » synapse.app.generic_worker","id":"769","title":"synapse.app.generic_worker"},"77":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.163.0","id":"77","title":"Upgrading to v1.163.0"},"770":{"body":"It is likely this option will be deprecated in the future and is not recommended for new\\ninstallations. Instead, use synapse.app.generic_worker with the pusher_instances. Handles sending push notifications to sygnal and email. Doesn’t handle any\\nREST endpoints itself, but you should set start_pushers: false in the\\nshared configuration file to stop the main synapse sending push notifications. To run multiple instances at once the pusher_instances\\noption should list all pusher instances by their worker_name, e.g.: start_pushers: false\\npusher_instances: - pusher_worker1 - pusher_worker2 An example for a pusher instance: worker_app: synapse.app.pusher\\nworker_name: pusher_worker1 worker_log_config: /etc/matrix-synapse/pusher-worker-log.yaml","breadcrumbs":"Configuration » Workers » synapse.app.pusher","id":"770","title":"synapse.app.pusher"},"771":{"body":"Deprecated as of Synapse v1.59. Use synapse.app.generic_worker with the notify_appservices_from_worker option instead. Handles sending output traffic to Application Services. Doesn’t handle any\\nREST endpoints itself, but you should set notify_appservices: False in the\\nshared configuration file to stop the main synapse sending appservice notifications. Note this worker cannot be load-balanced: only one instance should be active.","breadcrumbs":"Configuration » Workers » synapse.app.appservice","id":"771","title":"synapse.app.appservice"},"772":{"body":"It is likely this option will be deprecated in the future and not recommended for\\nnew installations. Instead, use synapse.app.generic_worker with the federation_sender_instances. Handles sending federation traffic to other servers. Doesn’t handle any\\nREST endpoints itself, but you should set send_federation: false\\nin the shared configuration file to stop the main synapse sending this traffic. If running multiple federation senders then you must list each\\ninstance in the federation_sender_instances\\noption by their worker_name.\\nAll instances must be stopped and started when adding or removing instances.\\nFor example: send_federation: false\\nfederation_sender_instances: - federation_sender1 - federation_sender2 An example for a federation sender instance: worker_app: synapse.app.federation_sender\\nworker_name: federation_sender1 worker_log_config: /etc/matrix-synapse/federation-sender-log.yaml","breadcrumbs":"Configuration » Workers » synapse.app.federation_sender","id":"772","title":"synapse.app.federation_sender"},"773":{"body":"Handles the media repository. It can handle all endpoints starting with: /_matrix/media/\\n/_matrix/client/v1/media/\\n/_matrix/federation/v1/media/ … and the following regular expressions matching media-specific administration APIs: ^/_synapse/admin/v1/purge_media_cache$\\n^/_synapse/admin/v1/room/.*/media.*$\\n^/_synapse/admin/v1/user/.*/media.*$\\n^/_synapse/admin/v1/media/.*$\\n^/_synapse/admin/v1/quarantine_media/.*$\\n^/_synapse/admin/v1/users/.*/media$ You should also set enable_media_repo: False\\nin the shared configuration\\nfile to stop the main synapse running background jobs related to managing the\\nmedia repository. Note that doing so will prevent the main process from being\\nable to handle the above endpoints. In the media_repository worker configuration file, configure the HTTP listener to\\nexpose the media resource. For example: worker_app: synapse.app.media_repository\\nworker_name: media_worker worker_listeners: - type: http port: 8085 x_forwarded: true resources: - names: [media] worker_log_config: /etc/matrix-synapse/media-worker-log.yaml Note that if running multiple media repositories they must be on the same server\\nand you must specify a single instance to run the background tasks in the shared configuration,\\ne.g.: media_instance_running_background_jobs: \\"media-repository-1\\" Note that if a reverse proxy is used , then /_matrix/media/ must be routed for both inbound client and federation requests (if they are handled separately).","breadcrumbs":"Configuration » Workers » synapse.app.media_repository","id":"773","title":"synapse.app.media_repository"},"774":{"body":"Deprecated as of Synapse v1.59. Use synapse.app.generic_worker with the update_user_directory_from_worker option instead. Handles searches in the user directory. It can handle REST endpoints matching\\nthe following regular expressions: ^/_matrix/client/(r0|v3|unstable)/user_directory/search$ When using this worker you must also set update_user_directory: false in the\\nshared configuration file to stop the main synapse running background\\njobs related to updating the user directory. Above endpoint is not required to be routed to this worker. By default, update_user_directory is set to true, which means the main process\\nwill handle updates. All workers configured with client can handle the above\\nendpoint as long as either this worker or the main process are configured to\\nhandle it, and are online. If update_user_directory is set to false, and this worker is not running,\\nthe above endpoint may give outdated results.","breadcrumbs":"Configuration » Workers » synapse.app.user_dir","id":"774","title":"synapse.app.user_dir"},"775":{"body":"The following used to be separate worker application types, but are now\\nequivalent to synapse.app.generic_worker: synapse.app.client_reader synapse.app.event_creator synapse.app.federation_reader synapse.app.federation_sender synapse.app.frontend_proxy synapse.app.pusher synapse.app.synchrotron","breadcrumbs":"Configuration » Workers » Historical apps","id":"775","title":"Historical apps"},"776":{"body":"A main change that has occurred is the merging of worker apps into synapse.app.generic_worker. This change is backwards compatible and so no\\nchanges to the config are required. To migrate apps to use synapse.app.generic_worker simply update the worker_app option in the worker configs, and where worker are started (e.g.\\nin systemd service files, but not required for synctl).","breadcrumbs":"Configuration » Workers » Migration from old config","id":"776","title":"Migration from old config"},"777":{"body":"The following shows an example setup using Redis and a reverse proxy: Clients & Federation | v +-----------+ | | | Reverse | | Proxy | | | +-----------+ | | | | | | HTTP requests +-------------------+ | +-----------+ | +---+ | | | | v v v\\n+--------------+ +--------------+ +--------------+ +--------------+\\n| Main | | Generic | | Generic | | Event |\\n| Process | | Worker 1 | | Worker 2 | | Persister |\\n+--------------+ +--------------+ +--------------+ +--------------+ ^ ^ | ^ | | ^ | | ^ ^ | | | | | | | | | | | | | | | | HTTP | | | | | | | +----------+<--|---|---------+<--|---|---------+ | | | | +-------------|-->+-------------+ | | | | | | | | | v v v v\\n====================================================================== Redis pub/sub channel","breadcrumbs":"Configuration » Workers » Architectural diagram","id":"777","title":"Architectural diagram"},"778":{"body":"If you want to use synctl to manage your synapse processes, you will need to\\ncreate an an additional configuration file for the main synapse process. That\\nconfiguration should look like this: worker_app: synapse.app.homeserver Additionally, each worker app must be configured with the name of a “pid file”,\\nto which it will write its process ID when it starts. For example, for a\\nsynchrotron, you might write: worker_pid_file: /home/matrix/synapse/worker1.pid Finally, to actually run your worker-based synapse, you must pass synctl the -a\\ncommandline option to tell it to operate on all the worker configurations found\\nin the given directory, e.g.: synctl -a $CONFIG/workers start Currently one should always restart all workers when restarting or upgrading\\nsynapse, unless you explicitly know it’s safe not to. For instance, restarting\\nsynapse without restarting all the synchrotrons may result in broken typing\\nnotifications. To manipulate a specific worker, you pass the -w option to synctl: synctl -w $CONFIG/workers/worker1.yaml restart","breadcrumbs":"Configuration » Workers » Using synctl with Workers » Using synctl with workers","id":"778","title":"Using synctl with workers"},"779":{"body":"This is a setup for managing synapse with systemd, including support for\\nmanaging workers. It provides a matrix-synapse service for the master, as\\nwell as a matrix-synapse-worker@ service template for any workers you\\nrequire. Additionally, to group the required services, it sets up a matrix-synapse.target. See the folder system\\nfor the systemd unit files. The folder workers\\ncontains an example configuration for the generic_worker worker.","breadcrumbs":"Configuration » Workers » Systemd » Setting up Synapse with Workers and Systemd","id":"779","title":"Setting up Synapse with Workers and Systemd"},"78":{"body":"The shared-room check enabled by limit_profile_requests_to_users_who_share_rooms\\nis only applied to authenticated requests, and profile requests are only\\nauthenticated when require_auth_for_profile_requests\\nis enabled. Enabling the former without the latter therefore never restricted\\nany profile lookup. Synapse will now refuse to start with that combination. If you have limit_profile_requests_to_users_who_share_rooms: true in your configuration,\\neither also set require_auth_for_profile_requests: true, or remove the option to\\nkeep the behaviour you have today.","breadcrumbs":"Upgrading between Synapse Versions » limit_profile_requests_to_users_who_share_rooms now requires require_auth_for_profile_requests","id":"78","title":"limit_profile_requests_to_users_who_share_rooms now requires require_auth_for_profile_requests"},"780":{"body":"See the worker documentation for information on how to set up the\\nconfiguration files and reverse-proxy correctly.\\nBelow is a sample generic_worker worker configuration file. worker_app: synapse.app.generic_worker\\nworker_name: generic_worker1 worker_listeners: - type: http port: 8083 x_forwarded: true resources: - names: [client, federation] worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml Systemd manages daemonization itself, so ensure that none of the configuration\\nfiles set either daemonize or worker_daemonize. The config files of all workers are expected to be located in /etc/matrix-synapse/workers. If you want to use a different location, edit\\nthe provided *.service files accordingly. There is no need for a separate configuration file for the master process.","breadcrumbs":"Configuration » Workers » Systemd » Synapse configuration files","id":"780","title":"Synapse configuration files"},"781":{"body":"Adjust synapse configuration files as above. Copy the *.service and *.target files in system\\nto /etc/systemd/system. Run systemctl daemon-reload to tell systemd to load the new unit files. Run systemctl enable matrix-synapse.service. This will configure the\\nsynapse master process to be started as part of the matrix-synapse.target\\ntarget. For each worker process to be enabled, run systemctl enable matrix-synapse-worker@.service. For each , there\\nshould be a corresponding configuration file. /etc/matrix-synapse/workers/.yaml. Start all the synapse processes with systemctl start matrix-synapse.target. Tell systemd to start synapse on boot with systemctl enable matrix-synapse.target.","breadcrumbs":"Configuration » Workers » Systemd » Set up","id":"781","title":"Set up"},"782":{"body":"Once the services are correctly set up, you can use the following commands\\nto manage your synapse installation: # Restart Synapse master and all workers\\nsystemctl restart matrix-synapse.target # Stop Synapse and all workers\\nsystemctl stop matrix-synapse.target # Restart the master alone\\nsystemctl start matrix-synapse.service # Restart a specific worker (eg. generic_worker); the master is\\n# unaffected by this.\\nsystemctl restart matrix-synapse-worker@generic_worker.service # Add a new worker (assuming all configs are set up already)\\nsystemctl enable matrix-synapse-worker@federation_writer.service\\nsystemctl restart matrix-synapse.target","breadcrumbs":"Configuration » Workers » Systemd » Usage","id":"782","title":"Usage"},"783":{"body":"Optional: If further hardening is desired, the file override-hardened.conf may be copied from contrib/systemd/override-hardened.conf\\nin this repository to the location /etc/systemd/system/matrix-synapse.service.d/override-hardened.conf (the\\ndirectory may have to be created). It enables certain sandboxing features in\\nsystemd to further secure the synapse service. You may read the comments to\\nunderstand what the override file is doing. The same file will need to be copied to /etc/systemd/system/matrix-synapse-worker@.service.d/override-hardened-worker.conf\\n(this directory may also have to be created) in order to apply the same\\nhardening options to any worker processes. Once these files have been copied to their appropriate locations, simply reload\\nsystemd’s manager config files and restart all Synapse services to apply the hardening options. They will automatically\\nbe applied at every restart as long as the override files are present at the\\nspecified locations. systemctl daemon-reload # Restart services\\nsystemctl restart matrix-synapse.target In order to see their effect, you may run systemd-analyze security matrix-synapse.service before and after applying the hardening options to see\\nthe changes being applied at a glance.","breadcrumbs":"Configuration » Workers » Systemd » Hardening","id":"783","title":"Hardening"},"784":{"body":"This section contains information on managing your Synapse homeserver. This includes: Managing users, rooms and media via the Admin API. Setting up metrics and monitoring to give you insight into your homeserver’s health. Configuring structured logging.","breadcrumbs":"Administration » Administration","id":"784","title":"Administration"},"785":{"body":"It is critical to maintain good backups of your server, to guard against\\nhardware failure as well as potential corruption due to bugs or administrator\\nerror. This page documents the things you will need to consider backing up as part of\\na Synapse installation.","breadcrumbs":"Administration » Backups » How to back up a Synapse homeserver","id":"785","title":"How to back up a Synapse homeserver"},"786":{"body":"Keep a copy of your configuration file ( homeserver.yaml), as well as any\\nauxiliary config files it refers to such as the log_config file, app_service_config_files.\\nOften, all such config files will be kept in a single directory such as /etc/synapse, which will make this easier.","breadcrumbs":"Administration » Backups » Configuration files","id":"786","title":"Configuration files"},"787":{"body":"Your server has a signing\\nkey which it uses\\nto sign events and outgoing federation requests. It is easiest to back it up\\nwith your configuration files, but an alternative is to have Synapse create a\\nnew signing key if you have to restore. If you do decide to replace the signing key, you should add the old public\\nkey to old_signing_keys.","breadcrumbs":"Administration » Backups » Server signing key","id":"787","title":"Server signing key"},"788":{"body":"Synapse’s support for SQLite is only suitable for testing purposes, so for the\\npurposes of this document, we’ll assume you are using PostgreSQL. A full discussion of backup strategies for PostgreSQL is out of scope for this\\ndocument; see the PostgreSQL\\ndocumentation for\\ndetailed information.","breadcrumbs":"Administration » Backups » Database","id":"788","title":"Database"},"789":{"body":"Be very careful not to restore into a database that already has tables\\npresent. At best, this will error; at worst, it will lead to subtle database\\ninconsistencies. The e2e_one_time_keys_json table should not be backed up, or if it is\\nbacked up, should be TRUNCATEd\\nafter restoring the database before Synapse is started. [Background: restoring the database to an older backup can cause\\nused one-time-keys to be re-issued, causing subsequent message decryption\\nerrors. Clearing\\nall one-time-keys from the database ensures that this cannot happen, and\\nwill prompt clients to generate and upload new one-time-keys.]","breadcrumbs":"Administration » Backups » Synapse-specfic details","id":"789","title":"Synapse-specfic details"},"79":{"body":"The default value of request_token_inhibit_3pid_errors has changed from false\\nto true. Synapse will now conceal whether an email address is associated with an\\naccount when responding to /requestToken requests, unless the setting is\\nexplicitly configured as false. Administrators who rely on the previous responses can retain them by adding the\\nfollowing to their configuration: request_token_inhibit_3pid_errors: false","breadcrumbs":"Upgrading between Synapse Versions » Privacy-preserving /requestToken responses are now enabled by default","id":"79","title":"Privacy-preserving /requestToken responses are now enabled by default"},"790":{"body":"Typically, the easiest solution is to use pg_dump to take a copy of the whole\\ndatabase. We recommend pg_dump’s custom dump format, as it produces\\nsignificantly smaller backup files. sudo -u postgres pg_dump -Fc --exclude-table-data e2e_one_time_keys_json synapse > synapse.dump There is no need to stop Postgres or Synapse while pg_dump is running: it\\nwill take a consistent snapshot of the databse. To restore, you will need to recreate the database as described in Using\\nPostgres,\\nthen load the dump into it with pg_restore: sudo -u postgres createdb --encoding=UTF8 --locale=C --template=template0 --owner=synapse_user synapse\\nsudo -u postgres pg_restore -d synapse < synapse.dump (If you forgot to exclude e2e_one_time_keys_json during pg_dump, remember\\nto connect to the new database and TRUNCATE e2e_one_time_keys_json; before\\nstarting Synapse.) To reiterate: do not restore a dump over an existing database. Again, if you plan to run your homeserver at any sort of production level, we\\nrecommend studying the PostgreSQL documentation on backup options.","breadcrumbs":"Administration » Backups » Quick and easy database backup and restore","id":"790","title":"Quick and easy database backup and restore"},"791":{"body":"Synapse keeps a copy of media uploaded by users, including avatars and message\\nattachments, in its Media\\nstore. It is a directory on the local disk, containing the following directories: local_content: this is content uploaded by your local users. As a general\\nrule, you should back this up: it may represent the only copy of those\\nmedia files anywhere in the federation, and if they are lost, users will\\nsee errors when viewing user or room avatars, and messages with attachments. local_thumbnails: “thumbnails” of images uploaded by your users. If dynamic_thumbnails\\nis enabled, these will be regenerated if they are removed from the disk, and\\nthere is therefore no need to back them up. If dynamic_thumbnails is not enabled (the default): although this can\\ntheoretically be regenerated from local_content, there is no tooling to do\\nso. We recommend that these are backed up too. remote_content: this is a cache of content that was uploaded by a user on\\nanother server, and has since been requested by a user on your own server. Typically there is no need to back up this directory: if a file in this directory\\nis removed, Synapse will attempt to fetch it again from the remote\\nserver. remote_thumbnails: thumbnails of images uploaded by users on other\\nservers. As with remote_content, there is normally no need to back this\\nup. url_cache, url_cache_thumbnails: temporary caches of files downloaded\\nby the URL previews feature.\\nThese do not need to be backed up.","breadcrumbs":"Administration » Backups » Media store","id":"791","title":"Media store"},"792":{"body":"","breadcrumbs":"Administration » Admin API » The Admin API","id":"792","title":"The Admin API"},"793":{"body":"Many of the API calls in the admin api will require an access_token for a\\nserver admin. (Note that a server admin is distinct from a room admin.) An existing user can be marked as a server admin by updating the database directly. Check your database settings in the configuration file, connect to the correct database using either psql [database name] (if using PostgreSQL) or sqlite3 path/to/your/database.db (if using SQLite) and elevate the user @foo:bar.com to administrator. UPDATE users SET admin = 1 WHERE name = \'@foo:bar.com\'; A new server admin user can also be created using the register_new_matrix_user\\ncommand. This is a script that is distributed as part of synapse. It is possibly\\nalready on your $PATH depending on how Synapse was installed. Finding your user’s access_token is client-dependent, but will usually be shown in the client’s settings.","breadcrumbs":"Administration » Admin API » Authenticate as a server admin","id":"793","title":"Authenticate as a server admin"},"794":{"body":"For security reasons, we recommend\\nthat the Admin API ( /_synapse/admin/...) should be hidden from public view using a\\nreverse proxy. This means you should typically query the Admin API from a terminal on\\nthe machine which runs Synapse. Once you have your access_token, you will need to authenticate each request to an Admin API endpoint by\\nproviding the token as either a query parameter or a request header. To add it as a request header in cURL: curl --header \\"Authorization: Bearer \\" For example, suppose we want to query the account of the user @foo:bar.com. We need an admin access token (e.g. syt_AjfVef2_L33JNpafeif_0feKJfeaf0CQpoZk), and we need to know which port\\nSynapse’s client listener is listening\\non (e.g. 8008). Then we can use the following command to request the account\\ninformation from the Admin API. curl --header \\"Authorization: Bearer syt_AjfVef2_L33JNpafeif_0feKJfeaf0CQpoZk\\" -X GET http://127.0.0.1:8008/_synapse/admin/v2/users/@foo:bar.com For more details on access tokens in Matrix, please refer to the complete matrix spec documentation.","breadcrumbs":"Administration » Admin API » Making an Admin API request","id":"794","title":"Making an Admin API request"},"795":{"body":"Note: This API is disabled when Matrix Authentication Service integration is enabled. See #15582 This API allows a server administrator to manage the validity of an account. To\\nuse it, you must enable the account validity feature (under account_validity) in Synapse’s configuration. To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API.","breadcrumbs":"Administration » Admin API » Account Validity » Account validity API","id":"795","title":"Account validity API"},"796":{"body":"This API extends the validity of an account by as much time as configured in the period parameter from the account_validity configuration. The API is: POST /_synapse/admin/v1/account_validity/validity with the following body: { \\"user_id\\": \\"\\", \\"expiration_ts\\": 0, \\"enable_renewal_emails\\": true\\n} expiration_ts is an optional parameter and overrides the expiration date,\\nwhich otherwise defaults to now + validity period. enable_renewal_emails is also an optional parameter and enables/disables\\nsending renewal emails to the user. Defaults to true. The API returns with the new expiration date for this account, as a timestamp in\\nmilliseconds since epoch: { \\"expiration_ts\\": 0\\n}","breadcrumbs":"Administration » Admin API » Account Validity » Renew account","id":"796","title":"Renew account"},"797":{"body":"This API allows a server administrator to manage the background updates being\\nrun against the database.","breadcrumbs":"Administration » Admin API » Background Updates » Background Updates API","id":"797","title":"Background Updates API"},"798":{"body":"This API gets the current status of the background updates. The API is: GET /_synapse/admin/v1/background_updates/status Returning: { \\"enabled\\": true, \\"current_updates\\": { \\"\\": { \\"name\\": \\"\\", \\"total_item_count\\": 50, \\"total_duration_ms\\": 10000.0, \\"average_items_per_ms\\": 2.2, }, }\\n} enabled whether the background updates are enabled or disabled. db_name the database name (usually Synapse is configured with a single database named ‘master’). For each update: name the name of the update. total_item_count total number of “items” processed (the meaning of ‘items’ depends on the update in question). total_duration_ms how long the background process has been running, not including time spent sleeping. average_items_per_ms how many items are processed per millisecond based on an exponential average.","breadcrumbs":"Administration » Admin API » Background Updates » Status","id":"798","title":"Status"},"799":{"body":"This API allows pausing background updates. Background updates should not be paused for significant periods of time, as\\nthis can affect the performance of Synapse. Note: This won’t persist over restarts. Note: This won’t cancel any update query that is currently running. This is\\nusually fine since most queries are short lived, except for CREATE INDEX\\nbackground updates which won’t be cancelled once started. The API is: POST /_synapse/admin/v1/background_updates/enabled with the following body: { \\"enabled\\": false\\n} enabled sets whether the background updates are enabled or disabled. The API returns the enabled param. { \\"enabled\\": false\\n} There is also a GET version which returns the enabled state.","breadcrumbs":"Administration » Admin API » Background Updates » Enabled","id":"799","title":"Enabled"},"8":{"body":"It’s also possible to install Synapse as a Python module from PyPI. When following this route please make sure that the Platform-specific prerequisites are already installed. System requirements: POSIX-compliant system (tested on Linux & OS X) Python 3.11 or later, up to Python 3.14. At least 1GB of free RAM if you want to join large public rooms like #matrix:matrix.org If building on an uncommon architecture for which pre-built wheels are\\nunavailable, you will need to have a recent Rust compiler installed. The easiest\\nway of installing the latest version is to use rustup. To install the Synapse homeserver run: mkdir -p ~/synapse\\nvirtualenv -p python3 ~/synapse/env\\nsource ~/synapse/env/bin/activate\\npip install --upgrade pip\\npip install --upgrade setuptools\\npip install matrix-synapse If you want to use a logging configuration that references systemd.journal.JournalHandler (for example contrib/systemd/log_config.yaml),\\nyou must install systemd-python separately in the same environment.\\nSynapse no longer provides a matrix-synapse[systemd] extra. This will download Synapse from PyPI\\nand install it, along with the python libraries it uses, into a virtual environment\\nunder ~/synapse/env. Feel free to pick a different directory if you\\nprefer. This Synapse installation can then be later upgraded by using pip again with the\\nupdate flag: source ~/synapse/env/bin/activate\\npip install -U matrix-synapse Before you can start Synapse, you will need to generate a configuration\\nfile. To do this, run (in your virtualenv, as before): cd ~/synapse\\npython -m synapse.app.homeserver \\\\ --server-name my.domain.name \\\\ --config-path homeserver.yaml \\\\ --generate-config \\\\ --report-stats=[yes|no] … substituting an appropriate value for --server-name and choosing whether\\nor not to report usage statistics (hostname, Synapse version, uptime, total\\nusers, etc.) to the developers via the --report-stats argument. This command will generate you a config file that you can then customise, but it will\\nalso generate a set of keys for you. These keys will allow your homeserver to\\nidentify itself to other homeservers, so don’t lose or delete them. It would be\\nwise to back them up somewhere safe. (If, for whatever reason, you do need to\\nchange your homeserver’s keys, you may find that other homeservers have the\\nold key cached. If you update the signing key, you should change the name of the\\nkey in the .signing.key file (the second word) to something\\ndifferent. See the spec for more information on key management). To actually run your new homeserver, pick a working directory for Synapse to\\nrun (e.g. ~/synapse), and: cd ~/synapse\\nsource env/bin/activate\\nsynctl start Platform-specific prerequisites Synapse is written in Python but some of the libraries it uses are written in\\nC. So before we can install Synapse itself we need a working C compiler and the\\nheader files for Python C extensions. Debian/Ubuntu/Raspbian Installing prerequisites on Ubuntu or Debian: sudo apt install build-essential python3-dev libffi-dev \\\\ python3-pip python3-setuptools sqlite3 \\\\ libssl-dev virtualenv libjpeg-dev libxslt1-dev ArchLinux Installing prerequisites on ArchLinux: sudo pacman -S base-devel python python-pip \\\\ python-setuptools python-virtualenv sqlite3 CentOS/Fedora Installing prerequisites on CentOS or Fedora Linux: sudo dnf install libtiff-devel libjpeg-devel libzip-devel freetype-devel \\\\ libwebp-devel libxslt-devel libpq-devel \\\\ python3-virtualenv libffi-devel openssl-devel python3-devel\\nsudo dnf group install \\"Development Tools\\" Red Hat Enterprise Linux / Rocky Linux / Oracle Linux Note: The term “RHEL” below refers to Red Hat Enterprise Linux, Oracle Linux and Rocky Linux.\\nThe distributions are 1:1 binary compatible. It’s recommended to use the latest Python versions. RHEL 8 & 9 in particular ship with Python 3.6 & 3.9 respectively by default\\nwhich are EOL and therefore no longer supported by Synapse.\\nHowever, newer Python versions provide significant performance improvements\\nand they’re available in official distributions’ repositories.\\nTherefore it’s recommended to use them. Python 3.11 and 3.12 are available for both RHEL 8 and 9. These commands should be run as root user. Install new version of Python. You only need one of these: # Python 3.11\\ndnf install python3.11 python3.11-devel # Python 3.12\\ndnf install python3.12 python3.12-devel Finally, install common prerequisites dnf install libpq5 libpq5-devel lz4 pkgconf\\ndnf group install \\"Development Tools\\" Using venv module instead of virtualenv command It’s recommended to use Python venv module directly rather than the virtualenv command. On RHEL 9, virtualenv is only available on EPEL. On RHEL 8, virtualenv is based on Python 3.6. It does not support creating 3.11/3.12 virtual environments. Here’s an example of creating Python 3.12 virtual environment and installing Synapse from PyPI. mkdir -p ~/synapse\\n# To use Python 3.11, simply use the command \\"python3.11\\" instead.\\npython3.12 -m venv ~/synapse/env\\nsource ~/synapse/env/bin/activate\\npip install --upgrade pip\\npip install --upgrade setuptools\\npip install matrix-synapse macOS Installing prerequisites on macOS: You may need to install the latest Xcode developer tools: xcode-select --install Some extra dependencies may be needed. You can use Homebrew (https://brew.sh) for them. On ARM-based Macs you may also need to install libjpeg and libpq: brew install jpeg libpq On macOS Catalina (10.15) you may need to explicitly install OpenSSL\\nvia brew and inform pip about it so that psycopg2 builds: brew install openssl@1.1\\nexport LDFLAGS=\\"-L/usr/local/opt/openssl/lib\\"\\nexport CPPFLAGS=\\"-I/usr/local/opt/openssl/include\\" OpenSUSE Installing prerequisites on openSUSE: sudo zypper in -t pattern devel_basis\\nsudo zypper in python-pip python-setuptools sqlite3 python-virtualenv \\\\ python-devel libffi-devel libopenssl-devel libjpeg62-devel OpenBSD A port of Synapse is available under net/synapse. The filesystem\\nunderlying the homeserver directory (defaults to /var/synapse) has to be\\nmounted with wxallowed (cf. mount(8)), so creating a separate filesystem\\nand mounting it to /var/synapse should be taken into consideration. To be able to build Synapse’s dependency on python the WRKOBJDIR\\n(cf. bsd.port.mk(5)) for building python, too, needs to be on a filesystem\\nmounted with wxallowed (cf. mount(8)). Creating a WRKOBJDIR for building python under /usr/local (which on a\\ndefault OpenBSD installation is mounted with wxallowed): doas mkdir /usr/local/pobj_wxallowed Assuming PORTS_PRIVSEP=Yes (cf. bsd.port.mk(5)) and SUDO=doas are\\nconfigured in /etc/mk.conf: doas chown _pbuild:_pbuild /usr/local/pobj_wxallowed Setting the WRKOBJDIR for building python: echo WRKOBJDIR_lang/python/3.7=/usr/local/pobj_wxallowed \\\\\\\\nWRKOBJDIR_lang/python/2.7=/usr/local/pobj_wxallowed >> /etc/mk.conf Building Synapse: cd /usr/ports/net/synapse\\nmake install Windows Running Synapse natively on Windows is not officially supported. If you wish to run or develop Synapse on Windows, the Windows Subsystem for\\nLinux provides a Linux environment which is capable of using the Debian, Fedora,\\nor source installation methods. More information about WSL can be found at https://docs.microsoft.com/en-us/windows/wsl/install for Windows 10/11 and https://docs.microsoft.com/en-us/windows/wsl/install-on-server for\\nWindows Server.","breadcrumbs":"Installation » Installing as a Python module from PyPI","id":"8","title":"Installing as a Python module from PyPI"},"80":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.161.0","id":"80","title":"Upgrading to v1.161.0"},"800":{"body":"This API schedules a specific background update to run. The job starts immediately after calling the API. The API is: POST /_synapse/admin/v1/background_updates/start_job with the following body: { \\"job_name\\": \\"populate_stats_process_rooms\\"\\n} The following JSON body parameters are available: job_name - A string which job to run. Valid values are: populate_stats_process_rooms - Recalculate the stats for all rooms. regenerate_directory - Recalculate the user directory if it is stale or out of sync. event_resign - Re-sign all locally-sent events with the current signing key. This is useful after rotating the server’s signing key to ensure all historical events are signed with the new key. Optional additional parameters: old_key - Only re-sign events whose signature verifies against this key. Format: \\"ed25519:key_id base64_public_key\\" (e.g. \\"ed25519:my_old_key XGX0JRS2Af3be3knz2fBiRbApjm2Dh61gXDJA8kcJNI\\"). before_ts - Only re-sign events with a received_ts less than this value (milliseconds since the epoch).","breadcrumbs":"Administration » Admin API » Background Updates » Run","id":"800","title":"Run"},"801":{"body":"The fetch event API allows admins to fetch an event regardless of their membership in the room it\\noriginated in. To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API. Request: GET /_synapse/admin/v1/fetch_event/ The API returns a JSON body like the following: Response: { \\"event\\": { \\"auth_events\\": [ \\"$WhLChbYg6atHuFRP7cUd95naUtc8L0f7fqeizlsUVvc\\", \\"$9Wj8dt02lrNEWweeq-KjRABUYKba0K9DL2liRvsAdtQ\\", \\"$qJxBFxBt8_ODd9b3pgOL_jXP98S_igc1_kizuPSZFi4\\" ], \\"content\\": { \\"body\\": \\"Hey now\\", \\"msgtype\\": \\"m.text\\" }, \\"depth\\": 6, \\"event_id\\": \\"$hJ_kcXbVMcI82JDrbqfUJIHu61tJD86uIFJ_8hNHi7s\\", \\"hashes\\": { \\"sha256\\": \\"LiNw8DtrRVf55EgAH8R42Wz7WCJUqGsPt2We6qZO5Rg\\" }, \\"origin_server_ts\\": 799, \\"prev_events\\": [ \\"$cnSUrNMnC3Ywh9_W7EquFxYQjC_sT3BAAVzcUVxZq1g\\" ], \\"room_id\\": \\"!aIhKToCqgPTBloWMpf:test\\", \\"sender\\": \\"@user:test\\", \\"signatures\\": { \\"test\\": { \\"ed25519:a_lPym\\": \\"7mqSDwK1k7rnw34Dd8Fahu0rhPW7jPmcWPRtRDoEN9Yuv+BCM2+Rfdpv2MjxNKy3AYDEBwUwYEuaKMBaEMiKAQ\\" } }, \\"type\\": \\"m.room.message\\", \\"unsigned\\": { \\"age_ts\\": 799 } }\\n}","breadcrumbs":"Administration » Admin API » Fetch Event » Fetch Event API","id":"801","title":"Fetch Event API"},"802":{"body":"This API returns information about reported events. To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API. The api is: GET /_synapse/admin/v1/event_reports?from=0&limit=10 It returns a JSON body like the following: { \\"event_reports\\": [ { \\"event_id\\": \\"$bNUFCwGzWca1meCGkjp-zwslF-GfVcXukvRLI1_FaVY\\", \\"id\\": 2, \\"reason\\": \\"foo\\", \\"score\\": -100, \\"received_ts\\": 1570897107409, \\"canonical_alias\\": \\"#alias1:matrix.org\\", \\"room_id\\": \\"!ERAgBpSOcCCuTJqQPk:matrix.org\\", \\"name\\": \\"Matrix HQ\\", \\"sender\\": \\"@foobar:matrix.org\\", \\"user_id\\": \\"@foo:matrix.org\\" }, { \\"event_id\\": \\"$3IcdZsDaN_En-S1DF4EMCy3v4gNRKeOJs8W5qTOKj4I\\", \\"id\\": 3, \\"reason\\": \\"bar\\", \\"score\\": -100, \\"received_ts\\": 1598889612059, \\"canonical_alias\\": \\"#alias2:matrix.org\\", \\"room_id\\": \\"!eGvUQuTCkHGVwNMOjv:matrix.org\\", \\"name\\": \\"Your room name here\\", \\"sender\\": \\"@foobar:matrix.org\\", \\"user_id\\": \\"@bar:matrix.org\\" } ], \\"next_token\\": 2, \\"total\\": 4\\n} To paginate, check for next_token and if present, call the endpoint again with from\\nset to the value of next_token. This will return a new page. If the endpoint does not return a next_token then there are no more reports to\\npaginate through. URL parameters: limit: integer - Is optional but is used for pagination, denoting the maximum number\\nof items to return in this call. Defaults to 100. from: integer - Is optional but used for pagination, denoting the offset in the\\nreturned results. This should be treated as an opaque value and not explicitly set to\\nanything other than the return value of next_token from a previous call. Defaults to 0. dir: string - Direction of event report order. Whether to fetch the most recent\\nfirst ( b) or the oldest first ( f). Defaults to b. user_id: optional string - Filter by the user ID of the reporter. This is the user who reported the event\\nand wrote the reason. room_id: optional string - Filter by room id. event_sender_user_id: optional string - Filter by the sender of the reported event. This is the user who\\nthe report was made against. Response The following fields are returned in the JSON response body: id: integer - ID of event report. received_ts: integer - The timestamp (in milliseconds since the unix epoch) when this\\nreport was sent. room_id: string - The ID of the room in which the event being reported is located. name: string - The name of the room. event_id: string - The ID of the reported event. user_id: string - This is the user who reported the event and wrote the reason. reason: string - Comment made by the user_id in this report. May be blank or null. score: integer - Content is reported based upon a negative score, where -100 is\\n“most offensive” and 0 is “inoffensive”. May be null. sender: string - This is the ID of the user who sent the original message/event that\\nwas reported. canonical_alias: string - The canonical alias of the room. null if the room does not\\nhave a canonical alias set. next_token: integer - Indication for pagination. See above. total: integer - Total number of event reports related to the query\\n( user_id and room_id).","breadcrumbs":"Administration » Admin API » Event Reports » Show reported events","id":"802","title":"Show reported events"},"803":{"body":"This API returns information about a specific event report. The api is: GET /_synapse/admin/v1/event_reports/ It returns a JSON body like the following: { \\"event_id\\": \\"$bNUFCwGzWca1meCGkjp-zwslF-GfVcXukvRLI1_FaVY\\", \\"event_json\\": { \\"auth_events\\": [ \\"$YK4arsKKcc0LRoe700pS8DSjOvUT4NDv0HfInlMFw2M\\", \\"$oggsNXxzPFRE3y53SUNd7nsj69-QzKv03a1RucHu-ws\\" ], \\"content\\": { \\"body\\": \\"matrix.org: This Week in Matrix\\", \\"format\\": \\"org.matrix.custom.html\\", \\"formatted_body\\": \\"matrix.org:
This Week in Matrix\\", \\"msgtype\\": \\"m.notice\\" }, \\"depth\\": 546, \\"hashes\\": { \\"sha256\\": \\"xK1//xnmvHJIOvbgXlkI8eEqdvoMmihVDJ9J4SNlsAw\\" }, \\"origin_server_ts\\": 1592291711430, \\"prev_events\\": [ \\"$YK4arsKKcc0LRoe700pS8DSjOvUT4NDv0HfInlMFw2M\\" ], \\"prev_state\\": [], \\"room_id\\": \\"!ERAgBpSOcCCuTJqQPk:matrix.org\\", \\"sender\\": \\"@foobar:matrix.org\\", \\"signatures\\": { \\"matrix.org\\": { \\"ed25519:a_JaEG\\": \\"cs+OUKW/iHx5pEidbWxh0UiNNHwe46Ai9LwNz+Ah16aWDNszVIe2gaAcVZfvNsBhakQTew51tlKmL2kspXk/Dg\\" } }, \\"type\\": \\"m.room.message\\", \\"unsigned\\": { \\"age_ts\\": 1592291711430 } }, \\"id\\": , \\"reason\\": \\"foo\\", \\"score\\": -100, \\"received_ts\\": 1570897107409, \\"canonical_alias\\": \\"#alias1:matrix.org\\", \\"room_id\\": \\"!ERAgBpSOcCCuTJqQPk:matrix.org\\", \\"name\\": \\"Matrix HQ\\", \\"sender\\": \\"@foobar:matrix.org\\", \\"user_id\\": \\"@foo:matrix.org\\"\\n} URL parameters: report_id: string - The ID of the event report. Response The following fields are returned in the JSON response body: id: integer - ID of event report. received_ts: integer - The timestamp (in milliseconds since the unix epoch) when this\\nreport was sent. room_id: string - The ID of the room in which the event being reported is located. name: string - The name of the room. event_id: string - The ID of the reported event. user_id: string - This is the user who reported the event and wrote the reason. reason: string - Comment made by the user_id in this report. May be blank. score: integer - Content is reported based upon a negative score, where -100 is\\n“most offensive” and 0 is “inoffensive”. sender: string - This is the ID of the user who sent the original message/event that\\nwas reported. canonical_alias: string - The canonical alias of the room. null if the room does not\\nhave a canonical alias set. event_json: object - Details of the original event that was reported.","breadcrumbs":"Administration » Admin API » Event Reports » Show details of a specific event report","id":"803","title":"Show details of a specific event report"},"804":{"body":"This API deletes a specific event report. If the request is successful, the response body\\nwill be an empty JSON object. The api is: DELETE /_synapse/admin/v1/event_reports/ URL parameters: report_id: string - The ID of the event report.","breadcrumbs":"Administration » Admin API » Event Reports » Delete a specific event report","id":"804","title":"Delete a specific event report"},"805":{"body":"This API allows a server administrator to enable or disable some experimental features on a per-user\\nbasis. The currently supported features are: MSC3881: enable remotely toggling push notifications\\nfor another client MSC3575: enable experimental sliding sync support To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API.","breadcrumbs":"Administration » Admin API » Experimental Features » Experimental Features API","id":"805","title":"Experimental Features API"},"806":{"body":"This API allows a server administrator to enable experimental features for a given user. The request must\\nprovide a body containing the user id and listing the features to enable/disable in the following format: { \\"features\\": { \\"msc3026\\":true, \\"msc3881\\":true }\\n} where true is used to enable the feature, and false is used to disable the feature. The API is: PUT /_synapse/admin/v1/experimental_features/","breadcrumbs":"Administration » Admin API » Experimental Features » Enabling/Disabling Features","id":"806","title":"Enabling/Disabling Features"},"807":{"body":"To list which features are enabled/disabled for a given user send a request to the following API: GET /_synapse/admin/v1/experimental_features/ It will return a list of possible features and indicate whether they are enabled or disabled for the\\nuser like so: { \\"features\\": { \\"msc3026\\": true, \\"msc3881\\": false, \\"msc3967\\": false }\\n}","breadcrumbs":"Administration » Admin API » Experimental Features » Listing Enabled Features","id":"807","title":"Listing Enabled Features"},"808":{"body":"These APIs allow extracting media information from the homeserver. Details about the format of the media_id and storage of the media in the file system\\nare documented under media repository. To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API.","breadcrumbs":"Administration » Admin API » Media » Querying media","id":"808","title":"Querying media"},"809":{"body":"This API gets a list of known media in a room.\\nHowever, it only shows media from unencrypted events or rooms. The API is: GET /_synapse/admin/v1/room//media The API returns a JSON body like the following: { \\"local\\": [ \\"mxc://localhost/xwvutsrqponmlkjihgfedcba\\", \\"mxc://localhost/abcdefghijklmnopqrstuvwx\\" ], \\"remote\\": [ \\"mxc://matrix.org/xwvutsrqponmlkjihgfedcba\\", \\"mxc://matrix.org/abcdefghijklmnopqrstuvwx\\" ]\\n}","breadcrumbs":"Administration » Admin API » Media » List all media in a room","id":"809","title":"List all media in a room"},"81":{"body":"When configuring the MatrixRTC LiveKit transport, the livekit_service_url is now\\ndeprecated but should continue to be listed to ensure backwards compatibility with\\nolder clients. A new sibling url config property is added that should be set to\\nyour SFU’s WebSocket URL. Clients that support url will use the Client-Server API\\nto (indirectly) interact with the LiveKit authorization service. The service needs\\nto be set up as an application service in order to support these endpoints. See\\nhttps://github.com/element-hq/lk-jwt-service and\\nhttps://element-hq.github.io/synapse/v1.161/usage/configuration/config_documentation.html#matrix_rtc\\nfor further details.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of matrix_rtc.livekit_service_url","id":"81","title":"Deprecation of matrix_rtc.livekit_service_url"},"810":{"body":"Listing all media that has been uploaded by a local user can be achieved through\\nthe use of the List media uploaded by a user\\nAdmin API.","breadcrumbs":"Administration » Admin API » Media » List all media uploaded by a user","id":"810","title":"List all media uploaded by a user"},"811":{"body":"This API returns information about a piece of local or cached remote media given the origin server name and media id. If\\ninformation is requested for remote media which is not cached the endpoint will return 404. Request: GET /_synapse/admin/v1/media// The API returns a JSON body with media info like the following: Response: { \\"media_info\\": { \\"media_origin\\": \\"remote.com\\", \\"user_id\\": null, \\"media_id\\": \\"sdginwegWEG\\", \\"media_type\\": \\"img/png\\", \\"media_length\\": 67, \\"upload_name\\": \\"test.png\\", \\"created_ts\\": 300, \\"filesystem_id\\": \\"wgeweg\\", \\"url_cache\\": null, \\"last_access_ts\\": 400, \\"quarantined_by\\": null, \\"authenticated\\": false, \\"safe_from_quarantine\\": null, \\"sha256\\": \\"ebf4f635a17d10d6eb46ba680b70142419aa3220f228001a036d311a22ee9d2a\\" }\\n}","breadcrumbs":"Administration » Admin API » Media » Query a piece of media by ID","id":"811","title":"Query a piece of media by ID"},"812":{"body":"Quarantining media means that it is marked as inaccessible by users. It applies\\nto any local media, and any locally-cached copies of remote media. The media file itself (and any thumbnails) is not deleted from the server. Since Synapse 1.128.0, hashes of uploaded media are tracked. If this media\\nis quarantined, Synapse will: Quarantine any media with a matching hash that has already been uploaded. Quarantine any future media. Quarantine any existing cached remote media. Quarantine any future remote media.","breadcrumbs":"Administration » Admin API » Media » Quarantine media","id":"812","title":"Quarantine media"},"813":{"body":"Normally, when media is quarantined, it will return a 404 error when downloaded.\\nAdmins can bypass this by adding ?admin_unsafely_bypass_quarantine=true\\nto the normal download URL. Bypassing the quarantine check is not recommended. Media is typically quarantined\\nto prevent harmful content from being served to users, which includes admins. Only\\nset the bypass parameter if you intentionally want to access potentially harmful\\ncontent. Non-admin users cannot bypass quarantine checks, even when specifying the above\\nquery parameter.","breadcrumbs":"Administration » Admin API » Media » Downloading quarantined media","id":"813","title":"Downloading quarantined media"},"814":{"body":"This API quarantines a single piece of local or remote media. Request: POST /_synapse/admin/v1/media/quarantine// {} Where server_name is in the form of example.org, and media_id is in the\\nform of abcdefg12345.... Response: {}","breadcrumbs":"Administration » Admin API » Media » Quarantining media by ID","id":"814","title":"Quarantining media by ID"},"815":{"body":"This API removes a single piece of local or remote media from quarantine. Request: POST /_synapse/admin/v1/media/unquarantine// {} Where server_name is in the form of example.org, and media_id is in the\\nform of abcdefg12345.... Response: {}","breadcrumbs":"Administration » Admin API » Media » Remove media from quarantine by ID","id":"815","title":"Remove media from quarantine by ID"},"816":{"body":"This API quarantines all local and remote media in a room. Request: POST /_synapse/admin/v1/room//media/quarantine {} Where room_id is in the form of !roomid12345:example.org. Response: { \\"num_quarantined\\": 10\\n} The following fields are returned in the JSON response body: num_quarantined: integer - The number of media items successfully quarantined Note that there is a legacy endpoint, POST /_synapse/admin/v1/quarantine_media/, that operates the same.\\nHowever, it is deprecated and may be removed in a future release.","breadcrumbs":"Administration » Admin API » Media » Quarantining media in a room","id":"816","title":"Quarantining media in a room"},"817":{"body":"This API quarantines all local media that a local user has uploaded. That is to say, if\\nyou would like to quarantine media uploaded by a user on a remote homeserver, you should\\ninstead use one of the other APIs. Request: POST /_synapse/admin/v1/user//media/quarantine {} URL Parameters user_id: string - User ID in the form of @bob:example.org Response: { \\"num_quarantined\\": 10\\n} The following fields are returned in the JSON response body: num_quarantined: integer - The number of media items successfully quarantined","breadcrumbs":"Administration » Admin API » Media » Quarantining all media of a user","id":"817","title":"Quarantining all media of a user"},"818":{"body":"This API protects a single piece of local media from being quarantined using the\\nabove APIs. This is useful for sticker packs and other shared media which you do\\nnot want to get quarantined, especially when quarantining media in a room. Request: POST /_synapse/admin/v1/media/protect/ {} Where media_id is in the form of abcdefg12345.... Response: {}","breadcrumbs":"Administration » Admin API » Media » Protecting media from being quarantined","id":"818","title":"Protecting media from being quarantined"},"819":{"body":"This API reverts the protection of a media. Request: POST /_synapse/admin/v1/media/unprotect/ {} Where media_id is in the form of abcdefg12345.... Response: {}","breadcrumbs":"Administration » Admin API » Media » Unprotecting media from being quarantined","id":"819","title":"Unprotecting media from being quarantined"},"82":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.159.0","id":"82","title":"Upgrading to v1.159.0"},"820":{"body":"When media is quarantined or unquarantined, a change record is created in the\\ndatabase. This API returns those change records in the order they were created. Note: This API should be considered best-effort and expected to have missing or\\nduplicate records. Currently, this only captures any media explicitly (un)quarantined by\\nthe media quarantine admin API, and the other cases are tracked by\\nhttps://github.com/element-hq/synapse/issues/19672. Historical media uploaded before\\nSynapse 1.152.0 is backfilled in a background update on a best-effort basis. Each page has a maximum of 100 records. The first page has the oldest records,\\npaginating forwards with each next_batch value. Request: GET /_synapse/admin/v1/media/quarantine_changes?from=2 Where from is the next_batch value from a previous request. It is optional\\nand defaults to the first page (the value 0). Response: { \\"next_batch\\": 4, \\"changes\\": [ { \\"origin\\": \\"example.org\\", \\"media_id\\": \\"abcdefg12345...\\", \\"quarantined\\": true }, { \\"origin\\": \\"example.org\\", \\"media_id\\": \\"abcdefg12345...\\", \\"quarantined\\": false }, { \\"origin\\": \\"another.example.org\\", \\"media_id\\": \\"abcdefg12345...\\", \\"quarantined\\": true } ]\\n}","breadcrumbs":"Administration » Admin API » Media » Listing quarantined media changes","id":"820","title":"Listing quarantined media changes"},"821":{"body":"This API deletes the local media from the disk of your own server.\\nThis includes any local thumbnails and copies of media downloaded from\\nremote homeservers.\\nThis API will not affect media that has been uploaded to external\\nmedia repositories (e.g https://github.com/turt2live/matrix-media-repo/).\\nSee also Purge Remote Media API.","breadcrumbs":"Administration » Admin API » Media » Delete local media","id":"821","title":"Delete local media"},"822":{"body":"Delete a specific media_id. Request: DELETE /_synapse/admin/v1/media// {} URL Parameters server_name: string - The name of your local server (e.g matrix.org) media_id: string - The ID of the media (e.g abcdefghijklmnopqrstuvwx) Response: { \\"deleted_media\\": [ \\"abcdefghijklmnopqrstuvwx\\" ], \\"total\\": 1\\n} The following fields are returned in the JSON response body: deleted_media: an array of strings - List of deleted media_id total: integer - Total number of deleted media_id","breadcrumbs":"Administration » Admin API » Media » Delete a specific local media","id":"822","title":"Delete a specific local media"},"823":{"body":"Request: POST /_synapse/admin/v1/media/delete?before_ts= {} Deprecated in Synapse v1.78.0: This API is available at the deprecated endpoint: POST /_synapse/admin/v1/media//delete?before_ts= {} URL Parameters server_name: string - The name of your local server (e.g matrix.org). Deprecated in Synapse v1.78.0. before_ts: string representing a positive integer - Unix timestamp in milliseconds.\\nFiles that were last used before this timestamp will be deleted. It is the timestamp of\\nlast access, not the timestamp when the file was created. size_gt: Optional - string representing a positive integer - Size of the media in bytes.\\nFiles that are larger will be deleted. Defaults to 0. keep_profiles: Optional - string representing a boolean - Switch to also delete files\\nthat are still used in image data (e.g user profile, room avatar).\\nIf false these files will be deleted. Defaults to true. Response: { \\"deleted_media\\": [ \\"abcdefghijklmnopqrstuvwx\\", \\"abcdefghijklmnopqrstuvwz\\" ], \\"total\\": 2\\n} The following fields are returned in the JSON response body: deleted_media: an array of strings - List of deleted media_id total: integer - Total number of deleted media_id","breadcrumbs":"Administration » Admin API » Media » Delete local media by date or size","id":"823","title":"Delete local media by date or size"},"824":{"body":"You can find details of how to delete multiple media uploaded by a user in User Admin API.","breadcrumbs":"Administration » Admin API » Media » Delete media uploaded by a user","id":"824","title":"Delete media uploaded by a user"},"825":{"body":"The purge remote media API allows server admins to purge old cached remote media. The API is: POST /_synapse/admin/v1/purge_media_cache?before_ts= {} URL Parameters before_ts: string representing a positive integer - Unix timestamp in milliseconds.\\nAll cached media that was last accessed before this timestamp will be removed. Response: { \\"deleted\\": 10\\n} The following fields are returned in the JSON response body: deleted: integer - The number of media items successfully deleted If the user re-requests purged remote media, synapse will re-request the media\\nfrom the originating server.","breadcrumbs":"Administration » Admin API » Media » Purge Remote Media API","id":"825","title":"Purge Remote Media API"},"826":{"body":"The purge history API allows server admins to purge historic events from their\\ndatabase, reclaiming disk space. Depending on the amount of history being purged a call to the API may take\\nseveral minutes or longer. During this period users will not be able to\\npaginate further back in the room from the point being purged from. Note that Synapse requires at least one message in each room, so it will never\\ndelete the last message in a room. To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API. The API is: POST /_synapse/admin/v1/purge_history/[/] By default, events sent by local users are not deleted, as they may represent\\nthe only copies of this content in existence. (Events sent by remote users are\\ndeleted.) Room state data (such as joins, leaves, topic) is always preserved. To delete local message events as well, set delete_local_events in the body: { \\"delete_local_events\\": true\\n} The caller must specify the point in the room to purge up to. This can be\\nspecified by including an event_id in the URI, or by setting a purge_up_to_event_id or purge_up_to_ts in the request body. If an event\\nid is given, that event (and others at the same graph depth) will be retained.\\nIf purge_up_to_ts is given, it should be a timestamp since the unix epoch,\\nin milliseconds. The API starts the purge running, and returns immediately with a JSON body with\\na purge id: { \\"purge_id\\": \\"\\"\\n}","breadcrumbs":"Administration » Admin API » Purge History » Purge History API","id":"826","title":"Purge History API"},"827":{"body":"It is possible to poll for updates on recent purges with a second API; GET /_synapse/admin/v1/purge_history_status/ This API returns a JSON body like the following: { \\"status\\": \\"active\\"\\n} The status will be one of active, complete, or failed. If status is failed there will be a string error with the error message.","breadcrumbs":"Administration » Admin API » Purge History » Purge status query","id":"827","title":"Purge status query"},"828":{"body":"To reclaim the disk space and return it to the operating system, you need to run VACUUM FULL; on the database. https://www.postgresql.org/docs/current/sql-vacuum.html","breadcrumbs":"Administration » Admin API » Purge History » Reclaim disk space (Postgres)","id":"828","title":"Reclaim disk space (Postgres)"},"829":{"body":"Note: This API is disabled when Matrix Authentication Service integration is enabled.\\nUse the MAS Admin API or the MAS CLI instead. This API allows for the creation of users in an administrative and\\nnon-interactive way. This is generally used for bootstrapping a Synapse\\ninstance with administrator accounts. To authenticate yourself to the server, you will need both the shared secret\\n( registration_shared_secret\\nin the homeserver configuration), and a one-time nonce. If the registration\\nshared secret is not configured, this API is not enabled. To fetch the nonce, you need to request one from the API: > GET /_synapse/admin/v1/register < {\\"nonce\\": \\"thisisanonce\\"} Once you have the nonce, you can make a POST to the same URL with a JSON\\nbody containing the nonce, username, password, whether they are an admin\\n(optional, False by default), and a HMAC digest of the content. Also you can\\nset the displayname (optional, username by default). As an example: > POST /_synapse/admin/v1/register\\n> { \\"nonce\\": \\"thisisanonce\\", \\"username\\": \\"pepper_roni\\", \\"displayname\\": \\"Pepper Roni\\", \\"password\\": \\"pizza\\", \\"admin\\": true, \\"mac\\": \\"mac_digest_here\\" } < { \\"access_token\\": \\"token_here\\", \\"user_id\\": \\"@pepper_roni:localhost\\", \\"home_server\\": \\"test\\", \\"device_id\\": \\"device_id_here\\" } The MAC is the hex digest output of the HMAC-SHA1 algorithm, with the key being\\nthe shared secret and the content being the nonce, user, password, either the\\nstring “admin” or “notadmin”, and optionally the user_type\\neach separated by NULs. Here is an easy way to generate the HMAC digest if you have Bash and OpenSSL: # Update these values and then paste this code block into a bash terminal\\nnonce=\'thisisanonce\'\\nusername=\'pepper_roni\'\\npassword=\'pizza\'\\nadmin=\'admin\'\\nsecret=\'shared_secret\' printf \'%s\\\\0%s\\\\0%s\\\\0%s\' \\"$nonce\\" \\"$username\\" \\"$password\\" \\"$admin\\" | openssl sha1 -hmac \\"$secret\\" | awk \'{print $2}\' For an example of generation in Python: import hmac, hashlib def generate_mac(nonce, user, password, admin=False, user_type=None): mac = hmac.new( key=shared_secret, digestmod=hashlib.sha1, ) mac.update(nonce.encode(\'utf8\')) mac.update(b\\"\\\\x00\\") mac.update(user.encode(\'utf8\')) mac.update(b\\"\\\\x00\\") mac.update(password.encode(\'utf8\')) mac.update(b\\"\\\\x00\\") mac.update(b\\"admin\\" if admin else b\\"notadmin\\") if user_type: mac.update(b\\"\\\\x00\\") mac.update(user_type.encode(\'utf8\')) return mac.hexdigest()","breadcrumbs":"Administration » Admin API » Register Users » Shared-Secret Registration","id":"829","title":"Shared-Secret Registration"},"83":{"body":"Administrators using the Debian/Ubuntu packages from packages.matrix.org,\\nplease be aware that we have recently updated the expiry date on the repository’s GPG signing key,\\nbut this change must be imported into your keyring. If you have the matrix-org-archive-keyring package installed and it updates before the current key expires, this should\\nhappen automatically. Otherwise, if you see an error similar to The following signatures were invalid: EXPKEYSIG F473DD4473365DE1, you\\nwill need to get a fresh copy of the keys. You can do so with: sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg The old version of the key will expire on 2027-03-15.","breadcrumbs":"Upgrading between Synapse Versions » Change of signing key expiry date for the Debian/Ubuntu package repository (2026)","id":"83","title":"Change of signing key expiry date for the Debian/Ubuntu package repository (2026)"},"830":{"body":"Note: This API is disabled when Matrix Authentication Service integration is enabled. Use the MAS Admin API or the MAS CLI instead. An easy way to make use of this functionality is provided by Element Admin as part of ESS Community and Pro. This API allows you to manage tokens which can be used to authenticate\\nregistration requests, as proposed in MSC3231\\nand stabilised in version 1.2 of the Matrix specification.\\nTo use it, you will need to enable the registration_requires_token config\\noption, and authenticate by providing an access_token for a server admin:\\nsee Admin API.","breadcrumbs":"Administration » Admin API » Registration Tokens » Registration Tokens","id":"830","title":"Registration Tokens"},"831":{"body":"Most endpoints make use of JSON objects that contain details about tokens.\\nThese objects have the following fields: token: The token which can be used to authenticate registration. uses_allowed: The number of times the token can be used to complete a\\nregistration before it becomes invalid. pending: The number of pending uses the token has. When someone uses\\nthe token to authenticate themselves, the pending counter is incremented\\nso that the token is not used more than the permitted number of times.\\nWhen the person completes registration the pending counter is decremented,\\nand the completed counter is incremented. completed: The number of times the token has been used to successfully\\ncomplete a registration. expiry_time: The latest time the token is valid. Given as the number of\\nmilliseconds since 1970-01-01 00:00:00 UTC (the start of the Unix epoch).\\nTo convert this into a human-readable form you can remove the milliseconds\\nand use the date command. For example, date -d \'@1625394937\'.","breadcrumbs":"Administration » Admin API » Registration Tokens » Registration token objects","id":"831","title":"Registration token objects"},"832":{"body":"Lists all tokens and details about them. If the request is successful, the top\\nlevel JSON object will have a registration_tokens key which is an array of\\nregistration token objects. GET /_synapse/admin/v1/registration_tokens Optional query parameters: valid: true or false. If true, only valid tokens are returned.\\nIf false, only tokens that have expired or have had all uses exhausted are\\nreturned. If omitted, all tokens are returned regardless of validity. Example: GET /_synapse/admin/v1/registration_tokens 200 OK { \\"registration_tokens\\": [ { \\"token\\": \\"abcd\\", \\"uses_allowed\\": 3, \\"pending\\": 0, \\"completed\\": 1, \\"expiry_time\\": null }, { \\"token\\": \\"pqrs\\", \\"uses_allowed\\": 2, \\"pending\\": 1, \\"completed\\": 1, \\"expiry_time\\": null }, { \\"token\\": \\"wxyz\\", \\"uses_allowed\\": null, \\"pending\\": 0, \\"completed\\": 9, \\"expiry_time\\": 1625394937000 // 2021-07-04 10:35:37 UTC } ]\\n} Example using the valid query parameter: GET /_synapse/admin/v1/registration_tokens?valid=false 200 OK { \\"registration_tokens\\": [ { \\"token\\": \\"pqrs\\", \\"uses_allowed\\": 2, \\"pending\\": 1, \\"completed\\": 1, \\"expiry_time\\": null }, { \\"token\\": \\"wxyz\\", \\"uses_allowed\\": null, \\"pending\\": 0, \\"completed\\": 9, \\"expiry_time\\": 1625394937000 // 2021-07-04 10:35:37 UTC } ]\\n}","breadcrumbs":"Administration » Admin API » Registration Tokens » List all tokens","id":"832","title":"List all tokens"},"833":{"body":"Get details about a single token. If the request is successful, the response\\nbody will be a registration token object. GET /_synapse/admin/v1/registration_tokens/ Path parameters: token: The registration token to return details of. Example: GET /_synapse/admin/v1/registration_tokens/abcd 200 OK { \\"token\\": \\"abcd\\", \\"uses_allowed\\": 3, \\"pending\\": 0, \\"completed\\": 1, \\"expiry_time\\": null\\n}","breadcrumbs":"Administration » Admin API » Registration Tokens » Get one token","id":"833","title":"Get one token"},"834":{"body":"Create a new registration token. If the request is successful, the newly created\\ntoken will be returned as a registration token object in the response body. POST /_synapse/admin/v1/registration_tokens/new The request body must be a JSON object and can contain the following fields: token: The registration token. A string of no more than 64 characters that\\nconsists only of characters matched by the regex [A-Za-z0-9._~-].\\nDefault: randomly generated. uses_allowed: The integer number of times the token can be used to complete\\na registration before it becomes invalid.\\nDefault: null (unlimited uses). expiry_time: The latest time the token is valid. Given as the number of\\nmilliseconds since 1970-01-01 00:00:00 UTC (the start of the Unix epoch).\\nYou could use, for example, date \'+%s000\' -d \'tomorrow\'.\\nDefault: null (token does not expire). length: The length of the token randomly generated if token is not\\nspecified. Must be between 1 and 64 inclusive. Default: 16. If a field is omitted the default is used. Example using defaults: POST /_synapse/admin/v1/registration_tokens/new {} 200 OK { \\"token\\": \\"0M-9jbkf2t_Tgiw1\\", \\"uses_allowed\\": null, \\"pending\\": 0, \\"completed\\": 0, \\"expiry_time\\": null\\n} Example specifying some fields: POST /_synapse/admin/v1/registration_tokens/new { \\"token\\": \\"defg\\", \\"uses_allowed\\": 1\\n} 200 OK { \\"token\\": \\"defg\\", \\"uses_allowed\\": 1, \\"pending\\": 0, \\"completed\\": 0, \\"expiry_time\\": null\\n}","breadcrumbs":"Administration » Admin API » Registration Tokens » Create token","id":"834","title":"Create token"},"835":{"body":"Update the number of allowed uses or expiry time of a token. If the request is\\nsuccessful, the updated token will be returned as a registration token object\\nin the response body. PUT /_synapse/admin/v1/registration_tokens/ Path parameters: token: The registration token to update. The request body must be a JSON object and can contain the following fields: uses_allowed: The integer number of times the token can be used to complete\\na registration before it becomes invalid. By setting uses_allowed to 0\\nthe token can be easily made invalid without deleting it.\\nIf null the token will have an unlimited number of uses. expiry_time: The latest time the token is valid. Given as the number of\\nmilliseconds since 1970-01-01 00:00:00 UTC (the start of the Unix epoch).\\nIf null the token will not expire. If a field is omitted its value is not modified. Example: PUT /_synapse/admin/v1/registration_tokens/defg { \\"expiry_time\\": 4781243146000 // 2121-07-06 11:05:46 UTC\\n} 200 OK { \\"token\\": \\"defg\\", \\"uses_allowed\\": 1, \\"pending\\": 0, \\"completed\\": 0, \\"expiry_time\\": 4781243146000\\n}","breadcrumbs":"Administration » Admin API » Registration Tokens » Update token","id":"835","title":"Update token"},"836":{"body":"Delete a registration token. If the request is successful, the response body\\nwill be an empty JSON object. DELETE /_synapse/admin/v1/registration_tokens/ Path parameters: token: The registration token to delete. Example: DELETE /_synapse/admin/v1/registration_tokens/wxyz 200 OK {}","breadcrumbs":"Administration » Admin API » Registration Tokens » Delete token","id":"836","title":"Delete token"},"837":{"body":"If a request fails a “standard error response” will be returned as defined in\\nthe Matrix Client-Server API specification. For example, if the token specified in a path parameter does not exist a 404 Not Found error will be returned. GET /_synapse/admin/v1/registration_tokens/1234 404 Not Found { \\"errcode\\": \\"M_NOT_FOUND\\", \\"error\\": \\"No such registration token: 1234\\"\\n}","breadcrumbs":"Administration » Admin API » Registration Tokens » Errors","id":"837","title":"Errors"},"838":{"body":"This API allows an administrator to join a user account with a given user_id\\nto a room with a given room_id_or_alias. You can only modify the membership of\\nlocal users. The server administrator must be in the room and have permission to\\ninvite users. To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API.","breadcrumbs":"Administration » Admin API » Manipulate Room Membership » Edit Room Membership API","id":"838","title":"Edit Room Membership API"},"839":{"body":"The following parameters are available: user_id - Fully qualified user: for example, @user:server.com. room_id_or_alias - The room identifier or alias to join: for example, !636q39766251:server.com.","breadcrumbs":"Administration » Admin API » Manipulate Room Membership » Parameters","id":"839","title":"Parameters"},"84":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.158.0","id":"84","title":"Upgrading to v1.158.0"},"840":{"body":"POST /_synapse/admin/v1/join/ { \\"user_id\\": \\"@user:server.com\\"\\n} Response: { \\"room_id\\": \\"!636q39766251:server.com\\"\\n}","breadcrumbs":"Administration » Admin API » Manipulate Room Membership » Usage","id":"840","title":"Usage"},"841":{"body":"The List Room admin API allows server admins to get a list of rooms on their\\nserver. There are various parameters available that allow for filtering and\\nsorting the returned list. This API supports pagination. To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API. Parameters The following query parameters are available: from - Offset in the returned list. Defaults to 0. limit - Maximum amount of rooms to return. Defaults to 100. order_by - The method in which to sort the returned list of rooms. Valid values are: alphabetical - Same as name. This is deprecated. size - Same as joined_members. This is deprecated. name - Rooms are ordered alphabetically by room name. This is the default. canonical_alias - Rooms are ordered alphabetically by main alias address of the room. joined_members - Rooms are ordered by the number of members. Largest to smallest. joined_local_members - Rooms are ordered by the number of local members. Largest to smallest. version - Rooms are ordered by room version. Largest to smallest. creator - Rooms are ordered alphabetically by creator of the room. encryption - Rooms are ordered alphabetically by the end-to-end encryption algorithm. federatable - Rooms are ordered by whether the room is federatable. public - Rooms are ordered by visibility in room list. join_rules - Rooms are ordered alphabetically by join rules of the room. guest_access - Rooms are ordered alphabetically by guest access option of the room. history_visibility - Rooms are ordered alphabetically by visibility of history of the room. state_events - Rooms are ordered by number of state events. Largest to smallest. dir - Direction of room order. Either f for forwards or b for backwards. Setting\\nthis value to b will reverse the above sort order. Defaults to f. search_term - Filter rooms by their room name, canonical alias and room id.\\nSpecifically, rooms are selected if the search term is contained in the room’s name, the local part of the room’s canonical alias, or the complete (local and server part) room’s id (case sensitive). public_rooms - Optional flag to filter public rooms. If true, only public rooms are queried. If false, public rooms are excluded from\\nthe query. When the flag is absent (the default), both public and non-public rooms are included in the search results. empty_rooms - Optional flag to filter empty rooms. A room is empty if joined_members is zero. If true, only empty rooms are queried. If false, empty rooms are excluded from\\nthe query. When the flag is absent (the default), both empty and non-empty rooms are included in the search results. Defaults to no filtering. Response The following fields are possible in the JSON response body: rooms - An array of objects, each containing information about a room. Room objects contain the following fields: room_id - The ID of the room. name - The name of the room. canonical_alias - The canonical (main) alias address of the room. joined_members - How many users are currently in the room. joined_local_members - How many local users are currently in the room. version - The version of the room as a string. creator - The user_id of the room creator. encryption - Algorithm of end-to-end encryption of messages. Is null if encryption is not active. federatable - Whether users on other servers can join this room. public - Whether the room is visible in room directory. join_rules - The type of rules used for users wishing to join this room. One of: [“public”, “knock”, “invite”, “private”]. guest_access - Whether guests can join the room. One of: [“can_join”, “forbidden”]. history_visibility - Who can see the room history. One of: [“invited”, “joined”, “shared”, “world_readable”]. state_events - Total number of state_events of a room. Complexity of the room. room_type - The type of the room taken from the room’s creation event; for example “m.space” if the room is a space. If the room does not define a type, the value will be null. offset - The current pagination offset in rooms. This parameter should be\\nused instead of next_token for room offset as next_token is\\nnot intended to be parsed. total_rooms - The total number of rooms this query can return. Using this\\nand offset, you have enough information to know the current\\nprogression through the list. next_batch - If this field is present, we know that there are potentially\\nmore rooms on the server that did not all fit into this response.\\nWe can use next_batch to get the “next page” of results. To do\\nso, simply repeat your request, setting the from parameter to\\nthe value of next_batch. prev_batch - If this field is present, it is possible to paginate backwards.\\nUse prev_batch for the from value in the next request to\\nget the “previous page” of results. The API is: A standard request with no filtering: GET /_synapse/admin/v1/rooms A response body like the following is returned: { \\"rooms\\": [ { \\"room_id\\": \\"!OGEhHVWSdvArJzumhm:matrix.org\\", \\"name\\": \\"Matrix HQ\\", \\"canonical_alias\\": \\"#matrix:matrix.org\\", \\"joined_members\\": 8326, \\"joined_local_members\\": 2, \\"version\\": \\"1\\", \\"creator\\": \\"@foo:matrix.org\\", \\"encryption\\": null, \\"federatable\\": true, \\"public\\": true, \\"join_rules\\": \\"invite\\", \\"guest_access\\": null, \\"history_visibility\\": \\"shared\\", \\"state_events\\": 93534, \\"room_type\\": \\"m.space\\" }, ... (8 hidden items) ... { \\"room_id\\": \\"!xYvNcQPhnkrdUmYczI:matrix.org\\", \\"name\\": \\"This Week In Matrix (TWIM)\\", \\"canonical_alias\\": \\"#twim:matrix.org\\", \\"joined_members\\": 314, \\"joined_local_members\\": 20, \\"version\\": \\"4\\", \\"creator\\": \\"@foo:matrix.org\\", \\"encryption\\": \\"m.megolm.v1.aes-sha2\\", \\"federatable\\": true, \\"public\\": false, \\"join_rules\\": \\"invite\\", \\"guest_access\\": null, \\"history_visibility\\": \\"shared\\", \\"state_events\\": 8345, \\"room_type\\": null } ], \\"offset\\": 0, \\"total_rooms\\": 10\\n} Filtering by room name: GET /_synapse/admin/v1/rooms?search_term=TWIM A response body like the following is returned: { \\"rooms\\": [ { \\"room_id\\": \\"!xYvNcQPhnkrdUmYczI:matrix.org\\", \\"name\\": \\"This Week In Matrix (TWIM)\\", \\"canonical_alias\\": \\"#twim:matrix.org\\", \\"joined_members\\": 314, \\"joined_local_members\\": 20, \\"version\\": \\"4\\", \\"creator\\": \\"@foo:matrix.org\\", \\"encryption\\": \\"m.megolm.v1.aes-sha2\\", \\"federatable\\": true, \\"public\\": false, \\"join_rules\\": \\"invite\\", \\"guest_access\\": null, \\"history_visibility\\": \\"shared\\", \\"state_events\\": 8, \\"room_type\\": null } ], \\"offset\\": 0, \\"total_rooms\\": 1\\n} Paginating through a list of rooms: GET /_synapse/admin/v1/rooms?order_by=size A response body like the following is returned: { \\"rooms\\": [ { \\"room_id\\": \\"!OGEhHVWSdvArJzumhm:matrix.org\\", \\"name\\": \\"Matrix HQ\\", \\"canonical_alias\\": \\"#matrix:matrix.org\\", \\"joined_members\\": 8326, \\"joined_local_members\\": 2, \\"version\\": \\"1\\", \\"creator\\": \\"@foo:matrix.org\\", \\"encryption\\": null, \\"federatable\\": true, \\"public\\": true, \\"join_rules\\": \\"invite\\", \\"guest_access\\": null, \\"history_visibility\\": \\"shared\\", \\"state_events\\": 93534, \\"room_type\\": null }, ... (98 hidden items) ... { \\"room_id\\": \\"!xYvNcQPhnkrdUmYczI:matrix.org\\", \\"name\\": \\"This Week In Matrix (TWIM)\\", \\"canonical_alias\\": \\"#twim:matrix.org\\", \\"joined_members\\": 314, \\"joined_local_members\\": 20, \\"version\\": \\"4\\", \\"creator\\": \\"@foo:matrix.org\\", \\"encryption\\": \\"m.megolm.v1.aes-sha2\\", \\"federatable\\": true, \\"public\\": false, \\"join_rules\\": \\"invite\\", \\"guest_access\\": null, \\"history_visibility\\": \\"shared\\", \\"state_events\\": 8345, \\"room_type\\": \\"m.space\\" } ], \\"offset\\": 0, \\"total_rooms\\": 150, \\"next_token\\": 100\\n} The presence of the next_token parameter tells us that there are more rooms\\nthan returned in this request, and we need to make another request to get them.\\nTo get the next batch of room results, we repeat our request, setting the from\\nparameter to the value of next_token. GET /_synapse/admin/v1/rooms?order_by=size&from=100 A response body like the following is returned: { \\"rooms\\": [ { \\"room_id\\": \\"!mscvqgqpHYjBGDxNym:matrix.org\\", \\"name\\": \\"Music Theory\\", \\"canonical_alias\\": \\"#musictheory:matrix.org\\", \\"joined_members\\": 127, \\"joined_local_members\\": 2, \\"version\\": \\"1\\", \\"creator\\": \\"@foo:matrix.org\\", \\"encryption\\": null, \\"federatable\\": true, \\"public\\": true, \\"join_rules\\": \\"invite\\", \\"guest_access\\": null, \\"history_visibility\\": \\"shared\\", \\"state_events\\": 93534, \\"room_type\\": \\"m.space\\" }, ... (48 hidden items) ... { \\"room_id\\": \\"!twcBhHVdZlQWuuxBhN:termina.org.uk\\", \\"name\\": \\"weechat-matrix\\", \\"canonical_alias\\": \\"#weechat-matrix:termina.org.uk\\", \\"joined_members\\": 137, \\"joined_local_members\\": 20, \\"version\\": \\"4\\", \\"creator\\": \\"@foo:termina.org.uk\\", \\"encryption\\": null, \\"federatable\\": true, \\"public\\": true, \\"join_rules\\": \\"invite\\", \\"guest_access\\": null, \\"history_visibility\\": \\"shared\\", \\"state_events\\": 8345, \\"room_type\\": null } ], \\"offset\\": 100, \\"prev_batch\\": 0, \\"total_rooms\\": 150\\n} Once the next_token parameter is no longer present, we know we’ve reached the\\nend of the list.","breadcrumbs":"Administration » Admin API » Rooms » List Room API","id":"841","title":"List Room API"},"842":{"body":"The Room Details admin API allows server admins to get all details of a room. The following fields are possible in the JSON response body: room_id - The ID of the room. name - The name of the room. topic - The topic of the room. avatar - The mxc URI to the avatar of the room. canonical_alias - The canonical (main) alias address of the room. joined_members - How many users are currently in the room. joined_local_members - How many local users are currently in the room. joined_local_devices - How many local devices are currently in the room. version - The version of the room as a string. creator - The user_id of the room creator. encryption - Algorithm of end-to-end encryption of messages. Is null if encryption is not active. federatable - Whether users on other servers can join this room. public - Whether the room is visible in room directory. join_rules - The type of rules used for users wishing to join this room. One of: [“public”, “knock”, “invite”, “private”]. guest_access - Whether guests can join the room. One of: [“can_join”, “forbidden”]. history_visibility - Who can see the room history. One of: [“invited”, “joined”, “shared”, “world_readable”]. state_events - Total number of state_events of a room. Complexity of the room. room_type - The type of the room taken from the room’s creation event; for example “m.space” if the room is a space.\\nIf the room does not define a type, the value will be null. forgotten - Whether all local users have forgotten the room. tombstoned - Whether the room has been tombstoned (permanently closed). replacement_room - The room ID of the new room that users should join instead, if this room was tombstoned. Will be null if the room has not been tombstoned, or if it was tombstoned without designating a successor room. The API is: GET /_synapse/admin/v1/rooms/ A response body like the following is returned: { \\"room_id\\": \\"!mscvqgqpHYjBGDxNym:matrix.org\\", \\"name\\": \\"Music Theory\\", \\"avatar\\": \\"mxc://matrix.org/AQDaVFlbkQoErdOgqWRgiGSV\\", \\"topic\\": \\"Theory, Composition, Notation, Analysis\\", \\"canonical_alias\\": \\"#musictheory:matrix.org\\", \\"joined_members\\": 127, \\"joined_local_members\\": 2, \\"joined_local_devices\\": 2, \\"version\\": \\"1\\", \\"creator\\": \\"@foo:matrix.org\\", \\"encryption\\": null, \\"federatable\\": true, \\"public\\": true, \\"join_rules\\": \\"invite\\", \\"guest_access\\": null, \\"history_visibility\\": \\"shared\\", \\"state_events\\": 93534, \\"room_type\\": \\"m.space\\", \\"forgotten\\": false, \\"tombstoned\\": false, \\"replacement_room\\": null\\n} Changed in Synapse 1.66: Added the forgotten key to the response body.","breadcrumbs":"Administration » Admin API » Rooms » Room Details API","id":"842","title":"Room Details API"},"843":{"body":"The Room Members admin API allows server admins to get a list of all members of a room. The response includes the following fields: members - A list of all the members that are present in the room, represented by their ids. total - Total number of members in the room. The API is: GET /_synapse/admin/v1/rooms//members A response body like the following is returned: { \\"members\\": [ \\"@foo:matrix.org\\", \\"@bar:matrix.org\\", \\"@foobar:matrix.org\\" ], \\"total\\": 3\\n}","breadcrumbs":"Administration » Admin API » Rooms » Room Members API","id":"843","title":"Room Members API"},"844":{"body":"The Room State admin API allows server admins to get a list of all state events in a room. The response includes the following fields: state - The current state of the room at the time of request. The API is: GET /_synapse/admin/v1/rooms//state Parameters The following query parameter is available: type - The type of room state event to filter by, eg “m.room.create”. If provided, only state events\\nof this type will be returned (regardless of their state_key value). A response body like the following is returned: { \\"state\\": [ {\\"type\\": \\"m.room.create\\", \\"state_key\\": \\"\\", \\"etc\\": true}, {\\"type\\": \\"m.room.power_levels\\", \\"state_key\\": \\"\\", \\"etc\\": true}, {\\"type\\": \\"m.room.name\\", \\"state_key\\": \\"\\", \\"etc\\": true} ]\\n}","breadcrumbs":"Administration » Admin API » Rooms » Room State API","id":"844","title":"Room State API"},"845":{"body":"The Room Messages admin API allows server admins to get all messages\\nsent to a room in a given timeframe. There are various parameters available\\nthat allow for filtering and ordering the returned list. This API supports pagination. To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API. This endpoint mirrors the Matrix Spec defined Messages API. The API is: GET /_synapse/admin/v1/rooms//messages Parameters The following path parameters are required: room_id - The ID of the room you wish you fetch messages from. The following query parameters are available: from (required) - The token to start returning events from. This token can be obtained from a prev_batch\\nor next_batch token returned by the /sync endpoint, or from an end token returned by a previous request to this endpoint. to - The token to stop returning events at. limit - The maximum number of events to return. Defaults to 10. filter - A JSON RoomEventFilter to filter returned events with. dir - The direction to return events from. Either f for forwards or b for backwards. Setting\\nthis value to b will reverse the above sort order. Defaults to f. Response The following fields are possible in the JSON response body: chunk - A list of room events. The order depends on the dir parameter.\\nNote that an empty chunk does not necessarily imply that no more events are available. Clients should continue to paginate until no end property is returned. end - A token corresponding to the end of chunk. This token can be passed back to this endpoint to request further events.\\nIf no further events are available, this property is omitted from the response. start - A token corresponding to the start of chunk. state - A list of state events relevant to showing the chunk. Example For more details on each chunk, read the Matrix specification. { \\"chunk\\": [ { \\"content\\": { \\"body\\": \\"This is an example text message\\", \\"format\\": \\"org.matrix.custom.html\\", \\"formatted_body\\": \\"This is an example text message\\", \\"msgtype\\": \\"m.text\\" }, \\"event_id\\": \\"$143273582443PhrSn:example.org\\", \\"origin_server_ts\\": 1432735824653, \\"room_id\\": \\"!636q39766251:example.com\\", \\"sender\\": \\"@example:example.org\\", \\"type\\": \\"m.room.message\\", \\"unsigned\\": { \\"age\\": 1234 } }, { \\"content\\": { \\"name\\": \\"The room name\\" }, \\"event_id\\": \\"$143273582443PhrSn:example.org\\", \\"origin_server_ts\\": 1432735824653, \\"room_id\\": \\"!636q39766251:example.com\\", \\"sender\\": \\"@example:example.org\\", \\"state_key\\": \\"\\", \\"type\\": \\"m.room.name\\", \\"unsigned\\": { \\"age\\": 1234 } }, { \\"content\\": { \\"body\\": \\"Gangnam Style\\", \\"info\\": { \\"duration\\": 2140786, \\"h\\": 320, \\"mimetype\\": \\"video/mp4\\", \\"size\\": 1563685, \\"thumbnail_info\\": { \\"h\\": 300, \\"mimetype\\": \\"image/jpeg\\", \\"size\\": 46144, \\"w\\": 300 }, \\"thumbnail_url\\": \\"mxc://example.org/FHyPlCeYUSFFxlgbQYZmoEoe\\", \\"w\\": 480 }, \\"msgtype\\": \\"m.video\\", \\"url\\": \\"mxc://example.org/a526eYUSFFxlgbQYZmo442\\" }, \\"event_id\\": \\"$143273582443PhrSn:example.org\\", \\"origin_server_ts\\": 1432735824653, \\"room_id\\": \\"!636q39766251:example.com\\", \\"sender\\": \\"@example:example.org\\", \\"type\\": \\"m.room.message\\", \\"unsigned\\": { \\"age\\": 1234 } } ], \\"end\\": \\"t47409-4357353_219380_26003_2265\\", \\"start\\": \\"t47429-4392820_219380_26003_2265\\"\\n}","breadcrumbs":"Administration » Admin API » Rooms » Room Messages API","id":"845","title":"Room Messages API"},"846":{"body":"The Room Timestamp to Event API endpoint fetches the event_id of the closest event to the given\\ntimestamp ( ts query parameter) in the given direction ( dir query parameter). Useful for cases like jump to date so you can start paginating messages from\\na given date in the archive. The API is: GET /_synapse/admin/v1/rooms//timestamp_to_event Parameters The following path parameters are required: room_id - The ID of the room you wish to check. The following query parameters are available: ts - a timestamp in milliseconds where we will find the closest event in\\nthe given direction. dir - can be f or b to indicate forwards and backwards in time from the\\ngiven timestamp. Defaults to f. Response event_id - The event ID closest to the given timestamp. origin_server_ts - The timestamp of the event in milliseconds since the Unix epoch.","breadcrumbs":"Administration » Admin API » Rooms » Room Timestamp to Event API","id":"846","title":"Room Timestamp to Event API"},"847":{"body":"The Block Room admin API allows server admins to block and unblock rooms,\\nand query to see if a given room is blocked.\\nThis API can be used to pre-emptively block a room, even if it’s unknown to this\\nhomeserver. Users will be prevented from joining a blocked room.","breadcrumbs":"Administration » Admin API » Rooms » Block Room API","id":"847","title":"Block Room API"},"848":{"body":"The API is: PUT /_synapse/admin/v1/rooms//block with a body of: { \\"block\\": true\\n} A response body like the following is returned: { \\"block\\": true\\n} Parameters The following parameters should be set in the URL: room_id - The ID of the room. The following JSON body parameters are available: block - If true the room will be blocked and if false the room will be unblocked. Response The following fields are possible in the JSON response body: block - A boolean. true if the room is blocked, otherwise false","breadcrumbs":"Administration » Admin API » Rooms » Block or unblock a room","id":"848","title":"Block or unblock a room"},"849":{"body":"The API is: GET /_synapse/admin/v1/rooms//block A response body like the following is returned: { \\"block\\": true, \\"user_id\\": \\"\\"\\n} Parameters The following parameters should be set in the URL: room_id - The ID of the room. Response The following fields are possible in the JSON response body: block - A boolean. true if the room is blocked, otherwise false user_id - An optional string. If the room is blocked ( block is true) shows\\nthe user who has add the room to blocking list. Otherwise it is not displayed.","breadcrumbs":"Administration » Admin API » Rooms » Get block status","id":"849","title":"Get block status"},"85":{"body":"Ubuntu 25.10 ‘Questing Quokka’ is end-of-life as of\\n2026-07-01. This release drops support for Ubuntu 25.10,\\nand in its place adds support for Ubuntu 26.04 ‘Resolute Raccoon’.","breadcrumbs":"Upgrading between Synapse Versions » Drop support for Ubuntu 25.10 ‘Questing Quokka’, add support for Ubuntu 26.04 ‘Resolute Raccoon’","id":"85","title":"Drop support for Ubuntu 25.10 ‘Questing Quokka’, add support for Ubuntu 26.04 ‘Resolute Raccoon’"},"850":{"body":"The Delete Room admin API allows server admins to remove rooms from the server\\nand block these rooms. Shuts down a room. Moves all local users and room aliases automatically to a\\nnew room if new_room_user_id is set. Otherwise local users only\\nleave the room without any information. The new room will be created with the user specified by the new_room_user_id parameter\\nas room administrator and will contain a message explaining what happened. Users invited\\nto the new room will have power level -10 by default, and thus be unable to speak. If block is true, users will be prevented from joining the old room.\\nThis option can in Version 1 also be used to pre-emptively\\nblock a room, even if it’s unknown to this homeserver. In this case, the room will be\\nblocked, and no further action will be taken. If block is false, attempting to\\ndelete an unknown room is invalid and will be rejected as a bad request. This API will remove all trace of the old room from your database after removing\\nall local users. If purge is true (the default), all traces of the old room will\\nbe removed from your database after removing all local users. If you do not want\\nthis to happen, set purge to false.\\nDepending on the amount of history being purged, a call to the API may take\\nseveral minutes or longer. The local server will only have the power to move local user and room aliases to\\nthe new room. Users on other servers will be unaffected.","breadcrumbs":"Administration » Admin API » Rooms » Delete Room API","id":"850","title":"Delete Room API"},"851":{"body":"This version works synchronously. That means you only get the response once the server has\\nfinished the action, which may take a long time. If you request the same action\\na second time, and the server has not finished the first one, the second request will block.\\nThis is fixed in version 2 of this API. The parameters are the same in both APIs.\\nThis API will become deprecated in the future. The API is: DELETE /_synapse/admin/v1/rooms/ with a body of: { \\"new_room_user_id\\": \\"@someuser:example.com\\", \\"room_name\\": \\"Content Violation Notification\\", \\"message\\": \\"Bad Room has been shutdown due to content violations on this server. Please review our Terms of Service.\\", \\"block\\": true, \\"purge\\": true\\n} A response body like the following is returned: { \\"kicked_users\\": [ \\"@foobar:example.com\\" ], \\"failed_to_kick_users\\": [], \\"local_aliases\\": [ \\"#badroom:example.com\\", \\"#evilsaloon:example.com\\" ], \\"new_room_id\\": \\"!newroomid:example.com\\"\\n} The parameters and response values have the same format as version 2 of the API.","breadcrumbs":"Administration » Admin API » Rooms » Version 1 (old version)","id":"851","title":"Version 1 (old version)"},"852":{"body":"Note: This API is new, experimental and “subject to change”. This version works asynchronously, meaning you get the response from server immediately\\nwhile the server works on that task in background. You can then request the status of the action\\nto check if it has completed. The API is: DELETE /_synapse/admin/v2/rooms/ with a body of: { \\"new_room_user_id\\": \\"@someuser:example.com\\", \\"room_name\\": \\"Content Violation Notification\\", \\"message\\": \\"Bad Room has been shutdown due to content violations on this server. Please review our Terms of Service.\\", \\"block\\": true, \\"purge\\": true\\n} The API starts the shut down and purge running, and returns immediately with a JSON body with\\na purge id: { \\"delete_id\\": \\"\\"\\n} Parameters The following parameters should be set in the URL: room_id - The ID of the room. The following JSON body parameters are available: new_room_user_id - Optional. If set, a new room will be created with this user ID\\nas the creator and admin, and all users in the old room will be moved into that\\nroom. If not set, no new room will be created and the users will just be removed\\nfrom the old room. The user ID must be on the local server, but does not necessarily\\nhave to belong to a registered user. room_name - Optional. A string representing the name of the room that new users will be\\ninvited to. Defaults to Content Violation Notification message - Optional. A string containing the first message that will be sent as new_room_user_id in the new room. Ideally this will clearly convey why the\\noriginal room was shut down. Defaults to Sharing illegal content on this server is not permitted and rooms in violation will be blocked. block - Optional. If set to true, this room will be added to a blocking list,\\npreventing future attempts to join the room. Rooms can be blocked\\neven if they’re not yet known to the homeserver (only with Version 1 of the API). Defaults to false. purge - Optional. If set to true, it will remove all traces of the room from your database.\\nDefaults to true. force_purge - Optional, and ignored unless purge is true. If set to true, it\\nwill force a purge to go ahead even if there are local users still in the room. Do not\\nuse this unless a regular purge operation fails, as it could leave those users’\\nclients in a confused state. The JSON body must not be empty. The body must be at least {}.","breadcrumbs":"Administration » Admin API » Rooms » Version 2 (new version)","id":"852","title":"Version 2 (new version)"},"853":{"body":"Note: This API is new, experimental and “subject to change”. It is possible to query the status of the background task for deleting rooms.\\nThe status can be queried up to 24 hours after completion of the task,\\nor until Synapse is restarted (whichever happens first).","breadcrumbs":"Administration » Admin API » Rooms » Status of deleting rooms","id":"853","title":"Status of deleting rooms"},"854":{"body":"With this API you can get the status of all active deletion tasks, and all those completed in the last 24h,\\nfor the given room_id. The API is: GET /_synapse/admin/v2/rooms//delete_status A response body like the following is returned: { \\"results\\": [ { \\"delete_id\\": \\"delete_id1\\", \\"room_id\\": \\"!roomid:example.com\\", \\"status\\": \\"failed\\", \\"error\\": \\"error message\\", \\"shutdown_room\\": { \\"kicked_users\\": [], \\"failed_to_kick_users\\": [], \\"local_aliases\\": [], \\"new_room_id\\": null } }, { \\"delete_id\\": \\"delete_id2\\", \\"room_id\\": \\"!roomid:example.com\\", \\"status\\": \\"active\\", \\"shutdown_room\\": { \\"kicked_users\\": [ \\"@foobar:example.com\\" ], \\"failed_to_kick_users\\": [], \\"local_aliases\\": [ \\"#badroom:example.com\\", \\"#evilsaloon:example.com\\" ], \\"new_room_id\\": \\"!newroomid:example.com\\" } } ]\\n} Parameters The following parameters should be set in the URL: room_id - The ID of the room.","breadcrumbs":"Administration » Admin API » Rooms » Query by room_id","id":"854","title":"Query by room_id"},"855":{"body":"With this API you can get the status of one specific task by delete_id. The API is: GET /_synapse/admin/v2/rooms/delete_status/ A response body like the following is returned: { \\"status\\": \\"active\\", \\"delete_id\\": \\"bHkCNQpHqOaFhPtK\\", \\"room_id\\": \\"!roomid:example.com\\", \\"shutdown_room\\": { \\"kicked_users\\": [ \\"@foobar:example.com\\" ], \\"failed_to_kick_users\\": [], \\"local_aliases\\": [ \\"#badroom:example.com\\", \\"#evilsaloon:example.com\\" ], \\"new_room_id\\": \\"!newroomid:example.com\\" }\\n} Parameters The following parameters should be set in the URL: delete_id - The ID for this delete.","breadcrumbs":"Administration » Admin API » Rooms » Query by delete_id","id":"855","title":"Query by delete_id"},"856":{"body":"The following fields are returned in the JSON response body: results - An array of objects, each containing information about one task.\\nThis field is omitted from the result when you query by delete_id.\\nTask objects contain the following fields: delete_id - The ID for this purge room_id - The ID of the room being deleted status - The status will be one of: scheduled - The deletion is waiting to be started active - The process is purging the room and event data from database. complete - The process has completed successfully. failed - The process is aborted, an error has occurred. error - A string that shows an error message if status is failed.\\nOtherwise this field is hidden. shutdown_room - An object containing information about the result of shutting down the room. Note: The result is shown after removing the room members.\\nThe delete process can still be running. Please pay attention to the status. kicked_users - An array of users ( user_id) that were kicked. failed_to_kick_users - An array of users ( user_id) that that were not kicked. local_aliases - An array of strings representing the local aliases that were\\nmigrated from the old room to the new. new_room_id - A string representing the room ID of the new room, or null if\\nno such room was created.","breadcrumbs":"Administration » Admin API » Rooms » Response","id":"856","title":"Response"},"857":{"body":"Note: This guide may be outdated by the time you read it. By nature of room deletions being performed at the database level,\\nthe structure can and does change without notice. First, it’s important to understand that a room deletion is very destructive. Undoing a deletion is not as simple as pretending it\\nnever happened - work has to be done to move forward instead of resetting the past. In fact, in some cases it might not be possible\\nto recover at all: If the room was invite-only, your users will need to be re-invited. If the room no longer has any members at all, it’ll be impossible to rejoin. The first user to rejoin will have to do so via an alias on a different\\nserver (or receive an invite from a user on a different server). With all that being said, if you still want to try and recover the room: If the room was blocked, you must unblock it on your server. This can be\\naccomplished as follows: For safety reasons, shut down Synapse. In the database, run DELETE FROM blocked_rooms WHERE room_id = \'!example:example.org\'; For caution: it’s recommended to run this in a transaction: BEGIN; DELETE ...;, verify you got 1 result, then COMMIT;. The room ID is the same one supplied to the delete room API, not the Content Violation room. Restart Synapse. This step is unnecessary if block was not set. Any room aliases on your server that pointed to the deleted room may have\\nbeen deleted, or redirected to the Content Violation room. These will need\\nto be restored manually. Users on your server that were in the deleted room will have been kicked\\nfrom the room. Consider whether you want to update their membership\\n(possibly via the Edit Room Membership API) or let\\nthem handle rejoining themselves. If new_room_user_id was given, a ‘Content Violation’ will have been\\ncreated. Consider whether you want to delete that room.","breadcrumbs":"Administration » Admin API » Rooms » Undoing room deletions","id":"857","title":"Undoing room deletions"},"858":{"body":"Grants another user the highest power available to a local user who is in the room.\\nIf the user is not in the room, and it is not publicly joinable, then invite the user. By default the server admin (the caller) is granted power, but another user can\\noptionally be specified, e.g.: POST /_synapse/admin/v1/rooms//make_room_admin\\n{ \\"user_id\\": \\"@foo:example.com\\"\\n}","breadcrumbs":"Administration » Admin API » Rooms » Make Room Admin API","id":"858","title":"Make Room Admin API"},"859":{"body":"Enables querying and deleting forward extremities from rooms. When a lot of forward\\nextremities accumulate in a room, performance can become degraded. For details, see #1760.","breadcrumbs":"Administration » Admin API » Rooms » Forward Extremities Admin API","id":"859","title":"Forward Extremities Admin API"},"86":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.157.0","id":"86","title":"Upgrading to v1.157.0"},"860":{"body":"To check the status of forward extremities for a room: GET /_synapse/admin/v1/rooms//forward_extremities A response as follows will be returned: { \\"count\\": 1, \\"results\\": [ { \\"event_id\\": \\"$M5SP266vsnxctfwFgFLNceaCo3ujhRtg_NiiHabcdefgh\\", \\"state_group\\": 439, \\"depth\\": 123, \\"received_ts\\": 1611263016761 } ]\\n}","breadcrumbs":"Administration » Admin API » Rooms » Check for forward extremities","id":"860","title":"Check for forward extremities"},"861":{"body":"WARNING: Please ensure you know what you’re doing and have read\\nthe related issue #1760.\\nUnder no situations should this API be executed as an automated maintenance task! If a room has lots of forward extremities, the extra can be\\ndeleted as follows: DELETE /_synapse/admin/v1/rooms//forward_extremities A response as follows will be returned, indicating the amount of forward extremities\\nthat were deleted. { \\"deleted\\": 1\\n}","breadcrumbs":"Administration » Admin API » Rooms » Deleting forward extremities","id":"861","title":"Deleting forward extremities"},"862":{"body":"This API lets a client find the context of an event. This is designed primarily to investigate abuse reports. GET /_synapse/admin/v1/rooms//context/ This API mimmicks GET /_matrix/client/r0/rooms/{roomId}/context/{eventId}. Please refer to the link for all details on parameters and reseponse. Example response: { \\"end\\": \\"t29-57_2_0_2\\", \\"events_after\\": [ { \\"content\\": { \\"body\\": \\"This is an example text message\\", \\"msgtype\\": \\"m.text\\", \\"format\\": \\"org.matrix.custom.html\\", \\"formatted_body\\": \\"This is an example text message\\" }, \\"type\\": \\"m.room.message\\", \\"event_id\\": \\"$143273582443PhrSn:example.org\\", \\"room_id\\": \\"!636q39766251:example.com\\", \\"sender\\": \\"@example:example.org\\", \\"origin_server_ts\\": 1432735824653, \\"unsigned\\": { \\"age\\": 1234 } } ], \\"event\\": { \\"content\\": { \\"body\\": \\"filename.jpg\\", \\"info\\": { \\"h\\": 398, \\"w\\": 394, \\"mimetype\\": \\"image/jpeg\\", \\"size\\": 31037 }, \\"url\\": \\"mxc://example.org/JWEIFJgwEIhweiWJE\\", \\"msgtype\\": \\"m.image\\" }, \\"type\\": \\"m.room.message\\", \\"event_id\\": \\"$f3h4d129462ha:example.com\\", \\"room_id\\": \\"!636q39766251:example.com\\", \\"sender\\": \\"@example:example.org\\", \\"origin_server_ts\\": 1432735824653, \\"unsigned\\": { \\"age\\": 1234 } }, \\"events_before\\": [ { \\"content\\": { \\"body\\": \\"something-important.doc\\", \\"filename\\": \\"something-important.doc\\", \\"info\\": { \\"mimetype\\": \\"application/msword\\", \\"size\\": 46144 }, \\"msgtype\\": \\"m.file\\", \\"url\\": \\"mxc://example.org/FHyPlCeYUSFFxlgbQYZmoEoe\\" }, \\"type\\": \\"m.room.message\\", \\"event_id\\": \\"$143273582443PhrSn:example.org\\", \\"room_id\\": \\"!636q39766251:example.com\\", \\"sender\\": \\"@example:example.org\\", \\"origin_server_ts\\": 1432735824653, \\"unsigned\\": { \\"age\\": 1234 } } ], \\"start\\": \\"t27-54_2_0_2\\", \\"state\\": [ { \\"content\\": { \\"creator\\": \\"@example:example.org\\", \\"room_version\\": \\"1\\", \\"m.federate\\": true, \\"predecessor\\": { \\"event_id\\": \\"$something:example.org\\", \\"room_id\\": \\"!oldroom:example.org\\" } }, \\"type\\": \\"m.room.create\\", \\"event_id\\": \\"$143273582443PhrSn:example.org\\", \\"room_id\\": \\"!636q39766251:example.com\\", \\"sender\\": \\"@example:example.org\\", \\"origin_server_ts\\": 1432735824653, \\"unsigned\\": { \\"age\\": 1234 }, \\"state_key\\": \\"\\" }, { \\"content\\": { \\"membership\\": \\"join\\", \\"avatar_url\\": \\"mxc://example.org/SEsfnsuifSDFSSEF\\", \\"displayname\\": \\"Alice Margatroid\\" }, \\"type\\": \\"m.room.member\\", \\"event_id\\": \\"$143273582443PhrSn:example.org\\", \\"room_id\\": \\"!636q39766251:example.com\\", \\"sender\\": \\"@example:example.org\\", \\"origin_server_ts\\": 1432735824653, \\"unsigned\\": { \\"age\\": 1234 }, \\"state_key\\": \\"@alice:example.org\\" } ]\\n}","breadcrumbs":"Administration » Admin API » Rooms » Event Context API","id":"862","title":"Event Context API"},"863":{"body":"This API allows an admin to fetch the space/room hierarchy for a given space,\\nreturning details about that room and any children the room may have, paginating\\nover the space tree in a depth-first manner to locate child rooms. This is\\nfunctionally similar to the CS Hierarchy endpoint but does not check for\\nroom membership when returning room summaries. The endpoint does not query other servers over federation about remote rooms\\nthat the server has not joined. This is a deliberate trade-off: while this\\nmeans it will leave some holes in the hierarchy that we could otherwise\\nsometimes fill in, it significantly improves the endpoint’s response time and\\nthe admin endpoint is designed for managing rooms local to the homeserver\\nanyway. Parameters The following query parameters are available: from - An optional pagination token, provided when there are more rooms to\\nreturn than the limit. limit - Maximum amount of rooms to return. Must be a non-negative integer,\\ndefaults to 50. max_depth - The maximum depth in the tree to explore, must be a non-negative\\ninteger. 0 would correspond to just the root room, 1 would include just the\\nroot room’s children, etc. If not provided will recurse into the space tree without limit. Request: GET /_synapse/admin/v1/rooms//hierarchy Response: { \\"rooms\\": [ { \\"children_state\\": [ { \\"content\\": { \\"via\\": [\\"local_test_server\\"] }, \\"origin_server_ts\\": 1500, \\"sender\\": \\"@user:test\\", \\"state_key\\": \\"!QrMkkqBSwYRIFNFCso:test\\", \\"type\\": \\"m.space.child\\" } ], \\"name\\": \\"space room\\", \\"guest_can_join\\": false, \\"join_rule\\": \\"public\\", \\"num_joined_members\\": 1, \\"room_id\\": \\"!sPOpNyMHbZAoAOsOFL:test\\", \\"room_type\\": \\"m.space\\", \\"world_readable\\": false }, { \\"children_state\\": [], \\"guest_can_join\\": true, \\"join_rule\\": \\"invite\\", \\"name\\": \\"nefarious\\", \\"num_joined_members\\": 1, \\"room_id\\": \\"!QrMkkqBSwYRIFNFCso:test\\", \\"topic\\": \\"being bad\\", \\"world_readable\\": false} ], \\"next_batch\\": \\"KUYmRbeSpAoaAIgOKGgyaCEn\\"\\n}","breadcrumbs":"Administration » Admin API » Rooms » Admin Space Hierarchy Endpoint","id":"863","title":"Admin Space Hierarchy Endpoint"},"864":{"body":"This API returns information about scheduled tasks. To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API. The api is: GET /_synapse/admin/v1/scheduled_tasks It returns a JSON body like the following: { \\"scheduled_tasks\\": [ { \\"id\\": \\"GSA124oegf1\\", \\"action\\": \\"shutdown_room\\", \\"status\\": \\"complete\\", \\"timestamp_ms\\": 23423523, \\"resource_id\\": \\"!roomid\\", \\"result\\": \\"some result\\", \\"error\\": null } ]\\n} Query parameters: action_name: string - Is optional. Returns only the scheduled tasks with the given action name.\\nMay be given multiple times to return tasks matching any of the given action names. resource_id: string - Is optional. Returns only the scheduled tasks with the given resource id. status: string - Is optional. Returns only the scheduled tasks matching the given status.\\nMay be given multiple times to return tasks matching any of the given statuses. The status must be one of “scheduled” - Task is scheduled but not active “active” - Task is active and probably running, and if not will be run on next scheduler loop run “complete” - Task has completed successfully “cancelled” - Task has been cancelled “failed” - Task is over and either returned a failed status, or had an exception max_timestamp: int - Is optional. Returns only the scheduled tasks with a timestamp (in milliseconds since the unix epoch) inferior to the specified one. Response The following fields are returned in the JSON response body along with a 200 HTTP status code: id: string - ID of scheduled task. action: string - The name of the scheduled task’s action. status: string - The status of the scheduled task. timestamp_ms: integer - The timestamp (in milliseconds since the unix epoch) of the given task - If the status is “scheduled” then this represents when it should be launched.\\nOtherwise it represents the last time this task got a change of state. resource_id: Optional string - The resource id of the scheduled task, if it possesses one result: Optional Json - Any result of the scheduled task, if given error: Optional string - If the task has the status “failed”, the error associated with this failure","breadcrumbs":"Administration » Admin API » Scheduled tasks » Show scheduled tasks","id":"864","title":"Show scheduled tasks"},"865":{"body":"The API to send notices is as follows: POST /_synapse/admin/v1/send_server_notice or: PUT /_synapse/admin/v1/send_server_notice/{txnId} You will need to authenticate with an access token for an admin user. When using the PUT form, retransmissions with the same transaction ID will be\\nignored in the same way as with PUT /_matrix/client/r0/rooms/{roomId}/send/{eventType}/{txnId}. The request body should look something like the following: { \\"user_id\\": \\"@target_user:server_name\\", \\"content\\": { \\"msgtype\\": \\"m.text\\", \\"body\\": \\"This is my message\\" }\\n} You can optionally include the following additional parameters: type: the type of event. Defaults to m.room.message. state_key: Setting this will result in a state event being sent. Once the notice has been sent, the API will return the following response: { \\"event_id\\": \\"\\"\\n} Note that server notices must be enabled in homeserver.yaml before this API\\ncan be used. See the server notices documentation for more information.","breadcrumbs":"Administration » Admin API » Server Notices » Server Notices","id":"865","title":"Server Notices"},"866":{"body":"Returns information about all local media usage of users. Gives the\\npossibility to filter them by time and user. To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API. The API is: GET /_synapse/admin/v1/statistics/users/media A response body like the following is returned: { \\"users\\": [ { \\"displayname\\": \\"foo_user_0\\", \\"media_count\\": 2, \\"media_length\\": 134, \\"user_id\\": \\"@foo_user_0:test\\" }, { \\"displayname\\": \\"foo_user_1\\", \\"media_count\\": 2, \\"media_length\\": 134, \\"user_id\\": \\"@foo_user_1:test\\" } ], \\"next_token\\": 3, \\"total\\": 10\\n} To paginate, check for next_token and if present, call the endpoint\\nagain with from set to the value of next_token. This will return a new page. If the endpoint does not return a next_token then there are no more\\nreports to paginate through. Parameters The following parameters should be set in the URL: limit: string representing a positive integer - Is optional but is\\nused for pagination, denoting the maximum number of items to return\\nin this call. Defaults to 100. from: string representing a positive integer - Is optional but used for pagination,\\ndenoting the offset in the returned results. This should be treated as an opaque value\\nand not explicitly set to anything other than the return value of next_token from a\\nprevious call. Defaults to 0. order_by - string - The method in which to sort the returned list of users. Valid values are: user_id - Users are ordered alphabetically by user_id. This is the default. displayname - Users are ordered alphabetically by displayname. media_length - Users are ordered by the total size of uploaded media in bytes.\\nSmallest to largest. media_count - Users are ordered by number of uploaded media. Smallest to largest. from_ts - string representing a positive integer - Considers only\\nfiles created at this timestamp or later. Unix timestamp in ms. until_ts - string representing a positive integer - Considers only\\nfiles created at this timestamp or earlier. Unix timestamp in ms. search_term - string - Filter users by their user ID localpart or displayname.\\nThe search term can be found in any part of the string.\\nDefaults to no filtering. dir - string - Direction of order. Either f for forwards or b for backwards.\\nSetting this value to b will reverse the above sort order. Defaults to f. Response The following fields are returned in the JSON response body: users - An array of objects, each containing information\\nabout the user and their local media. Objects contain the following fields: displayname - string - Displayname of this user. media_count - integer - Number of uploaded media by this user. media_length - integer - Size of uploaded media in bytes by this user. user_id - string - Fully-qualified user ID (ex. @user:server.com). next_token - integer - Opaque value used for pagination. See above. total - integer - Total number of users after filtering.","breadcrumbs":"Administration » Admin API » Statistics » Users’ media usage statistics","id":"866","title":"Users’ media usage statistics"},"867":{"body":"Returns the 10 largest rooms and an estimate of how much space in the database\\nthey are taking. This does not include the size of any associated media associated with the room. Returns an error on SQLite. Note: This uses the planner statistics from PostgreSQL to do the estimates,\\nwhich means that the returned information can vary widely from reality. However,\\nit should be enough to get a rough idea of where database disk space is going. The API is: GET /_synapse/admin/v1/statistics/database/rooms A response body like the following is returned: { \\"rooms\\": [ { \\"room_id\\": \\"!OGEhHVWSdvArJzumhm:matrix.org\\", \\"estimated_size\\": 47325417353 } ],\\n} Response The following fields are returned in the JSON response body: rooms - An array of objects, sorted by largest room first. Objects contain\\nthe following fields: room_id - string - The room ID. estimated_size - integer - Estimated disk space used in bytes by the room\\nin the database. Added in Synapse 1.83.0","breadcrumbs":"Administration » Admin API » Statistics » Get largest rooms by size in database","id":"867","title":"Get largest rooms by size in database"},"868":{"body":"To use it, you will need to authenticate by providing an access_token\\nfor a server admin: see Admin API.","breadcrumbs":"Administration » Admin API » Users » User Admin API","id":"868","title":"User Admin API"},"869":{"body":"This API returns information about a specific user account. The api is: GET /_synapse/admin/v2/users/ It returns a JSON body like the following: { \\"name\\": \\"@user:example.com\\", \\"displayname\\": \\"User\\", // can be null if not set \\"threepids\\": [ { \\"medium\\": \\"email\\", \\"address\\": \\"\\", \\"added_at\\": 1586458409743, \\"validated_at\\": 1586458409743 }, { \\"medium\\": \\"email\\", \\"address\\": \\"\\", \\"added_at\\": 1586458409743, \\"validated_at\\": 1586458409743 } ], \\"avatar_url\\": \\"\\", // can be null if not set \\"is_guest\\": false, \\"admin\\": false, \\"deactivated\\": false, \\"erased\\": false, \\"shadow_banned\\": false, \\"creation_ts\\": 1560432506, \\"last_seen_ts\\": 1732919539393, \\"appservice_id\\": null, \\"consent_server_notice_sent\\": null, \\"consent_version\\": null, \\"consent_ts\\": null, \\"external_ids\\": [ { \\"auth_provider\\": \\"\\", \\"external_id\\": \\"\\" }, { \\"auth_provider\\": \\"\\", \\"external_id\\": \\"\\" } ], \\"user_type\\": null, \\"locked\\": false, \\"suspended\\": false\\n} URL parameters: user_id: fully-qualified user id: for example, @user:server.com.","breadcrumbs":"Administration » Admin API » Users » Query User Account","id":"869","title":"Query User Account"},"87":{"body":"Support for the deprecated MSC3861 Auth Delegation ( experimental_features.msc3861)\\nhas been dropped in this version, in favour of the stable Matrix Authentication Service\\nintegration. See the previous upgrade notes\\nand the matrix_authentication_service section in the Configuration Manual\\nfor more information.","breadcrumbs":"Upgrading between Synapse Versions » MSC3861 Auth Delegation must be migrated to stable Matrix Authentication Service integration","id":"87","title":"MSC3861 Auth Delegation must be migrated to stable Matrix Authentication Service integration"},"870":{"body":"This API allows an administrator to create or modify a user account with a\\nspecific user_id. This api is: PUT /_synapse/admin/v2/users/ with a body of: { \\"password\\": \\"user_password\\", \\"logout_devices\\": false, \\"displayname\\": \\"Alice Marigold\\", \\"avatar_url\\": \\"mxc://example.com/abcde12345\\", \\"threepids\\": [ { \\"medium\\": \\"email\\", \\"address\\": \\"alice@example.com\\" }, { \\"medium\\": \\"email\\", \\"address\\": \\"alice@domain.org\\" } ], \\"external_ids\\": [ { \\"auth_provider\\": \\"example\\", \\"external_id\\": \\"12345\\" }, { \\"auth_provider\\": \\"example2\\", \\"external_id\\": \\"abc54321\\" } ], \\"admin\\": false, \\"deactivated\\": false, \\"user_type\\": null, \\"locked\\": false\\n} Returns HTTP status code: 201 - When a new user object was created. 200 - When a user was modified. URL parameters: user_id - A fully-qualified user id. For example, @user:server.com. Body parameters: password - string, optional. If provided, the user’s password is updated and all\\ndevices are logged out, unless logout_devices is set to false. logout_devices - bool, optional, defaults to true. If set to false, devices aren’t\\nlogged out even when password is provided. displayname - string, optional. If set to an empty string ( \\"\\"), the user’s display name\\nwill be removed. avatar_url - string, optional. Must be a MXC URI.\\nIf set to an empty string ( \\"\\"), the user’s avatar is removed. threepids - array, optional. If provided, the user’s third-party IDs (email, msisdn) are\\nentirely replaced with the given list. Each item in the array is an object with the following\\nfields: medium - string, required. The type of third-party ID, either email or msisdn (phone number). address - string, required. The third-party ID itself, e.g. alice@example.com for email or 447470274584 (for a phone number with country code “44”) and 19254857364 (for a phone number\\nwith country code “1”) for msisdn.\\nNote: If a threepid is removed from a user via this option, Synapse will also attempt to remove\\nthat threepid from any identity servers it is aware has a binding for it. external_ids - array, optional. Allow setting the identifier of the external identity\\nprovider for SSO (Single sign-on). More details are in the configuration manual under the\\nsections sso and oidc_providers. auth_provider - string, required. The unique, internal ID of the external identity provider.\\nThe same as idp_id from the homeserver configuration. If using OIDC, this value should be prefixed\\nwith oidc-. Note that no error is raised if the provided value is not in the homeserver configuration. external_id - string, required. An identifier for the user in the external identity provider.\\nWhen the user logs in to the identity provider, this must be the unique ID that they map to. admin - bool, optional, defaults to false. Whether the user is a homeserver administrator,\\ngranting them access to the Admin API, among other things. deactivated - bool, optional. If unspecified, deactivation state will be left unchanged. Note: For the password field there is no strict check of the necessity for its presence.\\nIt is possible to have active users without a password, e.g. when authenticating with OIDC is configured.\\nYou must check yourself whether a password is required when reactivating a user or not. It is not possible to set a password if the config option password_config.localdb_enabled is set false.\\nUsers’ passwords are wiped upon account deactivation, hence the need to set a new one here. Note: a user cannot be erased with this API. For more details on\\ndeactivating and erasing users see Deactivate Account. locked - bool, optional. If unspecified, locked state will be left unchanged. user_type - string or null, optional. If not provided, the user type will be\\nnot be changed. If null is given, the user type will be cleared.\\nOther allowed options are: bot and support and any extra values defined in the homserver configuration.","breadcrumbs":"Administration » Admin API » Users » Create or modify account","id":"870","title":"Create or modify account"},"871":{"body":"","breadcrumbs":"Administration » Admin API » Users » List Accounts","id":"871","title":"List Accounts"},"872":{"body":"This API returns all local user accounts.\\nBy default, the response is ordered by ascending user ID. GET /_synapse/admin/v2/users?from=0&limit=10&guests=false A response body like the following is returned: { \\"users\\": [ { \\"name\\": \\"\\", \\"is_guest\\": false, \\"admin\\": false, \\"user_type\\": null, \\"deactivated\\": false, \\"erased\\": false, \\"shadow_banned\\": false, \\"displayname\\": \\"\\", \\"avatar_url\\": null, \\"creation_ts\\": 1560432668000, \\"locked\\": false }, { \\"name\\": \\"\\", \\"is_guest\\": false, \\"admin\\": true, \\"user_type\\": null, \\"deactivated\\": false, \\"erased\\": false, \\"shadow_banned\\": false, \\"displayname\\": \\"\\", \\"avatar_url\\": \\"\\", \\"creation_ts\\": 1561550621000, \\"locked\\": false } ], \\"next_token\\": \\"100\\", \\"total\\": 200\\n} To paginate, check for next_token and if present, call the endpoint again\\nwith from set to the value of next_token. This will return a new page. If the endpoint does not return a next_token then there are no more users\\nto paginate through. Parameters The following parameters should be set in the URL: user_id - Is optional and filters to only return users with user IDs\\nthat contain this value. This parameter is ignored when using the name parameter. name - Is optional and filters to only return users with user ID localparts or displaynames that contain this value. guests - string representing a bool - Is optional and if false will exclude guest users.\\nDefaults to true to include guest users. Setting this option to true is not supported when Matrix Authentication\\nService integration is enabled. See #15582 admins - Optional flag to filter admins. If true, only admins are queried. If false, admins are excluded from\\nthe query. When the flag is absent (the default), both admins and non-admins are included in the search results. deactivated - string representing a bool - Is optional and if true will include deactivated users.\\nDefaults to false to exclude deactivated users. limit - string representing a positive integer - Is optional but is used for pagination,\\ndenoting the maximum number of items to return in this call. Defaults to 100. from - string representing a positive integer - Is optional but used for pagination,\\ndenoting the offset in the returned results. This should be treated as an opaque value and\\nnot explicitly set to anything other than the return value of next_token from a previous call.\\nDefaults to 0. order_by - The method by which to sort the returned list of users.\\nIf the ordered field has duplicates, the second order is always by ascending name,\\nwhich guarantees a stable ordering. Valid values are: name - Users are ordered alphabetically by name. This is the default. is_guest - Users are ordered by is_guest status. admin - Users are ordered by admin status. user_type - Users are ordered alphabetically by user_type. deactivated - Users are ordered by deactivated status. shadow_banned - Users are ordered by shadow_banned status. displayname - Users are ordered alphabetically by displayname. avatar_url - Users are ordered alphabetically by avatar URL. creation_ts - Users are ordered by when the users was created in ms. last_seen_ts - Users are ordered by when the user was lastly seen in ms. dir - Direction of media order. Either f for forwards or b for backwards.\\nSetting this value to b will reverse the above sort order. Defaults to f. not_user_type - Exclude certain user types, such as bot users, from the request.\\nCan be provided multiple times. Possible values are bot, support or “empty string”.\\n“empty string” here means to exclude users without a type. locked - string representing a bool - Is optional and if true will include locked users.\\nDefaults to false to exclude locked users. Note: Introduced in v1.93. Caution. The database only has indexes on the columns name and creation_ts.\\nThis means that if a different sort order is used ( is_guest, admin, user_type, deactivated, shadow_banned, avatar_url or displayname),\\nthis can cause a large load on the database, especially for large environments. Response The following fields are returned in the JSON response body: users - An array of objects, each containing information about an user.\\nUser objects contain the following fields: name - string - Fully-qualified user ID (ex. @user:server.com). is_guest - bool - Status if that user is a guest account. admin - bool - Status if that user is a server administrator. user_type - string - Type of the user. Normal users are type None.\\nThis allows user type specific behaviour. There are also types support and bot. deactivated - bool - Status if that user has been marked as deactivated. erased - bool - Status if that user has been marked as erased. shadow_banned - bool - Status if that user has been marked as shadow banned. displayname - string - The user’s display name if they have set one. avatar_url - string - The user’s avatar URL if they have set one. creation_ts - integer - The user’s creation timestamp in ms. last_seen_ts - integer - The user’s last activity timestamp in ms. locked - bool - Status if that user has been marked as locked. Note: Introduced in v1.93. next_token: string representing a positive integer - Indication for pagination. See above. total - integer - Total number of media. Added in Synapse 1.93: the locked query parameter and response field.","breadcrumbs":"Administration » Admin API » Users » List Accounts (V2)","id":"872","title":"List Accounts (V2)"},"873":{"body":"This API returns all local user accounts (see v2). In contrast to v2, the query parameter deactivated is handled differently. GET /_synapse/admin/v3/users Parameters deactivated - Optional flag to filter deactivated users. If true, only deactivated users are returned.\\nIf false, deactivated users are excluded from the query. When the flag is absent (the default),\\nusers are not filtered by deactivation status.","breadcrumbs":"Administration » Admin API » Users » List Accounts (V3)","id":"873","title":"List Accounts (V3)"},"874":{"body":"This API returns information about the active sessions for a specific user. The endpoints are: GET /_synapse/admin/v1/whois/ and: GET /_matrix/client/r0/admin/whois/ See also: Client Server\\nAPI Whois. It returns a JSON body like the following: { \\"user_id\\": \\"\\", \\"devices\\": { \\"\\": { \\"sessions\\": [ { \\"connections\\": [ { \\"ip\\": \\"1.2.3.4\\", \\"last_seen\\": 1417222374433, \\"user_agent\\": \\"Mozilla/5.0 ...\\" }, { \\"ip\\": \\"1.2.3.10\\", \\"last_seen\\": 1417222374500, \\"user_agent\\": \\"Dalvik/2.1.0 ...\\" } ] } ] } }\\n} last_seen is measured in milliseconds since the Unix epoch.","breadcrumbs":"Administration » Admin API » Users » Query current sessions for a user","id":"874","title":"Query current sessions for a user"},"875":{"body":"This API deactivates an account. It removes active access tokens, resets the\\npassword, and deletes third-party IDs (to prevent the user requesting a\\npassword reset). It can also mark the user as GDPR-erased. This means messages sent by the\\nuser will still be visible by anyone that was in the room when these messages\\nwere sent, but hidden from users joining the room afterwards. The api is: POST /_synapse/admin/v1/deactivate/ with a body of: { \\"erase\\": true\\n} The erase parameter is optional and defaults to false.\\nAn empty body may be passed for backwards compatibility. The following actions are performed when deactivating an user: Try to unbind 3PIDs from the identity server Remove all 3PIDs from the homeserver Delete all devices and E2EE keys Delete all access tokens Delete all pushers Delete the password hash Removal from all rooms the user is a member of Remove the user from the user directory Reject all pending invites Remove all account validity information related to the user Remove the arbitrary data store known as account data. For example, this includes: list of ignored users; push rules; secret storage keys; and cross-signing keys. The following additional actions are performed during deactivation if erase\\nis set to true: Remove the user’s display name Remove the user’s avatar URL Remove the user’s custom profile fields Mark the user as erased The following actions are NOT performed. The list may be incomplete. Remove mappings of SSO IDs Delete media uploaded by user (included avatar images) Delete sent and received messages Remove the user’s creation (registration) timestamp Remove rate limit overrides Remove from monthly active users Remove user’s consent information (consent version and timestamp)","breadcrumbs":"Administration » Admin API » Users » Deactivate Account","id":"875","title":"Deactivate Account"},"876":{"body":"This API allows an admin to suspend/unsuspend an account. While an account is suspended, the user is\\nprohibited from sending invites, joining or knocking on rooms, sending messages, changing profile data, and redacting messages other than their own. The api is: PUT /_synapse/admin/v1/suspend/ with a body of: { \\"suspend\\": true\\n} To unsuspend a user, use the same endpoint with a body of: { \\"suspend\\": false\\n}","breadcrumbs":"Administration » Admin API » Users » Suspend/Unsuspend Account","id":"876","title":"Suspend/Unsuspend Account"},"877":{"body":"Note: This API is disabled when Matrix Authentication Service integration is enabled. Use the MAS Admin API or the MAS CLI instead. An easy way to make use of this functionality is provided by Element Admin as part of ESS Community and Pro. Changes the password of another user. This will automatically log the user out of all their devices. The api is: POST /_synapse/admin/v1/reset_password/ with a body of: { \\"new_password\\": \\"\\", \\"logout_devices\\": true\\n} The parameter new_password is required.\\nThe parameter logout_devices is optional and defaults to true.","breadcrumbs":"Administration » Admin API » Users » Reset password","id":"877","title":"Reset password"},"878":{"body":"Note: This API is disabled when Matrix Authentication Service integration is enabled. Use the MAS Admin API instead. An easy way to make use of this functionality is provided by Element Admin as part of ESS Community and Pro. The api is: GET /_synapse/admin/v1/users//admin A response body like the following is returned: { \\"admin\\": true\\n}","breadcrumbs":"Administration » Admin API » Users » Get whether a user is a server administrator or not","id":"878","title":"Get whether a user is a server administrator or not"},"879":{"body":"Note: This API is disabled when Matrix Authentication Service integration is enabled. Use the MAS Admin API or the MAS CLI instead. An easy way to make use of this functionality is provided by Element Admin as part of ESS Community and Pro. Note that you cannot demote yourself. The api is: PUT /_synapse/admin/v1/users//admin with a body of: { \\"admin\\": true\\n}","breadcrumbs":"Administration » Admin API » Users » Change whether a user is a server administrator or not","id":"879","title":"Change whether a user is a server administrator or not"},"88":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.152.0","id":"88","title":"Upgrading to v1.152.0"},"880":{"body":"Gets a list of room memberships for a specific user_id. This\\nendpoint differs from GET /_synapse/admin/v1/users//joined_rooms\\nin that it returns rooms with memberships other than “join”. The API is: GET /_synapse/admin/v1/users//memberships A response body like the following is returned: { \\"memberships\\": { \\"!DuGcnbhHGaSZQoNQR:matrix.org\\": \\"join\\", \\"!ZtSaPCawyWtxfWiIy:matrix.org\\": \\"leave\\", } } which is a list of room membership states for the given user. This endpoint can\\nbe used with both local and remote users, with the caveat that the homeserver will\\nonly be aware of the memberships for rooms that one of its local users has joined. Remote user memberships may also be out of date if all local users have since left\\na room. The homeserver will thus no longer receive membership updates about it. The list includes rooms that the user has since left; other membership states (knock,\\ninvite, etc.) are also possible. Note that rooms will only disappear from this list if they are purged from the homeserver. Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. Response The following fields are returned in the JSON response body: memberships - A map of room_id (string) to membership state (string).","breadcrumbs":"Administration » Admin API » Users » List room memberships of a user","id":"880","title":"List room memberships of a user"},"881":{"body":"Gets a list of all room_id that a specific user_id is joined to and is a member of (participating in). The API is: GET /_synapse/admin/v1/users//joined_rooms A response body like the following is returned: { \\"joined_rooms\\": [ \\"!DuGcnbhHGaSZQoNQR:matrix.org\\", \\"!ZtSaPCawyWtxfWiIy:matrix.org\\" ], \\"total\\": 2 } The server returns the list of rooms of which the user and the server\\nare member. If the user is local, all the rooms of which the user is\\nmember are returned. Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. Response The following fields are returned in the JSON response body: joined_rooms - An array of room_id. total - Number of rooms.","breadcrumbs":"Administration » Admin API » Users » List joined rooms of a user","id":"881","title":"List joined rooms of a user"},"882":{"body":"Fetches the number of invites sent by the provided user ID across all rooms\\nafter the given timestamp. GET /_synapse/admin/v1/users//sent_invite_count Parameters The following parameters should be set in the URL: user_id: fully qualified: for example, @user:server.com The following should be set as query parameters in the URL: from_ts: int, required. A timestamp in ms from the unix epoch. Only\\ninvites sent at or after the provided timestamp will be returned.\\nThis works by comparing the provided timestamp to the received_ts\\ncolumn in the events table.\\nNote: https://currentmillis.com/ is a useful tool for converting dates\\ninto timestamps and vice versa. A response body like the following is returned: { \\"invite_count\\": 30\\n} Added in Synapse 1.122.0","breadcrumbs":"Administration » Admin API » Users » Get the number of invites sent by the user","id":"882","title":"Get the number of invites sent by the user"},"883":{"body":"Fetches the number of rooms that the user joined after the given timestamp, even\\nif they have subsequently left/been banned from those rooms. GET /_synapse/admin/v1/users//cumulative_joined_room_count Parameters The following parameters should be set in the URL: user_id: fully qualified: for example, @user:server.com The following should be set as query parameters in the URL: from_ts: int, required. A timestamp in ms from the unix epoch. Only\\ninvites sent at or after the provided timestamp will be returned.\\nThis works by comparing the provided timestamp to the received_ts\\ncolumn in the events table.\\nNote: https://currentmillis.com/ is a useful tool for converting dates\\ninto timestamps and vice versa. A response body like the following is returned: { \\"cumulative_joined_room_count\\": 30\\n} Added in Synapse 1.122.0","breadcrumbs":"Administration » Admin API » Users » Get the cumulative number of rooms a user has joined after a given timestamp","id":"883","title":"Get the cumulative number of rooms a user has joined after a given timestamp"},"884":{"body":"Gets information about account data for a specific user_id. The API is: GET /_synapse/admin/v1/users//accountdata A response body like the following is returned: { \\"account_data\\": { \\"global\\": { \\"m.secret_storage.key.LmIGHTg5W\\": { \\"algorithm\\": \\"m.secret_storage.v1.aes-hmac-sha2\\", \\"iv\\": \\"fwjNZatxg==\\", \\"mac\\": \\"eWh9kNnLWZUNOgnc=\\" }, \\"im.vector.hide_profile\\": { \\"hide_profile\\": true }, \\"org.matrix.preview_urls\\": { \\"disable\\": false }, \\"im.vector.riot.breadcrumb_rooms\\": { \\"rooms\\": [ \\"!LxcBDAsDUVAfJDEo:matrix.org\\", \\"!MAhRxqasbItjOqxu:matrix.org\\" ] }, \\"m.accepted_terms\\": { \\"accepted\\": [ \\"https://example.org/somewhere/privacy-1.2-en.html\\", \\"https://example.org/somewhere/terms-2.0-en.html\\" ] }, \\"im.vector.setting.breadcrumbs\\": { \\"recent_rooms\\": [ \\"!MAhRxqasbItqxuEt:matrix.org\\", \\"!ZtSaPCawyWtxiImy:matrix.org\\" ] } }, \\"rooms\\": { \\"!GUdfZSHUJibpiVqHYd:matrix.org\\": { \\"m.fully_read\\": { \\"event_id\\": \\"$156334540fYIhZ:matrix.org\\" } }, \\"!tOZwOOiqwCYQkLhV:matrix.org\\": { \\"m.fully_read\\": { \\"event_id\\": \\"$xjsIyp4_NaVl2yPvIZs_k1Jl8tsC_Sp23wjqXPno\\" } } } }\\n} Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. Response The following fields are returned in the JSON response body: account_data - A map containing the account data for the user global - A map containing the global account data for the user rooms - A map containing the account data per room for the user","breadcrumbs":"Administration » Admin API » Users » Account Data","id":"884","title":"Account Data"},"885":{"body":"","breadcrumbs":"Administration » Admin API » Users » User media","id":"885","title":"User media"},"886":{"body":"Gets a list of all local media that a specific user_id has created.\\nThese are media that the user has uploaded themselves\\n( local media), as well as URL preview images requested by the user if the feature is enabled. By default, the response is ordered by descending creation date and ascending media ID.\\nThe newest media is on top. You can change the order with parameters order_by and dir. The API is: GET /_synapse/admin/v1/users//media A response body like the following is returned: { \\"media\\": [ { \\"created_ts\\": 100400, \\"last_access_ts\\": null, \\"media_id\\": \\"qXhyRzulkwLsNHTbpHreuEgo\\", \\"media_length\\": 67, \\"media_type\\": \\"image/png\\", \\"quarantined_by\\": null, \\"safe_from_quarantine\\": false, \\"upload_name\\": \\"test1.png\\" }, { \\"created_ts\\": 200400, \\"last_access_ts\\": null, \\"media_id\\": \\"FHfiSnzoINDatrXHQIXBtahw\\", \\"media_length\\": 67, \\"media_type\\": \\"image/png\\", \\"quarantined_by\\": null, \\"safe_from_quarantine\\": false, \\"upload_name\\": \\"test2.png\\" }, { \\"created_ts\\": 300400, \\"last_access_ts\\": 300700, \\"media_id\\": \\"BzYNLRUgGHphBkdKGbzXwbjX\\", \\"media_length\\": 1337, \\"media_type\\": \\"application/octet-stream\\", \\"quarantined_by\\": null, \\"safe_from_quarantine\\": false, \\"upload_name\\": null } ], \\"next_token\\": 3, \\"total\\": 2\\n} To paginate, check for next_token and if present, call the endpoint again\\nwith from set to the value of next_token. This will return a new page. If the endpoint does not return a next_token then there are no more\\nreports to paginate through. Parameters The following parameters should be set in the URL: user_id - string - fully qualified: for example, @user:server.com. limit: string representing a positive integer - Is optional but is used for pagination,\\ndenoting the maximum number of items to return in this call. Defaults to 100. from: string representing a positive integer - Is optional but used for pagination,\\ndenoting the offset in the returned results. This should be treated as an opaque value and\\nnot explicitly set to anything other than the return value of next_token from a previous call.\\nDefaults to 0. order_by - The method by which to sort the returned list of media.\\nIf the ordered field has duplicates, the second order is always by ascending media_id,\\nwhich guarantees a stable ordering. Valid values are: media_id - Media are ordered alphabetically by media_id. upload_name - Media are ordered alphabetically by name the media was uploaded with. created_ts - Media are ordered by when the content was uploaded in ms.\\nSmallest to largest. This is the default. last_access_ts - Media are ordered by when the content was last accessed in ms.\\nSmallest to largest. media_length - Media are ordered by length of the media in bytes.\\nSmallest to largest. media_type - Media are ordered alphabetically by MIME-type. quarantined_by - Media are ordered alphabetically by the user ID that\\ninitiated the quarantine request for this media. safe_from_quarantine - Media are ordered by the status if this media is safe\\nfrom quarantining. dir - Direction of media order. Either f for forwards or b for backwards.\\nSetting this value to b will reverse the above sort order. Defaults to f. If neither order_by nor dir is set, the default order is newest media on top\\n(corresponds to order_by = created_ts and dir = b). Caution. The database only has indexes on the columns media_id, user_id and created_ts. This means that if a different sort order is used\\n( upload_name, last_access_ts, media_length, media_type, quarantined_by or safe_from_quarantine), this can cause a large load on the\\ndatabase, especially for large environments. Response The following fields are returned in the JSON response body: media - An array of objects, each containing information about a media.\\nMedia objects contain the following fields: created_ts - integer - Timestamp when the content was uploaded in ms. last_access_ts - integer or null - Timestamp when the content was last accessed in ms.\\nNull if there was no access, yet. media_id - string - The id used to refer to the media. Details about the format\\nare documented under media repository. media_length - integer - Length of the media in bytes. media_type - string - The MIME-type of the media. quarantined_by - string or null - The user ID that initiated the quarantine request\\nfor this media. Null if not quarantined. safe_from_quarantine - bool - Status if this media is safe from quarantining. upload_name - string or null - The name the media was uploaded with. Null if not provided during upload. next_token: integer - Indication for pagination. See above. total - integer - Total number of media.","breadcrumbs":"Administration » Admin API » Users » List media uploaded by a user","id":"886","title":"List media uploaded by a user"},"887":{"body":"This API deletes the local media from the disk of your own server\\nthat a specific user_id has created. This includes any local thumbnails. This API will not affect media that has been uploaded to external\\nmedia repositories (e.g https://github.com/turt2live/matrix-media-repo/). By default, the API deletes media ordered by descending creation date and ascending media ID.\\nThe newest media is deleted first. You can change the order with parameters order_by and dir. If no limit is set the API deletes 100 files per request. The API is: DELETE /_synapse/admin/v1/users//media A response body like the following is returned: { \\"deleted_media\\": [ \\"abcdefghijklmnopqrstuvwx\\" ], \\"total\\": 1\\n} The following fields are returned in the JSON response body: deleted_media: an array of strings - List of deleted media_id total: integer - Total number of deleted media_id Note: There is no next_token. This is not useful for deleting media, because\\nafter deleting media the remaining media have a new order. Parameters This API has the same parameters as List media uploaded by a user.\\nWith the parameters you can for example limit the number of files to delete at once or\\ndelete largest/smallest or newest/oldest files first.","breadcrumbs":"Administration » Admin API » Users » Delete media uploaded by a user","id":"887","title":"Delete media uploaded by a user"},"888":{"body":"Note: This API is disabled when Matrix Authentication Service integration is enabled. Use Personal sessions through the MAS Admin API instead. An easy way to make use of this functionality is provided by Element Admin as part of ESS Community and Pro. Get an access token that can be used to authenticate as that user. Useful for\\nwhen admins wish to do actions on behalf of a user. The API is: POST /_synapse/admin/v1/users//login\\n{} An optional valid_until_ms field can be specified in the request body as an\\ninteger timestamp that specifies when the token should expire. By default tokens\\ndo not expire. Note that this API does not allow a user to login as themselves\\n(to create more tokens). A response body like the following is returned: { \\"access_token\\": \\"\\"\\n} This API does not generate a new device for the user, and so will not appear\\ntheir /devices list, and in general the target user should not be able to\\ntell they have been logged in as. To expire the token call the standard /logout API with the token. Note: The token will expire if the admin user calls /logout/all from any\\nof their devices, but the token will not expire if the target user does the\\nsame.","breadcrumbs":"Administration » Admin API » Users » Login as a user","id":"888","title":"Login as a user"},"889":{"body":"This endpoint is not intended for server administrator usage;\\nwe describe it here for completeness. This API temporarily permits a user to replace their master cross-signing key\\nwithout going through user-interactive authentication (UIA).\\nThis is useful when Synapse has delegated its authentication to the Matrix Authentication Service;\\nas Synapse cannot perform UIA is not possible in these circumstances. The API is POST /_synapse/admin/v1/users//_allow_cross_signing_replacement_without_uia\\n{} If the user does not exist, or does exist but has no master cross-signing key,\\nthis will return with status code 404 Not Found. Otherwise, a response body like the following is returned, with status 200 OK: { \\"updatable_without_uia_before_ms\\": 1234567890\\n} The response body is a JSON object with a single field: updatable_without_uia_before_ms: integer. The timestamp in milliseconds\\nbefore which the user is permitted to replace their cross-signing key without\\ngoing through UIA. Added in Synapse 1.97.0.","breadcrumbs":"Administration » Admin API » Users » Allow replacing master cross-signing key without User-Interactive Auth","id":"889","title":"Allow replacing master cross-signing key without User-Interactive Auth"},"89":{"body":"A new quarantined_media_changes stream writer is\\nintroduced. Existing deployments which route the /quarantine_media endpoints to a\\nworker (instead of the main process) must also add those workers to the quarantined_media_changes stream writer list. Quarantining media will not work without\\nthis. If your deployment does not use workers, or instead uses the main process for\\nquarantining media, you do not need to make any changes to your configuration.","breadcrumbs":"Upgrading between Synapse Versions » Workers which quarantine media must be stream writers","id":"89","title":"Workers which quarantine media must be stream writers"},"890":{"body":"","breadcrumbs":"Administration » Admin API » Users » User devices","id":"890","title":"User devices"},"891":{"body":"Gets information about all devices for a specific user_id. The API is: GET /_synapse/admin/v2/users//devices A response body like the following is returned: { \\"devices\\": [ { \\"device_id\\": \\"QBUAZIFURK\\", \\"display_name\\": \\"android\\", \\"last_seen_ip\\": \\"1.2.3.4\\", \\"last_seen_user_agent\\": \\"Mozilla/5.0 (X11; Linux x86_64; rv:103.0) Gecko/20100101 Firefox/103.0\\", \\"last_seen_ts\\": 1474491775024, \\"user_id\\": \\"\\", \\"dehydrated\\": false }, { \\"device_id\\": \\"AUIECTSRND\\", \\"display_name\\": \\"ios\\", \\"last_seen_ip\\": \\"1.2.3.5\\", \\"last_seen_user_agent\\": \\"Mozilla/5.0 (X11; Linux x86_64; rv:103.0) Gecko/20100101 Firefox/103.0\\", \\"last_seen_ts\\": 1474491775025, \\"user_id\\": \\"\\", \\"dehydrated\\": false } ], \\"total\\": 2\\n} Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. Response The following fields are returned in the JSON response body: devices - An array of objects, each containing information about a device.\\nDevice objects contain the following fields: device_id - Identifier of device. display_name - Display name set by the user for this device.\\nAbsent if no name has been set. last_seen_ip - The IP address where this device was last seen.\\n(May be a few minutes out of date, for efficiency reasons). last_seen_user_agent - The user agent of the device when it was last seen.\\n(May be a few minutes out of date, for efficiency reasons). last_seen_ts - The timestamp (in milliseconds since the unix epoch) when this\\ndevices was last seen. (May be a few minutes out of date, for efficiency reasons). user_id - Owner of device. dehydrated - Whether the device is a dehydrated device. total - Total number of user’s devices.","breadcrumbs":"Administration » Admin API » Users » List all devices","id":"891","title":"List all devices"},"892":{"body":"Creates a new device for a specific user_id and device_id. Does nothing if the device_id\\nexists already. The API is: POST /_synapse/admin/v2/users//devices { \\"device_id\\": \\"QBUAZIFURK\\"\\n} An empty JSON dict is returned. Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. The following fields are required in the JSON request body: device_id - The device ID to create.","breadcrumbs":"Administration » Admin API » Users » Create a device","id":"892","title":"Create a device"},"893":{"body":"Deletes the given devices for a specific user_id, and invalidates\\nany access token associated with them. The API is: POST /_synapse/admin/v2/users//delete_devices { \\"devices\\": [ \\"QBUAZIFURK\\", \\"AUIECTSRND\\" ]\\n} An empty JSON dict is returned. Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. The following fields are required in the JSON request body: devices - The list of device IDs to delete.","breadcrumbs":"Administration » Admin API » Users » Delete multiple devices","id":"893","title":"Delete multiple devices"},"894":{"body":"Gets information on a single device, by device_id for a specific user_id. The API is: GET /_synapse/admin/v2/users//devices/ A response body like the following is returned: { \\"device_id\\": \\"\\", \\"display_name\\": \\"android\\", \\"last_seen_ip\\": \\"1.2.3.4\\", \\"last_seen_user_agent\\": \\"Mozilla/5.0 (X11; Linux x86_64; rv:103.0) Gecko/20100101 Firefox/103.0\\", \\"last_seen_ts\\": 1474491775024, \\"user_id\\": \\"\\"\\n} Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. device_id - The device to retrieve. Response The following fields are returned in the JSON response body: device_id - Identifier of device. display_name - Display name set by the user for this device.\\nAbsent if no name has been set. last_seen_ip - The IP address where this device was last seen.\\n(May be a few minutes out of date, for efficiency reasons). last_seen_user_agent - The user agent of the device when it was last seen.\\n(May be a few minutes out of date, for efficiency reasons). last_seen_ts - The timestamp (in milliseconds since the unix epoch) when this\\ndevices was last seen. (May be a few minutes out of date, for efficiency reasons). user_id - Owner of device.","breadcrumbs":"Administration » Admin API » Users » Show a device","id":"894","title":"Show a device"},"895":{"body":"Updates the metadata on the given device_id for a specific user_id. The API is: PUT /_synapse/admin/v2/users//devices/ { \\"display_name\\": \\"My other phone\\"\\n} An empty JSON dict is returned. Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. device_id - The device to update. The following fields are required in the JSON request body: display_name - The new display name for this device. If not given,\\nthe display name is unchanged.","breadcrumbs":"Administration » Admin API » Users » Update a device","id":"895","title":"Update a device"},"896":{"body":"Deletes the given device_id for a specific user_id,\\nand invalidates any access token associated with it. The API is: DELETE /_synapse/admin/v2/users//devices/ {} An empty JSON dict is returned. Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. device_id - The device to delete.","breadcrumbs":"Administration » Admin API » Users » Delete a device","id":"896","title":"Delete a device"},"897":{"body":"Gets information about all pushers for a specific user_id. The API is: GET /_synapse/admin/v1/users//pushers A response body like the following is returned: { \\"pushers\\": [ { \\"app_display_name\\":\\"HTTP Push Notifications\\", \\"app_id\\":\\"m.http\\", \\"data\\": { \\"url\\":\\"example.com\\" }, \\"device_display_name\\":\\"pushy push\\", \\"kind\\":\\"http\\", \\"lang\\":\\"None\\", \\"profile_tag\\":\\"\\", \\"pushkey\\":\\"a@example.com\\" } ], \\"total\\": 1\\n} Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. Response The following fields are returned in the JSON response body: pushers - An array containing the current pushers for the user app_display_name - string - A string that will allow the user to identify\\nwhat application owns this pusher. app_id - string - This is a reverse-DNS style identifier for the application.\\nMax length, 64 chars. data - A dictionary of information for the pusher implementation itself. url - string - Required if kind is http. The URL to use to send\\nnotifications to. format - string - The format to use when sending notifications to the\\nPush Gateway. device_display_name - string - A string that will allow the user to identify\\nwhat device owns this pusher. profile_tag - string - This string determines which set of device specific rules\\nthis pusher executes. kind - string - The kind of pusher. “http” is a pusher that sends HTTP pokes. lang - string - The preferred language for receiving notifications\\n(e.g. ‘en’ or ‘en-US’) profile_tag - string - This string determines which set of device specific rules\\nthis pusher executes. pushkey - string - This is a unique identifier for this pusher.\\nMax length, 512 bytes. total - integer - Number of pushers. See also the Client-Server API Spec on pushers.","breadcrumbs":"Administration » Admin API » Users » List all pushers","id":"897","title":"List all pushers"},"898":{"body":"Shadow-banning is a useful tool for moderating malicious or egregiously abusive users.\\nA shadow-banned users receives successful responses to their client-server API requests,\\nbut the events are not propagated into rooms. This can be an effective tool as it\\n(hopefully) takes longer for the user to realise they are being moderated before\\npivoting to another account. Shadow-banning a user should be used as a tool of last resort and may lead to confusing\\nor broken behaviour for the client. A shadow-banned user will not receive any\\nnotification and it is generally more appropriate to ban or kick abusive users.\\nA shadow-banned user will be unable to contact anyone on the server. To shadow-ban a user the API is: POST /_synapse/admin/v1/users//shadow_ban To un-shadow-ban a user the API is: DELETE /_synapse/admin/v1/users//shadow_ban An empty JSON dict is returned in both cases. Parameters The following parameters should be set in the URL: user_id - The fully qualified MXID: for example, @user:server.com. The user must\\nbe local.","breadcrumbs":"Administration » Admin API » Users » Controlling whether a user is shadow-banned","id":"898","title":"Controlling whether a user is shadow-banned"},"899":{"body":"This API allows to override or disable ratelimiting for a specific user.\\nThere are specific APIs to set, get and delete a ratelimit.","breadcrumbs":"Administration » Admin API » Users » Override ratelimiting for users","id":"899","title":"Override ratelimiting for users"},"9":{"body":"Once you have installed synapse as above, you will need to configure it.","breadcrumbs":"Installation » Setting up Synapse","id":"9","title":"Setting up Synapse"},"90":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.150.0","id":"90","title":"Upgrading to v1.150.0"},"900":{"body":"The API is: GET /_synapse/admin/v1/users//override_ratelimit A response body like the following is returned: { \\"messages_per_second\\": 0, \\"burst_count\\": 0\\n} Parameters The following parameters should be set in the URL: user_id - The fully qualified MXID: for example, @user:server.com. The user must\\nbe local. Response The following fields are returned in the JSON response body: messages_per_second - integer - The number of actions that can\\nbe performed in a second. 0 mean that ratelimiting is disabled for this user. burst_count - integer - How many actions that can be performed before\\nbeing limited. If no custom ratelimit is set, an empty JSON dict is returned. {}","breadcrumbs":"Administration » Admin API » Users » Get status of ratelimit","id":"900","title":"Get status of ratelimit"},"901":{"body":"The API is: POST /_synapse/admin/v1/users//override_ratelimit A response body like the following is returned: { \\"messages_per_second\\": 0, \\"burst_count\\": 0\\n} Parameters The following parameters should be set in the URL: user_id - The fully qualified MXID: for example, @user:server.com. The user must\\nbe local. Body parameters: messages_per_second - positive integer, optional. The number of actions that can\\nbe performed in a second. Defaults to 0. burst_count - positive integer, optional. How many actions that can be performed\\nbefore being limited. Defaults to 0. To disable users’ ratelimit set both values to 0. Response The following fields are returned in the JSON response body: messages_per_second - integer - The number of actions that can\\nbe performed in a second. burst_count - integer - How many actions that can be performed before\\nbeing limited.","breadcrumbs":"Administration » Admin API » Users » Set ratelimit","id":"901","title":"Set ratelimit"},"902":{"body":"The API is: DELETE /_synapse/admin/v1/users//override_ratelimit An empty JSON dict is returned. {} Parameters The following parameters should be set in the URL: user_id - The fully qualified MXID: for example, @user:server.com. The user must\\nbe local.","breadcrumbs":"Administration » Admin API » Users » Delete ratelimit","id":"902","title":"Delete ratelimit"},"903":{"body":"Checks to see if a username is available, and valid, for the server. See the client-server\\nAPI\\nfor more information. This endpoint will work even if registration is disabled on the server, unlike /_matrix/client/r0/register/available. The API is: GET /_synapse/admin/v1/username_available?username=$localpart The request and response format is the same as the /_matrix/client/r0/register/available API.","breadcrumbs":"Administration » Admin API » Users » Check username availability","id":"903","title":"Check username availability"},"904":{"body":"The API is: GET /_synapse/admin/v1/auth_providers//users/ When a user matched the given ID for the given provider, an HTTP code 200 with a response body like the following is returned: { \\"user_id\\": \\"@hello:example.org\\"\\n} Parameters The following parameters should be set in the URL: provider - The ID of the authentication provider, as advertised by the GET /_matrix/client/v3/login API in the m.login.sso authentication method. external_id - The user ID from the authentication provider. Usually corresponds to the sub claim for OIDC providers, or to the uid attestation for SAML2 providers. The external_id may have characters that are not URL-safe (typically /, : or @), so it is advised to URL-encode those parameters. Errors Returns a 404 HTTP status code if no user was found, with a response body like this: { \\"errcode\\":\\"M_NOT_FOUND\\", \\"error\\":\\"User not found\\"\\n} Added in Synapse 1.68.0.","breadcrumbs":"Administration » Admin API » Users » Find a user based on their ID in an auth provider","id":"904","title":"Find a user based on their ID in an auth provider"},"905":{"body":"The API is: GET /_synapse/admin/v1/threepid//users/ When a user matched the given address for the given medium, an HTTP code 200 with a response body like the following is returned: { \\"user_id\\": \\"@hello:example.org\\"\\n} Parameters The following parameters should be set in the URL: medium - Kind of third-party ID, either email or msisdn. address - Value of the third-party ID. The address may have characters that are not URL-safe, so it is advised to URL-encode those parameters. Errors Returns a 404 HTTP status code if no user was found, with a response body like this: { \\"errcode\\":\\"M_NOT_FOUND\\", \\"error\\":\\"User not found\\"\\n} Added in Synapse 1.72.0.","breadcrumbs":"Administration » Admin API » Users » Find a user based on their Third Party ID (ThreePID or 3PID)","id":"905","title":"Find a user based on their Third Party ID (ThreePID or 3PID)"},"906":{"body":"This endpoint allows an admin to redact the events of a given user. There are no restrictions on\\nredactions for a local user. By default, we puppet the user who sent the message to redact it themselves.\\nRedactions for non-local users are issued using the admin user, and will fail in rooms where the\\nadmin user is not admin/does not have the specified power level to issue redactions. An option\\nis provided to override the default and allow the admin to issue the redactions in all cases.\\nThere are optional parameters to filter for events that happened in the given time period. The API is POST /_synapse/admin/v1/user//redact { \\"rooms\\": [\\"!roomid1\\", \\"!roomid2\\"], \\"after_ts\\": 1779564103728, \\"before_ts\\": 1779564103730\\n} If an empty list is provided as the key for rooms, all events in all the rooms the user is member of will be redacted,\\notherwise all the events in the rooms provided in the request will be redacted.\\nIf neither after_ts nor before_ts is provided, events will be redacted regardless of when they happened. If only one parameter is provided, all events occurring on or before/after given time will be redacted. The API starts redaction process running, and returns immediately with a JSON body with\\na redact id which can be used to query the status of the redaction process: { \\"redact_id\\": \\"\\"\\n} Parameters The following parameters should be set in the URL: user_id - The fully qualified MXID of the user: for example, @user:server.com. The following JSON body parameter must be provided: rooms - A list of rooms to redact the user’s events in. If an empty list is provided all events in all rooms\\nthe user is a member of will be redacted The following JSON body parameters are optional: reason - Reason the redaction is being requested, ie “spam”, “abuse”, etc. This will be included in each redaction event, and be visible to users. limit - a limit on the number of the user’s events to search for ones that can be redacted (events are redacted newest to oldest) in each room, defaults to 1000 if not provided. use_admin - If set to true, the admin user is used to issue the redactions, rather than puppeting the user. Useful\\nwhen the admin is also the moderator of the rooms that require redactions. Note that the redactions will fail in rooms\\nwhere the admin does not have the sufficient power level to issue the redactions. after_ts - Redact only events that were sent at this time or after. Format: milliseconds timestamp. Added in Synapse 1.157.0. before_ts - Redact only events that were sent at this time or before. Format: milliseconds timestamp. Added in Synapse 1.157.0. Added in Synapse 1.116.0.","breadcrumbs":"Administration » Admin API » Users » Redact events of a user","id":"906","title":"Redact events of a user"},"907":{"body":"It is possible to query the status of the background task for redacting a user’s events.\\nThe status can be queried up to 24 hours after completion of the task,\\nor until Synapse is restarted (whichever happens first). The API is: GET /_synapse/admin/v1/user/redact_status/