{
+{
"rooms": [
{
"room_id": "!mscvqgqpHYjBGDxNym:matrix.org",
@@ -10090,7 +10258,7 @@ end of the list.
}
-The Delete Room admin API allows server admins to remove rooms from server
+
The Delete Room admin API allows server admins to remove rooms from the server
and block these rooms.
Shuts down a room. Moves all local users and room aliases automatically to a
new room if new_room_user_id is set. Otherwise local users only
@@ -10215,11 +10383,6 @@ them handle rejoining themselves.
created. Consider whether you want to delete that roomm.
-
-The previous deprecated API will be removed in a future release, it was:
-POST /_synapse/admin/v1/rooms/<room_id>/delete
-
-It behaves the same way than the current endpoint except the path and the method.
Grants another user the highest power available to a local user who is in the room.
If the user is not in the room, and it is not publicly joinable, then invite the user.
@@ -11783,6 +11946,10 @@ license the code under the same terms as the project's overall 'outbound'
license - in our case, this is almost always Apache Software License v2 (see
LICENSE).
+If you are running Windows, the Windows Subsystem for Linux (WSL) is strongly
+recommended for development. More information about WSL can be found at
+https://docs.microsoft.com/en-us/windows/wsl/install. Running Synapse natively
+on Windows is not officially supported.
The code of Synapse is written in Python 3. To do pretty much anything, you'll need a recent version of Python 3.
The source code of Synapse is hosted on GitHub. You will also need a recent version of git.
For some tests, you will need a recent version of Docker.
@@ -11797,7 +11964,6 @@ git checkout develop
If you need help getting started with git, this is beyond the scope of the document, but you
can find many good git tutorials on the web.
-
Once you have installed Python 3 and added the source, please open a terminal and
setup a virtualenv, as follows:
cd path/where/you/have/cloned/the/repository
@@ -11807,8 +11973,6 @@ pip install -e ".[all,dev]"
pip install tox
This will install the developer dependencies for the project.
-
-TBD
Join our developer community on Matrix: #synapse-dev:matrix.org!
@@ -12126,7 +12290,7 @@ quickly and automatically check for formatting (and sometimes logical)
errors in code.
The necessary tools are detailed below.
First install them with:
-pip install -e ".[lint,mypy]"
+pip install -e ".[lint,mypy]"
-
@@ -12136,7 +12300,7 @@ as an opinionated code formatter, ensuring all comitted code is
properly formatted.
Have black auto-format your code (it shouldn't change any
functionality) with:
-black . --exclude="\.tox|build|env"
+black . --exclude="\.tox|build|env"
-
@@ -12144,7 +12308,7 @@ functionality) with:
flake8 is a code checking tool. We require code to pass flake8
before being merged into the codebase.
Check all application and test code with:
-flake8 synapse tests
+flake8 synapse tests
-
@@ -12152,7 +12316,7 @@ before being merged into the codebase.
isort ensures imports are nicely formatted, and can suggest and
auto-fix issues such as double-importing.
Auto-fix imports with:
-isort -rc synapse tests
+isort -rc synapse tests
-rc means to recursively search the given directories.
@@ -12184,12 +12348,12 @@ in the sphinx documentation.
Prefer to import classes and functions rather than packages or
modules.
Example:
-
from synapse.types import UserID
+from synapse.types import UserID
...
user_id = UserID(local, server)
is preferred over:
-from synapse import types
+from synapse import types
...
user_id = types.UserID(local, server)
@@ -12270,7 +12434,7 @@ will be if no sub-options are enabled).
Example:
-## Frobnication ##
+## Frobnication ##
# The frobnicator will ensure that all requests are fully frobnicated.
# To enable it, uncomment the following.
@@ -12572,7 +12736,7 @@ has had all background updates run.
To do so, use scripts-dev/make_full_schema.sh. This will produce new
full.sql.postgres and full.sql.sqlite files.
Ensure postgres is installed, then run:
-./scripts-dev/make_full_schema.sh -p postgres_username -o output_dir/
+./scripts-dev/make_full_schema.sh -p postgres_username -o output_dir/
NB at the time of writing, this script predates the split into separate state/main
databases so will require updates to handle that correctly.
@@ -13187,7 +13351,7 @@ the XML from step 2 as the contents.
sp_config:
allow_unknown_attributes: true # Works around a bug with AVA Hashes: https://github.com/IdentityPython/pysaml2/issues/388
metadata:
- local: ["samling.xml"]
+ local: ["samling.xml"]
Ensure that your homeserver.yaml has a setting for public_baseurl:
@@ -13219,17 +13383,17 @@ easy to run CAS implementation built on top of Django.
Create a new virtualenv: python3 -m venv <your virtualenv>
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"
+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 .
+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
+python manage.py createsuperuser
- Use whatever you want as the username and password.
@@ -13237,7 +13401,7 @@ easy to run CAS implementation built on top of Django.
Use the built-in Django test server to serve the CAS endpoints on port 8000:
-python manage.py runserver
+python manage.py runserver
diff --git a/latest/replication.html b/latest/replication.html
index 8e1f649f3d..ed3bb4525c 100644
--- a/latest/replication.html
+++ b/latest/replication.html
@@ -99,7 +99,7 @@
diff --git a/latest/reverse_proxy.html b/latest/reverse_proxy.html
index d83219a722..0629f263a6 100644
--- a/latest/reverse_proxy.html
+++ b/latest/reverse_proxy.html
@@ -99,7 +99,7 @@
@@ -222,7 +222,7 @@ to proxied traffic.)
NOTE: You only need one of these.
-server {
+server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
@@ -301,7 +301,7 @@ matrix.example.com {
}
-<VirtualHost *:443>
+<VirtualHost *:443>
SSLEngine on
ServerName matrix.example.com
@@ -326,7 +326,7 @@ matrix.example.com {
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 </VirtualHost> above:
-<IfModule security2_module>
+<IfModule security2_module>
SecRuleEngine off
</IfModule>
@@ -339,7 +339,7 @@ matrix.example.com {
http-request set-header X-Forwarded-For %[src]
# Matrix client traffic
- acl matrix-host hdr(host) -i matrix.example.com
+ 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
diff --git a/latest/room_and_user_statistics.html b/latest/room_and_user_statistics.html
index b5342f0740..026f5bb6eb 100644
--- a/latest/room_and_user_statistics.html
+++ b/latest/room_and_user_statistics.html
@@ -99,7 +99,7 @@
diff --git a/latest/sample_config.yaml b/latest/sample_config.yaml
index b90ed62d61..d48c08f1d9 100644
--- a/latest/sample_config.yaml
+++ b/latest/sample_config.yaml
@@ -91,8 +91,28 @@ pid_file: DATADIR/homeserver.pid
# Otherwise, it should be the URL to reach Synapse's client HTTP listener (see
# 'listeners' below).
#
+# Defaults to 'https:///'.
+#
#public_baseurl: https://example.com/
+# Uncomment the following to tell other servers to send federation traffic on
+# port 443.
+#
+# 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.
+#
+# See https://matrix-org.github.io/synapse/latest/delegate.html for more
+# information.
+#
+# Defaults to 'false'.
+#
+#serve_server_wellknown: true
+
# 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.
@@ -1247,7 +1267,7 @@ oembed:
# 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 set.)
+# This setting is ignored unless public_baseurl is also explicitly set.)
#
#default_identity_server: https://matrix.org
@@ -1272,8 +1292,6 @@ oembed:
# by the Matrix Identity Service API specification:
# https://matrix.org/docs/spec/identity_service/latest
#
-# If a delegate is specified, the config option public_baseurl must also be filled out.
-#
account_threepid_delegates:
#email: https://example.com # Delegate email sending to example.com
#msisdn: http://localhost:8090 # Delegate SMS sending to this local process
@@ -1963,11 +1981,10 @@ sso:
# phishing attacks from evil.site. To avoid this, include a slash after the
# hostname: "https://my.client/".
#
- # If public_baseurl is set, then 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.
+ # 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 is empty.
+ # By default, this list contains only the login fallback page.
#
#client_whitelist:
# - https://riot.im/develop
diff --git a/latest/searchindex.js b/latest/searchindex.js
index ffdf7b8ff5..753e9eef8b 100644
--- a/latest/searchindex.js
+++ b/latest/searchindex.js
@@ -1 +1 @@
-Object.assign(window.search, {"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#donating-to-synapse-development","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#troubleshooting-installation","postgres.html#using-postgres","postgres.html#install-postgres-client-libraries","postgres.html#set-up-database","postgres.html#synapse-config","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","postgres.html#fixing-inconsistent-sequences-error","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#caddy-v1","reverse_proxy.html#caddy-v2","reverse_proxy.html#apache","reverse_proxy.html#haproxy","reverse_proxy.html#relayd","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#coturn-setup","turn-howto.html#initial-installation","turn-howto.html#configuration","turn-howto.html#synapse-setup","turn-howto.html#troubleshooting","delegate.html#delegation","delegate.html#well-known-delegation","delegate.html#srv-dns-record-delegation","delegate.html#delegation-faq","delegate.html#when-do-i-need-delegation","delegate.html#do-you-still-recommend-against-using-a-reverse-proxy-on-the-federation-port","delegate.html#do-i-still-need-to-give-my-tls-certificates-to-synapse-if-i-am-using-a-reverse-proxy","delegate.html#do-i-need-the-same-certificate-for-the-client-and-federation-port","upgrade.html#upgrading-synapse","upgrade.html#rolling-back-to-older-versions","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","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","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","MSC1711_certificates_FAQ.html#msc1711-certificates-faq","MSC1711_certificates_FAQ.html#historical-note","MSC1711_certificates_FAQ.html#introduction","MSC1711_certificates_FAQ.html#contents","MSC1711_certificates_FAQ.html#timeline","MSC1711_certificates_FAQ.html#configuring-certificates-for-compatibility-with-synapse-100","MSC1711_certificates_FAQ.html#if-you-do-not-currently-have-an-srv-record","MSC1711_certificates_FAQ.html#if-you-do-have-an-srv-record-currently","MSC1711_certificates_FAQ.html#faq","MSC1711_certificates_FAQ.html#synapse-0990-has-just-been-released-what-do-i-need-to-do-right-now","MSC1711_certificates_FAQ.html#what-will-happen-if-i-do-not-set-up-a-valid-federation-certificate-immediately","MSC1711_certificates_FAQ.html#what-will-happen-if-i-do-nothing-at-all","MSC1711_certificates_FAQ.html#when-do-i-need-a-srv-record-or-well-known-uri","MSC1711_certificates_FAQ.html#can-i-still-use-an-srv-record","MSC1711_certificates_FAQ.html#i-have-created-a-well-known-uri-do-i-still-need-an-srv-record","MSC1711_certificates_FAQ.html#it-used-to-work-just-fine-why-are-you-breaking-everything","MSC1711_certificates_FAQ.html#can-i-manage-my-own-certificates-rather-than-having-synapse-renew-certificates-itself","MSC1711_certificates_FAQ.html#do-you-still-recommend-against-using-a-reverse-proxy-on-the-federation-port","MSC1711_certificates_FAQ.html#do-i-still-need-to-give-my-tls-certificates-to-synapse-if-i-am-using-a-reverse-proxy","MSC1711_certificates_FAQ.html#do-i-need-the-same-certificate-for-the-client-and-federation-port","MSC1711_certificates_FAQ.html#how-do-i-tell-synapse-to-reload-my-keyscertificates-after-i-replace-them","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/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#upgrading-from-legacy-structured-logging-configuration","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","openid.html#configuring-synapse-to-authenticate-against-an-openid-connect-provider","openid.html#preparing-synapse","openid.html#sample-configs","openid.html#microsoft-azure-active-directory","openid.html#dex","openid.html#keycloak","openid.html#auth0","openid.html#github","openid.html#google","openid.html#twitch","openid.html#gitlab","openid.html#facebook","openid.html#gitea","openid.html#xwiki","openid.html#apple","openid.html#django-oauth-toolkit","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","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","development/url_previews.html#url-previews","user_directory.html#user-directory-api-implementation","user_directory.html#data-model","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/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#user_may_send_3pid_invite","modules/spam_checker_callbacks.html#user_may_create_room","modules/spam_checker_callbacks.html#user_may_create_room_with_invites","modules/spam_checker_callbacks.html#user_may_create_room_alias","modules/spam_checker_callbacks.html#user_may_publish_room","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#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#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/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#example","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#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#synapseappfrontend_proxy","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/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","admin_api/delete_group.html#delete-a-local-group","admin_api/event_reports.html#show-reported-events","admin_api/event_reports.html#show-details-of-a-specific-event-report","admin_api/media_admin_api.html#contents","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#quarantine-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#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#contents","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#delete-room-api","admin_api/rooms.html#undoing-room-deletions","admin_api/rooms.html#deprecated-endpoint","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/server_notices.html#server-notices","admin_api/statistics.html#users-media-usage-statistics","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#query-current-sessions-for-a-user","admin_api/user_admin_api.html#deactivate-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#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#user-devices","admin_api/user_admin_api.html#list-all-devices","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#shadow-banning-users","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/version_api.html#version-api","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","metrics-howto.html#renaming-of-metrics--deprecation-of-old-names-in-12","metrics-howto.html#removal-of-deprecated-metrics--time-based-counters-becoming-histograms-in-0310","metrics-howto.html#block-and-response-metrics-renamed-for-0270","metrics-howto.html#standard-metric-names","usage/administration/request_log.html#request-log-format","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#under-unix-macos-linux-bsd-","development/contributing_guide.html#under-windows","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#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#access-database-for-homeserver-after-complement-test-runs","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-file-format","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","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#boolean-columns","development/experimental_features.html#implementing-experimental-features-in-synapse","log_contexts.html#log-contexts","log_contexts.html#logcontexts-without-asynchronous-code","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#fire-and-forget","log_contexts.html#passing-synapse-deferreds-into-third-party-functions","log_contexts.html#a-note-on-garbage-collection-of-awaitable-chains","replication.html#replication-architecture","replication.html#motivation","replication.html#architecture","replication.html#the-replication-protocol","replication.html#the-slaved-datastore","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#cache-invalidation-stream","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#forward-extremity","development/room-dag-concepts.html#backwards-extremity","development/room-dag-concepts.html#outliers","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#storage","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","deprecation_policy.html#deprecation-policy-for-platform-dependencies","deprecation_policy.html#policy","deprecation_policy.html#context"],"index":{"documentStore":{"docInfo":{"0":{"body":11,"breadcrumbs":3,"title":1},"1":{"body":55,"breadcrumbs":5,"title":3},"10":{"body":6,"breadcrumbs":4,"title":3},"100":{"body":42,"breadcrumbs":9,"title":5},"101":{"body":57,"breadcrumbs":7,"title":3},"102":{"body":0,"breadcrumbs":6,"title":2},"103":{"body":66,"breadcrumbs":11,"title":7},"104":{"body":50,"breadcrumbs":9,"title":5},"105":{"body":0,"breadcrumbs":6,"title":2},"106":{"body":39,"breadcrumbs":9,"title":5},"107":{"body":0,"breadcrumbs":6,"title":2},"108":{"body":61,"breadcrumbs":7,"title":3},"109":{"body":0,"breadcrumbs":6,"title":2},"11":{"body":58,"breadcrumbs":3,"title":2},"110":{"body":50,"breadcrumbs":9,"title":5},"111":{"body":63,"breadcrumbs":7,"title":3},"112":{"body":46,"breadcrumbs":9,"title":5},"113":{"body":0,"breadcrumbs":6,"title":2},"114":{"body":46,"breadcrumbs":10,"title":6},"115":{"body":23,"breadcrumbs":11,"title":7},"116":{"body":20,"breadcrumbs":6,"title":2},"117":{"body":0,"breadcrumbs":6,"title":2},"118":{"body":65,"breadcrumbs":10,"title":6},"119":{"body":19,"breadcrumbs":9,"title":5},"12":{"body":112,"breadcrumbs":3,"title":2},"120":{"body":18,"breadcrumbs":9,"title":5},"121":{"body":57,"breadcrumbs":9,"title":5},"122":{"body":196,"breadcrumbs":6,"title":2},"123":{"body":16,"breadcrumbs":6,"title":2},"124":{"body":18,"breadcrumbs":6,"title":2},"125":{"body":51,"breadcrumbs":6,"title":2},"126":{"body":19,"breadcrumbs":6,"title":2},"127":{"body":0,"breadcrumbs":6,"title":2},"128":{"body":40,"breadcrumbs":7,"title":3},"129":{"body":216,"breadcrumbs":7,"title":3},"13":{"body":120,"breadcrumbs":5,"title":4},"130":{"body":191,"breadcrumbs":5,"title":1},"131":{"body":95,"breadcrumbs":6,"title":2},"132":{"body":67,"breadcrumbs":7,"title":3},"133":{"body":10,"breadcrumbs":6,"title":2},"134":{"body":11,"breadcrumbs":6,"title":2},"135":{"body":48,"breadcrumbs":7,"title":3},"136":{"body":17,"breadcrumbs":7,"title":3},"137":{"body":0,"breadcrumbs":6,"title":2},"138":{"body":65,"breadcrumbs":7,"title":3},"139":{"body":88,"breadcrumbs":5,"title":1},"14":{"body":55,"breadcrumbs":2,"title":1},"140":{"body":53,"breadcrumbs":7,"title":3},"141":{"body":29,"breadcrumbs":6,"title":2},"142":{"body":223,"breadcrumbs":6,"title":2},"143":{"body":40,"breadcrumbs":6,"title":2},"144":{"body":42,"breadcrumbs":6,"title":2},"145":{"body":16,"breadcrumbs":6,"title":2},"146":{"body":49,"breadcrumbs":6,"title":2},"147":{"body":97,"breadcrumbs":6,"title":2},"148":{"body":20,"breadcrumbs":6,"title":2},"149":{"body":20,"breadcrumbs":6,"title":2},"15":{"body":96,"breadcrumbs":3,"title":2},"150":{"body":49,"breadcrumbs":6,"title":2},"151":{"body":24,"breadcrumbs":6,"title":2},"152":{"body":136,"breadcrumbs":6,"title":2},"153":{"body":25,"breadcrumbs":6,"title":2},"154":{"body":79,"breadcrumbs":6,"title":2},"155":{"body":23,"breadcrumbs":6,"title":2},"156":{"body":68,"breadcrumbs":6,"title":2},"157":{"body":94,"breadcrumbs":6,"title":2},"158":{"body":0,"breadcrumbs":7,"title":3},"159":{"body":62,"breadcrumbs":6,"title":2},"16":{"body":13,"breadcrumbs":5,"title":4},"160":{"body":113,"breadcrumbs":5,"title":1},"161":{"body":81,"breadcrumbs":5,"title":1},"162":{"body":90,"breadcrumbs":5,"title":1},"163":{"body":0,"breadcrumbs":9,"title":5},"164":{"body":19,"breadcrumbs":7,"title":3},"165":{"body":232,"breadcrumbs":7,"title":3},"166":{"body":0,"breadcrumbs":5,"title":1},"167":{"body":9,"breadcrumbs":10,"title":6},"168":{"body":9,"breadcrumbs":11,"title":7},"169":{"body":23,"breadcrumbs":6,"title":2},"17":{"body":61,"breadcrumbs":3,"title":2},"170":{"body":78,"breadcrumbs":10,"title":6},"171":{"body":78,"breadcrumbs":8,"title":4},"172":{"body":61,"breadcrumbs":12,"title":8},"173":{"body":188,"breadcrumbs":9,"title":5},"174":{"body":21,"breadcrumbs":11,"title":7},"175":{"body":30,"breadcrumbs":12,"title":8},"176":{"body":58,"breadcrumbs":13,"title":9},"177":{"body":16,"breadcrumbs":10,"title":6},"178":{"body":19,"breadcrumbs":9,"title":5},"179":{"body":132,"breadcrumbs":4,"title":3},"18":{"body":32,"breadcrumbs":3,"title":2},"180":{"body":77,"breadcrumbs":2,"title":1},"181":{"body":64,"breadcrumbs":3,"title":2},"182":{"body":17,"breadcrumbs":5,"title":4},"183":{"body":15,"breadcrumbs":2,"title":1},"184":{"body":7449,"breadcrumbs":9,"title":4},"185":{"body":293,"breadcrumbs":9,"title":4},"186":{"body":196,"breadcrumbs":5,"title":2},"187":{"body":182,"breadcrumbs":8,"title":5},"188":{"body":105,"breadcrumbs":3,"title":1},"189":{"body":288,"breadcrumbs":4,"title":2},"19":{"body":6,"breadcrumbs":4,"title":2},"190":{"body":129,"breadcrumbs":8,"title":6},"191":{"body":465,"breadcrumbs":8,"title":6},"192":{"body":52,"breadcrumbs":5,"title":2},"193":{"body":76,"breadcrumbs":14,"title":7},"194":{"body":61,"breadcrumbs":9,"title":2},"195":{"body":6,"breadcrumbs":9,"title":2},"196":{"body":77,"breadcrumbs":11,"title":4},"197":{"body":83,"breadcrumbs":8,"title":1},"198":{"body":98,"breadcrumbs":8,"title":1},"199":{"body":71,"breadcrumbs":8,"title":1},"2":{"body":74,"breadcrumbs":4,"title":2},"20":{"body":63,"breadcrumbs":6,"title":4},"200":{"body":85,"breadcrumbs":8,"title":1},"201":{"body":72,"breadcrumbs":8,"title":1},"202":{"body":42,"breadcrumbs":8,"title":1},"203":{"body":49,"breadcrumbs":8,"title":1},"204":{"body":132,"breadcrumbs":8,"title":1},"205":{"body":82,"breadcrumbs":8,"title":1},"206":{"body":33,"breadcrumbs":8,"title":1},"207":{"body":103,"breadcrumbs":8,"title":1},"208":{"body":105,"breadcrumbs":10,"title":3},"209":{"body":167,"breadcrumbs":11,"title":3},"21":{"body":70,"breadcrumbs":5,"title":3},"210":{"body":39,"breadcrumbs":11,"title":3},"211":{"body":220,"breadcrumbs":13,"title":5},"212":{"body":12,"breadcrumbs":12,"title":4},"213":{"body":39,"breadcrumbs":11,"title":3},"214":{"body":267,"breadcrumbs":13,"title":5},"215":{"body":12,"breadcrumbs":12,"title":4},"216":{"body":76,"breadcrumbs":10,"title":4},"217":{"body":50,"breadcrumbs":8,"title":2},"218":{"body":269,"breadcrumbs":8,"title":2},"219":{"body":116,"breadcrumbs":9,"title":3},"22":{"body":104,"breadcrumbs":4,"title":2},"220":{"body":58,"breadcrumbs":8,"title":2},"221":{"body":88,"breadcrumbs":9,"title":3},"222":{"body":18,"breadcrumbs":4,"title":1},"223":{"body":80,"breadcrumbs":6,"title":3},"224":{"body":34,"breadcrumbs":7,"title":4},"225":{"body":96,"breadcrumbs":6,"title":3},"226":{"body":42,"breadcrumbs":5,"title":2},"227":{"body":56,"breadcrumbs":5,"title":2},"228":{"body":84,"breadcrumbs":5,"title":2},"229":{"body":6,"breadcrumbs":5,"title":2},"23":{"body":38,"breadcrumbs":4,"title":2},"230":{"body":50,"breadcrumbs":10,"title":7},"231":{"body":182,"breadcrumbs":7,"title":4},"232":{"body":77,"breadcrumbs":7,"title":4},"233":{"body":80,"breadcrumbs":6,"title":3},"234":{"body":65,"breadcrumbs":10,"title":7},"235":{"body":57,"breadcrumbs":10,"title":7},"236":{"body":227,"breadcrumbs":5,"title":2},"237":{"body":48,"breadcrumbs":7,"title":4},"238":{"body":155,"breadcrumbs":5,"title":2},"239":{"body":199,"breadcrumbs":7,"title":3},"24":{"body":0,"breadcrumbs":4,"title":2},"240":{"body":22,"breadcrumbs":6,"title":2},"241":{"body":67,"breadcrumbs":6,"title":2},"242":{"body":218,"breadcrumbs":6,"title":2},"243":{"body":105,"breadcrumbs":6,"title":2},"244":{"body":58,"breadcrumbs":6,"title":2},"245":{"body":53,"breadcrumbs":8,"title":4},"246":{"body":36,"breadcrumbs":4,"title":1},"247":{"body":31,"breadcrumbs":5,"title":2},"248":{"body":76,"breadcrumbs":6,"title":3},"249":{"body":36,"breadcrumbs":5,"title":2},"25":{"body":88,"breadcrumbs":3,"title":1},"250":{"body":51,"breadcrumbs":7,"title":2},"251":{"body":58,"breadcrumbs":10,"title":5},"252":{"body":37,"breadcrumbs":8,"title":3},"253":{"body":93,"breadcrumbs":8,"title":3},"254":{"body":69,"breadcrumbs":7,"title":2},"255":{"body":21,"breadcrumbs":11,"title":3},"256":{"body":4,"breadcrumbs":9,"title":1},"257":{"body":60,"breadcrumbs":9,"title":1},"258":{"body":85,"breadcrumbs":9,"title":1},"259":{"body":61,"breadcrumbs":9,"title":1},"26":{"body":138,"breadcrumbs":5,"title":3},"260":{"body":130,"breadcrumbs":9,"title":1},"261":{"body":54,"breadcrumbs":9,"title":1},"262":{"body":136,"breadcrumbs":9,"title":1},"263":{"body":58,"breadcrumbs":9,"title":1},"264":{"body":60,"breadcrumbs":9,"title":1},"265":{"body":87,"breadcrumbs":9,"title":1},"266":{"body":106,"breadcrumbs":9,"title":1},"267":{"body":54,"breadcrumbs":9,"title":1},"268":{"body":96,"breadcrumbs":9,"title":1},"269":{"body":25,"breadcrumbs":13,"title":4},"27":{"body":0,"breadcrumbs":3,"title":1},"270":{"body":5,"breadcrumbs":10,"title":1},"271":{"body":180,"breadcrumbs":10,"title":1},"272":{"body":86,"breadcrumbs":10,"title":1},"273":{"body":59,"breadcrumbs":10,"title":1},"274":{"body":61,"breadcrumbs":10,"title":1},"275":{"body":64,"breadcrumbs":10,"title":1},"276":{"body":26,"breadcrumbs":11,"title":3},"277":{"body":4,"breadcrumbs":9,"title":1},"278":{"body":75,"breadcrumbs":9,"title":1},"279":{"body":95,"breadcrumbs":9,"title":1},"28":{"body":67,"breadcrumbs":5,"title":3},"280":{"body":76,"breadcrumbs":9,"title":1},"281":{"body":33,"breadcrumbs":11,"title":3},"282":{"body":83,"breadcrumbs":9,"title":1},"283":{"body":37,"breadcrumbs":9,"title":1},"284":{"body":20,"breadcrumbs":13,"title":4},"285":{"body":0,"breadcrumbs":10,"title":1},"286":{"body":147,"breadcrumbs":10,"title":1},"287":{"body":96,"breadcrumbs":10,"title":1},"288":{"body":45,"breadcrumbs":10,"title":1},"289":{"body":110,"breadcrumbs":10,"title":1},"29":{"body":72,"breadcrumbs":6,"title":4},"290":{"body":84,"breadcrumbs":16,"title":6},"291":{"body":85,"breadcrumbs":6,"title":4},"292":{"body":112,"breadcrumbs":5,"title":3},"293":{"body":155,"breadcrumbs":5,"title":3},"294":{"body":83,"breadcrumbs":4,"title":2},"295":{"body":108,"breadcrumbs":4,"title":2},"296":{"body":33,"breadcrumbs":5,"title":3},"297":{"body":0,"breadcrumbs":5,"title":3},"298":{"body":465,"breadcrumbs":3,"title":1},"299":{"body":38,"breadcrumbs":3,"title":1},"3":{"body":33,"breadcrumbs":5,"title":3},"30":{"body":36,"breadcrumbs":6,"title":4},"300":{"body":30,"breadcrumbs":3,"title":1},"301":{"body":41,"breadcrumbs":3,"title":1},"302":{"body":96,"breadcrumbs":3,"title":1},"303":{"body":30,"breadcrumbs":3,"title":1},"304":{"body":62,"breadcrumbs":3,"title":1},"305":{"body":39,"breadcrumbs":4,"title":2},"306":{"body":64,"breadcrumbs":5,"title":3},"307":{"body":36,"breadcrumbs":4,"title":2},"308":{"body":90,"breadcrumbs":8,"title":3},"309":{"body":42,"breadcrumbs":8,"title":5},"31":{"body":126,"breadcrumbs":7,"title":4},"310":{"body":71,"breadcrumbs":6,"title":3},"311":{"body":68,"breadcrumbs":5,"title":2},"312":{"body":62,"breadcrumbs":4,"title":1},"313":{"body":103,"breadcrumbs":4,"title":1},"314":{"body":25,"breadcrumbs":2,"title":1},"315":{"body":0,"breadcrumbs":5,"title":2},"316":{"body":57,"breadcrumbs":6,"title":3},"317":{"body":36,"breadcrumbs":7,"title":4},"318":{"body":16,"breadcrumbs":8,"title":3},"319":{"body":57,"breadcrumbs":7,"title":2},"32":{"body":41,"breadcrumbs":5,"title":2},"320":{"body":31,"breadcrumbs":8,"title":3},"321":{"body":268,"breadcrumbs":8,"title":3},"322":{"body":184,"breadcrumbs":10,"title":5},"323":{"body":52,"breadcrumbs":5,"title":1},"324":{"body":6,"breadcrumbs":6,"title":2},"325":{"body":34,"breadcrumbs":7,"title":3},"326":{"body":14,"breadcrumbs":8,"title":4},"327":{"body":20,"breadcrumbs":6,"title":2},"328":{"body":17,"breadcrumbs":7,"title":3},"329":{"body":18,"breadcrumbs":8,"title":4},"33":{"body":3,"breadcrumbs":7,"title":4},"330":{"body":39,"breadcrumbs":7,"title":3},"331":{"body":44,"breadcrumbs":7,"title":3},"332":{"body":29,"breadcrumbs":8,"title":4},"333":{"body":11,"breadcrumbs":8,"title":4},"334":{"body":30,"breadcrumbs":7,"title":3},"335":{"body":44,"breadcrumbs":8,"title":4},"336":{"body":92,"breadcrumbs":9,"title":5},"337":{"body":10,"breadcrumbs":8,"title":4},"338":{"body":70,"breadcrumbs":8,"title":4},"339":{"body":135,"breadcrumbs":8,"title":3},"34":{"body":70,"breadcrumbs":4,"title":1},"340":{"body":27,"breadcrumbs":8,"title":3},"341":{"body":13,"breadcrumbs":9,"title":4},"342":{"body":146,"breadcrumbs":8,"title":3},"343":{"body":30,"breadcrumbs":7,"title":2},"344":{"body":91,"breadcrumbs":8,"title":3},"345":{"body":111,"breadcrumbs":7,"title":2},"346":{"body":32,"breadcrumbs":7,"title":2},"347":{"body":138,"breadcrumbs":7,"title":2},"348":{"body":102,"breadcrumbs":7,"title":2},"349":{"body":23,"breadcrumbs":7,"title":2},"35":{"body":13,"breadcrumbs":5,"title":2},"350":{"body":32,"breadcrumbs":6,"title":1},"351":{"body":21,"breadcrumbs":10,"title":4},"352":{"body":16,"breadcrumbs":7,"title":1},"353":{"body":17,"breadcrumbs":7,"title":1},"354":{"body":29,"breadcrumbs":5,"title":1},"355":{"body":656,"breadcrumbs":7,"title":3},"356":{"body":162,"breadcrumbs":7,"title":3},"357":{"body":38,"breadcrumbs":7,"title":3},"358":{"body":43,"breadcrumbs":7,"title":3},"359":{"body":335,"breadcrumbs":7,"title":3},"36":{"body":75,"breadcrumbs":5,"title":2},"360":{"body":160,"breadcrumbs":7,"title":3},"361":{"body":16,"breadcrumbs":6,"title":2},"362":{"body":30,"breadcrumbs":8,"title":4},"363":{"body":17,"breadcrumbs":8,"title":4},"364":{"body":20,"breadcrumbs":7,"title":3},"365":{"body":36,"breadcrumbs":7,"title":3},"366":{"body":167,"breadcrumbs":7,"title":3},"367":{"body":78,"breadcrumbs":7,"title":2},"368":{"body":268,"breadcrumbs":8,"title":4},"369":{"body":0,"breadcrumbs":7,"title":3},"37":{"body":93,"breadcrumbs":4,"title":1},"370":{"body":78,"breadcrumbs":7,"title":3},"371":{"body":227,"breadcrumbs":7,"title":3},"372":{"body":397,"breadcrumbs":6,"title":2},"373":{"body":50,"breadcrumbs":8,"title":4},"374":{"body":162,"breadcrumbs":6,"title":2},"375":{"body":34,"breadcrumbs":6,"title":2},"376":{"body":17,"breadcrumbs":8,"title":4},"377":{"body":18,"breadcrumbs":9,"title":5},"378":{"body":62,"breadcrumbs":8,"title":4},"379":{"body":0,"breadcrumbs":6,"title":2},"38":{"body":104,"breadcrumbs":4,"title":1},"380":{"body":360,"breadcrumbs":8,"title":4},"381":{"body":120,"breadcrumbs":8,"title":4},"382":{"body":67,"breadcrumbs":6,"title":2},"383":{"body":0,"breadcrumbs":6,"title":2},"384":{"body":118,"breadcrumbs":6,"title":2},"385":{"body":49,"breadcrumbs":7,"title":3},"386":{"body":93,"breadcrumbs":6,"title":2},"387":{"body":52,"breadcrumbs":6,"title":2},"388":{"body":38,"breadcrumbs":6,"title":2},"389":{"body":167,"breadcrumbs":6,"title":2},"39":{"body":142,"breadcrumbs":4,"title":1},"390":{"body":95,"breadcrumbs":7,"title":3},"391":{"body":12,"breadcrumbs":7,"title":3},"392":{"body":65,"breadcrumbs":6,"title":2},"393":{"body":85,"breadcrumbs":6,"title":2},"394":{"body":29,"breadcrumbs":6,"title":2},"395":{"body":38,"breadcrumbs":7,"title":3},"396":{"body":34,"breadcrumbs":7,"title":2},"397":{"body":33,"breadcrumbs":5,"title":3},"398":{"body":91,"breadcrumbs":4,"title":2},"399":{"body":40,"breadcrumbs":4,"title":2},"4":{"body":15,"breadcrumbs":5,"title":3},"40":{"body":20,"breadcrumbs":6,"title":3},"400":{"body":64,"breadcrumbs":5,"title":3},"401":{"body":150,"breadcrumbs":7,"title":5},"402":{"body":117,"breadcrumbs":4,"title":2},"403":{"body":112,"breadcrumbs":8,"title":6},"404":{"body":44,"breadcrumbs":11,"title":9},"405":{"body":101,"breadcrumbs":7,"title":5},"406":{"body":62,"breadcrumbs":5,"title":3},"407":{"body":241,"breadcrumbs":7,"title":3},"408":{"body":5,"breadcrumbs":3,"title":1},"409":{"body":44,"breadcrumbs":5,"title":3},"41":{"body":27,"breadcrumbs":6,"title":3},"410":{"body":28,"breadcrumbs":4,"title":2},"411":{"body":41,"breadcrumbs":4,"title":2},"412":{"body":0,"breadcrumbs":5,"title":3},"413":{"body":31,"breadcrumbs":7,"title":5},"414":{"body":1,"breadcrumbs":4,"title":2},"415":{"body":6,"breadcrumbs":4,"title":2},"416":{"body":9,"breadcrumbs":5,"title":3},"417":{"body":85,"breadcrumbs":7,"title":5},"418":{"body":9,"breadcrumbs":6,"title":4},"419":{"body":66,"breadcrumbs":4,"title":2},"42":{"body":27,"breadcrumbs":7,"title":4},"420":{"body":57,"breadcrumbs":7,"title":5},"421":{"body":124,"breadcrumbs":6,"title":4},"422":{"body":49,"breadcrumbs":6,"title":4},"423":{"body":78,"breadcrumbs":6,"title":4},"424":{"body":72,"breadcrumbs":8,"title":6},"425":{"body":59,"breadcrumbs":5,"title":3},"426":{"body":117,"breadcrumbs":3,"title":1},"427":{"body":65,"breadcrumbs":9,"title":7},"428":{"body":74,"breadcrumbs":4,"title":2},"429":{"body":214,"breadcrumbs":3,"title":1},"43":{"body":111,"breadcrumbs":4,"title":1},"430":{"body":76,"breadcrumbs":7,"title":5},"431":{"body":3,"breadcrumbs":6,"title":4},"432":{"body":8,"breadcrumbs":7,"title":5},"433":{"body":31,"breadcrumbs":3,"title":1},"434":{"body":0,"breadcrumbs":4,"title":2},"435":{"body":123,"breadcrumbs":4,"title":2},"436":{"body":71,"breadcrumbs":4,"title":2},"437":{"body":236,"breadcrumbs":5,"title":3},"438":{"body":0,"breadcrumbs":5,"title":3},"439":{"body":195,"breadcrumbs":6,"title":4},"44":{"body":42,"breadcrumbs":5,"title":2},"440":{"body":157,"breadcrumbs":6,"title":4},"441":{"body":200,"breadcrumbs":5,"title":3},"442":{"body":0,"breadcrumbs":2,"title":1},"443":{"body":144,"breadcrumbs":2,"title":1},"444":{"body":32,"breadcrumbs":4,"title":3},"445":{"body":21,"breadcrumbs":4,"title":3},"446":{"body":76,"breadcrumbs":3,"title":2},"447":{"body":5,"breadcrumbs":3,"title":2},"448":{"body":6,"breadcrumbs":6,"title":4},"449":{"body":48,"breadcrumbs":4,"title":2},"45":{"body":28,"breadcrumbs":4,"title":1},"450":{"body":189,"breadcrumbs":5,"title":3},"451":{"body":16,"breadcrumbs":5,"title":3},"452":{"body":40,"breadcrumbs":6,"title":4},"453":{"body":125,"breadcrumbs":4,"title":2},"454":{"body":154,"breadcrumbs":6,"title":4},"455":{"body":82,"breadcrumbs":6,"title":2},"456":{"body":59,"breadcrumbs":8,"title":4},"457":{"body":195,"breadcrumbs":7,"title":3},"458":{"body":104,"breadcrumbs":7,"title":3},"459":{"body":63,"breadcrumbs":10,"title":6},"46":{"body":50,"breadcrumbs":4,"title":1},"460":{"body":215,"breadcrumbs":6,"title":2},"461":{"body":113,"breadcrumbs":10,"title":6},"462":{"body":163,"breadcrumbs":9,"title":5},"463":{"body":0,"breadcrumbs":5,"title":2},"464":{"body":111,"breadcrumbs":4,"title":1},"465":{"body":0,"breadcrumbs":4,"title":1},"466":{"body":4,"breadcrumbs":5,"title":2},"467":{"body":12,"breadcrumbs":5,"title":2},"468":{"body":0,"breadcrumbs":6,"title":2},"469":{"body":23,"breadcrumbs":5,"title":1},"47":{"body":20,"breadcrumbs":4,"title":1},"470":{"body":167,"breadcrumbs":5,"title":1},"471":{"body":34,"breadcrumbs":5,"title":1},"472":{"body":57,"breadcrumbs":6,"title":2},"473":{"body":56,"breadcrumbs":6,"title":2},"474":{"body":17,"breadcrumbs":6,"title":2},"475":{"body":36,"breadcrumbs":5,"title":1},"476":{"body":49,"breadcrumbs":5,"title":1},"477":{"body":106,"breadcrumbs":5,"title":1},"478":{"body":142,"breadcrumbs":6,"title":2},"479":{"body":14,"breadcrumbs":7,"title":3},"48":{"body":0,"breadcrumbs":5,"title":2},"480":{"body":105,"breadcrumbs":7,"title":3},"481":{"body":46,"breadcrumbs":4,"title":2},"482":{"body":142,"breadcrumbs":10,"title":5},"483":{"body":11,"breadcrumbs":10,"title":5},"484":{"body":81,"breadcrumbs":6,"title":1},"485":{"body":38,"breadcrumbs":10,"title":5},"486":{"body":30,"breadcrumbs":7,"title":2},"487":{"body":0,"breadcrumbs":8,"title":3},"488":{"body":26,"breadcrumbs":6,"title":1},"489":{"body":85,"breadcrumbs":8,"title":3},"49":{"body":57,"breadcrumbs":5,"title":2},"490":{"body":15,"breadcrumbs":7,"title":2},"491":{"body":31,"breadcrumbs":7,"title":2},"492":{"body":43,"breadcrumbs":6,"title":1},"493":{"body":37,"breadcrumbs":7,"title":2},"494":{"body":7,"breadcrumbs":8,"title":3},"495":{"body":15,"breadcrumbs":12,"title":4},"496":{"body":63,"breadcrumbs":9,"title":1},"497":{"body":61,"breadcrumbs":12,"title":4},"498":{"body":114,"breadcrumbs":11,"title":3},"499":{"body":53,"breadcrumbs":9,"title":1},"5":{"body":0,"breadcrumbs":3,"title":2},"50":{"body":315,"breadcrumbs":4,"title":1},"500":{"body":80,"breadcrumbs":10,"title":2},"501":{"body":111,"breadcrumbs":10,"title":2},"502":{"body":28,"breadcrumbs":6,"title":2},"503":{"body":80,"breadcrumbs":5,"title":1},"504":{"body":15,"breadcrumbs":8,"title":3},"505":{"body":0,"breadcrumbs":8,"title":3},"506":{"body":0,"breadcrumbs":8,"title":3},"507":{"body":18,"breadcrumbs":6,"title":1},"508":{"body":15,"breadcrumbs":6,"title":1},"509":{"body":17,"breadcrumbs":7,"title":4},"51":{"body":153,"breadcrumbs":5,"title":2},"510":{"body":29,"breadcrumbs":4,"title":1},"511":{"body":50,"breadcrumbs":4,"title":1},"52":{"body":250,"breadcrumbs":4,"title":1},"53":{"body":50,"breadcrumbs":2,"title":1},"54":{"body":64,"breadcrumbs":4,"title":3},"55":{"body":31,"breadcrumbs":5,"title":4},"56":{"body":0,"breadcrumbs":3,"title":2},"57":{"body":60,"breadcrumbs":3,"title":2},"58":{"body":30,"breadcrumbs":9,"title":8},"59":{"body":44,"breadcrumbs":10,"title":9},"6":{"body":60,"breadcrumbs":4,"title":3},"60":{"body":9,"breadcrumbs":7,"title":6},"61":{"body":116,"breadcrumbs":6,"title":2},"62":{"body":50,"breadcrumbs":8,"title":4},"63":{"body":0,"breadcrumbs":6,"title":2},"64":{"body":28,"breadcrumbs":14,"title":10},"65":{"body":0,"breadcrumbs":6,"title":2},"66":{"body":18,"breadcrumbs":11,"title":7},"67":{"body":0,"breadcrumbs":6,"title":2},"68":{"body":19,"breadcrumbs":10,"title":6},"69":{"body":0,"breadcrumbs":6,"title":2},"7":{"body":0,"breadcrumbs":3,"title":2},"70":{"body":26,"breadcrumbs":9,"title":5},"71":{"body":24,"breadcrumbs":12,"title":8},"72":{"body":12,"breadcrumbs":9,"title":5},"73":{"body":0,"breadcrumbs":6,"title":2},"74":{"body":70,"breadcrumbs":13,"title":9},"75":{"body":43,"breadcrumbs":6,"title":2},"76":{"body":21,"breadcrumbs":8,"title":4},"77":{"body":0,"breadcrumbs":6,"title":2},"78":{"body":44,"breadcrumbs":11,"title":7},"79":{"body":0,"breadcrumbs":6,"title":2},"8":{"body":443,"breadcrumbs":3,"title":2},"80":{"body":96,"breadcrumbs":10,"title":6},"81":{"body":0,"breadcrumbs":6,"title":2},"82":{"body":48,"breadcrumbs":9,"title":5},"83":{"body":0,"breadcrumbs":6,"title":2},"84":{"body":34,"breadcrumbs":7,"title":3},"85":{"body":0,"breadcrumbs":6,"title":2},"86":{"body":75,"breadcrumbs":13,"title":9},"87":{"body":0,"breadcrumbs":6,"title":2},"88":{"body":27,"breadcrumbs":11,"title":7},"89":{"body":22,"breadcrumbs":11,"title":7},"9":{"body":491,"breadcrumbs":5,"title":4},"90":{"body":32,"breadcrumbs":10,"title":6},"91":{"body":26,"breadcrumbs":11,"title":7},"92":{"body":0,"breadcrumbs":6,"title":2},"93":{"body":72,"breadcrumbs":9,"title":5},"94":{"body":0,"breadcrumbs":6,"title":2},"95":{"body":99,"breadcrumbs":11,"title":7},"96":{"body":64,"breadcrumbs":7,"title":3},"97":{"body":0,"breadcrumbs":6,"title":2},"98":{"body":102,"breadcrumbs":9,"title":5},"99":{"body":0,"breadcrumbs":6,"title":2}},"docs":{"0":{"body":"Welcome to the documentation repository for Synapse, a Matrix homeserver implementation developed by the matrix.org core team.","breadcrumbs":"Welcome and Overview » Introduction","id":"0","title":"Introduction"},"1":{"body":"This documentation covers topics for installation , configuration and maintainence of your Synapse process: Learn how to install and configure your own instance, perhaps with Single Sign-On . See how to upgrade between Synapse versions. Administer your instance using the Admin API , installing pluggable modules , or by accessing the manhole . Learn how to read log lines , configure logging or set up structured logging . Scale Synapse through additional worker processes . Set up monitoring and metrics to keep an eye on your Synapse instance's performance.","breadcrumbs":"Welcome and Overview » Installing and using Synapse","id":"1","title":"Installing and using Synapse"},"10":{"body":"Once you have installed synapse as above, you will need to configure it.","breadcrumbs":"Installation » Setting up Synapse","id":"10","title":"Setting up Synapse"},"100":{"body":"This is the last release of Synapse which guarantees support with Python 3.5, which passed its upstream End of Life date several months ago. We will attempt to maintain support through March 2021, but without guarantees. In the future, Synapse will follow upstream schedules for ending support of older versions of Python and PostgreSQL. Please upgrade to at least Python 3.6 and PostgreSQL 9.6 as soon as possible.","breadcrumbs":"Upgrading between Synapse Versions » Last release supporting Python 3.5","id":"100","title":"Last release supporting Python 3.5"},"101":{"body":"Synapse v1.25.0 includes new settings, ip_range_blacklist and ip_range_whitelist, for controlling outgoing requests from Synapse for federation, identity servers, push, and for checking key validity for third-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 recommended that you remove that setting. If you have customised federation_ip_range_blacklist you should update the setting name to ip_range_blacklist. If you have a custom push server that is reached via private IP space you may need to customise ip_range_blacklist or ip_range_whitelist.","breadcrumbs":"Upgrading between Synapse Versions » Blacklisting IP ranges","id":"101","title":"Blacklisting IP ranges"},"102":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.24.0","id":"102","title":"Upgrading to v1.24.0"},"103":{"body":"This release allows the OpenID Connect mapping provider to perform normalisation of the localpart of the Matrix ID. This allows for the mapping provider to specify different algorithms, instead of the default way . If your Synapse configuration uses a custom mapping provider (oidc_config.user_mapping_provider.module is specified and not equal to synapse.handlers.oidc_handler.JinjaOidcMappingProvider) then you must ensure that map_user_attributes of the mapping provider performs some normalisation of the localpart returned. To match previous behaviour you can use the map_username_to_mxid_localpart function provided by 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":"103","title":"Custom OpenID Connect mapping provider breaking change"},"104":{"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 v1.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 API . The deprecation of the old endpoints was announced with Synapse 1.20.0 (released on 2020-09-22) and makes it easier for homeserver admins to lock down external access to the Admin API endpoints.","breadcrumbs":"Upgrading between Synapse Versions » Removal historical Synapse Admin API","id":"104","title":"Removal historical Synapse Admin API"},"105":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.23.0","id":"105","title":"Upgrading to v1.23.0"},"106":{"body":"This release deprecates use of the structured: true logging configuration for structured logging. If your logging configuration contains structured: true then it should be modified based on the structured logging documentation . The structured and drains logging options are now deprecated and should be replaced by standard logging configuration of handlers and formatters. A future will release of Synapse will make using structured: true an error.","breadcrumbs":"Upgrading between Synapse Versions » Structured logging configuration breaking changes","id":"106","title":"Structured logging configuration breaking changes"},"107":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.22.0","id":"107","title":"Upgrading to v1.22.0"},"108":{"body":"This release introduces a backwards-incompatible change to modules making use of ThirdPartyEventRules in Synapse. If you make use of a module defined under the third_party_event_rules config option, please make sure it is updated to handle the below change: The http_client argument is no longer passed to modules as they are initialised. Instead, modules are expected to make use of the http_client property on the ModuleApi class. Modules are now passed a module_api argument during initialisation, which is an instance of ModuleApi. ModuleApi instances have a http_client property which acts the same as the http_client argument previously passed to ThirdPartyEventRules modules.","breadcrumbs":"Upgrading between Synapse Versions » ThirdPartyEventRules breaking changes","id":"108","title":"ThirdPartyEventRules breaking changes"},"109":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.21.0","id":"109","title":"Upgrading to v1.21.0"},"11":{"body":"By default Synapse uses an SQLite database and in doing so trades performance for convenience. Almost all installations should opt to use PostgreSQL instead. Advantages include: significant performance improvements due to the superior threading and caching 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 a production server. Synapse will perform poorly when using SQLite, especially when participating in large rooms.","breadcrumbs":"Installation » Using PostgreSQL","id":"11","title":"Using PostgreSQL"},"110":{"body":"The reverse proxy documentation has been updated to include reverse proxy directives for /_synapse/client/* endpoints. As the user password reset flow now uses endpoints under this prefix, you must update your reverse proxy configurations 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 endpoint can be handled by all workers. If you make use of Synapse's worker feature, please update your reverse proxy configuration to reflect this change.","breadcrumbs":"Upgrading between Synapse Versions » Forwarding /_synapse/client through your reverse proxy","id":"110","title":"Forwarding /_synapse/client through your reverse proxy"},"111":{"body":"A new HTML template, password_reset_confirmation.html , has been added to the synapse/res/templates directory. If you are using a custom template directory, you may want to copy the template over and modify it. Note that as of v1.20.0, templates do not need to be included in custom template directories for Synapse to start. The default templates will be used if a custom template cannot be found. This page will appear to the user after clicking a password reset link that 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 parameters from the original link, presented as a URL-encoded form. See the file itself for more details.","breadcrumbs":"Upgrading between Synapse Versions » New HTML templates","id":"111","title":"New HTML templates"},"112":{"body":"The saml_error.html template was removed from Synapse and replaced with the sso_error.html template. If your Synapse is configured to use SAML and a custom sso_redirect_confirm_template_dir configuration then any customisations of the saml_error.html template will need to be merged into the sso_error.html template. These templates are similar, but 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 of why a user is seeing the error page.","breadcrumbs":"Upgrading between Synapse Versions » Updated Single Sign-on HTML Templates","id":"112","title":"Updated Single Sign-on HTML Templates"},"113":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.18.0","id":"113","title":"Upgrading to v1.18.0"},"114":{"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 since release 0.99.0, and the suffix is obsolete. On 10th August, we will remove the latest-py3 tag. Existing per-release tags (such as v1.18.0-py3 will not be removed, but no new -py3 tags will be added. Scripts relying on the -py3 suffix will need to be updated.","breadcrumbs":"Upgrading between Synapse Versions » Docker -py3 suffix will be removed in future versions","id":"114","title":"Docker -py3 suffix will be removed in future versions"},"115":{"body":"When setting up worker processes, we now recommend the use of a Redis server for replication. The old direct TCP connection method is deprecated and will be removed in a future release. See workers for more details.","breadcrumbs":"Upgrading between Synapse Versions » Redis replication is now recommended in lieu of TCP replication","id":"115","title":"Redis replication is now recommended in lieu of TCP replication"},"116":{"body":"This version includes a database update which is run as part of the upgrade, and which may take a couple of minutes in the case of a large server. Synapse will not respond to HTTP requests while this update is taking place.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.14.0","id":"116","title":"Upgrading to v1.14.0"},"117":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.13.0","id":"117","title":"Upgrading to v1.13.0"},"118":{"body":"A bug was introduced in Synapse 1.4.0 which could cause the room directory to be incomplete or empty if Synapse was upgraded directly from 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 are 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":"118","title":"Incorrect database migration in old synapse versions"},"119":{"body":"New templates (sso_auth_confirm.html, sso_auth_success.html, and sso_account_deactivated.html) were added to Synapse. If your Synapse is configured to use SSO and a custom sso_redirect_confirm_template_dir configuration then these templates will need to be copied from synapse/res/templates into that directory.","breadcrumbs":"Upgrading between Synapse Versions » New Single Sign-on HTML Templates","id":"119","title":"New Single Sign-on HTML Templates"},"12":{"body":"The default configuration exposes a single HTTP port on the local interface: http://localhost:8008. It is suitable for local testing, but for any practical use, you will need Synapse's APIs to be served over 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 so, you will need to edit homeserver.yaml, as follows: First, under the listeners section, uncomment the configuration for the TLS-enabled listener. (Remove the hash sign (#) at the start of each line). The relevant lines are like this: - port: 8448 type: http tls: true resources: - names: [client, federation] You will also need to uncomment the tls_certificate_path and tls_private_key_path lines under the TLS section. You will need to manage provisioning of these certificates yourself. If you are using your own certificate, 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). For a more detailed guide to configuring your server for federation, see Federation .","breadcrumbs":"Installation » TLS certificates","id":"12","title":"TLS certificates"},"120":{"body":"Plugins using the complete_sso_login method of synapse.module_api.ModuleApi should update to using the async/await version complete_sso_login_async which includes additional checks. The non-async version is considered deprecated.","breadcrumbs":"Upgrading between Synapse Versions » Synapse SSO Plugins Method Deprecation","id":"120","title":"Synapse SSO Plugins Method Deprecation"},"121":{"body":"v1.13.0 includes a lot of large changes. If something problematic occurs, you may want to roll-back to a previous version of Synapse. Because v1.13.0 also includes a new database schema version, reverting that version is also required alongside the generic rollback instructions mentioned above. In short, to roll back to v1.12.4 you need to: Stop the server Decrease the schema version in the database: UPDATE schema_version SET version = 57; Downgrade Synapse by following the instructions for your installation method in the \"Rolling back to older versions\" section above.","breadcrumbs":"Upgrading between Synapse Versions » Rolling back to v1.12.4 after a failed upgrade","id":"121","title":"Rolling back to v1.12.4 after a failed upgrade"},"122":{"body":"This version includes a database update which is run as part of the upgrade, and which may take some time (several hours in the case of a large server). Synapse will not respond to HTTP requests while this update is taking place. This is only likely to be a problem in the case of a server which is participating in many rooms. As with all upgrades, it is recommended that you have a recent backup of your database which can be used for recovery in the event of any problems. As an initial check to see if you will be affected, you can try running the following query from the psql or sqlite3 console. It is safe to run it while Synapse is still 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 process: ie, if it takes 5 minutes, then it is likely that Synapse will be unresponsive for 5 minutes during the upgrade. If you consider an outage of this duration to be acceptable, no further action is necessary and you can simply start Synapse 1.12.0. If you would prefer to reduce the downtime, continue with the steps below. The easiest workaround for this issue is to manually create a new index 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 Synapse is running. We assume that no SQLite users have databases large enough to be affected. If you are affected, you can run a similar query, omitting the CONCURRENTLY keyword. Note however that this operation may in itself cause Synapse to stop running for some time. Synapse admins are reminded that SQLite is not recommended for use outside a test environment . Once the index has been created, the SELECT query in step 1 above should complete quickly. It is therefore safe to upgrade to Synapse 1.12.0. Once Synapse 1.12.0 has successfully started and is responding to HTTP 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":"122","title":"Upgrading to v1.12.0"},"123":{"body":"Synapse will now log a warning on start up if used with a PostgreSQL database that has a non-recommended locale set. See Postgres for details.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.10.0","id":"123","title":"Upgrading to v1.10.0"},"124":{"body":"Specifying a log_file config option will now cause Synapse to refuse to start, and should be replaced by with the log_config option. Support for the log_file option was removed in v1.3.0 and has since had no effect.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.8.0","id":"124","title":"Upgrading to v1.8.0"},"125":{"body":"In an attempt to configure Synapse in a privacy preserving way, the default behaviours of allow_public_rooms_without_auth and allow_public_rooms_over_federation have been inverted. This means that by default, only authenticated users querying the Client/Server API will be able to query the room directory, and relatedly that the server will not share room directory information with other servers over federation. If your installation does not explicitly set these settings one way or the other and you want either setting to be true then it will necessary 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":"125","title":"Upgrading to v1.7.0"},"126":{"body":"This release includes a database migration which may take several minutes to complete if there are a large number (more than a million or so) of entries in the devices table. This is only likely to a be a problem on very large installations.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.5.0","id":"126","title":"Upgrading to v1.5.0"},"127":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.4.0","id":"127","title":"Upgrading to v1.4.0"},"128":{"body":"If you have configured a custom template directory with the email.template_dir option, be aware that there are new templates regarding registration and threepid management (see below) that must be included. 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 directory, and will fail to start if they are absent. To view the default templates, see synapse/res/templates .","breadcrumbs":"Upgrading between Synapse Versions » New custom templates","id":"128","title":"New custom templates"},"129":{"body":"Note: As of this release, users will be unable to add phone numbers or email addresses to their accounts, without changes to the Synapse configuration. This includes adding an email address during registration. It is possible for a user to associate an email address or phone number with 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 recovery. 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 account, or before such an address is used to carry out a password-reset, Synapse must confirm the operation with the owner of the email address or phone number. It does this by sending an email or text giving the user a link or token to confirm receipt. This process is known as '3pid verification'. ('3pid', or 'threepid', stands for third-party identifier, and we use it to refer to external identifiers such as email addresses and phone numbers.) Previous versions of Synapse delegated the task of 3pid verification to an identity server by default. In most cases this server is vector.im or matrix.org. In Synapse 1.4.0, for security and privacy reasons, the homeserver will no longer delegate this task to an identity server by default. Instead, the server administrator will need to explicitly decide how they would like the verification messages to be sent. In the medium term, the vector.im and matrix.org identity servers will disable support for delegated 3pid verification entirely. However, in order to ease the transition, they will retain the capability for a limited period. Delegated email verification will be disabled on Monday 2nd December 2019 (giving roughly 2 months notice). Disabling delegated SMS verification will follow some time after that once SMS verification support lands in Synapse. Once delegated 3pid verification support has been disabled in the vector.im and matrix.org identity servers, all Synapse versions that depend on those instances will be unable to verify email and phone numbers through them. There are no imminent plans to remove delegated 3pid verification from Sydent generally. (Sydent is the identity server project that backs the vector.im and matrix.org instances).","breadcrumbs":"Upgrading between Synapse Versions » 3pid verification changes","id":"129","title":"3pid verification changes"},"13":{"body":"Setting up the client Well-Known URI is optional but if you set it up, it will allow users to enter their full username (e.g. @user:) into clients which support well-known lookup to automatically configure the homeserver and identity server URLs. This is useful so that users don't have to memorize or think about the actual homeserver URL you are using. The URL https:///.well-known/matrix/client should return JSON in the 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 Cross-Origin Resource Sharing (CORS) headers. A recommended value would be Access-Control-Allow-Origin: * which would allow all browser based clients to view 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 correctly. public_baseurl should be set to the URL that clients will use to connect 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":"13","title":"Client Well-Known URI"},"130":{"body":"Following upgrade, to continue verifying email (e.g. as part of the registration process), admins can either:- Configure Synapse to use an email server. Run or choose an identity server which allows delegated email verification and delegate to it. Configure SMTP in Synapse To configure an SMTP server for Synapse, modify the configuration section 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 for more details on these settings. Delegate email to an identity server Some admins will wish to continue using email verification as part of the registration process, but will not immediately have an appropriate SMTP server at hand. To this end, we will continue to support email verification delegation via the vector.im and matrix.org identity servers for two months. Support for delegated email verification will be disabled on Monday 2nd December. The account_threepid_delegates dictionary defines whether the homeserver should delegate an external server (typically an identity server ) to handle sending 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 server. 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 with existing Synapse installs that set up external server handling for these tasks before v1.4.0. If email.trust_identity_server_for_password_resets is true and no trusted identity server domains are configured, Synapse will report an error and refuse to start. If email.trust_identity_server_for_password_resets is false or absent and no email delegate is configured in account_threepid_delegates, then Synapse will send email verification messages itself, using the configured SMTP server (see above). that type.","breadcrumbs":"Upgrading between Synapse Versions » Email","id":"130","title":"Email"},"131":{"body":"Synapse does not support phone-number verification itself, so the only way to maintain the ability for users to add phone numbers to their accounts will be by continuing to delegate phone number verification to the matrix.org and vector.im identity servers (or another identity server that supports SMS sending). The account_threepid_delegates dictionary defines whether the homeserver should delegate an external server (typically an identity server ) to handle sending 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 server. 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 support delegated phone number verification via SMS until such time as it is possible for admins to configure their servers to perform phone number verification directly. More details will follow in a future release.","breadcrumbs":"Upgrading between Synapse Versions » Phone numbers","id":"131","title":"Phone numbers"},"132":{"body":"If you encounter problems with v1.4.0, it should be possible to roll back to v1.3.1, subject to the following: The 'room statistics' engine was heavily reworked in this release (see #5971 ), including significant changes to the database schema, which are not easily reverted. This will cause the room statistics engine to stop updating when you downgrade. The room statistics are essentially unused in v1.3.1 (in future versions of Synapse, they will be used to populate the room directory), so there should be no loss of functionality. However, the statistics engine will write errors to the logs, which can be avoided by setting the following in homeserver.yaml: stats: enabled: false Don't forget to re-enable it when you upgrade again, in preparation for its use in the room directory!","breadcrumbs":"Upgrading between Synapse Versions » Rolling back to v1.3.1","id":"132","title":"Rolling back to v1.3.1"},"133":{"body":"Some counter metrics have been renamed, with the old names deprecated. See the metrics documentation for details.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.2.0","id":"133","title":"Upgrading to v1.2.0"},"134":{"body":"Synapse v1.1.0 removes support for older Python and PostgreSQL versions, as outlined in our deprecation notice .","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.1.0","id":"134","title":"Upgrading to v1.1.0"},"135":{"body":"Synapse v1.1.0 has a minimum Python requirement of Python 3.5. Python 3.6 or Python 3.7 are recommended as they have improved internal string handling, significantly reducing memory usage. If you use current versions of the Matrix.org-distributed Debian packages or Docker images, action is not required. If you install Synapse in a Python virtual environment, please see \"Upgrading to v0.34.0\" for notes on setting up a new virtualenv under Python 3.","breadcrumbs":"Upgrading between Synapse Versions » Minimum Python Version","id":"135","title":"Minimum Python Version"},"136":{"body":"If using PostgreSQL under Synapse, you will need to use PostgreSQL 9.5 or above. Please see the PostgreSQL documentation for more details on upgrading your database.","breadcrumbs":"Upgrading between Synapse Versions » Minimum PostgreSQL Version","id":"136","title":"Minimum PostgreSQL Version"},"137":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.0","id":"137","title":"Upgrading to v1.0"},"138":{"body":"Synapse v1.0 is the first release to enforce validation of TLS certificates for the federation API. It is therefore essential that your certificates are correctly configured. See the FAQ for more information. Note, v1.0 installations will also no longer be able to federate with servers that have not correctly configured their certificates. In rare cases, it may be desirable to disable certificate checking: for example, it might be essential to be able to federate with a given legacy server in a closed federation. This can be done in one of two ways:- 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 for more details on these settings.","breadcrumbs":"Upgrading between Synapse Versions » Validation of TLS certificates","id":"138","title":"Validation of TLS certificates"},"139":{"body":"When a user requests a password reset, Synapse will send an email to the user to confirm the request. Previous versions of Synapse delegated the job of sending this email to an identity server. If the identity server was somehow malicious or became compromised, it would be theoretically possible to hijack an account through this means. Therefore, by default, Synapse v1.0 will send the confirmation email itself. If Synapse is not configured with an SMTP server, password reset via email will be disabled. To configure an SMTP server for Synapse, modify the configuration section 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 identity server for password resets, set trust_identity_server_for_password_resets to true. See the sample configuration file for more details on these settings.","breadcrumbs":"Upgrading between Synapse Versions » Email","id":"139","title":"Email"},"14":{"body":"It is desirable for Synapse to have the capability to send email. This allows Synapse to send password reset emails, send verifications when an email address is added to a user's account, and send email notifications to users when they receive new messages. To configure an SMTP server for Synapse, modify the configuration section 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 email is not configured, password reset, registration and notifications via email will be disabled.","breadcrumbs":"Installation » Email","id":"14","title":"Email"},"140":{"body":"Some new templates have been added to the default template directory for the purpose of the homeserver sending its own password reset emails. If you have configured a custom 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 templates respectively that contain the contents of what will be emailed to the user upon attempting to reset their password via email. password_reset_success.html and password_reset_failure.html are HTML files that the content of which (assuming no redirect URL is set) will be shown to the user after they attempt to click the link in the email sent to them.","breadcrumbs":"Upgrading between Synapse Versions » New email templates","id":"140","title":"New email templates"},"141":{"body":"Please be aware that, before Synapse v1.0 is released around March 2019, you will need to replace any self-signed certificates with those verified by a root CA. Information on how to do so can be found at the ACME docs. For more information on configuring TLS certificates see the FAQ .","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.99.0","id":"141","title":"Upgrading to v0.99.0"},"142":{"body":"This release is the first to fully support Python 3. Synapse will now run on Python versions 3.5, or 3.6 (as well as 2.7). We recommend switching to Python 3, as it has been shown to give performance improvements. For users who have installed Synapse into a virtualenv, we recommend doing 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 virtualenv: cd ~/synapse\nsource env3/bin/activate\nsynctl start Users who have installed from distribution packages should see the relevant package documentation. See below for notes on Debian packages. When upgrading to Python 3, you must make sure that your log files 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 file 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 Python 2. We are also making available Debian packages which will run Synapse on Python 3. You can switch to these packages with apt-get install matrix-synapse-py3, however, please read debian/NEWS before doing so. The existing matrix-synapse packages will continue to use Python 2 for the time being. This release removes the riot.im from the default list of trusted identity servers. If riot.im is in your homeserver's list of trusted_third_party_id_servers, you should remove it. It was added in case a hypothetical future identity server was put there. If you don't remove it, users may be unable to deactivate their accounts. This release no longer installs the (unmaintained) Matrix Console web client as part of the default installation. It is possible to re-enable it by installing it separately and setting the web_client_location config option, but please consider switching to another client.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.34.0","id":"142","title":"Upgrading to v0.34.0"},"143":{"body":"This release removes the example email notification templates from res/templates (they are now internal to the python package). This should only affect you if you (a) deploy your Synapse instance from a git checkout or a github snapshot URL, and (b) have email notifications enabled. If you have email notifications enabled, you should ensure that email.template_dir is either configured to point at a directory where you have installed customised templates, or leave it unset to use the default templates.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.33.7","id":"143","title":"Upgrading to v0.33.7"},"144":{"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 and cpu use at a very coarse level. This requires administrators to install the optional psutil python module. We would appreciate it if you could assist by ensuring this module is available and report_stats is enabled. This will let us see if performance changes to synapse are having an impact to the general community.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.27.3","id":"144","title":"Upgrading to v0.27.3"},"145":{"body":"If you want to use the new URL previewing API (/_matrix/media/r0/preview_url) then you have to explicitly enable it in the config and update your dependencies dependencies. See README.rst for details.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.15.0","id":"145","title":"Upgrading to v0.15.0"},"146":{"body":"This release includes the option to send anonymous usage stats to matrix.org, and requires that administrators explictly opt in or out by setting the report_stats option to either true or false. We would really appreciate it if you could help our project out by reporting anonymized usage statistics from your homeserver. Only very basic aggregate data (e.g. number of users) will be reported, but it helps us to track the growth of the Matrix community, and helps us to make Matrix a success, as well as to convince other networks that they should peer with us.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.11.0","id":"146","title":"Upgrading to v0.11.0"},"147":{"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 HTTP API. This decision was made because a compromised application service with free reign to register any regex in effect grants full read/write access to the home server if a regex of .* is used. An attack where a compromised AS re-registers itself with .* was deemed too big of a security risk to ignore, and so the ability to register with the HS remotely has been removed. It has been replaced by specifying a list of application service registrations 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":"147","title":"Upgrading to v0.9.0"},"148":{"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 used on mobile devices).","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.8.0","id":"148","title":"Upgrading to v0.8.0"},"149":{"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":"149","title":"Upgrading to v0.7.0"},"15":{"body":"The easiest way to create a new user is to do so from a client like Element . Alternatively, you can do so from the command line. This can be done as follows: If synapse was installed via pip, activate the virtualenv as follows (if Synapse was installed via a prebuilt package, register_new_matrix_user should already be on 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 http://localhost:8008 This will prompt you to add details for the new user, and will then connect to the 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 in homeserver.yaml, which is shared between Synapse itself and the register_new_matrix_user script. 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 it can register users, including admin accounts, on your server even if enable_registration is false.","breadcrumbs":"Installation » Registering a user","id":"15","title":"Registering a user"},"150":{"body":"To pull in new dependencies, run: python setup.py develop --user This update includes a change to the database schema. To upgrade you first 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 synapse configuration, and is the location of the signing key as specified in the synapse configuration. This may take some time to complete. Failures of signatures and content hashes can safely be ignored.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.6.0","id":"150","title":"Upgrading to v0.6.0"},"151":{"body":"Depending on precisely when you installed v0.5.0 you may have ended up with a stale release of the reference matrix webclient installed as a python module. To uninstall it and ensure you are depending on the latest module, please run: $ pip uninstall syweb","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.5.1","id":"151","title":"Upgrading to v0.5.1"},"152":{"body":"The webclient has been split out into a seperate repository/pacakage in this release. Before you restart your homeserver you will need to pull in the webclient package by running: python setup.py develop --user This release completely changes the database schema and so requires upgrading it before starting the new version of the homeserver. The script \"database-prepare-for-0.5.0.sh\" should be used to upgrade the database. This will save all user information, such as logins and profiles, but will otherwise purge the database. This includes messages, which 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 database file and ask for help in #matrix:matrix.org. The upgrade process is, unfortunately, non trivial and requires human intervention to resolve any resulting conflicts during the upgrade process. Before running the command the homeserver should be first completely shutdown. 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 homeserver. You may notice that the homeserver takes a few seconds longer to restart than usual as it reinitializes the database. On startup of the new version, users can either rejoin remote rooms using room aliases or by being reinvited. Alternatively, if any other homeserver sends a message to a room that the homeserver was previously in the local HS will automatically rejoin the room.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.5.0","id":"152","title":"Upgrading to v0.5.0"},"153":{"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 format has changed. Run: python -m synapse.app.homeserver --config-path --generate-config","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.4.0","id":"153","title":"Upgrading to v0.4.0"},"154":{"body":"This registration API now closely matches the login API. This introduces a bit more backwards and forwards between the HS and the client, but this improves the overall flexibility of the API. You can now GET on /register to retrieve a list of valid registration flows. Upon choosing one, 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 authentication. Enabling captcha on the HS will add in an extra step to all flows: m.login.recaptcha which must be completed before you can transition to the next stage. There is a new login type: m.login.email.identity which contains the threepidCreds key which were previously sent in the original register request. For more information on this, see the specification.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.3.0","id":"154","title":"Upgrading to v0.3.0"},"155":{"body":"The VoIP specification has changed between v0.2.0 and v0.3.0. Users should refresh any browser tabs to get the latest web client code. Users on v0.2.0 of the web client will not be able to call those on v0.3.0 and vice versa.","breadcrumbs":"Upgrading between Synapse Versions » Web Client","id":"155","title":"Web Client"},"156":{"body":"The home server now requires setting up of SSL config before it can run. To 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 SSL 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":"156","title":"Upgrading to v0.2.0"},"157":{"body":"This release completely changes the database schema and so requires upgrading it before starting the new version of the homeserver. The script \"database-prepare-for-0.0.1.sh\" should be used to upgrade the database. This will save all user information, such as logins and profiles, but will otherwise purge the database. This includes messages, which rooms the home server was a member of and room alias mappings. Before running the command the homeserver should be first completely shutdown. 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 homeserver. You may notice that the homeserver takes a few seconds longer to restart than usual as it reinitializes the database. On startup of the new version, users can either rejoin remote rooms using room aliases or by being reinvited. Alternatively, if any other homeserver sends a message to a room that the homeserver was previously in the local HS will automatically rejoin the room.","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v0.0.1","id":"157","title":"Upgrading to v0.0.1"},"158":{"body":"","breadcrumbs":"Upgrading from pre-Synapse 1.0 » MSC1711 Certificates FAQ","id":"158","title":"MSC1711 Certificates FAQ"},"159":{"body":"This document was originally written to guide server admins through the upgrade path towards Synapse 1.0. Specifically, MSC1711 required that all servers present valid TLS certificates on their federation API. Admins were encouraged to achieve compliance from version 0.99.0 (released in February 2019) ahead of version 1.0 (released June 2019) enforcing the certificate checks. Much of what follows is now outdated since most admins will have already upgraded, however it may be of use to those with old installs returning to the project. If you are setting up a server from scratch you almost certainly should look at the installation guide instead.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » Historical Note","id":"159","title":"Historical Note"},"16":{"body":"For reliable VoIP calls to be routed via this homeserver, you MUST configure a TURN server. See TURN setup for details.","breadcrumbs":"Installation » Setting up a TURN server","id":"16","title":"Setting up a TURN server"},"160":{"body":"The goal of Synapse 0.99.0 is to act as a stepping stone to Synapse 1.0.0. It supports the r0.1 release of the server to server specification, but is compatible with both the legacy Matrix federation behaviour (pre-r0.1) as well as post-r0.1 behaviour, in order to allow for a smooth upgrade across the federation. The most important thing to know is that Synapse 1.0.0 will require a valid TLS certificate on federation endpoints. Self signed certificates will not be sufficient. Synapse 0.99.0 makes it easy to configure TLS certificates and will interoperate with both >= 1.0.0 servers as well as existing servers yet to upgrade. It is critical that all admins upgrade to 0.99.0 and configure a valid TLS certificate. Admins will have 1 month to do so, after which 1.0.0 will be released and those servers without a valid certificate will not longer be able to federate with >= 1.0.0 servers. Full details on how to carry out this configuration change is given below . A timeline and some frequently asked questions are also given below. For more details and context on the release of the r0.1 Server/Server API and imminent Matrix 1.0 release, you can also see our main talk from FOSDEM 2019 .","breadcrumbs":"Upgrading from pre-Synapse 1.0 » Introduction","id":"160","title":"Introduction"},"161":{"body":"Timeline Configuring certificates for compatibility with Synapse 1.0 FAQ Synapse 0.99.0 has just been released, what do I need to do right now? How do I upgrade? What will happen if I do not set up a valid federation certificate immediately? What will happen if I do nothing at all? When do I need a SRV record or .well-known URI? Can I still use an SRV record? I have created a .well-known URI. Do I still need an SRV record? It used to work just fine, why are you breaking everything? Can I manage my own certificates rather than having Synapse renew certificates itself? Do you still recommend against using a reverse proxy on the federation port? Do I still need to give my TLS certificates to Synapse if I am using a reverse proxy? Do I need the same certificate for the client and federation port? How do I tell Synapse to reload my keys/certificates after I replace them?","breadcrumbs":"Upgrading from pre-Synapse 1.0 » Contents","id":"161","title":"Contents"},"162":{"body":"5th Feb 2019 - Synapse 0.99.0 is released. All server admins are encouraged to upgrade. 0.99.0: provides support for ACME to make setting up Let's Encrypt certs easy, as well as .well-known support. does not enforce that a valid CA cert is present on the federation API, but rather makes it easy to set one up. provides support for .well-known Admins should upgrade and configure a valid CA cert. Homeservers that require a .well-known entry (see below), should retain their SRV record and use it alongside their .well-known record. 10th June 2019 - Synapse 1.0.0 is released 1.0.0 is scheduled for release on 10th June. In accordance with the the S2S spec 1.0.0 will enforce certificate validity. This means that any homeserver without a valid certificate after this point will no longer be able to federate with 1.0.0 servers.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » Timeline","id":"162","title":"Timeline"},"163":{"body":"","breadcrumbs":"Upgrading from pre-Synapse 1.0 » Configuring certificates for compatibility with Synapse 1.0.0","id":"163","title":"Configuring certificates for compatibility with Synapse 1.0.0"},"164":{"body":"In this case, your server_name points to the host where your Synapse is running. There is no need to create a .well-known URI or an SRV record, but you will need to give Synapse a valid, signed, certificate.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » If you do not currently have an SRV record","id":"164","title":"If you do not currently have an SRV record"},"165":{"body":"If you are using an SRV record, your matrix domain (server_name) may not point to the same host that your Synapse is running on (the 'target domain'). (If it does, you can follow the recommendation above; otherwise, read on.) Let's assume that your server_name is example.com, and your Synapse is hosted at a target domain of customer.example.net. Currently you should have an SRV record which looks like: _matrix._tcp.example.com. IN SRV 10 5 8000 customer.example.net. In this situation, you have three choices for how to proceed: Option 1: give Synapse a certificate for your matrix domain Synapse 1.0 will expect your server to present a TLS certificate for your server_name (example.com in the above example). You can achieve this by acquiring a certificate for the server_name yourself (for example, using certbot), and giving it and the key to Synapse via tls_certificate_path and tls_private_key_path. Option 2: run Synapse behind a reverse proxy If you have an existing reverse proxy set up with correct TLS certificates for your domain, you can simply route all traffic through the reverse proxy by updating the SRV record appropriately (or removing it, if the proxy listens on 8448). See the reverse proxy documentation for information on setting up a reverse proxy. Option 3: add a .well-known file to delegate your matrix traffic This will allow you to keep Synapse on a separate domain, without having to give it a certificate for the matrix domain. You can do this with a .well-known file as follows: Keep the SRV record in place - it is needed for backwards compatibility with Synapse 0.34 and earlier. Give Synapse a certificate corresponding to the target domain (customer.example.net in the above example). You can do this by acquire a certificate for the target domain and giving it to Synapse via tls_certificate_path and tls_private_key_path. Restart Synapse to ensure the new certificate is loaded. Arrange for a .well-known file at https:///.well-known/matrix/server with contents: {\"m.server\": \"\"} where the target server name is resolved as usual (i.e. SRV lookup, falling back to talking to port 8448). In the above example, where synapse is listening on port 8000, https://example.com/.well-known/matrix/server should have m.server set to one of: customer.example.net ─ with a SRV record on _matrix._tcp.customer.example.com pointing to port 8000, or: customer.example.net ─ updating synapse to listen on the default port 8448, or: customer.example.net:8000 ─ ensuring that if there is a reverse proxy on customer.example.net:8000 it correctly handles HTTP requests with Host header set to customer.example.net:8000.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » If you do have an SRV record currently","id":"165","title":"If you do have an SRV record currently"},"166":{"body":"","breadcrumbs":"Upgrading from pre-Synapse 1.0 » FAQ","id":"166","title":"FAQ"},"167":{"body":"Upgrade as soon as you can in preparation for Synapse 1.0.0, and update your TLS certificates as above .","breadcrumbs":"Upgrading from pre-Synapse 1.0 » Synapse 0.99.0 has just been released, what do I need to do right now?","id":"167","title":"Synapse 0.99.0 has just been released, what do I need to do right now?"},"168":{"body":"Nothing initially, but once 1.0.0 is in the wild it will not be possible to federate with 1.0.0 servers.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » What will happen if I do not set up a valid federation certificate immediately?","id":"168","title":"What will happen if I do not set up a valid federation certificate immediately?"},"169":{"body":"If the admin takes no action at all, and remains on a Synapse < 0.99.0 then the homeserver will be unable to federate with those who have implemented .well-known. Then, as above, once the month upgrade window has expired the homeserver will not be able to federate with any Synapse >= 1.0.0","breadcrumbs":"Upgrading from pre-Synapse 1.0 » What will happen if I do nothing at all?","id":"169","title":"What will happen if I do nothing at all?"},"17":{"body":"Synapse includes support for previewing URLs, which is disabled by default. To turn it on you must enable the url_preview_enabled: True config parameter and explicitly specify the IP ranges that Synapse is not allowed to spider for previewing in the url_preview_ip_range_blacklist configuration parameter. This is critical from a security perspective to stop arbitrary Matrix users spidering 'internal' URLs on your network. At the very least we recommend that your loopback and RFC1918 IP addresses are blacklisted. This also requires the optional lxml python dependency to be installed. This in turn requires the libxml2 library to be available - on Debian/Ubuntu this means apt-get install libxml2-dev, or equivalent for your OS.","breadcrumbs":"Installation » URL previews","id":"17","title":"URL previews"},"170":{"body":"If your homeserver listens on the default federation port (8448), and your server_name points to the host that your homeserver runs on, you do not need an SRV record or .well-known/matrix/server URI. For instance, if you registered example.com and pointed its DNS A record at a fresh Upcloud VPS or similar, you could install Synapse 0.99 on that host, giving it a server_name of example.com, and it would automatically generate a valid TLS certificate for you via Let's Encrypt and no SRV record or .well-known URI would be needed. This is the common case, although you can add an SRV record or .well-known/matrix/server URI for completeness if you wish. However , if your server does not listen on port 8448, or if your server_name does not point to the host that your homeserver runs on, you will need to let other servers know how to find it. In this case, you should see \"If you do have an SRV record currently\" above.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » When do I need a SRV record or .well-known URI?","id":"170","title":"When do I need a SRV record or .well-known URI?"},"171":{"body":"Firstly, if you didn't need an SRV record before (because your server is listening on port 8448 of your server_name), you certainly don't need one now: the defaults are still the same. If you previously had an SRV record, you can keep using it provided you are able to give Synapse a TLS certificate corresponding to your server name. For example, suppose you had the following SRV record, which directs matrix traffic for example.com to matrix.example.com:443: _matrix._tcp.example.com. IN SRV 10 5 443 matrix.example.com In this case, Synapse must be given a certificate for example.com - or be configured to acquire one from Let's Encrypt. If you are unable to give Synapse a certificate for your server_name, you will also need to use a .well-known URI instead. However, see also \"I have created a .well-known URI. Do I still need an SRV record?\".","breadcrumbs":"Upgrading from pre-Synapse 1.0 » Can I still use an SRV record?","id":"171","title":"Can I still use an SRV record?"},"172":{"body":"As of Synapse 0.99, Synapse will first check for the existence of a .well-known URI and follow any delegation it suggests. It will only then check for the existence of an SRV record. That means that the SRV record will often be redundant. However, you should remember that there may still be older versions of Synapse in the federation which do not understand .well-known URIs, so if you removed your SRV record you would no longer be able to federate with them. It is therefore best to leave the SRV record in place for now. Synapse 0.34 and earlier will follow the SRV record (and not care about the invalid certificate). Synapse 0.99 and later will follow the .well-known URI, with the correct certificate chain.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » I have created a .well-known URI. Do I still need an SRV record?","id":"172","title":"I have created a .well-known URI. Do I still need an SRV record?"},"173":{"body":"We have always wanted Matrix servers to be as easy to set up as possible, and so back when we started federation in 2014 we didn't want admins to have to go through the cumbersome process of buying a valid TLS certificate to run a server. This was before Let's Encrypt came along and made getting a free and valid TLS certificate straightforward. So instead, we adopted a system based on Perspectives : an approach where you check a set of \"notary servers\" (in practice, homeservers) to vouch for the validity of a certificate rather than having it signed by a CA. As long as enough different notaries agree on the certificate's validity, then it is trusted. However, in practice this has never worked properly. Most people only use the default notary server (matrix.org), leading to inadvertent centralisation which we want to eliminate. Meanwhile, we never implemented the full consensus algorithm to query the servers participating in a room to determine consensus on whether a given certificate is valid. This is fiddly to get right (especially in face of sybil attacks), and we found ourselves questioning whether it was worth the effort to finish the work and commit to maintaining a secure certificate validation system as opposed to focusing on core Matrix development. Meanwhile, Let's Encrypt came along in 2016, and put the final nail in the coffin of the Perspectives project (which was already pretty dead). So, the Spec Core Team decided that a better approach would be to mandate valid TLS certificates for federation alongside the rest of the Web. More details can be found in MSC1711 . This results in a breaking change, which is disruptive, but absolutely critical for the security model. However, the existence of Let's Encrypt as a trivial way to replace the old self-signed certificates with valid CA-signed ones helps smooth things over massively, especially as Synapse can now automate Let's Encrypt certificate generation if needed.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » It used to work just fine, why are you breaking everything?","id":"173","title":"It used to work just fine, why are you breaking everything?"},"174":{"body":"Yes, you are welcome to manage your certificates yourself. Synapse will only attempt to obtain certificates from Let's Encrypt if you configure it to do so.The only requirement is that there is a valid TLS cert present for federation end points.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » Can I manage my own certificates rather than having Synapse renew certificates itself?","id":"174","title":"Can I manage my own certificates rather than having Synapse renew certificates itself?"},"175":{"body":"We no longer actively recommend against using a reverse proxy. Many admins will find it easier to direct federation traffic to a reverse proxy and manage their own TLS certificates, and this is a supported configuration. See the reverse proxy documentation for information on setting up a reverse proxy.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » Do you still recommend against using a reverse proxy on the federation port?","id":"175","title":"Do you still recommend against using a reverse proxy on the federation port?"},"176":{"body":"Practically speaking, this is no longer necessary. If you are using a reverse proxy for all of your TLS traffic, then you can set no_tls: True. In that case, the only reason Synapse needs the certificate is to populate a legacy 'tls_fingerprints' field in the federation API. This is ignored by Synapse 0.99.0 and later, and the only time pre-0.99 Synapses will check it is when attempting to fetch the server keys - and generally this is delegated via matrix.org, which is on 0.99.0. However, there is a bug in Synapse 0.99.0 4554 which prevents Synapse from starting if you do not give it a TLS certificate. To work around this, you can give it any TLS certificate at all. This will be fixed soon.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » Do I still need to give my TLS certificates to Synapse if I am using a reverse proxy?","id":"176","title":"Do I still need to give my TLS certificates to Synapse if I am using a reverse proxy?"},"177":{"body":"No. There is nothing stopping you from using different certificates, particularly if you are using a reverse proxy. However, Synapse will use the same certificate on any ports where TLS is configured.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » Do I need the same certificate for the client and federation port?","id":"177","title":"Do I need the same certificate for the client and federation port?"},"178":{"body":"Synapse will reload the keys and certificates when it receives a SIGHUP - for example kill -HUP $(cat homeserver.pid). Alternatively, simply restart Synapse, though this will result in downtime while it restarts.","breadcrumbs":"Upgrading from pre-Synapse 1.0 » How do I tell Synapse to reload my keys/certificates after I replace them?","id":"178","title":"How do I tell Synapse to reload my keys/certificates after I replace them?"},"179":{"body":"Federation is the process by which users on different servers can participate in the same room. For this to work, those other servers must be able to contact yours to send messages. The server_name configured in the Synapse configuration file (often homeserver.yaml) defines how resources (users, rooms, etc.) will be identified (eg: @user:example.com, #room:example.com). By default, it is also the domain that other servers will use to try to reach your server (via port 8448). This is easy to set up and will work provided you 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 connections on port 8448. The preferred way to do that is by using a reverse proxy: see the reverse proxy documentation for instructions on how to correctly set one up. In some cases you might not want to run Synapse on the machine that has the server_name as its public DNS hostname, or you might want federation traffic to use a different port than 8448. For example, you might want to have your user names look like @user:example.com, but you want to run Synapse on synapse.example.com on port 443. This can be done using delegation, which allows an admin to control where federation traffic should be 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 federation. A good place to start is #synapse:matrix.org - a room for Synapse admins.","breadcrumbs":"Federation » Setting up federation","id":"179","title":"Setting up federation"},"18":{"body":"pip seems to leak lots of memory during installation. For instance, a Linux host with 512MB of RAM may run out of memory whilst installing Twisted. If this happens, you will have to individually install the dependencies which are failing, 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":"You can use the federation tester to check if your homeserver is configured correctly. Alternatively try the JSON API used by the federation tester . Note 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 a room, it is rejected with \"401: Unauthorized\". Generally this means that other servers in the room could not access yours. (Joining a room over federation is a complicated dance which requires connections in both directions). Another common problem is that people on other servers can't join rooms that you invite them to. This can be caused by an incorrectly-configured reverse proxy: see the reverse proxy documentation for instructions on how to correctly configure a reverse proxy.","breadcrumbs":"Federation » Troubleshooting","id":"180","title":"Troubleshooting"},"181":{"body":"HTTP 308 Permanent Redirect redirects are not followed : Due to missing features in the HTTP library used by Synapse, 308 redirects are currently not followed by federating servers, which can cause M_UNKNOWN or 401 Unauthorized errors. This may affect users who are redirecting apex-to-www (e.g. example.com -> www.example.com), and especially users of the Kubernetes Nginx Ingress module, which uses 308 redirect codes by default. For those Kubernetes users, this Stackoverflow post might be helpful. For other users, switching to a 301 Moved Permanently code may be an option. 308 redirect codes will be supported properly in a future release of Synapse.","breadcrumbs":"Federation » Known issues","id":"181","title":"Known issues"},"182":{"body":"If you want to get up and running quickly with a trio of homeservers in a private federation, there is a script in the demo directory. This is mainly useful just for development purposes. See demo/README .","breadcrumbs":"Federation » Running a demo federation of Synapses","id":"182","title":"Running a demo federation of Synapses"},"183":{"body":"This section contains information on tweaking Synapse via the various options in the configuration file. A configuration file should have been generated when you installed Synapse .","breadcrumbs":"Configuration » Configuration","id":"183","title":"Configuration"},"184":{"body":"Below is a sample homeserver configuration file. The homeserver configuration file can be tweaked to change the behaviour of your homeserver. A restart of the server is generally 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 a real homeserver.yaml. Instead, if you are starting from scratch, please generate a fresh config using Synapse by following the instructions in Installation . # This file is maintained as an up-to-date snapshot of the default\n# homeserver.yaml configuration generated by Synapse.\n#\n# It is intended to act as a reference for the default configuration,\n# helping admins keep track of new options and other changes, and compare\n# their configs with the current default. As such, many of the actual\n# config values shown are placeholders.\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://matrix-org.github.io/synapse/latest/setup/installation.html. # Configuration options that take a time period can be set using a number\n# followed by a letter. Letters have the following meanings:\n# s = second\n# m = minute\n# h = hour\n# d = day\n# w = week\n# y = year\n# For example, setting redaction_retention_period: 5m would remove redacted\n# messages from the database after 5 minutes, rather than 5 months. ################################################################################ # 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 ## Modules ## # Server admins can expand Synapse's functionality with external modules.\n#\n# See https://matrix-org.github.io/synapse/latest/modules.html for more\n# documentation on how to configure or create custom modules for Synapse.\n#\nmodules: # - module: my_super_module.MySuperClass # config: # do_thing: true # - module: my_other_super_module.SomeClass # config: {} ## Server ## # The public-facing domain of the server\n#\n# The server_name name will appear at the end of usernames and room addresses\n# created on this server. For example if the server_name was example.com,\n# usernames on this server would be in the format @user:example.com\n#\n# In most cases you should avoid using a matrix specific subdomain such as\n# matrix.example.com or synapse.example.com as the server_name for the same\n# reasons you wouldn't use user@email.example.com as your email address.\n# See https://matrix-org.github.io/synapse/latest/delegate.html\n# for information on how to host Synapse on a subdomain while preserving\n# a clean server_name.\n#\n# The server_name cannot be changed later so it is important to\n# configure this correctly before you start Synapse. It should be all\n# lowercase and may contain an explicit port.\n# Examples: matrix.org, localhost:8080\n#\nserver_name: \"SERVERNAME\" # When running as a daemon, the file to store the pid in\n#\npid_file: DATADIR/homeserver.pid # The absolute URL to the web client which /_matrix/client will redirect\n# to if 'webclient' is configured under the 'listeners' configuration.\n#\n# This option can be also set to the filesystem path to the web client\n# which will be served at /_matrix/client/ if 'webclient' is configured\n# under the 'listeners' configuration, however this is a security risk:\n# https://github.com/matrix-org/synapse#security-note\n#\n#web_client_location: https://riot.example.com/ # The public-facing base URL that clients use to access this Homeserver (not\n# including _matrix/...). This is the same URL a user might enter into the\n# 'Custom Homeserver URL' field on their client. If you use Synapse with a\n# reverse proxy, this should be the URL to reach Synapse via the proxy.\n# Otherwise, it should be the URL to reach Synapse's client HTTP listener (see\n# 'listeners' below).\n#\n#public_baseurl: https://example.com/ # Set the soft limit on the number of file descriptors synapse can use\n# Zero is used to indicate synapse should set the soft limit to the\n# hard limit.\n#\n#soft_file_limit: 0 # Presence tracking allows users to see the state (e.g online/offline)\n# of other local and remote users.\n#\npresence: # Uncomment to disable presence tracking on this homeserver. This option # replaces the previous top-level 'use_presence' option. # #enabled: false # Whether to require authentication to retrieve profile data (avatars,\n# display names) of other users through the client API. Defaults to\n# 'false'. Note that profile data is also available via the federation\n# API, unless allow_profile_lookup_over_federation is set to false.\n#\n#require_auth_for_profile_requests: true # Uncomment to require a user to share a room with another user in order\n# to retrieve their profile information. Only checked on Client-Server\n# requests. Profile requests from other servers should be checked by the\n# requesting server. Defaults to 'false'.\n#\n#limit_profile_requests_to_users_who_share_rooms: true # Uncomment to prevent a user's profile data from being retrieved and\n# displayed in a room until they have joined it. By default, a user's\n# profile data is included in an invite event, regardless of the values\n# of the above two settings, and whether or not the users share a server.\n# Defaults to 'true'.\n#\n#include_profile_data_on_invite: false # If set to 'true', removes the need for authentication to access the server's\n# public rooms directory through the client API, meaning that anyone can\n# query the room directory. Defaults to 'false'.\n#\n#allow_public_rooms_without_auth: true # If set to 'true', allows any other homeserver to fetch the server's public\n# rooms directory via federation. Defaults to 'false'.\n#\n#allow_public_rooms_over_federation: true # The default room version for newly created rooms.\n#\n# Known room versions are listed here:\n# https://matrix.org/docs/spec/#complete-list-of-room-versions\n#\n# For example, for room version 1, default_room_version should be set\n# to \"1\".\n#\n#default_room_version: \"6\" # The GC threshold parameters to pass to `gc.set_threshold`, if defined\n#\n#gc_thresholds: [700, 10, 10] # The minimum time in seconds between each GC for a generation, regardless of\n# the GC thresholds. This ensures that we don't do GC too frequently.\n#\n# A value of `[1s, 10s, 30s]` indicates that a second must pass between consecutive\n# generation 0 GCs, etc.\n#\n# Defaults to `[1s, 10s, 30s]`.\n#\n#gc_min_interval: [0.5s, 30s, 1m] # Set the limit on the returned events in the timeline in the get\n# and sync operations. The default value is 100. -1 means no upper limit.\n#\n# Uncomment the following to increase the limit to 5000.\n#\n#filter_timeline_limit: 5000 # Whether room invites to users on this server should be blocked\n# (except those sent by local server admins). The default is False.\n#\n#block_non_admin_invites: true # Room searching\n#\n# If disabled, new messages will not be indexed for searching and users\n# will receive errors when searching for messages. Defaults to enabled.\n#\n#enable_search: false # Prevent outgoing requests from being sent to the following blacklisted IP address\n# CIDR ranges. If this option is not specified then it defaults to private IP\n# address ranges (see the example below).\n#\n# The blacklist applies to the outbound requests for federation, identity servers,\n# push servers, and for checking key validity for third-party invite events.\n#\n# (0.0.0.0 and :: are always blacklisted, whether or not they are explicitly\n# listed here, since they correspond to unroutable addresses.)\n#\n# This option replaces federation_ip_range_blacklist in Synapse v1.25.0.\n#\n# Note: The value is ignored when an HTTP proxy is in use\n#\n#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' # List of IP address CIDR ranges that should be allowed for federation,\n# identity servers, push servers, and for checking key validity for\n# third-party invite events. This is useful for specifying exceptions to\n# wide-ranging blacklisted target IP ranges - e.g. for communication with\n# a push server only visible in your network.\n#\n# This whitelist overrides ip_range_blacklist and defaults to an empty\n# list.\n#\n#ip_range_whitelist:\n# - '192.168.1.1' # List of ports that Synapse should listen on, their purpose and their\n# configuration.\n#\n# Options for each listener include:\n#\n# port: the TCP port to bind to\n#\n# bind_addresses: a list of local addresses to listen on. The default is\n# 'all local interfaces'.\n#\n# type: the type of listener. Normally 'http', but other valid options are:\n# 'manhole' (see https://matrix-org.github.io/synapse/latest/manhole.html),\n# 'metrics' (see https://matrix-org.github.io/synapse/latest/metrics-howto.html),\n# 'replication' (see https://matrix-org.github.io/synapse/latest/workers.html).\n#\n# tls: set to true to enable TLS for this listener. Will use the TLS\n# key/cert specified in tls_private_key_path / tls_certificate_path.\n#\n# x_forwarded: Only valid for an 'http' listener. Set to true to use the\n# X-Forwarded-For header as the client IP. Useful when Synapse is\n# behind a reverse-proxy.\n#\n# resources: Only valid for an 'http' listener. A list of resources to host\n# on this port. Options for each resource are:\n#\n# names: a list of names of HTTP resources. See below for a list of\n# valid resource names.\n#\n# compress: set to true to enable HTTP compression for this resource.\n#\n# additional_resources: Only valid for an 'http' listener. A map of\n# additional endpoints which should be loaded via dynamic modules.\n#\n# Valid resource names are:\n#\n# client: the client-server API (/_matrix/client), and the synapse admin\n# API (/_synapse/admin). Also implies 'media' and 'static'.\n#\n# consent: user consent forms (/_matrix/consent).\n# See https://matrix-org.github.io/synapse/latest/consent_tracking.html.\n#\n# federation: the server-server API (/_matrix/federation). Also implies\n# 'media', 'keys', 'openid'\n#\n# keys: the key discovery API (/_matrix/keys).\n#\n# media: the media API (/_matrix/media).\n#\n# metrics: the metrics interface.\n# See https://matrix-org.github.io/synapse/latest/metrics-howto.html.\n#\n# openid: OpenID authentication.\n#\n# replication: the HTTP replication API (/_synapse/replication).\n# See https://matrix-org.github.io/synapse/latest/workers.html.\n#\n# static: static resources under synapse/static (/_matrix/static). (Mostly\n# useful for 'fallback authentication'.)\n#\n# webclient: A web client. Requires web_client_location to be set.\n#\nlisteners: # TLS-enabled listener: for when matrix traffic is sent directly to synapse. # # Disabled by default. To enable it, uncomment the following. (Note that you # will also need to give Synapse a TLS key and certificate: see the TLS section # below.) # #- port: 8448 # type: http # tls: true # resources: # - names: [client, federation] # Unsecure HTTP listener: for when matrix traffic passes through a reverse proxy # that unwraps TLS. # # If you plan to use a reverse proxy, please see # https://matrix-org.github.io/synapse/latest/reverse_proxy.html. # - port: 8008 tls: false type: http x_forwarded: true bind_addresses: ['::1', '127.0.0.1'] resources: - names: [client, federation] compress: false # example additional_resources: # #additional_resources: # \"/_matrix/my/custom/endpoint\": # module: my_module.CustomRequestHandler # config: {} # Turn on the twisted ssh manhole service on localhost on the given # port. # #- port: 9000 # bind_addresses: ['::1', '127.0.0.1'] # type: manhole # Connection settings for the manhole\n#\nmanhole_settings: # The username for the manhole. This defaults to 'matrix'. # #username: manhole # The password for the manhole. This defaults to 'rabbithole'. # #password: mypassword # The private and public SSH key pair used to encrypt the manhole traffic. # If these are left unset, then hardcoded and non-secret keys are used, # which could allow traffic to be intercepted if sent over a public network. # #ssh_priv_key_path: CONFDIR/id_rsa #ssh_pub_key_path: CONFDIR/id_rsa.pub # Forward extremities can build up in a room due to networking delays between\n# homeservers. Once this happens in a large room, calculation of the state of\n# that room can become quite expensive. To mitigate this, once the number of\n# forward extremities reaches a given threshold, Synapse will send an\n# org.matrix.dummy_event event, which will reduce the forward extremities\n# in the room.\n#\n# This setting defines the threshold (i.e. number of forward extremities in the\n# room) at which dummy events are sent. The default value is 10.\n#\n#dummy_events_threshold: 5 ## Homeserver blocking ## # How to reach the server admin, used in ResourceLimitError\n#\n#admin_contact: 'mailto:admin@server.com' # Global blocking\n#\n#hs_disabled: false\n#hs_disabled_message: 'Human readable reason for why the HS is blocked' # Monthly Active User Blocking\n#\n# Used in cases where the admin or server owner wants to limit to the\n# number of monthly active users.\n#\n# 'limit_usage_by_mau' disables/enables monthly active user blocking. When\n# enabled and a limit is reached the server returns a 'ResourceLimitError'\n# with error type Codes.RESOURCE_LIMIT_EXCEEDED\n#\n# 'max_mau_value' is the hard limit of monthly active users above which\n# the server will start blocking user actions.\n#\n# 'mau_trial_days' is a means to add a grace period for active users. It\n# means that users must be active for this number of days before they\n# can be considered active and guards against the case where lots of users\n# sign up in a short space of time never to return after their initial\n# session.\n#\n# 'mau_limit_alerting' is a means of limiting client side alerting\n# should the mau limit be reached. This is useful for small instances\n# where the admin has 5 mau seats (say) for 5 specific people and no\n# interest increasing the mau limit further. Defaults to True, which\n# means that alerting is enabled\n#\n#limit_usage_by_mau: false\n#max_mau_value: 50\n#mau_trial_days: 2\n#mau_limit_alerting: false # If enabled, the metrics for the number of monthly active users will\n# be populated, however no one will be limited. If limit_usage_by_mau\n# is true, this is implied to be true.\n#\n#mau_stats_only: false # Sometimes the server admin will want to ensure certain accounts are\n# never blocked by mau checking. These accounts are specified here.\n#\n#mau_limit_reserved_threepids:\n# - medium: 'email'\n# address: 'reserved_user@example.com' # Used by phonehome stats to group together related servers.\n#server_context: context # Resource-constrained homeserver settings\n#\n# When this is enabled, the room \"complexity\" will be checked before a user\n# joins a new remote room. If it is above the complexity limit, the server will\n# disallow joining, or will instantly leave.\n#\n# Room complexity is an arbitrary measure based on factors such as the number of\n# users in the room.\n#\nlimit_remote_rooms: # Uncomment to enable room complexity checking. # #enabled: true # the limit above which rooms cannot be joined. The default is 1.0. # #complexity: 0.5 # override the error which is returned when the room is too complex. # #complexity_error: \"This room is too complex.\" # allow server admins to join complex rooms. Default is false. # #admins_can_join: true # Whether to require a user to be in the room to add an alias to it.\n# Defaults to 'true'.\n#\n#require_membership_for_aliases: false # Whether to allow per-room membership profiles through the send of membership\n# events with profile information that differ from the target's global profile.\n# Defaults to 'true'.\n#\n#allow_per_room_profiles: false # How long to keep redacted events in unredacted form in the database. After\n# this period redacted events get replaced with their redacted form in the DB.\n#\n# Defaults to `7d`. Set to `null` to disable.\n#\n#redaction_retention_period: 28d # How long to track users' last seen time and IPs in the database.\n#\n# Defaults to `28d`. Set to `null` to disable clearing out of old rows.\n#\n#user_ips_max_age: 14d # Inhibits the /requestToken endpoints from returning an error that might leak\n# information about whether an e-mail address is in use or not on this\n# homeserver.\n# Note that for some endpoints the error situation is the e-mail already being\n# used, and for others the error is entering the e-mail being unused.\n# If this option is enabled, instead of returning an error, these endpoints will\n# act as if no error happened and return a fake session ID ('sid') to clients.\n#\n#request_token_inhibit_3pid_errors: true # A list of domains that the domain portion of 'next_link' parameters\n# must match.\n#\n# This parameter is optionally provided by clients while requesting\n# validation of an email or phone number, and maps to a link that\n# users will be automatically redirected to after validation\n# succeeds. Clients can make use this parameter to aid the validation\n# process.\n#\n# The whitelist is applied whether the homeserver or an\n# identity server is handling validation.\n#\n# The default value is no whitelist functionality; all domains are\n# allowed. Setting this value to an empty list will instead disallow\n# all domains.\n#\n#next_link_domain_whitelist: [\"matrix.org\"] # Templates to use when generating email or HTML page contents.\n#\ntemplates: # Directory in which Synapse will try to find template files to use to generate # email or HTML page contents. # If not set, or a file is not found within the template directory, a default # template from within the Synapse package will be used. # # See https://matrix-org.github.io/synapse/latest/templates.html for more # information about using custom templates. # #custom_template_directory: /path/to/custom/templates/ # Message retention policy at the server level.\n#\n# Room admins and mods can define a retention period for their rooms using the\n# 'm.room.retention' state event, and server admins can cap this period by setting\n# the 'allowed_lifetime_min' and 'allowed_lifetime_max' config options.\n#\n# If this feature is enabled, Synapse will regularly look for and purge events\n# which are older than the room's maximum retention period. Synapse will also\n# filter events received over federation so that events that should have been\n# purged are ignored and not stored again.\n#\nretention: # The message retention policies feature is disabled by default. Uncomment the # following line to enable it. # #enabled: true # Default retention policy. If set, Synapse will apply it to rooms that lack the # 'm.room.retention' state event. Currently, the value of 'min_lifetime' doesn't # matter much because Synapse doesn't take it into account yet. # #default_policy: # min_lifetime: 1d # max_lifetime: 1y # Retention policy limits. If set, and the state of a room contains a # 'm.room.retention' event in its state which contains a 'min_lifetime' or a # 'max_lifetime' that's out of these bounds, Synapse will cap the room's policy # to these limits when running purge jobs. # #allowed_lifetime_min: 1d #allowed_lifetime_max: 1y # Server admins can define the settings of the background jobs purging the # events which lifetime has expired under the 'purge_jobs' section. # # If no configuration is provided, 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 # which '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). # #purge_jobs: # - longest_max_lifetime: 3d # interval: 12h # - shortest_max_lifetime: 3d # interval: 1d ## TLS ## # PEM-encoded X509 certificate for TLS.\n# This certificate, as of Synapse 1.0, will need to be a valid and verifiable\n# certificate, signed by a recognised Certificate Authority.\n#\n# Be sure to use a `.pem` file that includes the full certificate chain including\n# any intermediate certificates (for instance, if using certbot, use\n# `fullchain.pem` as your certificate, not `cert.pem`).\n#\n#tls_certificate_path: \"CONFDIR/SERVERNAME.tls.crt\" # PEM-encoded private key for TLS\n#\n#tls_private_key_path: \"CONFDIR/SERVERNAME.tls.key\" # Whether to verify TLS server certificates for outbound federation requests.\n#\n# Defaults to `true`. To disable certificate verification, uncomment the\n# following line.\n#\n#federation_verify_certificates: false # The minimum TLS version that will be used for outbound federation requests.\n#\n# Defaults to `1`. Configurable to `1`, `1.1`, `1.2`, or `1.3`. Note\n# that setting this value higher than `1.2` will prevent federation to most\n# of the public Matrix network: only configure it to `1.3` if you have an\n# entirely private federation setup and you can ensure TLS 1.3 support.\n#\n#federation_client_minimum_tls_version: 1.2 # Skip federation certificate verification on the following whitelist\n# of domains.\n#\n# This setting should only be used in very specific cases, such as\n# federation over Tor hidden services and similar. For private networks\n# of homeservers, you likely want to use a private CA instead.\n#\n# Only effective if federation_verify_certicates is `true`.\n#\n#federation_certificate_verification_whitelist:\n# - lon.example.com\n# - *.domain.com\n# - *.onion # List of custom certificate authorities for federation traffic.\n#\n# This setting should only normally be used within a private network of\n# homeservers.\n#\n# Note that this list will replace those that are provided by your\n# operating environment. Certificates must be in PEM format.\n#\n#federation_custom_ca_list:\n# - myCA1.pem\n# - myCA2.pem\n# - myCA3.pem ## Federation ## # Restrict federation to the following whitelist of domains.\n# N.B. we recommend also firewalling your federation listener to limit\n# inbound federation traffic as early as possible, rather than relying\n# purely on this application-layer restriction. If not specified, the\n# default is to whitelist everything.\n#\n#federation_domain_whitelist:\n# - lon.example.com\n# - nyc.example.com\n# - syd.example.com # Report prometheus metrics on the age of PDUs being sent to and received from\n# the following domains. This can be used to give an idea of \"delay\" on inbound\n# and outbound federation, though be aware that any delay can be due to problems\n# at either end or with the intermediate network.\n#\n# By default, no domains are monitored in this way.\n#\n#federation_metrics_domains:\n# - matrix.org\n# - example.com # Uncomment to disable profile lookup over federation. By default, the\n# Federation API allows other homeservers to obtain profile data of any user\n# on this homeserver. Defaults to 'true'.\n#\n#allow_profile_lookup_over_federation: false # Uncomment to disable device display name lookup over federation. By default, the\n# Federation API allows other homeservers to obtain device display names of any user\n# on this homeserver. Defaults to 'true'.\n#\n#allow_device_name_lookup_over_federation: false ## Caching ## # Caching can be configured through the following options.\n#\n# A cache 'factor' is a multiplier that can be applied to each of\n# Synapse's caches in order to increase or decrease the maximum\n# number of entries that can be stored. # The number of events to cache in memory. Not affected by\n# caches.global_factor.\n#\n#event_cache_size: 10K caches: # 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 half the size of all caches. # #global_factor: 1.0 # 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`. # per_cache_factors: #get_users_who_share_room_with_user: 2.0 # Controls how long an entry can be in a cache without having been # accessed before being evicted. Defaults to None, which means # entries are never evicted based on time. # #expiry_time: 30m # 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. # # By default, this is zero, which means that sync responses are not cached # at all. # #sync_response_cache_duration: 2m ## Database ## # The 'database' setting defines the database that synapse uses to store all of\n# its data.\n#\n# 'name' gives the database engine to use: either 'sqlite3' (for SQLite) or\n# 'psycopg2' (for PostgreSQL).\n#\n# 'txn_limit' gives the maximum number of transactions to run per connection\n# before reconnecting. Defaults to 0, which means no limit.\n#\n# 'args' gives options which are passed through to the database engine,\n# except for options starting 'cp_', which are used to configure the Twisted\n# connection pool. For a reference to valid arguments, see:\n# * for sqlite: https://docs.python.org/3/library/sqlite3.html#sqlite3.connect\n# * for postgres: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS\n# * for the connection pool: https://twistedmatrix.com/documents/current/api/twisted.enterprise.adbapi.ConnectionPool.html#__init__\n#\n#\n# Example SQLite configuration:\n#\n#database:\n# name: sqlite3\n# args:\n# database: /path/to/homeserver.db\n#\n#\n# Example Postgres configuration:\n#\n#database:\n# name: psycopg2\n# txn_limit: 10000\n# args:\n# user: synapse_user\n# password: secretpassword\n# database: synapse\n# host: localhost\n# port: 5432\n# cp_min: 5\n# cp_max: 10\n#\n# For more information on using Synapse with Postgres,\n# see https://matrix-org.github.io/synapse/latest/postgres.html.\n#\ndatabase: name: sqlite3 args: database: DATADIR/homeserver.db ## Logging ## # A yaml python logging config file as described by\n# https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema\n#\nlog_config: \"CONFDIR/SERVERNAME.log.config\" ## Ratelimiting ## # Ratelimiting settings for client actions (registration, login, messaging).\n#\n# Each ratelimiting configuration is made of two parameters:\n# - per_second: number of requests a client can send per second.\n# - burst_count: number of requests a client can send before being throttled.\n#\n# Synapse currently uses the following configurations:\n# - one for messages that ratelimits sending based on the account the client\n# is using\n# - one for registration that ratelimits registration requests based on the\n# client's IP address.\n# - one for checking the validity of registration tokens that ratelimits\n# requests based on the client's IP address.\n# - one for login that ratelimits login requests based on the client's IP\n# address.\n# - one for login that ratelimits login requests based on the account the\n# client is attempting to log into.\n# - one for login that ratelimits login requests based on the account the\n# client is attempting to log into, based on the amount of failed login\n# attempts for this account.\n# - one for ratelimiting redactions by room admins. If this is not explicitly\n# set then it uses the same ratelimiting as per rc_message. This is useful\n# to allow room admins to deal with abuse quickly.\n# - two for ratelimiting number of rooms a user can join, \"local\" for when\n# users are joining rooms the server is already in (this is cheap) vs\n# \"remote\" for when users are trying to join rooms not on the server (which\n# can be more expensive)\n# - one for ratelimiting how often a user or IP can attempt to validate a 3PID.\n# - two for ratelimiting how often invites can be sent in a room or to a\n# specific user.\n#\n# The defaults are as shown below.\n#\n#rc_message:\n# per_second: 0.2\n# burst_count: 10\n#\n#rc_registration:\n# per_second: 0.17\n# burst_count: 3\n#\n#rc_registration_token_validity:\n# per_second: 0.1\n# burst_count: 5\n#\n#rc_login:\n# address:\n# per_second: 0.17\n# burst_count: 3\n# account:\n# per_second: 0.17\n# burst_count: 3\n# failed_attempts:\n# per_second: 0.17\n# burst_count: 3\n#\n#rc_admin_redaction:\n# per_second: 1\n# burst_count: 50\n#\n#rc_joins:\n# local:\n# per_second: 0.1\n# burst_count: 10\n# remote:\n# per_second: 0.01\n# burst_count: 10\n#\n#rc_3pid_validation:\n# per_second: 0.003\n# burst_count: 5\n#\n#rc_invites:\n# per_room:\n# per_second: 0.3\n# burst_count: 10\n# per_user:\n# per_second: 0.003\n# burst_count: 5 # Ratelimiting settings for incoming federation\n#\n# The rc_federation configuration is made up of the following settings:\n# - window_size: window size in milliseconds\n# - sleep_limit: number of federation requests from a single server in\n# a window before the server will delay processing the request.\n# - sleep_delay: duration in milliseconds to delay processing events\n# from remote servers by if they go over the sleep limit.\n# - reject_limit: maximum number of concurrent federation requests\n# allowed from a single server\n# - concurrent: number of federation requests to concurrently process\n# from a single server\n#\n# The defaults are as shown below.\n#\n#rc_federation:\n# window_size: 1000\n# sleep_limit: 10\n# sleep_delay: 500\n# reject_limit: 50\n# concurrent: 3 # Target outgoing federation transaction frequency for sending read-receipts,\n# per-room.\n#\n# If we end up trying to send out more read-receipts, they will get buffered up\n# into fewer transactions.\n#\n#federation_rr_transactions_per_room_per_second: 50 ## Media Store ## # Enable the media store service in the Synapse master. Uncomment the\n# following if you are using a separate media store worker.\n#\n#enable_media_repo: false # Directory where uploaded images and attachments are stored.\n#\nmedia_store_path: \"DATADIR/media_store\" # Media storage providers allow media to be stored in different\n# locations.\n#\n#media_storage_providers:\n# - module: file_system\n# # Whether to store newly uploaded local files\n# store_local: false\n# # Whether to store newly downloaded remote files\n# store_remote: false\n# # Whether to wait for successful storage for local uploads\n# store_synchronous: false\n# config:\n# directory: /mnt/some/other/directory # The largest allowed upload size in bytes\n#\n# If you are using a reverse proxy you may also need to set this value in\n# your reverse proxy's config. Notably Nginx has a small max body size by default.\n# See https://matrix-org.github.io/synapse/latest/reverse_proxy.html.\n#\n#max_upload_size: 50M # Maximum number of pixels that will be thumbnailed\n#\n#max_image_pixels: 32M # Whether to generate new thumbnails on the fly to precisely match\n# the resolution requested by the client. If true then whenever\n# a new resolution is requested by the client the server will\n# generate a new thumbnail. If false the server will pick a thumbnail\n# from a precalculated list.\n#\n#dynamic_thumbnails: false # List of thumbnails to precalculate when an image is uploaded.\n#\n#thumbnail_sizes:\n# - width: 32\n# height: 32\n# method: crop\n# - width: 96\n# height: 96\n# method: crop\n# - width: 320\n# height: 240\n# method: scale\n# - width: 640\n# height: 480\n# method: scale\n# - width: 800\n# height: 600\n# method: scale # Is the preview URL API enabled?\n#\n# 'false' by default: uncomment the following to enable it (and specify a\n# url_preview_ip_range_blacklist blacklist).\n#\n#url_preview_enabled: true # List of IP address CIDR ranges that the URL preview spider is denied\n# from accessing. There are no defaults: you must explicitly\n# specify a list for URL previewing to work. You should specify any\n# internal services in your network that you do not want synapse to try\n# to connect to, otherwise anyone in any Matrix room could cause your\n# synapse to issue arbitrary GET requests to your internal services,\n# causing serious security issues.\n#\n# (0.0.0.0 and :: are always blacklisted, whether or not they are explicitly\n# listed here, since they correspond to unroutable addresses.)\n#\n# This must be specified if url_preview_enabled is set. It is recommended that\n# you uncomment the following list as a starting point.\n#\n# Note: The value is ignored when an HTTP proxy is in use\n#\n#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' # List of IP address CIDR ranges that the URL preview spider is allowed\n# to access even if they are specified in url_preview_ip_range_blacklist.\n# This is useful for specifying exceptions to wide-ranging blacklisted\n# target IP ranges - e.g. for enabling URL previews for a specific private\n# website only visible in your network.\n#\n#url_preview_ip_range_whitelist:\n# - '192.168.1.1' # Optional list of URL matches that the URL preview spider is\n# denied from accessing. You should use url_preview_ip_range_blacklist\n# in preference to this, otherwise someone could define a public DNS\n# entry that points to a private IP address and circumvent the blacklist.\n# This is more useful if you know there is an entire shape of URL that\n# you know that will never want synapse to try to spider.\n#\n# Each list entry is a dictionary of url component attributes as returned\n# by urlparse.urlsplit as applied to the absolute form of the URL. See\n# https://docs.python.org/2/library/urlparse.html#urlparse.urlsplit\n# The values of the dictionary are treated as an filename match pattern\n# applied to that component of URLs, unless they start with a ^ in which\n# case they are treated as a regular expression match. If all the\n# specified component matches for a given list item succeed, the URL is\n# blacklisted.\n#\n#url_preview_url_blacklist:\n# # blacklist any URL with a username in its URI\n# - username: '*'\n#\n# # blacklist all *.google.com URLs\n# - netloc: 'google.com'\n# - netloc: '*.google.com'\n#\n# # blacklist all plain HTTP URLs\n# - scheme: 'http'\n#\n# # blacklist http(s)://www.acme.com/foo\n# - netloc: 'www.acme.com'\n# path: '/foo'\n#\n# # blacklist any URL with a literal IPv4 address\n# - netloc: '^[0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+$' # The largest allowed URL preview spidering size in bytes\n#\n#max_spider_size: 10M # A list of values for the Accept-Language HTTP header used when\n# downloading webpages during URL preview generation. This allows\n# Synapse to specify the preferred languages that URL previews should\n# be in when communicating with remote servers.\n#\n# Each value is a IETF language tag; a 2-3 letter identifier for a\n# language, optionally followed by subtags separated by '-', specifying\n# a country or region variant.\n#\n# Multiple values can be provided, and a weight can be added to each by\n# using quality value syntax (;q=). '*' translates to any language.\n#\n# Defaults to \"en\".\n#\n# Example:\n#\n# url_preview_accept_language:\n# - en-UK\n# - en-US;q=0.9\n# - fr;q=0.8\n# - *;q=0.7\n#\nurl_preview_accept_language:\n# - en # oEmbed allows for easier embedding content from a website. It can be\n# used for generating URLs previews of services which support it.\n#\noembed: # A default list of oEmbed providers is included with Synapse. # # Uncomment the following to disable using these default oEmbed URLs. # Defaults to 'false'. # #disable_default_providers: true # Additional files with oEmbed configuration (each should be in the # form of providers.json). # # By default, this list is empty (so only the default providers.json # is used). # #additional_providers: # - oembed/my_providers.json ## Captcha ##\n# See docs/CAPTCHA_SETUP.md for full details of configuring this. # This homeserver's ReCAPTCHA public key. Must be specified if\n# enable_registration_captcha is enabled.\n#\n#recaptcha_public_key: \"YOUR_PUBLIC_KEY\" # This homeserver's ReCAPTCHA private key. Must be specified if\n# enable_registration_captcha is enabled.\n#\n#recaptcha_private_key: \"YOUR_PRIVATE_KEY\" # Uncomment to enable ReCaptcha checks when registering, preventing signup\n# unless a captcha is answered. Requires a valid ReCaptcha\n# public/private key. Defaults to 'false'.\n#\n#enable_registration_captcha: true # The API endpoint to use for verifying m.login.recaptcha responses.\n# Defaults to \"https://www.recaptcha.net/recaptcha/api/siteverify\".\n#\n#recaptcha_siteverify_api: \"https://my.recaptcha.site\" ## TURN ## # The public URIs of the TURN server to give to clients\n#\n#turn_uris: [] # The shared secret used to compute passwords for the TURN server\n#\n#turn_shared_secret: \"YOUR_SHARED_SECRET\" # The Username and password if the TURN server needs them and\n# does not use a token\n#\n#turn_username: \"TURNSERVER_USERNAME\"\n#turn_password: \"TURNSERVER_PASSWORD\" # How long generated TURN credentials last\n#\n#turn_user_lifetime: 1h # Whether guests should be allowed to use the TURN server.\n# This defaults to True, otherwise VoIP will be unreliable for guests.\n# However, it does introduce a slight security risk as it allows users to\n# connect to arbitrary endpoints without having first signed up for a\n# valid account (e.g. by passing a CAPTCHA).\n#\n#turn_allow_guests: true ## Registration ##\n#\n# Registration can be rate-limited using the parameters in the \"Ratelimiting\"\n# section of this file. # Enable registration for new users.\n#\n#enable_registration: false # Time that a user's session remains valid for, after they log in.\n#\n# Note that this is not currently compatible with guest logins.\n#\n# Note also that this is calculated at login time: changes are not applied\n# retrospectively to users who have already logged in.\n#\n# By default, this is infinite.\n#\n#session_lifetime: 24h # The user must provide all of the below types of 3PID when registering.\n#\n#registrations_require_3pid:\n# - email\n# - msisdn # Explicitly disable asking for MSISDNs from the registration\n# flow (overrides registrations_require_3pid if MSISDNs are set as required)\n#\n#disable_msisdn_registration: true # Mandate that users are only allowed to associate certain formats of\n# 3PIDs with accounts on this server.\n#\n#allowed_local_3pids:\n# - medium: email\n# pattern: '^[^@]+@matrix\\.org$'\n# - medium: email\n# pattern: '^[^@]+@vector\\.im$'\n# - medium: msisdn\n# pattern: '\\+44' # Enable 3PIDs lookup requests to identity servers from this server.\n#\n#enable_3pid_lookup: true # Require users to submit a token during registration.\n# Tokens can be managed using the admin API:\n# https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/registration_tokens.html\n# Note that `enable_registration` must be set to `true`.\n# Disabling this option will not delete any tokens previously generated.\n# Defaults to false. Uncomment the following to require tokens:\n#\n#registration_requires_token: true # If set, allows registration of standard or admin accounts by anyone who\n# has the shared secret, even if registration is otherwise disabled.\n#\n#registration_shared_secret: # Set the number of bcrypt rounds used to generate password hash.\n# Larger numbers increase the work factor needed to generate the hash.\n# The default number is 12 (which equates to 2^12 rounds).\n# N.B. that increasing this will exponentially increase the time required\n# to register or login - e.g. 24 => 2^24 rounds which will take >20 mins.\n#\n#bcrypt_rounds: 12 # Allows users to register as guests without a password/email/etc, and\n# participate in rooms hosted on this server which have been made\n# accessible to anonymous users.\n#\n#allow_guest_access: false # The identity server which we suggest that clients should use when users log\n# in on this server.\n#\n# (By default, no suggestion is made, so it is left up to the client.\n# This setting is ignored unless public_baseurl is also set.)\n#\n#default_identity_server: https://matrix.org # Handle threepid (email/phone etc) registration and password resets through a set of\n# *trusted* identity servers. Note that this allows the configured identity server to\n# reset passwords for accounts!\n#\n# Be aware that if `email` is not set, and SMTP options have not been\n# configured in the email config block, registration and user password resets via\n# email will be globally disabled.\n#\n# Additionally, if `msisdn` is not set, registration and password resets via msisdn\n# will be disabled regardless, and users will not be able to associate an msisdn\n# identifier to their account. This is due to Synapse currently not supporting\n# any method of sending SMS messages on its own.\n#\n# To enable using an identity server for operations regarding a particular third-party\n# identifier type, set the value to the URL of that identity server as shown in the\n# examples below.\n#\n# Servers handling the these requests must answer the `/requestToken` endpoints defined\n# by the Matrix Identity Service API specification:\n# https://matrix.org/docs/spec/identity_service/latest\n#\n# If a delegate is specified, the config option public_baseurl must also be filled out.\n#\naccount_threepid_delegates: #email: https://example.com # Delegate email sending to example.com #msisdn: http://localhost:8090 # Delegate SMS sending to this local process # Whether users are allowed to change their displayname after it has\n# been initially set. Useful when provisioning users based on the\n# contents of a third-party directory.\n#\n# Does not apply to server administrators. Defaults to 'true'\n#\n#enable_set_displayname: false # Whether users are allowed to change their avatar after it has been\n# initially set. Useful when provisioning users based on the contents\n# of a third-party directory.\n#\n# Does not apply to server administrators. Defaults to 'true'\n#\n#enable_set_avatar_url: false # Whether users can change the 3PIDs associated with their accounts\n# (email address and msisdn).\n#\n# Defaults to 'true'\n#\n#enable_3pid_changes: false # Users who register on this homeserver will automatically be joined\n# to these rooms.\n#\n# By default, any room aliases included in this list will be created\n# as a publicly joinable room when the first user registers for the\n# homeserver. This behaviour can be customised with the settings below.\n# If the room already exists, make certain it is a publicly joinable\n# room. The join rule of the room must be set to 'public'.\n#\n#auto_join_rooms:\n# - \"#example:example.com\" # Where auto_join_rooms are specified, setting this flag ensures that the\n# the rooms exist by creating them when the first user on the\n# homeserver registers.\n#\n# By default the auto-created rooms are publicly joinable from any federated\n# server. Use the autocreate_auto_join_rooms_federated and\n# autocreate_auto_join_room_preset settings below to customise this behaviour.\n#\n# Setting to false means that if the rooms are not manually created,\n# users cannot be auto-joined since they do not exist.\n#\n# Defaults to true. Uncomment the following line to disable automatically\n# creating auto-join rooms.\n#\n#autocreate_auto_join_rooms: false # Whether the auto_join_rooms that are auto-created are available via\n# federation. Only has an effect if autocreate_auto_join_rooms is true.\n#\n# Note that whether a room is federated cannot be modified after\n# creation.\n#\n# Defaults to true: the room will be joinable from other servers.\n# Uncomment the following to prevent users from other homeservers from\n# joining these rooms.\n#\n#autocreate_auto_join_rooms_federated: false # The room preset to use when auto-creating one of auto_join_rooms. Only has an\n# effect if autocreate_auto_join_rooms is true.\n#\n# This can be one of \"public_chat\", \"private_chat\", or \"trusted_private_chat\".\n# If a value of \"private_chat\" or \"trusted_private_chat\" is used then\n# auto_join_mxid_localpart must also be configured.\n#\n# Defaults to \"public_chat\", meaning that the room is joinable by anyone, including\n# federated servers if autocreate_auto_join_rooms_federated is true (the default).\n# Uncomment the following to require an invitation to join these rooms.\n#\n#autocreate_auto_join_room_preset: private_chat # The local part of the user id which is used to create auto_join_rooms if\n# autocreate_auto_join_rooms is true. If this is not provided then the\n# initial user account that registers will be used to create the rooms.\n#\n# The user id is also used to invite new users to any auto-join rooms which\n# are set to invite-only.\n#\n# It *must* be configured if autocreate_auto_join_room_preset is set to\n# \"private_chat\" or \"trusted_private_chat\".\n#\n# Note that this must be specified in order for new users to be correctly\n# invited to any auto-join rooms which have been set to invite-only (either\n# at the time of creation or subsequently).\n#\n# Note that, if the room already exists, this user must be joined and\n# have the appropriate permissions to invite new members.\n#\n#auto_join_mxid_localpart: system # When auto_join_rooms is specified, setting this flag to false prevents\n# guest accounts from being automatically joined to the rooms.\n#\n# Defaults to true.\n#\n#auto_join_rooms_for_guests: false ## Metrics ### # Enable collection and rendering of performance metrics\n#\n#enable_metrics: false # Enable sentry integration\n# NOTE: While attempts are made to ensure that the logs don't contain\n# any sensitive information, this cannot be guaranteed. By enabling\n# this option the sentry server may therefore receive sensitive\n# information, and it in turn may then diseminate sensitive information\n# through insecure notification channels if so configured.\n#\n#sentry:\n# dsn: \"...\" # Flags to enable Prometheus metrics which are not suitable to be\n# enabled by default, either for performance reasons or limited use.\n#\nmetrics_flags: # Publish synapse_federation_known_servers, a gauge of the number of # servers this homeserver knows about, including itself. May cause # performance problems on large homeservers. # #known_servers: true # Whether or not to report anonymized homeserver usage statistics.\n#\n#report_stats: true|false # The endpoint to report the anonymized homeserver usage statistics to.\n# Defaults to https://matrix.org/report-usage-stats/push\n#\n#report_stats_endpoint: https://example.com/report-usage-stats/push ## API Configuration ## # Controls for the state that is shared with users who receive an invite\n# to a room\n#\nroom_prejoin_state: # By default, the following state event types are shared with users who # receive invites to the room: # # - m.room.join_rules # - m.room.canonical_alias # - m.room.avatar # - m.room.encryption # - m.room.name # - m.room.create # # Uncomment the following to disable these defaults (so that only the event # types listed in 'additional_event_types' are shared). Defaults to 'false'. # #disable_default_event_types: true # Additional state event types to share with users when they are invited # to a room. # # By default, this list is empty (so only the default event types are shared). # #additional_event_types: # - org.example.custom.event.type # A list of application service config files to use\n#\n#app_service_config_files:\n# - app_service_1.yaml\n# - app_service_2.yaml # Uncomment to enable tracking of application service IP addresses. Implicitly\n# enables MAU tracking for application service users.\n#\n#track_appservice_user_ips: true # a secret which is used to sign access tokens. If none is specified,\n# the registration_shared_secret is used, if one is given; otherwise,\n# a secret key is derived from the signing key.\n#\n#macaroon_secret_key: # a secret which is used to calculate HMACs for form values, to stop\n# falsification of values. Must be specified for the User Consent\n# forms to work.\n#\n#form_secret: ## Signing Keys ## # Path to the signing key to sign messages with\n#\nsigning_key_path: \"CONFDIR/SERVERNAME.signing.key\" # The keys that the server used to sign messages with but won't use\n# to sign new messages.\n#\nold_signing_keys: # For each key, `key` should be the base64-encoded public key, and # `expired_ts`should be the time (in milliseconds since the unix epoch) that # it was last used. # # It is possible to build an entry from an old signing.key file using the # `export_signing_key` script which is provided with synapse. # # For example: # #\"ed25519:id\": { key: \"base64string\", expired_ts: 123456789123 } # How long key response published by this server is valid for.\n# Used to set the valid_until_ts in /key/v2 APIs.\n# Determines how quickly servers will query to check which keys\n# are still valid.\n#\n#key_refresh_interval: 1d # The trusted servers to download signing keys from.\n#\n# When we need to fetch a signing key, each server is tried in parallel.\n#\n# Normally, the connection to the key server is validated via TLS certificates.\n# Additional security can be provided by configuring a `verify key`, which\n# will make synapse check that the response is signed by that key.\n#\n# This setting supercedes an older setting named `perspectives`. The old format\n# is still supported for backwards-compatibility, but it is deprecated.\n#\n# 'trusted_key_servers' defaults to matrix.org, but using it will generate a\n# warning on start-up. To suppress this warning, set\n# 'suppress_key_server_warning' to true.\n#\n# Options for each entry in the list include:\n#\n# server_name: the name of the server. required.\n#\n# verify_keys: an optional map from key id to base64-encoded public key.\n# If specified, we will check that the response is signed by at least\n# one of the given keys.\n#\n# accept_keys_insecurely: a boolean. Normally, if `verify_keys` is unset,\n# and federation_verify_certificates is not `true`, synapse will refuse\n# to start, because this would allow anyone who can spoof DNS responses\n# to masquerade as the trusted key server. If you know what you are doing\n# and are sure that your network environment provides a secure connection\n# to the key server, you can set this to `true` to override this\n# behaviour.\n#\n# An example configuration might look like:\n#\n#trusted_key_servers:\n# - server_name: \"my_trusted_server.example.com\"\n# verify_keys:\n# \"ed25519:auto\": \"abcdefghijklmnopqrstuvwxyzabcdefghijklmopqr\"\n# - server_name: \"my_other_trusted_server.example.com\"\n#\ntrusted_key_servers: - server_name: \"matrix.org\" # Uncomment the following to disable the warning that is emitted when the\n# trusted_key_servers include 'matrix.org'. See above.\n#\n#suppress_key_server_warning: true # The signing keys to use when acting as a trusted key server. If not specified\n# defaults to the server signing key.\n#\n# Can contain multiple keys, one per line.\n#\n#key_server_signing_keys_path: \"key_server_signing_keys.key\" ## Single sign-on integration ## # The following settings can be used to make Synapse use a single sign-on\n# provider for authentication, instead of its internal password database.\n#\n# You will probably also want to set the following options to `false` to\n# disable the regular login/registration flows:\n# * enable_registration\n# * password_config.enabled\n#\n# You will also want to investigate the settings under the \"sso\" configuration\n# section below. # Enable SAML2 for registration and login. Uses pysaml2.\n#\n# At least one of `sp_config` or `config_path` must be set in this section to\n# enable SAML login.\n#\n# Once SAML support is enabled, a metadata file will be exposed at\n# https://:/_synapse/client/saml2/metadata.xml, which you may be able to\n# use to configure your SAML IdP with. Alternatively, you can manually configure\n# the IdP to use an ACS location of\n# https://:/_synapse/client/saml2/authn_response.\n#\nsaml2_config: # `sp_config` is the 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. # sp_config: # 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. # #metadata: # local: [\"saml2/idp.xml\"] # remote: # - url: https://our_idp/metadata.xml # Allowed clock difference in seconds between the homeserver and IdP. # # Uncomment the below to increase the accepted time difference from 0 to 3 seconds. # #accepted_time_diff: 3 # By default, the user has to go to our login page first. If you'd like # to allow IdP-initiated login, set 'allow_unsolicited: true' in a # 'service.sp' section: # #service: # sp: # allow_unsolicited: true # The examples below are just used to generate our metadata xml, and you # may well not need them, depending on your setup. Alternatively you # may need a whole lot more detail - see the pysaml2 docs! #description: [\"My awesome SP\", \"en\"] #name: [\"Test SP\", \"en\"] #ui_info: # display_name: # - lang: en # text: \"Display Name is the descriptive name of your service.\" # description: # - lang: en # text: \"Description should be a short paragraph explaining the purpose of the service.\" # information_url: # - lang: en # text: \"https://example.com/terms-of-service\" # privacy_statement_url: # - lang: en # text: \"https://example.com/privacy-policy\" # keywords: # - lang: en # text: [\"Matrix\", \"Element\"] # logo: # - lang: en # text: \"https://example.com/logo.svg\" # width: \"200\" # height: \"80\" #organization: # name: Example com # display_name: # - [\"Example co\", \"en\"] # url: \"http://example.com\" #contact_person: # - given_name: Bob # sur_name: \"the Sysadmin\" # email_address\": [\"admin@example.com\"] # contact_type\": technical # Instead of putting the config inline as above, you can specify a # separate pysaml2 configuration file: # #config_path: \"CONFDIR/sp_conf.py\" # The lifetime of a SAML session. This defines how long a user has to # complete the authentication process, if allow_unsolicited is unset. # The default is 15 minutes. # #saml_session_lifetime: 5m # An external module can be provided here as a custom solution to # mapping attributes returned from a saml provider onto a matrix user. # user_mapping_provider: # The custom module's class. Uncomment to use a custom module. # #module: mapping_provider.SamlMappingProvider # Custom configuration values for the module. Below options are # intended for the built-in provider, they should be changed if # using a custom module. This section will be passed as a Python # dictionary to the module's `parse_config` method. # config: # The SAML attribute (after mapping via the attribute maps) to use # to derive the Matrix ID from. '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_source_attribute: displayName # The mapping system to use for mapping the saml attribute onto a # matrix ID. # # Options include: # * 'hexencode' (which maps unpermitted characters to '=xx') # * '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. # #mxid_mapping: dotreplace # 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. # # The default is 'uid'. # #grandfathered_mxid_source_attribute: upn # 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 below. All of the listed attributes must # match for the login to be permitted. # #attribute_requirements: # - attribute: userGroup # value: \"staff\" # - attribute: department # value: \"sales\" # 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. # #idp_entityid: 'https://our_idp/entityid' # List of OpenID Connect (OIDC) / OAuth 2.0 identity providers, for registration\n# and login.\n#\n# Options for each entry include:\n#\n# idp_id: a unique identifier for this identity provider. Used internally\n# by Synapse; should be a single word such as 'github'.\n#\n# Note that, if this is changed, users authenticating via that provider\n# will no longer be recognised as the same user!\n#\n# (Use \"oidc\" here if you are migrating from an old \"oidc_config\"\n# configuration.)\n#\n# idp_name: A user-facing name for this identity provider, which is used to\n# offer the user a choice of login mechanisms.\n#\n# idp_icon: An optional icon for this identity provider, which is presented\n# by clients and Synapse's own IdP picker page. If given, must be an\n# MXC URI of the format mxc:///. (An easy way to\n# obtain such an MXC URI is to upload an image to an (unencrypted) room\n# and then copy the \"url\" from the source of the event.)\n#\n# idp_brand: An optional brand for this identity provider, allowing clients\n# to style the login flow according to the identity provider in question.\n# See the spec for possible options here.\n#\n# discover: set to 'false' to disable the use of the OIDC discovery mechanism\n# to discover endpoints. Defaults to true.\n#\n# issuer: Required. The OIDC issuer. Used to validate tokens and (if discovery\n# is enabled) to discover the provider's endpoints.\n#\n# client_id: Required. oauth2 client id to use.\n#\n# client_secret: oauth2 client secret to use. May be omitted if\n# client_secret_jwt_key is given, or if client_auth_method is 'none'.\n#\n# client_secret_jwt_key: Alternative to client_secret: details of a key used\n# to create a JSON Web Token to be used as an OAuth2 client secret. If\n# given, must be a dictionary with the following properties:\n#\n# key: a pem-encoded signing key. Must be a suitable key for the\n# algorithm specified. Required unless 'key_file' is given.\n#\n# key_file: the path to file containing a pem-encoded signing key file.\n# Required unless 'key' is given.\n#\n# jwt_header: a dictionary giving properties to include in the JWT\n# header. Must include the key 'alg', giving the algorithm used to\n# sign the JWT, such as \"ES256\", using the JWA identifiers in\n# RFC7518.\n#\n# jwt_payload: an optional dictionary giving properties to include in\n# the JWT payload. Normally this should include an 'iss' key.\n#\n# client_auth_method: auth method to use when exchanging the token. Valid\n# values are 'client_secret_basic' (default), 'client_secret_post' and\n# 'none'.\n#\n# scopes: list of scopes to request. This should normally include the \"openid\"\n# scope. Defaults to [\"openid\"].\n#\n# authorization_endpoint: the oauth2 authorization endpoint. Required if\n# provider discovery is disabled.\n#\n# token_endpoint: the oauth2 token endpoint. Required if provider discovery is\n# disabled.\n#\n# userinfo_endpoint: the OIDC userinfo endpoint. Required if discovery is\n# disabled and the 'openid' scope is not requested.\n#\n# jwks_uri: URI where to fetch the JWKS. Required if discovery is disabled and\n# the 'openid' scope is used.\n#\n# skip_verification: set to 'true' to skip metadata verification. Use this if\n# you are connecting to a provider that is not OpenID Connect compliant.\n# Defaults to false. Avoid this in production.\n#\n# user_profile_method: Whether to fetch the user profile from the userinfo\n# endpoint. Valid values are: 'auto' or 'userinfo_endpoint'.\n#\n# Defaults to 'auto', which fetches the userinfo endpoint if 'openid' is\n# included in 'scopes'. Set to 'userinfo_endpoint' to always fetch the\n# userinfo endpoint.\n#\n# allow_existing_users: set to 'true' to allow a user logging in via OIDC to\n# match a pre-existing account instead of failing. This could be used if\n# switching from password logins to OIDC. Defaults to false.\n#\n# user_mapping_provider: Configuration for how attributes returned from a OIDC\n# provider are mapped onto a matrix user. This setting has the following\n# sub-properties:\n#\n# module: The class name of a custom mapping module. Default is\n# 'synapse.handlers.oidc.JinjaOidcMappingProvider'.\n# See https://matrix-org.github.io/synapse/latest/sso_mapping_providers.html#openid-mapping-providers\n# for information on implementing a custom mapping provider.\n#\n# config: Configuration for the mapping provider module. This section will\n# be passed as a Python dictionary to the user mapping provider\n# module's `parse_config` method.\n#\n# For the default provider, the following settings are available:\n#\n# subject_claim: name of the claim containing a unique identifier\n# for the user. Defaults to 'sub', which OpenID Connect\n# compliant providers should provide.\n#\n# localpart_template: Jinja2 template for the localpart of the MXID.\n# If this is not set, the user will be prompted to choose their\n# own username (see 'sso_auth_account_details.html' in the 'sso'\n# section of this file).\n#\n# display_name_template: Jinja2 template for the display name to set\n# on first login. If unset, no displayname will be set.\n#\n# email_template: Jinja2 template for the email address of the user.\n# If unset, no email address will be added to the account.\n#\n# extra_attributes: a map of Jinja2 templates for extra attributes\n# to send back to the client during login.\n# Note that these are non-standard and clients will ignore them\n# without modifications.\n#\n# When rendering, the Jinja2 templates are given a 'user' variable,\n# which is set to the claims returned by the UserInfo Endpoint and/or\n# in the ID Token.\n#\n# It is possible to configure Synapse to only allow logins if certain attributes\n# match particular values in the OIDC userinfo. The requirements can be listed under\n# `attribute_requirements` as shown below. All of the listed attributes must\n# match for the login to be permitted. Additional attributes can be added to\n# userinfo by expanding the `scopes` section of the OIDC config to retrieve\n# additional information from the OIDC provider.\n#\n# If the OIDC claim is a list, then the attribute must match any value in the list.\n# Otherwise, it must exactly match the value of the claim. Using the example\n# below, the `family_name` claim MUST be \"Stephensson\", but the `groups`\n# claim MUST contain \"admin\".\n#\n# attribute_requirements:\n# - attribute: family_name\n# value: \"Stephensson\"\n# - attribute: groups\n# value: \"admin\"\n#\n# See https://matrix-org.github.io/synapse/latest/openid.html\n# for information on how to configure these options.\n#\n# For backwards compatibility, it is also possible to configure a single OIDC\n# provider via an 'oidc_config' setting. This is now deprecated and admins are\n# advised to migrate to the 'oidc_providers' format. (When doing that migration,\n# use 'oidc' for the idp_id to ensure that existing users continue to be\n# recognised.)\n#\noidc_providers: # Generic example # #- idp_id: my_idp # idp_name: \"My OpenID provider\" # idp_icon: \"mxc://example.com/mediaid\" # discover: false # issuer: \"https://accounts.example.com/\" # client_id: \"provided-by-your-issuer\" # client_secret: \"provided-by-your-issuer\" # client_auth_method: client_secret_post # scopes: [\"openid\", \"profile\"] # authorization_endpoint: \"https://accounts.example.com/oauth2/auth\" # token_endpoint: \"https://accounts.example.com/oauth2/token\" # userinfo_endpoint: \"https://accounts.example.com/userinfo\" # jwks_uri: \"https://accounts.example.com/.well-known/jwks.json\" # skip_verification: true # user_mapping_provider: # config: # subject_claim: \"id\" # localpart_template: \"{{ user.login }}\" # display_name_template: \"{{ user.name }}\" # email_template: \"{{ user.email }}\" # attribute_requirements: # - attribute: userGroup # value: \"synapseUsers\" # Enable Central Authentication Service (CAS) for registration and login.\n#\ncas_config: # Uncomment the following to enable authorization against a CAS server. # Defaults to false. # #enabled: true # The URL of the CAS authorization endpoint. # #server_url: \"https://cas-server.com\" # The attribute of the CAS response to use as the display name. # # If unset, no displayname will be set. # #displayname_attribute: name # It is possible to configure Synapse to only allow logins if CAS attributes # match particular values. All of the keys in the mapping 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. # #required_attributes: # userGroup: \"staff\" # department: None # Additional settings to use with single-sign on systems such as OpenID Connect,\n# SAML2 and CAS.\n#\n# Server admins can configure custom templates for pages related to SSO. See\n# https://matrix-org.github.io/synapse/latest/templates.html for more information.\n#\nsso: # 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/\". # # If public_baseurl is set, then 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 is empty. # #client_whitelist: # - https://riot.im/develop # - https://my.custom.client/ # Uncomment to keep a user's profile fields in sync with information from # the identity provider. Currently only syncing the displayname is # supported. 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. Defaults to false. # #update_profile_information: true # JSON web token integration. The following settings can be used to make\n# Synapse JSON web tokens for authentication, instead of its internal\n# password database.\n#\n# Each JSON Web Token needs to contain a \"sub\" (subject) claim, which is\n# used as the localpart of the mxid.\n#\n# Additionally, the expiration time (\"exp\"), not before time (\"nbf\"),\n# and issued at (\"iat\") claims are validated if present.\n#\n# Note that this is a non-standard login type and client support is\n# expected to be non-existent.\n#\n# See https://matrix-org.github.io/synapse/latest/jwt.html.\n#\n#jwt_config: # Uncomment the following to enable authorization using JSON web # tokens. Defaults to false. # #enabled: true # 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 true. # #secret: \"provided-by-your-issuer\" # The algorithm used to sign the JSON web token. # # Supported algorithms are listed at # https://pyjwt.readthedocs.io/en/latest/algorithms.html # # Required if 'enabled' is true. # #algorithm: \"provided-by-your-issuer\" # The issuer to validate the \"iss\" claim against. # # Optional, if provided the \"iss\" claim will be required and # validated for all JSON web tokens. # #issuer: \"provided-by-your-issuer\" # A list of audiences to validate the \"aud\" claim against. # # Optional, 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. # #audiences: # - \"provided-by-your-issuer\" password_config: # Uncomment to disable password login # #enabled: false # Uncomment 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. # #localdb_enabled: false # Uncomment and change to a secret random string for extra security. # DO NOT CHANGE THIS AFTER INITIAL SETUP! # #pepper: \"EVEN_MORE_SECRET\" # Define and enforce a password policy. Each parameter is optional. # This is an implementation of MSC2000. # policy: # Whether to enforce the password policy. # Defaults to 'false'. # #enabled: true # Minimum accepted length for a password. # Defaults to 0. # #minimum_length: 15 # Whether a password must contain at least one digit. # Defaults to 'false'. # #require_digit: true # 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_symbol: true # Whether a password must contain at least one lowercase letter. # Defaults to 'false'. # #require_lowercase: true # Whether a password must contain at least one uppercase letter. # Defaults to 'false'. # #require_uppercase: true ui_auth: # The amount of time to allow a user-interactive authentication session # to be active. # # This defaults to 0, meaning the user is queried for their credentials # before every action, but this can be overridden to allow a single # validation to be re-used. This weakens the protections afforded by # the user-interactive authentication process, by allowing for multiple # (and potentially different) operations to use the same validation session. # # This is ignored for potentially \"dangerous\" operations (including # deactivating an account, modifying an account password, and # adding a 3PID). # # Uncomment below to allow for credential validation to last for 15 # seconds. # #session_timeout: \"15s\" # Configuration for sending emails from Synapse.\n#\n# Server admins can configure custom templates for email content. See\n# https://matrix-org.github.io/synapse/latest/templates.html for more information.\n#\nemail: # The hostname of the outgoing SMTP server to use. Defaults to 'localhost'. # #smtp_host: mail.server # The port on the mail server for outgoing SMTP. Defaults to 25. # #smtp_port: 587 # Username/password for authentication to the SMTP server. By default, no # authentication is attempted. # #smtp_user: \"exampleusername\" #smtp_pass: \"examplepassword\" # Uncomment the following 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. # #require_transport_security: true # Uncomment the following to disable TLS for SMTP. # # By default, if the server supports TLS, it will be used, and the server # must present a certificate that is valid for 'smtp_host'. If this option # is set to false, TLS will not be used. # #enable_tls: false # notif_from 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 'app_name' (below), but may be overridden by the # Matrix client application. # # Note that the placeholder must be written '%(app)s', including the # trailing 's'. # #notif_from: \"Your Friendly %(app)s homeserver \" # app_name defines the default value for '%(app)s' in notif_from and email # subjects. It defaults to 'Matrix'. # #app_name: my_branded_matrix_server # Uncomment the following to enable sending emails for messages that the user # has missed. Disabled by default. # #enable_notifs: true # Uncomment the following to disable automatic subscription to email # notifications for new users. Enabled by default. # #notif_for_new_users: false # Custom URL for client links within the email notifications. By default # links will be based on \"https://matrix.to\". # # (This setting used to be called riot_base_url; the old name is still # supported for backwards-compatibility but is now deprecated.) # #client_base_url: \"http://localhost/riot\" # Configure the time that a validation email will expire after sending. # Defaults to 1h. # #validation_token_lifetime: 15m # 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. Defaults # to unset, giving no guidance to the identity server. # #invite_client_location: https://app.element.io # Subjects to use when sending emails from Synapse. # # The placeholder '%(app)s' will be replaced with the value of the 'app_name' # setting above, or by a value dictated by the Matrix client application. # # If a subject isn't overridden in this configuration file, the value used as # its example will be used. # #subjects: # Subjects for notification emails. # # On top of the '%(app)s' placeholder, these can use the following # placeholders: # # * '%(person)s', which will be replaced by the display name of the user(s) # that sent the message(s), e.g. \"Alice and Bob\". # * '%(room)s', which will be replaced by the name of the room the # message(s) have been sent to, e.g. \"My super room\". # # See the example provided for each setting to see which placeholder can be # used and how to use them. # # Subject to use to notify about one message from one or more user(s) in a # room which has a name. #message_from_person_in_room: \"[%(app)s] You have a message on %(app)s from %(person)s in the %(room)s room...\" # # Subject to use to notify about one message from one or more user(s) in a # room which doesn't have a name. #message_from_person: \"[%(app)s] You have a message on %(app)s from %(person)s...\" # # Subject to use to notify about multiple messages from one or more users in # a room which doesn't have a name. #messages_from_person: \"[%(app)s] You have messages on %(app)s from %(person)s...\" # # Subject to use to notify about multiple messages in a room which has a # name. #messages_in_room: \"[%(app)s] You have messages on %(app)s in the %(room)s room...\" # # Subject to use to notify about multiple messages in multiple rooms. #messages_in_room_and_others: \"[%(app)s] You have messages on %(app)s in the %(room)s room and others...\" # # 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. #messages_from_person_and_others: \"[%(app)s] You have messages on %(app)s from %(person)s and others...\" # # Subject to use to notify about an invite to a room which has a name. #invite_from_person_to_room: \"[%(app)s] %(person)s has invited you to join the %(room)s room on %(app)s...\" # # Subject to use to notify about an invite to a room which doesn't have a # name. #invite_from_person: \"[%(app)s] %(person)s has invited you to chat on %(app)s...\" # Subject for emails related to account administration. # # On top of the '%(app)s' placeholder, these one can use the # '%(server_name)s' placeholder, which will be replaced by the value of the # 'server_name' setting in your Synapse configuration. # # Subject to use when sending a password reset email. #password_reset: \"[%(server_name)s] Password reset\" # # Subject to use when sending a verification email to assert an address's # ownership. #email_validation: \"[%(server_name)s] Validate your email\" ## Push ## push: # Clients requesting push notifications can either have the body of # the message sent in the notification poke along with other details # like the sender, or just the event ID and room ID (`event_id_only`). # If clients choose the former, this option controls whether the # notification request includes the content of the event (other details # like the sender are still included). For `event_id_only` push, it # has no effect. # # For modern android devices the notification content will still appear # because it is loaded by the app. iPhone, however will send a # notification saying only that a message arrived and who it came from. # # The default value is \"true\" to include message details. Uncomment to only # include the event ID and room ID in push notification payloads. # #include_content: false # 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. # # The default value is \"true\", meaning push clients will see the number of # rooms with unread messages in them. Uncomment to instead send the number # of unread messages. # #group_unread_count_by_room: false ## Rooms ## # Controls whether locally-created rooms should be end-to-end encrypted by\n# default.\n#\n# Possible options are \"all\", \"invite\", and \"off\". They are defined as:\n#\n# * \"all\": any locally-created room\n# * \"invite\": any room created with the \"private_chat\" or \"trusted_private_chat\"\n# room creation presets\n# * \"off\": this option will take no effect\n#\n# The default value is \"off\".\n#\n# Note that this option will only affect rooms created after it is set. It\n# will also not affect rooms created by other servers.\n#\n#encryption_enabled_by_default_for_room_type: invite # Uncomment to allow non-server-admin users to create groups on this server\n#\n#enable_group_creation: true # If enabled, non server admins can only create groups with local parts\n# starting with this prefix\n#\n#group_creation_prefix: \"unofficial_\" # User Directory configuration\n#\nuser_directory: # Defines whether users can search the user directory. If false then # empty responses are returned to all queries. Defaults to true. # # Uncomment to disable the user directory. # #enabled: false # Defines whether to search all users visible to your HS when searching # the user directory. If false, search results will only contain users # visible in public rooms and users sharing a room with the requester. # Defaults to false. # # 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 following the instructions at # https://matrix-org.github.io/synapse/latest/user_directory.html # # Uncomment to return search results containing all known users, even if that # user does not share a room with the requester. # #search_all_users: true # Defines whether to prefer local users in search query results. # If True, local users are more likely to appear above remote users # when searching the user directory. Defaults to false. # # Uncomment to prefer local over remote users in user directory search # results. # #prefer_local_users: true # User Consent configuration\n#\n# for detailed instructions, see\n# https://matrix-org.github.io/synapse/latest/consent_tracking.html\n#\n# Parts of this section are required if enabling the 'consent' resource under\n# 'listeners', in particular 'template_dir' and 'version'.\n#\n# 'template_dir' gives the location of the templates for the HTML forms.\n# This directory should contain one subdirectory per language (eg, 'en', 'fr'),\n# and each language directory should contain the policy document (named as\n# '.html') and a success page (success.html).\n#\n# 'version' specifies the 'current' version of the policy document. It defines\n# the version to be served by the consent resource if there is no 'v'\n# parameter.\n#\n# 'server_notice_content', if enabled, will send a user a \"Server Notice\"\n# asking them to consent to the privacy policy. The 'server_notices' section\n# must also be configured for this to work. Notices will *not* be sent to\n# guest users unless 'send_server_notice_to_guests' is set to true.\n#\n# 'block_events_error', if set, will block any attempts to send events\n# until the user consents to the privacy policy. The value of the setting is\n# used as the text of the error.\n#\n# 'require_at_registration', if enabled, will add a step to the registration\n# process, similar to how captcha works. Users will be required to accept the\n# policy before their account is created.\n#\n# 'policy_name' is the display name of the policy users will see when registering\n# for an account. Has no effect unless `require_at_registration` is enabled.\n# Defaults to \"Privacy Policy\".\n#\n#user_consent:\n# template_dir: res/templates/privacy\n# version: 1.0\n# server_notice_content:\n# msgtype: m.text\n# body: >-\n# To continue using this homeserver you must review and agree to the\n# terms and conditions at %(consent_uri)s\n# send_server_notice_to_guests: true\n# block_events_error: >-\n# To continue using this homeserver you must review and agree to the\n# terms and conditions at %(consent_uri)s\n# require_at_registration: false\n# policy_name: Privacy Policy\n# # Settings for local room and user statistics collection. See\n# https://matrix-org.github.io/synapse/latest/room_and_user_statistics.html.\n#\nstats: # Uncomment the following to disable room and user statistics. Note that doing # so may cause certain features (such as the room directory) not to work # correctly. # #enabled: false # Server Notices room configuration\n#\n# Uncomment this section to enable a room which can be used to send notices\n# from the server to users. It is a special room which cannot be left; notices\n# come from a special \"notices\" user id.\n#\n# If you uncomment this section, you *must* define the system_mxid_localpart\n# setting, which defines the id of the user which will be used to send the\n# notices.\n#\n# It's also possible to override the room name, the display name of the\n# \"notices\" user, and the avatar for the user.\n#\n#server_notices:\n# system_mxid_localpart: notices\n# system_mxid_display_name: \"Server Notices\"\n# system_mxid_avatar_url: \"mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ\"\n# room_name: \"Server Notices\" # Uncomment to disable searching the public room list. When disabled\n# blocks searching local and remote room lists for local and remote\n# users by always returning an empty list for all queries.\n#\n#enable_room_list_search: false # The `alias_creation` option controls who's allowed to create aliases\n# on this server.\n#\n# The format of this option is a list of rules that contain globs that\n# match against user_id, room_id and the new alias (fully qualified with\n# server name). The action in the first rule that matches is taken,\n# which can currently either be \"allow\" or \"deny\".\n#\n# Missing user_id/room_id/alias fields default to \"*\".\n#\n# If no rules match the request is denied. An empty list means no one\n# can create aliases.\n#\n# Options for the rules include:\n#\n# user_id: Matches against the creator of the alias\n# alias: Matches against the alias being created\n# room_id: Matches against the room ID the alias is being pointed at\n# action: Whether to \"allow\" or \"deny\" the request if the rule matches\n#\n# The default is:\n#\n#alias_creation_rules:\n# - user_id: \"*\"\n# alias: \"*\"\n# room_id: \"*\"\n# action: allow # The `room_list_publication_rules` option controls who can publish and\n# which rooms can be published in the public room list.\n#\n# The format of this option is the same as that for\n# `alias_creation_rules`.\n#\n# If the room has one or more aliases associated with it, only one of\n# the aliases needs to match the alias rule. If there are no aliases\n# then only rules with `alias: *` match.\n#\n# If no rules match the request is denied. An empty list means no one\n# can publish rooms.\n#\n# Options for the rules include:\n#\n# user_id: Matches against the creator of the alias\n# room_id: Matches against the room ID being published\n# alias: Matches against any current local or canonical aliases\n# associated with the room\n# action: Whether to \"allow\" or \"deny\" the request if the rule matches\n#\n# The default is:\n#\n#room_list_publication_rules:\n# - user_id: \"*\"\n# alias: \"*\"\n# room_id: \"*\"\n# action: allow ## Opentracing ## # These settings enable opentracing, which implements distributed tracing.\n# This allows you to observe the causal chains of events across servers\n# including requests, key lookups etc., across any server running\n# synapse or any other other services which supports opentracing\n# (specifically those implemented with Jaeger).\n#\nopentracing: # tracing is disabled by default. Uncomment the following line to enable it. # #enabled: true # The list of homeservers we wish to send and receive span contexts and span baggage. # See https://matrix-org.github.io/synapse/latest/opentracing.html. # # This is a list of regexes which are matched against the server_name of the # homeserver. # # By default, it is empty, so no servers are matched. # #homeserver_whitelist: # - \".*\" # 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. # # By default, the list is empty. # #force_tracing_for_users: # - \"@user1:server_name\" # - \"@user2:server_name\" # 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: # https://www.jaegertracing.io/docs/latest/sampling/. # #jaeger_config: # sampler: # type: const # param: 1 # logging: # false ## Workers ## # Disables sending of outbound federation transactions on the main process.\n# Uncomment if using a federation sender worker.\n#\n#send_federation: false # It is possible to run multiple federation sender workers, in which case the\n# work is balanced across them.\n#\n# This configuration must be shared between all federation sender workers, and if\n# changed all federation sender workers must be stopped at the same time and then\n# started, to ensure that all instances are running with the same config (otherwise\n# events may be dropped).\n#\n#federation_sender_instances:\n# - federation_sender1 # When using workers this should be a map from `worker_name` to the\n# HTTP replication listener of the worker, if configured.\n#\n#instance_map:\n# worker1:\n# host: localhost\n# port: 8034 # Experimental: When using workers you can define which workers should\n# handle event persistence and typing notifications. Any worker\n# specified here must also be in the `instance_map`.\n#\n#stream_writers:\n# events: worker1\n# typing: worker1 # The worker that is used to run background tasks (e.g. cleaning up expired\n# data). If not provided this defaults to the main process.\n#\n#run_background_tasks_on: worker1 # A shared secret used by the replication APIs to authenticate HTTP requests\n# from workers.\n#\n# By default this is unused and traffic is not authenticated.\n#\n#worker_replication_secret: \"\" # Configuration for Redis when using workers. This *must* be enabled when\n# using workers (unless using old style direct TCP configuration).\n#\nredis: # Uncomment the below to enable Redis support. # #enabled: true # Optional host and port to use to connect to redis. Defaults to # localhost and 6379 # #host: localhost #port: 6379 # Optional password if configured on the Redis instance # #password: ","breadcrumbs":"Configuration » Homeserver Sample Config File » Homeserver Sample Configuration File","id":"184","title":"Homeserver Sample Configuration File"},"185":{"body":"Below is a sample logging configuration file. This file can be tweaked to control how your homeserver will output logs. A restart of the server is generally required to apply any changes made to this file. The value of the log_config option in your homeserver config should be the path to this file. Note that a default logging configuration (shown below) is created automatically alongside the homeserver config when following the installation instructions . It should be named .log.config by default. # 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.7/library/logging.config.html#configuration-dictionary-schema\n# [2]: https://matrix-org.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 twisted: # We send the twisted logging directly to the file handler, # to work around https://github.com/matrix-org/synapse/issues/3471 # when using \"buffer\" logger. Use \"console\" to log to stderr instead. handlers: [file] propagate: false 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. (Note that you'll # also need to update the configuration for the `twisted` logger above, in # this case.) # handlers: [buffer] disable_existing_loggers: false","breadcrumbs":"Configuration » Logging Sample Config File » Logging Sample Configuration File","id":"185","title":"Logging Sample Configuration File"},"186":{"body":"A structured logging system can be useful when your logs are destined for a machine to parse and process. By maintaining its machine-readable characteristics, it enables more efficient searching and aggregations when consumed by software such 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 uses the synapse.logging.TerseJsonFormatter class included with Synapse and a handler which uses the above formatter. There is also a synapse.logging.JsonFormatter option which does not include a timestamp in the resulting JSON. This is useful if the log ingester adds its own 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: [remote] synapse.storage.SQL: level: WARNING The above logging config will set Synapse as 'INFO' logging level by default, with the SQL layer at 'WARNING', and will log to a file, stored as JSON. It is also possible to figure Synapse to log to a remote endpoint by using the synapse.logging.RemoteHandler class included with Synapse. It takes the following 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, with the SQL layer at 'WARNING', and will log JSON formatted messages to a remote endpoint at 10.1.2.3:9999.","breadcrumbs":"Configuration » Structured Logging » Structured Logging","id":"186","title":"Structured Logging"},"187":{"body":"Versions of Synapse prior to v1.23.0 included a custom structured logging configuration which is deprecated. It used a structured: true flag and configured drains instead of handlers and formatters. Synapse currently automatically converts the old configuration to the new configuration, but this will be removed in a future version of Synapse. The following reference can be used to update your configuration. Based on the drain type, we can pick a new handler: For a type of console, console_json, or console_json_terse: a handler with a class of logging.StreamHandler and a stream of ext://sys.stdout or ext://sys.stderr should be used. For a type of file or file_json: a handler of logging.FileHandler with a location of the file path should be used. For a type of network_json_terse: a handler of synapse.logging.RemoteHandler with the host and port should be used. Then based on the drain type we can pick a new formatter: For a type of console or file no formatter is necessary. For a type of console_json or file_json: a formatter of synapse.logging.JsonFormatter should be used. For a type of console_json_terse or network_json_terse: a formatter of synapse.logging.TerseJsonFormatter should be used. For each new handler and formatter they should be added to the logging configuration and then assigned to either a logger or the root logger. An example legacy configuration: structured: true loggers: synapse: level: INFO synapse.storage.SQL: level: WARNING drains: console: type: console location: stdout file: type: file_json location: homeserver.log Would be converted into a new configuration: version: 1 formatters: json: class: synapse.logging.JsonFormatter handlers: console: class: logging.StreamHandler location: ext://sys.stdout file: class: logging.FileHandler formatter: json filename: homeserver.log loggers: synapse: level: INFO handlers: [console, file] synapse.storage.SQL: level: WARNING The new logging configuration is a bit more verbose, but significantly more flexible. It allows for configuration that were not previously possible, such as sending plain logs over the network, or using different handlers for different modules.","breadcrumbs":"Configuration » Structured Logging » Upgrading from legacy structured logging configuration","id":"187","title":"Upgrading from legacy structured logging configuration"},"188":{"body":"Synapse uses parametrised templates to generate the content of emails it sends and webpages it shows to users. By default, Synapse will use the templates listed here . Server admins can configure an additional directory for Synapse to look for templates in, allowing them to specify custom templates: templates: custom_templates_directory: /path/to/custom/templates/ If this setting is not set, or the files named below are not found within the directory, default templates from within the Synapse package will be used. Templates that are given variables when being rendered are rendered using Jinja 2 . Templates rendered by Jinja 2 can also access two functions on top of the functions already 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)","breadcrumbs":"Configuration » Templates » Templates","id":"188","title":"Templates"},"189":{"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 events. When 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 by configuring the various settings in the email.subjects section of the configuration file. rooms: a list of rooms containing events to include in the email. Each element is an 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 accepted yet, False otherwise notifs: a list of events, or an empty list if invite is True. Each element is 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 message in the event, and one message after the event. Each element is an object with the following attributes: event_type: the type of the event is_historical: a boolean, which is False if the message is the one that 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 sender sender_hash: a hash of the user ID of the sender link: a matrix.to link to the room reason: information on the event that triggered the email to be sent. It's an object 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 before ever emailing about a notification (to give the user a chance to respond to other push or notice the window) last_sent_ts: the time in milliseconds at which a notification was last sent for an event in this room throttle_ms: the minimum amount of time in milliseconds between two notifications can be sent for this room password_reset.html and password_reset.txt: The contents of password reset emails sent by the homeserver. When rendering, these templates are given a link variable which contains the link the user must click in order to reset their password. registration.html and registration.txt: The contents of address verification emails sent during registration. When rendering, these templates are given a link variable which contains the link the user must click in order to validate their email address. add_threepid.html and add_threepid.txt: The contents of address verification emails sent when an address is added to a Matrix account. When rendering, these templates are given a link variable which contains the link the user must click in order to validate their email address.","breadcrumbs":"Configuration » Templates » Email templates","id":"189","title":"Email templates"},"19":{"body":"Synapse supports PostgreSQL versions 9.6 or later.","breadcrumbs":"Using Postgres » Using Postgres","id":"19","title":"Using Postgres"},"190":{"body":"Below are the templates Synapse will look for when generating pages related to registration and password reset: password_reset_confirmation.html: An HTML page that a user will see when they follow the link in the password reset email. The user will be asked to confirm the action before their password is reset. When 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 and failure that a user will see when they confirm the password reset flow using the page above. When rendering, password_reset_success.html is given no variable, and password_reset_failure.html is given a failure_reason, which contains the reason for the password reset failure. registration_success.html and registration_failure.html: HTML pages for success and failure that a user will see when they follow the link in an address verification email sent during registration. When rendering, registration_success.html is given no variable, and registration_failure.html is given a failure_reason, which contains the reason for the registration failure. add_threepid_success.html and add_threepid_failure.html: HTML pages for success and failure that a user will see when they follow the link in an address verification email sent when an address is added to a Matrix account. When rendering, add_threepid_success.html is given no variable, and add_threepid_failure.html is given a failure_reason, which contains the reason for the registration failure.","breadcrumbs":"Configuration » Templates » HTML page templates for registration and password reset","id":"190","title":"HTML page templates for registration and password reset"},"191":{"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 Identity Provider during login. This is only used if multiple SSO Identity Providers are configured. When rendering, this template is given the following variables: redirect_url: the URL that the user will be redirected to after login. server_name: the homeserver's name. providers: a list of available Identity Providers. Each element is 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 for the IdP idp_brand: if specified in the IdP config, a textual identifier for the brand of the IdP The rendered HTML page should contain a form which submits its results back as a GET request, with the following query parameters: redirectUrl: the client redirect URI (ie, the redirect_url passed to the template) idp: the 'idp_id' of the chosen IDP. sso_auth_account_details.html: HTML page to prompt new users to enter a userid and confirm other details. This is only shown if the SSO implementation (with any user_mapping_provider) does not return a localpart. When 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 with: 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 for the IdP idp_brand: if specified in the IdP config, a textual identifier for the brand of the IdP user_attributes: an object containing details about the user that we received from the IdP. May have the following attributes: display_name: the user's display_name emails: a list of email addresses The 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 server's terms and conditions. This is only shown for new users, and only if user_consent.require_at_registration is set. When 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 shown terms_url: a link to the page showing the terms. The template should render a form which submits the following fields: accepted_version: the version of the terms accepted by the user (ie, 'consent_version' from the input variables). sso_redirect_confirm.html: HTML page for a confirmation step before redirecting back to the client with the login token. When 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 parameters stripped. The intention is to have a human-readable URL to show to users, not to use it as the final address to redirect to. server_name: the homeserver's name. new_user: a boolean indicating whether this is the user's first time logging 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 has not set a display name. sso_auth_confirm.html: HTML page which notifies the user that they are authenticating to confirm an operation on their account during the user interactive authentication process. When 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 the 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 for the IdP idp_brand: if specified in the IdP config, a textual identifier for the brand of the IdP sso_auth_success.html: HTML page shown after a successful user interactive authentication session. Note that this page must include the JavaScript which notifies of a successful authentication (see https://matrix.org/docs/spec/client_server/r0.6.0#fallback). This template has no additional variables. sso_auth_bad_user.html: HTML page shown after a user-interactive authentication session which does not map correctly onto the expected user. When 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 validate. sso_account_deactivated.html: HTML page shown during single sign-on if a deactivated user (according to Synapse's database) attempts to login. This template has no additional variables. sso_error.html: HTML page to display to users if something goes wrong during the OpenID Connect authentication process. When 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":"191","title":"HTML page templates for Single Sign-On (SSO)"},"192":{"body":"Synapse supports multiple methods of authenticating users, either out-of-the-box or through custom pluggable authentication 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\" modules.","breadcrumbs":"Configuration » User Authentication » User Authentication","id":"192","title":"User Authentication"},"193":{"body":"Synapse can be configured to use an OpenID Connect Provider (OP) for authentication, instead of its own local password database. Any OP should work with Synapse, as long as it supports the authorization code flow. 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 secure (HTTPS) origin. A certificate signed with a self-signed, locally trusted CA should work. In that case, start Synapse with a SSL_CERT_FILE environment 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 , such as Github .","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Configuring Synapse to authenticate against an OpenID Connect provider","id":"193","title":"Configuring Synapse to authenticate against an OpenID Connect provider"},"194":{"body":"The OpenID integration in Synapse uses the authlib library, which must be installed as follows: The relevant libraries are included in the Docker images and Debian packages provided 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 maintainer. To enable the OpenID integration, you should then add a section to the oidc_providers setting in your configuration file (or uncomment one of the existing examples). See sample_config.yaml for some sample settings, as well as the text below for example configurations for specific providers.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Preparing Synapse","id":"194","title":"Preparing Synapse"},"195":{"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":"195","title":"Sample configs"},"196":{"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 application 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 Directory (tenant) ID as it will be used in the Azure links. Edit 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":"196","title":"Microsoft Azure Active Directory"},"197":{"body":"Dex is a simple, open-source, certified OpenID Connect Provider. Although it is designed to help building a full-blown provider with an external database, it can be configured with static passwords in a config file. Follow the Getting Started guide to 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":"197","title":"Dex"},"198":{"body":"Keycloak is an opensource IdP maintained by Red Hat. 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 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/auth/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 }}\"","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Keycloak","id":"198","title":"Keycloak"},"199":{"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 to add the preferred_username claim. Code sample function 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} 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":"199","title":"Auth0"},"2":{"body":"Contributions are welcome! Synapse is primarily written in Python . As a developer, you may be interested in the following documentation: Read the Contributing Guide . It is meant to walk new contributors through the process of developing and submitting a change to the Synapse codebase (which is hosted on GitHub ). Set up your development environment , then learn how to lint and test your code. Look at the issue tracker for bugs to fix or features to add. If you're new, it may be best to start with those labeled good first issue . Understand how Synapse is built , how to migrate database schemas , learn about federation and how to set up a local federation for development. We like to keep our git history clean. Learn how to do 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":"Synapse will require the python postgres client library in order to connect to a postgres database. If you are using the matrix.org debian/ubuntu packages , the necessary python library will already be installed, but you will need to ensure the low-level postgres library is installed, which you can do with apt install libpq5. For other pre-built packages, please consult the documentation from the relevant package. If you installed synapse in a virtualenv , you can install the library with: ~/synapse/env/bin/pip install \"matrix-synapse[postgres]\" (substituting the path to your virtualenv for ~/synapse/env, if you used a different path). You will require the postgres development files. These are in the libpq-dev package on Debian-derived distributions.","breadcrumbs":"Using Postgres » Install postgres client libraries","id":"20","title":"Install postgres client libraries"},"200":{"body":"GitHub is a bit special as it is not an OpenID Connect compliant provider, but just a regular OAuth2 provider. The /user API endpoint can be used to retrieve information on the authenticated user. As the Synapse login mechanism needs an attribute to uniquely identify users, and that endpoint does 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":"200","title":"GitHub"},"201":{"body":"Google is an OpenID certified authentication and authorisation provider. Set up a project in the Google API Console (see https://developers.google.com/identity/protocols/oauth2/openid-connect#appsetup). 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\"] user_mapping_provider: config: localpart_template: \"{{ user.given_name|lower }}\" display_name_template: \"{{ user.name }}\" 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":"201","title":"Google"},"202":{"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":"202","title":"Twitch"},"203":{"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":"203","title":"GitLab"},"204":{"body":"Like Github, Facebook provide a custom OAuth2 API rather than an OIDC-compliant one so requires a little more configuration. You will need a Facebook developer account. You can register for one here . On the apps page of the developer console, \"Create App\", and choose \"Build Connected Experiences\". Once the app is created, add \"Facebook Login\" and choose \"Web\". You don't need 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 URL. In the left-hand menu, open \"Settings/Basic\". Here you can copy the \"App ID\" and \"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://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 user_profile_method: \"userinfo_endpoint\" userinfo_endpoint: \"https://graph.facebook.com/v9.0/me?fields=id,name,email,picture\" user_mapping_provider: config: subject_claim: \"id\" display_name_template: \"{{ user.name }}\" Relevant documents: https://developers.facebook.com/docs/facebook-login/manually-build-a-login-flow Using Facebook's Graph API: https://developers.facebook.com/docs/graph-api/using-graph-api/ Reference to the User endpoint: https://developers.facebook.com/docs/graph-api/reference/user","breadcrumbs":"Configuration » User Authentication » Single-Sign On » OpenID Connect » Facebook","id":"204","title":"Facebook"},"205":{"body":"Gitea is, like Github, not an OpenID provider, but just an OAuth2 provider. The /user API endpoint can be used to retrieve information on the authenticated user. As the Synapse login mechanism needs an attribute to uniquely identify users, and that endpoint does 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":"205","title":"Gitea"},"206":{"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":"206","title":"XWiki"},"207":{"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 private 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. https://help.apple.com/developer-account/?lang=en#/dev77c875b7e has more documentation 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":"207","title":"Apple"},"208":{"body":"django-oauth-toolkit is a Django application providing out of the box all the endpoints, data and logic needed 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":"208","title":"Django OAuth Toolkit"},"209":{"body":"A mapping provider is a Python class (loaded via a Python module) that works out how to map attributes of a SSO response to Matrix-specific user attributes. Details such as user ID localpart, displayname, and even avatar URLs are all things that can be mapped from talking to a SSO service. As an example, a SSO service may return the email address \"john.smith@example.com\" for a user, whereas Synapse will need to figure out how to turn that into a displayname when creating a Matrix user for this individual. It may choose John Smith, or Smith, John [Example.com] or any number of variations. As each Synapse configuration may want something different, this is where SAML mapping providers come into play. SSO mapping providers are currently supported for OpenID and SAML SSO configurations. 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 Matrix ID based on the SSO attributes, or if the user should be allowed to choose their own username. In the first case - where users are automatically allocated a Matrix ID - it is the responsibility of the mapping provider to normalise the SSO attributes and map them to a valid Matrix ID. The specification for Matrix IDs has some information about what is considered valid. If the mapping provider does not assign a Matrix ID, then Synapse will automatically 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 Python module. You can retrieve this module from PyPI or elsewhere, but it must be importable via Synapse (e.g. it must be in the same virtualenv as Synapse). The Synapse config is then modified to point to the mapping provider (and optionally provide additional configuration for it).","breadcrumbs":"Configuration » User Authentication » Single-Sign On » SSO Mapping Providers » SSO Mapping Providers","id":"209","title":"SSO Mapping Providers"},"21":{"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 (as shown above), otherwise it will not be able to store UTF8 strings. You may need to enable password authentication so synapse_user can connect to the database. See https://www.postgresql.org/docs/current/auth-pg-hba-conf.html .","breadcrumbs":"Using Postgres » Set up database","id":"21","title":"Set up database"},"210":{"body":"The OpenID mapping provider can be customized by editing the oidc_config.user_mapping_provider.module config option. oidc_config.user_mapping_provider.config allows you to provide custom configuration options to the module. Check with the module's documentation for what options it provides (if any). The options listed by default are for the user mapping provider built in to Synapse. If using a custom module, you should comment 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":"210","title":"OpenID Mapping Providers"},"211":{"body":"A custom mapping provider must specify the following methods: __init__(self, parsed_config) Arguments: parsed_config - A configuration object that is the return value of the parse_config method. You should set any configuration options needed by the module here. parse_config(config) This method should have the @staticmethod decoration. Arguments: config - A dict representing the parsed content of the oidc_config.user_mapping_provider.config homeserver config option. Runs on homeserver startup. Providers should extract and validate any option values they need here. Whatever is returned will be passed back to the user mapping provider module's __init__ method during construction. get_remote_user_id(self, userinfo) Arguments: userinfo - A authlib.oidc.core.claims.UserInfo object to extract user information from. This method must return a string, which is the unique, immutable identifier for the user. Commonly the sub claim of the response. map_user_attributes(self, userinfo, token, failures) This method must be async. Arguments: userinfo - A authlib.oidc.core.claims.UserInfo object to extract user information from. token - A dictionary which includes information necessary to make further requests to the OpenID provider. failures - An int that represents the amount of times the returned mxid localpart mapping has failed. This should be used to create a deduplicated mxid localpart which should be returned instead. For example, if this method returns john.doe as the value of localpart in the returned dict, and that is already taken on the homeserver, this method will be called again with the same parameters but with 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 during a user's first login. Once a localpart has been associated with a remote user ID (see get_remote_user_id) it cannot be updated. displayname: An optional string, the display name for the user. get_extra_attributes(self, userinfo, token) This method must be async. Arguments: userinfo - A authlib.oidc.core.claims.UserInfo object to extract user information from. token - A dictionary which includes information necessary to make further requests to the OpenID provider. Returns a dictionary that is suitable to be serialized to JSON. This will be returned as part of the response during a successful login. Note that care should be taken to not overwrite any of the parameters usually returned as part of the login response .","breadcrumbs":"Configuration » User Authentication » Single-Sign On » SSO Mapping Providers » Building a Custom OpenID Mapping Provider","id":"211","title":"Building a Custom OpenID Mapping Provider"},"212":{"body":"Synapse has a built-in OpenID mapping provider if a custom provider isn't specified 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":"212","title":"Default OpenID Mapping Provider"},"213":{"body":"The SAML mapping provider can be customized by editing the saml2_config.user_mapping_provider.module config option. saml2_config.user_mapping_provider.config allows you to provide custom configuration options to the module. Check with the module's documentation for what options it provides (if any). The options listed by default are for the user mapping provider built in to Synapse. If using a custom module, you should comment 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":"213","title":"SAML Mapping Providers"},"214":{"body":"A custom mapping provider must specify the following methods: __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 the module here. module_api - a synapse.module_api.ModuleApi object which provides the stable API available for extension modules. 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. Runs on homeserver startup. Providers should extract and validate any option values they need here. Whatever is returned will be passed back to the user mapping provider module's __init__ method during construction. 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 response attributes that are required for the module to function, whereas the second set consists of those attributes which can be used if available, but are not necessary. get_remote_user_id(self, saml_response, client_redirect_url) Arguments: saml_response - A saml2.response.AuthnResponse object to extract user information from. client_redirect_url - A string, the URL that the client will be redirected to. This method must return a string, which is the unique, immutable identifier for the user. Commonly the uid claim of the response. saml_response_to_user_attributes(self, saml_response, failures, client_redirect_url) Arguments: saml_response - A saml2.response.AuthnResponse object to extract user information from. failures - An int that represents the amount of times the returned mxid localpart mapping has failed. This should be used to create a deduplicated mxid localpart which should be returned instead. For example, if this method returns john.doe as the value of mxid_localpart in the returned dict, and that is already taken on the homeserver, this method will be called again with the same parameters but with 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 redirected to. This method must return a dictionary, which will then be used by Synapse to 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 during a user's first login. Once a localpart has been associated with a remote user ID (see get_remote_user_id) it cannot be updated. displayname - The displayname of the new user. If not provided, will default to the value of mxid_localpart. emails - A list of emails for the new user. If not provided, will default to an empty list. Alternatively it can raise a synapse.api.errors.RedirectException to redirect the user to another page. This is useful to prompt the user for additional information, e.g. if you want them to provide their own username. It is the responsibility of the mapping provider to either redirect back to client_redirect_url (including any additional information) or to complete registration using methods from the ModuleApi.","breadcrumbs":"Configuration » User Authentication » Single-Sign On » SSO Mapping Providers » Building a Custom SAML Mapping Provider","id":"214","title":"Building a Custom SAML Mapping Provider"},"215":{"body":"Synapse has a built-in SAML mapping provider if a custom provider isn't specified 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":"215","title":"Default SAML Mapping Provider"},"216":{"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\nthis page. Password auth providers offer a way for server administrators to integrate their Synapse installation with an existing authentication system. A password auth provider is a Python class which is dynamically loaded into Synapse, and provides a number of methods by which it can integrate with the authentication system. This document serves as a reference for those looking to implement their own password auth providers. Additionally, here is a list of known password 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":"216","title":"Password auth provider modules"},"217":{"body":"Password auth provider classes must provide the following methods: parse_config(config) This method is passed the config object for this module from the homeserver configuration file. It should perform any appropriate sanity checks on the provided configuration, 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 allows the password provider to check if accounts exist and/or create new ones.","breadcrumbs":"Configuration » User Authentication » Password Auth Providers » Required methods","id":"217","title":"Required methods"},"218":{"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 in turn at initialisation, and a record is then made in the database so 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 login type identifier (such as m.login.password) to an iterable giving the fields which must be provided by the user in the submission to the /login API . These fields are passed in the login_dict dictionary to check_auth. For example, if a password auth provider wants to implement a custom login type of com.example.custom_login, where the client is expected to pass the fields secret1 and secret2, the provider should implement 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 will be called for each login attempt where the login type matches one of the keys returned by get_supported_login_types. It is passed the (possibly unqualified) user field provided by the client, the login type, and a dictionary of login secrets passed by the client. The method should return an Awaitable object, which resolves to the canonical @localpart:domain user ID if authentication is successful, and None if not. Alternatively, the Awaitable can resolve to a (str, func) tuple, in which case the second field is a callback which will be called with the 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 register or log in with a third party identifier, such as email. It is passed the medium (ex. \"email\"), an address (ex. \" jdoe@example.com \") and the user's password. The method should return an Awaitable object, which resolves to a str containing the user's (canonical) User id if authentication 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 providers 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 to 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 passed the qualified user ID, the ID of the deactivated device (if any: access tokens are occasionally created without an associated device ID), and the (now deactivated) access token. It may return an Awaitable object; the logout request will wait for the Awaitable to complete, but the result is ignored.","breadcrumbs":"Configuration » User Authentication » Password Auth Providers » Optional methods","id":"218","title":"Optional methods"},"219":{"body":"Synapse comes with a non-standard login type to support JSON Web Tokens . In general the documentation for the login endpoint is 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 follows: { \"type\": \"org.matrix.login.jwt\", \"token\": \"\"\n} Note that the login type of m.login.jwt is supported, but is deprecated. This will be removed in a future version of Synapse. The token field should include the JSON web token with the following claims: The sub (subject) claim is required and should encode the local part of the user ID. The expiration time (exp), not before time (nbf), and issued at (iat) claims 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. Providing 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":"219","title":"JWT Login Type"},"22":{"body":"When you are ready to start using PostgreSQL, edit the database section in your config file to match the following lines: database: name: psycopg2 args: user: password: database: host: cp_min: 5 cp_max: 10 All key, values in args are passed to the psycopg2.connect(..) function, except keys beginning with cp_, which are consumed by the twisted adbapi connection pool. See the libpq documentation for a list of options which can be passed. You should consider tuning the args.keepalives_* options if there is any danger of the connection between your homeserver and database dropping, otherwise Synapse may block for an extended period while it waits for a response from the database 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":"22","title":"Synapse config"},"220":{"body":"The JSON Web Token integration in Synapse uses the PyJWT library, which must be installed as follows: The relevant libraries are included in the Docker images and Debian packages provided by matrix.org so no further action is needed. If you installed Synapse into a virtualenv, run /path/to/env/bin/pip install synapse[pyjwt] to install the necessary dependencies. For other installation mechanisms, see the documentation provided by the maintainer. To enable the JSON web token integration, you should then add an jwt_config section to your configuration file (or uncomment the enabled: true line in the existing section). See sample_config.yaml for some sample settings.","breadcrumbs":"Configuration » User Authentication » JSON Web Tokens » Preparing Synapse","id":"220","title":"Preparing Synapse"},"221":{"body":"Although JSON Web Tokens are typically generated from an external server, the examples below use PyJWT directly. Configure Synapse with JWT logins, note that this example uses a pre-shared secret and an algorithm of HS256: jwt_config: enabled: true secret: \"my-secret-token\" algorithm: \"HS256\" Generate a JSON web token: $ pyjwt --key=my-secret-token --alg=HS256 encode sub=test-user\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0LXVzZXIifQ.Ag71GT8v01UO3w80aqRPTeuVPBIBZkYhNTJJ-_-zQIc 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":"221","title":"How to test JWT as a developer"},"222":{"body":"A captcha can be enabled on your homeserver to help prevent bots from registering accounts. Synapse currently uses Google's reCAPTCHA service which requires API keys from Google.","breadcrumbs":"Configuration » Registration Captcha » Overview","id":"222","title":"Overview"},"223":{"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. This is the only type of captcha that works with Synapse. Add the public hostname for your server, as set in public_baseurl in 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 configuration 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 captcha can be displayed in any client. If you do not disable this option then you must specify the domains of every client that is allowed to display the CAPTCHA.","breadcrumbs":"Configuration » Registration Captcha » Getting API keys","id":"223","title":"Getting API keys"},"224":{"body":"The reCAPTCHA API requires that the IP address of the user who solved the CAPTCHA is sent. If the client is connecting through a proxy or load balancer, it may be required to use the X-Forwarded-For (XFF) header instead of the origin IP address. This can be configured using the x_forwarded directive in the listeners section of the homeserver.yaml configuration file.","breadcrumbs":"Configuration » Registration Captcha » Configuring IP used for auth","id":"224","title":"Configuring IP used for auth"},"225":{"body":"The registration of new application services depends on the homeserver used. In synapse, you need to create a new configuration file for your AS and add it to the list specified under the app_service_config_files config option 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: url: \nas_token: \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":"225","title":"Registering an Application Service"},"226":{"body":"'Server Notices' are a new feature introduced in Synapse 0.30. They provide a channel 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 they 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 communication mechanisms, so should work with any Matrix client.","breadcrumbs":"Configuration » Server Notices » Server Notices","id":"226","title":"Server Notices"},"227":{"body":"When the user is first sent a server notice, they will get an invitation to a room (typically called 'Server Notices', though this is configurable in homeserver.yaml). They will be unable to reject this invitation - attempts to do so will receive an error. Once they accept the invitation, they will see the notice message in the room history; it will appear to have come from the 'server notices user' (see below). The user is prevented from sending any messages in this room by the power levels. Having joined the room, the user can leave the room if they want. Subsequent server notices will then cause a new room to be created.","breadcrumbs":"Configuration » Server Notices » User experience","id":"227","title":"User experience"},"228":{"body":"Server notices come from a specific user id on the server. Server administrators are free to choose the user id - something like server is suggested, meaning the notices will come from @server:. Once the Server Notices user is configured, that user id becomes a special, privileged user, so administrators should ensure that it is not already allocated . In order to support server notices, it is necessary to add some configuration to the homeserver.yaml file. In particular, you should add a server_notices section, which should look like this: server_notices: system_mxid_localpart: server system_mxid_display_name: \"Server Notices\" system_mxid_avatar_url: \"mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ\" room_name: \"Server Notices\" The only compulsory setting is system_mxid_localpart, which defines the user id of the Server Notices user, as above. room_name defines the name of the room which will be created. system_mxid_display_name and system_mxid_avatar_url can be used to set the displayname and avatar of the Server Notices user.","breadcrumbs":"Configuration » Server Notices » Synapse configuration","id":"228","title":"Synapse configuration"},"229":{"body":"To send server notices to users you can use the admin_api .","breadcrumbs":"Configuration » Server Notices » Sending notices","id":"229","title":"Sending notices"},"23":{"body":"The default settings should be fine for most deployments. For larger scale deployments tuning some of the settings is recommended, details of which can be found at https://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server . In particular, we've found tuning the following values helpful for performance: 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 of free memory the database host has available.","breadcrumbs":"Using Postgres » Tuning Postgres","id":"23","title":"Tuning Postgres"},"230":{"body":"Synapse 0.30 introduces support for tracking whether users have agreed to the terms and conditions set by the administrator of a server - and blocking access to the server until they have. There are several parts to this functionality; each requires some specific configuration in homeserver.yaml to be enabled. Note that various parts of the configuation and this document refer to the \"privacy policy\": agreement with a privacy policy is one particular use of this feature, but of course adminstrators can specify other terms and conditions unrelated to \"privacy\" per se.","breadcrumbs":"Configuration » Consent Tracking » Support in Synapse for tracking agreement to server terms and conditions","id":"230","title":"Support in Synapse for tracking agreement to server terms and conditions"},"231":{"body":"Synapse can be configured to serve the user a simple policy form with an \"accept\" button. Clicking \"Accept\" records the user's acceptance in the database and shows a success page. To enable this, first create templates for the policy and success pages. These should be stored on the local filesystem. These templates use the Jinja2 templating language, and docs/privacy_policy_templates gives 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 template - currently this must always be en (for \"English\"); internationalisation support is intended for the future. The template for the policy itself should be versioned and named according to the version: for example 1.0.html. The version of the policy which the user has 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 templates. version defines the version of the policy which will be served to 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 generate 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 should 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 an error \"Missing string query parameter 'u'\". It is now possible to manually construct URIs where users can give their consent.","breadcrumbs":"Configuration » Consent Tracking » Collecting policy agreement from a user","id":"231","title":"Collecting policy agreement from a user"},"232":{"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 see if an unauthenticated user is viewing the page. This is typically wrapped 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 document. This is what users will be able to see when registering for accounts.","breadcrumbs":"Configuration » Consent Tracking » Enabling consent tracking at registration","id":"232","title":"Enabling consent tracking at registration"},"233":{"body":"It may be useful to manually construct the \"consent URI\" for a given user - for instance, in order to send them an email asking them to consent. To do this, take the base https:///_matrix/consent URL and add the following query parameters: u: the user id of the user. This can either be a full MXID (@user:server.com) or just the localpart (user). h: hex-encoded HMAC-SHA256 of u using the form_secret as a key. It is possible 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 the document from an unauthenticated perspective, such as prior to registration. Therefore, the h parameter is not required in this scenario. To enable this behaviour, set require_at_registration to true in your user_consent config.","breadcrumbs":"Configuration » Consent Tracking » Constructing the consent URI","id":"233","title":"Constructing the consent URI"},"234":{"body":"It is possible to configure Synapse to send a server notice to anybody who has not yet agreed to the current version 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 example: 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 consent uri for that user. ensure that public_baseurl is set in homeserver.yaml, and gives the base URI 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":"234","title":"Sending users a server notice asking them to agree to the policy"},"235":{"body":"Synapse can be configured to block any attempts to join rooms or send messages until the user has given their agreement to the policy. (Joining the server notices 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 consent uri for that user. ensure that public_baseurl is set in homeserver.yaml, and gives the base URI 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":"235","title":"Blocking users from using the server until they agree to the policy"},"236":{"body":"The GET /_matrix/media/r0/preview_url endpoint provides a generic preview API for URLs which outputs Open Graph responses (with some Matrix specific additions). This does have trade-offs compared to other designs: Pros: Simple and flexible; can be used by any clients at any point Cons: If each homeserver provides one of these independently, all the HSes in a room may needlessly DoS the target URI The URL metadata must be stored somewhere, rather than just using Matrix itself to store the media. Matrix cannot be used to distribute the metadata between homeservers. When Synapse is asked to preview a URL it does the following: Checks against a URL blacklist (defined as url_preview_url_blacklist in the config). Checks the in-memory cache by URLs and returns the result if it exists. (This is also used to de-duplicate processing of multiple in-flight requests at once.) Kicks off a background process to generate a preview: Checks the database cache by URL and timestamp and returns the result if it has not expired and was successful (a 2xx return code). Checks if the URL matches an oEmbed pattern. If it does, update the URL to download. Downloads the URL and stores it into a file via the media storage provider and saves the local media metadata. If the media is an image: Generates thumbnails. Generates an Open Graph response based on image properties. If the media is HTML: Decodes the HTML via the stored file. Generates an Open Graph response from the HTML. If an image exists in the Open Graph response: Downloads the URL and stores it into a file via the media storage provider and saves the local media metadata. Generates thumbnails. Updates the Open Graph response based on image properties. If the media is JSON and an oEmbed URL was found: Convert the oEmbed response to an Open Graph response. If a thumbnail or image is in the oEmbed response: Downloads the URL and stores it into a file via the media storage provider and saves the local media metadata. Generates thumbnails. Updates the Open Graph response based on image properties. Stores the result in the database cache. Returns the result. The in-memory cache expires after 1 hour. Expired entries in the database cache (and their associated media files) are deleted every 10 seconds. The default expiration time is 1 hour from download.","breadcrumbs":"Configuration » URL Previews » URL Previews","id":"236","title":"URL Previews"},"237":{"body":"The user directory is currently maintained based on the 'visible' users on this particular server - i.e. ones which your account shares a room with, or who are present in a publicly viewable room present on the server. The directory info is stored in various tables, which can (typically after DB corruption) get stale or out of sync. If this happens, for now the solution to fix it is to execute the SQL here and then restart synapse. This should then start a background task to flush the current tables and regenerate the directory.","breadcrumbs":"Configuration » User Directory » User Directory API Implementation","id":"237","title":"User Directory API Implementation"},"238":{"body":"There are five relevant tables that collectively form the \"user directory\". Three of them track a master list of all the users we could search for. The last two (collectively called the \"search tables\") track who can see who. From all of these tables we exclude three types of local user: support users appservice users deactivated users user_directory. This contains the user_id, display name and avatar we'll return when you search the directory. Because there's only one directory entry per user, it's important that we only ever put publicly visible names here. Otherwise we might leak a private nickname 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 column that enables full text search based on user ids and display names. Different schemas for SQLite and Postgres with different code paths to match. Indexed on the full text search data. Indexed on users. user_directory_stream_pos. When the initial background update to populate the directory is complete, we record a stream position here. This indicates that synapse should now listen for room changes and incrementally update the directory where necessary. users_in_public_rooms. Contains associations between users and the public rooms they're in. Used to determine which users are in public rooms and should be publicly visible in the directory. users_who_share_private_rooms. Rows are triples (L, M, room id) where L is a local user and M is a local or remote user. L and M should be different, but this isn't enforced by a constraint.","breadcrumbs":"Configuration » User Directory » Data model","id":"238","title":"Data model"},"239":{"body":"Synapse admins can enable support for message retention policies on their homeserver. Message retention policies exist at a room level, follow the semantics described in MSC1763 , and allow server and room admins to configure how long messages should be kept in a homeserver's database before being purged from it. Please note that, as this feature isn't part of the Matrix specification yet, this implementation is to be considered as experimental. A message retention policy is mainly defined by its max_lifetime parameter, which defines how long a message can be kept around after it was sent to the room. If a room doesn't have a message retention policy, and there's no default one for a given server, then no message sent in that room is ever purged on that server. MSC1763 also specifies semantics for a min_lifetime parameter which defines the amount of time after which an event can get purged (after it was sent to the room), but Synapse doesn't currently support it beyond 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 plus 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\" section) and is removed from Synapse's database. Since purge jobs don't run continuously, this means that an event might stay in a server's database for longer than the value for max_lifetime in the room would allow, though hidden from clients. Similarly, if a server (with support for message retention policies enabled) receives from another server an event that should have been purged according to its room's policy, then the receiving server will process and store that event until it's picked up by the next purge job, though it will always hide it from clients. Synapse requires at least one message in each room, so it will never delete the last message in a room. It will, however, hide it from clients.","breadcrumbs":"Configuration » Message Retention Policies » Message retention policies","id":"239","title":"Message retention policies"},"24":{"body":"","breadcrumbs":"Using Postgres » Porting from SQLite","id":"24","title":"Porting from SQLite"},"240":{"body":"Support for this feature can be enabled and configured in the retention section of the Synapse configuration file (see the sample file ). To enable support for message retention policies, set the setting enabled in this section to true.","breadcrumbs":"Configuration » Message Retention Policies » Server configuration","id":"240","title":"Server configuration"},"241":{"body":"A default message retention policy is a policy defined in Synapse's configuration that is used by Synapse for every room that doesn't have a message retention policy configured in its state. This allows server admins to ensure that messages are never kept indefinitely in a server's database. A default policy can be defined as such, in the retention section of the configuration file: default_policy: min_lifetime: 1d max_lifetime: 1y Here, min_lifetime and max_lifetime have the same meaning and level of support as previously described. They can be expressed either as a duration (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":"241","title":"Default policy"},"242":{"body":"Purge jobs are the jobs that Synapse runs in the background to purge expired events from the database. They are only run if support for message retention policies is enabled in the server's configuration. If no configuration for purge jobs is configured by the server admin, Synapse will use a default configuration, which is described in the sample configuration file . Some server admins might want a finer control on when events are removed depending 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 file. 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 which 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 policy's max_lifetime is greater than a week. Note that this example is tailored to show different configurations and features slightly more jobs than it's probably necessary (in practice, a server admin would probably consider it better to replace the two last jobs with one that runs once a day and handles rooms which which policy's max_lifetime is greater than 3 days). Keep in mind, when configuring these jobs, that a purge job can become quite heavy on the server if it targets many rooms, therefore prefer having jobs with a low interval that target a limited set of rooms. Also make sure to include a job with no minimum and one with no maximum to make sure your configuration handles every policy. As previously mentioned in this documentation, while a purge job that runs e.g. every day means that an expired event might stay in the database for up to a day after its expiry, Synapse hides expired events from clients as soon as they expire, so the event is not visible to local users between its expiry date and the moment it gets purged from the server's database.","breadcrumbs":"Configuration » Message Retention Policies » Purge jobs","id":"242","title":"Purge jobs"},"243":{"body":"Server admins can set limits on the values of max_lifetime to use when purging old events in a room. These limits can be defined as such in the retention section of the configuration file: allowed_lifetime_min: 1d allowed_lifetime_max: 1y The limits are considered when running purge jobs. If necessary, the effective value of max_lifetime will be brought between allowed_lifetime_min and allowed_lifetime_max (inclusive). This means that, if the value of max_lifetime defined in the room's state is lower than allowed_lifetime_min, the value of allowed_lifetime_min will be used instead. Likewise, if the value of max_lifetime is higher than allowed_lifetime_max, the value of allowed_lifetime_max will be used instead. In the example above, we ensure Synapse never deletes events that are less than one day old, and that it always deletes events that are over a year old. 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 process applies. Both parameters are optional; if one is omitted Synapse won't use it to adjust the effective value of max_lifetime. Like other settings in this section, these parameters can be expressed either as a duration or as a number of milliseconds.","breadcrumbs":"Configuration » Message Retention Policies » Lifetime limits","id":"243","title":"Lifetime limits"},"244":{"body":"To configure a room's message retention policy, a room's admin or moderator 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 meaning as previously described, and needs to be expressed in milliseconds. The event's content can also include a min_lifetime parameter, which has the same meaning and limited support as previously described. Note that over every server in the room, only the ones with support for message retention policies will actually remove expired events. This support is currently not enabled by default in Synapse.","breadcrumbs":"Configuration » Message Retention Policies » Room configuration","id":"244","title":"Room configuration"},"245":{"body":"While purge jobs actually delete data from the database, the disk space used by the database might not decrease immediately on the database's host. However, even though the database engine won't free up the disk space, 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 operating 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":"245","title":"Note on reclaiming disk space"},"246":{"body":"Synapse supports extending its functionality by configuring external modules. Note : When using third-party modules, you effectively allow someone else to run custom code on your Synapse homeserver. Server admins are encouraged to verify the provenance of the modules they use on their homeserver and make sure the modules aren't running malicious code on their instance.","breadcrumbs":"Configuration » Pluggable Modules » Modules","id":"246","title":"Modules"},"247":{"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 information for a given module should be available in the module's own documentation.","breadcrumbs":"Configuration » Pluggable Modules » Using modules","id":"247","title":"Using modules"},"248":{"body":"The order in which modules are listed in this section is important. When processing an action that can be handled by several modules, Synapse will always prioritise the module that 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 that appears first is used. If several modules try to register a handler for the same HTTP path, only the handler registered by the module that appears first is used. Handlers registered by the other module(s) are ignored and Synapse will log a warning message about them. Note that Synapse doesn't allow multiple modules implementing authentication checkers via the password auth provider feature for the same login type with different fields. If this happens, Synapse will refuse to start.","breadcrumbs":"Configuration » Pluggable Modules » Using multiple modules","id":"248","title":"Using multiple modules"},"249":{"body":"We are currently in the process of migrating module interfaces to this system. While some interfaces might be compatible with it, others still require configuring modules in another 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":"249","title":"Current status"},"25":{"body":"The script synapse_port_db allows porting an existing synapse server backed by SQLite to using PostgreSQL. This is done in as a two phase process: Copy the existing SQLite database to a separate location and run the port script against that offline database. Shut down the server. Rerun the port script to port any data that has come in since taking the first snapshot. Restart server against the PostgreSQL database. The port script is designed to be run repeatedly against newer snapshots of the SQLite database file. This makes it safe to repeat step 1 if there was a delay between taking the previous snapshot and being ready to do step 2. It is safe to at any time kill the port script and restart it. Note that the database may take up significantly more (25% - 100% more) space on disk after porting to Postgres.","breadcrumbs":"Using Postgres » Overview","id":"25","title":"Overview"},"250":{"body":"A module is a Python class that uses Synapse's module API to interact with the homeserver. It can register callbacks that Synapse will call on specific operations, as well 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 the synapse.module_api.ModuleApi class. The configuration is a dictionary, and is either the output of the module's parse_config static method (see below), or the configuration 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":"250","title":"Writing a module"},"251":{"body":"If Synapse is running with other modules configured, the order each module appears in within the modules section of the Synapse configuration file might restrict what it can or cannot register. See this section for more information. On top of the rules listed in the link above, if a callback returns a value that should cause the current operation to fail (e.g. if a callback checking an event returns with a value that should cause the event to be denied), Synapse will fail the operation and ignore any subsequent callbacks that should have been run after this one. The documentation for each callback mentions how Synapse behaves when multiple modules implement it.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » When Synapse runs with several modules configured","id":"251","title":"When Synapse runs with several modules configured"},"252":{"body":"A module can implement the following static method: @staticmethod\ndef parse_config(config: dict) -> dict This method is given a dictionary resulting from parsing the YAML configuration for the module. It may modify it (for example by parsing durations expressed as strings (e.g. \"5d\") into milliseconds, etc.), and return the modified dictionary. It may also verify that 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":"252","title":"Handling the module's configuration"},"253":{"body":"Modules can register web resources onto Synapse's web server using the following module API 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 register a resource for the path /_synapse/client/my_super_module/say_hello, Synapse will serve it at http(s)://[HS_URL]/_synapse/client/my_super_module/say_hello. Note that Synapse does not allow registering resources for several sub-paths in the /_matrix namespace (such as anything under /_matrix/client for example). It is strongly recommended that modules register their web resources under the /_synapse/client namespace. The provided resource is a Python class that implements Twisted's IResource interface (such as Resource ). Only one resource can be registered for a given path. If several modules attempt to register a resource for the same path, the module that appears first in Synapse's configuration 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":"253","title":"Registering a web resource"},"254":{"body":"Modules can use Synapse's module API to register callbacks. Callbacks are functions that Synapse will call when performing specific actions. Callbacks must be asynchronous, and are split in categories. A single module may implement callbacks from multiple categories, and is under no obligation to implement all callbacks from the categories it registers callbacks for. Modules can register callbacks using one of the module API's register_[...]_callbacks methods. The callback functions are passed to these methods as keyword arguments, with the callback name as the argument name and the function as its value. This is demonstrated in the example below. 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":"254","title":"Registering a callback"},"255":{"body":"Spam checker callbacks allow module developers to implement spam mitigation actions for Synapse 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":"255","title":"Spam checker callbacks"},"256":{"body":"The available spam checker callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » Callbacks","id":"256","title":"Callbacks"},"257":{"body":"First introduced in Synapse v1.37.0 async def check_event_for_spam(event: \"synapse.events.EventBase\") -> Union[bool, str] Called when receiving an event from a client or via federation. The module can return either a bool to indicate whether the event must be rejected because of spam, or a str to indicate the event must be rejected because of spam and to give a rejection reason to forward to clients. If multiple modules implement this callback, they will be considered in order. If a callback returns False, Synapse falls through to the next one. The value of the first callback that does not return False will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » check_event_for_spam","id":"257","title":"check_event_for_spam"},"258":{"body":"First introduced in Synapse v1.37.0 async def user_may_join_room(user: str, room: str, is_invited: bool) -> bool Called when a user is trying to join a room. The module must return a bool to indicate whether the user can join the 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 currently has a pending invite in the room. This callback isn't called if the join is performed by a server administrator, or in the context of a room creation. If multiple modules implement this callback, they will be considered in order. If a callback returns True, Synapse falls through to the next one. The value of the first callback that does not return True will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_join_room","id":"258","title":"user_may_join_room"},"259":{"body":"First introduced in Synapse v1.37.0 async def user_may_invite(inviter: str, invitee: str, room_id: str) -> bool Called when processing an invitation. The module must return a bool indicating whether the inviter can invite the invitee to the given room. Both inviter and invitee are represented by their Matrix user ID (e.g. @alice:example.com). If multiple modules implement this callback, they will be considered in order. If a callback returns True, Synapse falls through to the next one. The value of the first callback that does not return True will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_invite","id":"259","title":"user_may_invite"},"26":{"body":"Firstly, shut down the currently running synapse server and copy its database file (typically homeserver.db) to another location. Once the copy is complete, restart synapse. For instance: ./synctl stop\ncp homeserver.db homeserver.db.snapshot\n./synctl 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 above and with the SQLite snapshot located at homeserver.db.snapshot simply run: synapse_port_db --sqlite-database homeserver.db.snapshot \\ --postgres-config homeserver-postgres.yaml The flag --curses displays a coloured curses progress UI. If the script took a long time to complete, or time has otherwise passed since the original snapshot was taken, repeat the previous steps with a newer snapshot. To complete the conversion shut down the synapse server and run the port script one last time, e.g. if the SQLite database is at homeserver.db run: synapse_port_db --sqlite-database homeserver.db \\ --postgres-config homeserver-postgres.yaml Once that has completed, change the synapse config to point at the PostgreSQL database configuration file homeserver-postgres.yaml: ./synctl stop\nmv homeserver.yaml homeserver-old-sqlite.yaml\nmv homeserver-postgres.yaml homeserver.yaml\n./synctl start Synapse should now be running against PostgreSQL.","breadcrumbs":"Using Postgres » Using the port script","id":"26","title":"Using the port script"},"260":{"body":"First introduced in Synapse v1.45.0 async def user_may_send_3pid_invite( inviter: str, medium: str, address: str, room_id: str,\n) -> bool Called when processing an invitation using a third-party identifier (also called a 3PID, e.g. an email address or a phone number). The module must return a bool indicating whether the inviter can invite the invitee to the given room. The inviter is represented by their Matrix user ID (e.g. @alice:example.com), and the invitee is represented by its medium (e.g. \"email\") and its address (e.g. alice@example.com). See the Matrix specification for 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. If multiple modules implement this callback, they will be considered in order. If a callback returns True, Synapse falls through to the next one. The value of the first callback that does not return True will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_send_3pid_invite","id":"260","title":"user_may_send_3pid_invite"},"261":{"body":"First introduced in Synapse v1.37.0 async def user_may_create_room(user: str) -> bool Called when processing a room creation request. The module must return a bool indicating whether the given user (represented by their Matrix user ID) is allowed to create a room. If multiple modules implement this callback, they will be considered in order. If a callback returns True, Synapse falls through to the next one. The value of the first callback that does not return True will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_create_room","id":"261","title":"user_may_create_room"},"262":{"body":"First introduced in Synapse v1.44.0 async def user_may_create_room_with_invites( user: str, invites: List[str], threepid_invites: List[Dict[str, str]],\n) -> bool Called when processing a room creation request (right after user_may_create_room). The module is given the Matrix user ID of the user trying to create a room, as well as a list of Matrix users to invite and a list of third-party identifiers (3PID, e.g. email addresses) to invite. An invited Matrix user to invite is represented by their Matrix user IDs, and an invited 3PIDs is represented by a dict that includes the 3PID medium (e.g. \"email\") through its medium key and its address (e.g. \"alice@example.com\") through its address key. See the Matrix specification for more information regarding third-party identifiers. If no invite and/or 3PID invite were specified in the room creation request, the corresponding list(s) will be empty. Note : This callback is not called when a room is cloned (e.g. during a room upgrade) since no invites are sent when cloning a room. To cover this case, modules also need to implement user_may_create_room. If multiple modules implement this callback, they will be considered in order. If a callback returns True, Synapse falls through to the next one. The value of the first callback that does not return True will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_create_room_with_invites","id":"262","title":"user_may_create_room_with_invites"},"263":{"body":"First introduced in Synapse v1.37.0 async def user_may_create_room_alias(user: str, room_alias: \"synapse.types.RoomAlias\") -> bool Called when trying to associate an alias with an existing room. The module must return a bool indicating whether the given user (represented by their Matrix user ID) is allowed to set the given alias. If multiple modules implement this callback, they will be considered in order. If a callback returns True, Synapse falls through to the next one. The value of the first callback that does not return True will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_create_room_alias","id":"263","title":"user_may_create_room_alias"},"264":{"body":"First introduced in Synapse v1.37.0 async def user_may_publish_room(user: str, room_id: str) -> bool Called when trying to publish a room to the homeserver's public rooms directory. The module must return a bool indicating whether the given user (represented by their Matrix user ID) is allowed to publish the given room. If multiple modules implement this callback, they will be considered in order. If a callback returns True, Synapse falls through to the next one. The value of the first callback that does not return True will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » user_may_publish_room","id":"264","title":"user_may_publish_room"},"265":{"body":"First introduced in Synapse v1.37.0 async def check_username_for_spam(user_profile: Dict[str, str]) -> bool Called when computing search results in the user directory. The module must return a bool indicating whether the given user profile can appear in search results. The profile is represented as a dictionary with the following keys: user_id: The Matrix ID for this user. display_name: The user's display name. avatar_url: The mxc:// URL to the user's avatar. The module is given a copy of the original dictionary, so modifying it from within the module cannot modify a user's profile when included in user directory search results. If multiple modules implement this callback, they will be considered in order. If a callback returns False, Synapse falls through to the next one. The value of the first callback that does not return False will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » check_username_for_spam","id":"265","title":"check_username_for_spam"},"266":{"body":"First introduced in Synapse v1.37.0 async def check_registration_for_spam( email_threepid: Optional[dict], username: Optional[str], request_info: Collection[Tuple[str, str]], auth_provider_id: Optional[str] = None,\n) -> \"synapse.spam_checker_api.RegistrationBehaviour\" Called when registering a new user. The module must return a RegistrationBehaviour indicating whether the registration can go through or must be denied, or whether the user may 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 Synapse will generate one later. request_info: A collection of tuples, which first item is a user agent, and which second item is an IP address. These user agents and IP addresses are the ones that were used 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 callback returns RegistrationBehaviour.ALLOW, Synapse falls through to the next one. The value of the first callback that does not return RegistrationBehaviour.ALLOW will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » check_registration_for_spam","id":"266","title":"check_registration_for_spam"},"267":{"body":"First introduced in Synapse v1.37.0 async def check_media_file_for_spam( file_wrapper: \"synapse.rest.media.v1.media_storage.ReadableFileWrapper\", file_info: \"synapse.rest.media.v1._base.FileInfo\",\n) -> bool Called when storing a local or remote file. The module must return a boolean indicating whether the given file can be stored in the homeserver's media store. If multiple modules implement this callback, they will be considered in order. If a callback returns False, Synapse falls through to the next one. The value of the first callback that does not return False will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » check_media_file_for_spam","id":"267","title":"check_media_file_for_spam"},"268":{"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 mentioned 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 whether 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\") -> Union[bool, str]: return event.sender not in self.evil_users","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Spam checker callbacks » Example","id":"268","title":"Example"},"269":{"body":"Third party rules callbacks allow module developers to add extra checks to verify the validity of incoming events. Third party event rules callbacks can be registered using the 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":"269","title":"Third party rules callbacks"},"27":{"body":"","breadcrumbs":"Using Postgres » Troubleshooting","id":"27","title":"Troubleshooting"},"270":{"body":"The available third party rules callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » Callbacks","id":"270","title":"Callbacks"},"271":{"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, Optional[dict]] This callback is very experimental and can and will break without notice. Module developers are 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 representing the current state of the room the event is being sent into. A StateMap is a dictionary that maps tuples containing an event type and a state key to the corresponding state event. For example retrieving the room's m.room.create event from the state_events argument would look like this: state_events.get((\"m.room.create\", \"\")). The module must return a boolean indicating whether the event can be allowed. Note that this callback function processes incoming events coming via federation traffic (on top of client traffic). This means denying an event might cause the local copy of the room's history to diverge from that of remote servers. This may cause federation issues in the room. It is strongly recommended to only deny events using this callback function if the sender is a local user, or in a private federation in which all servers 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 event with new data by returning the new event's data as a dictionary. In order to do that, it is recommended the module calls event.get_dict() to get the current event as a dictionary, and modify the returned dictionary accordingly. Note that replacing the event only works for events sent by local users, not for events received over federation. If multiple modules implement this callback, they will be considered in order. If a callback returns True, Synapse falls through to the next one. The value of the first callback that does not return True will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » check_event_allowed","id":"271","title":"check_event_allowed"},"272":{"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 performing the request, a dictionary representing the room creation request's JSON body (see the spec for a list of possible parameters), and a boolean indicating whether the user performing the request is a server admin. Modules can modify the request_content (by e.g. adding events to its initial_state), or 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 callback returns without raising an exception, Synapse falls through to the next one. The room creation will be forbidden as soon as one of the callbacks raises an exception. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » on_create_room","id":"272","title":"on_create_room"},"273":{"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). The 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 callback returns True, Synapse falls through to the next one. The value of the first callback that does not return True will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » check_threepid_can_be_invited","id":"273","title":"check_threepid_can_be_invited"},"274":{"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 visibility is a string that's either \"public\" or \"private\". The module must return a boolean indicating whether the change can go through. If multiple modules implement this callback, they will be considered in order. If a callback returns True, Synapse falls through to the next one. The value of the first callback that does not return True will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Third-party rules callbacks » check_visibility_can_be_modified","id":"274","title":"check_visibility_can_be_modified"},"275":{"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, Optional[dict]]: 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":"275","title":"Example"},"276":{"body":"Presence router callbacks allow module developers to specify additional users (local or remote) to receive certain presence updates from local users. 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":"276","title":"Presence router callbacks"},"277":{"body":"The available presence router callbacks are:","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Presence router callbacks » Callbacks","id":"277","title":"Callbacks"},"278":{"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 be used to instruct the server to forward that presence state to specific users. The module must 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 by the callbacks. If multiple callbacks return a dictionary containing the same key, Synapse 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":"278","title":"get_users_for_states"},"279":{"body":"First introduced in Synapse v1.42.0 async def get_interested_users( user_id: str\n) -> Union[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 callback should return complementary results to get_users_for_state or the presence information may not be properly forwarded. The callback is given the Matrix user ID for a local user that is requesting presence data and should return the Matrix user IDs of the users whose presence state they are allowed to query. The returned users can be local or remote. Alternatively the callback can return synapse.module_api.PRESENCE_ALL_USERS to indicate that the user should receive updates from all known users. If multiple modules implement this callback, they will be considered in order. Synapse calls each callback one by one, and use a concatenation of all the sets returned by the callbacks. If one callback returns synapse.module_api.PRESENCE_ALL_USERS, Synapse uses this value instead. If this happens, Synapse does not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Presence router callbacks » get_interested_users","id":"279","title":"get_interested_users"},"28":{"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: section 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 have to be added to homeserver.yaml. But the following does need to be added to 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 new line, it is inserted before: host all all ::1/128 ident","breadcrumbs":"Using Postgres » Alternative auth methods","id":"28","title":"Alternative auth methods"},"280":{"body":"The example below is a module that implements both presence router callbacks, and ensures that @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 Dict, Iterable, Set, Union 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, ) -> Union[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":"280","title":"Example"},"281":{"body":"Account validity callbacks allow module developers to add extra steps to verify the validity on an account, i.e. see if a user can be granted access to their account on the Synapse 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":"281","title":"Account validity callbacks"},"282":{"body":"First introduced in Synapse v1.39.0 async def is_user_expired(user: str) -> Optional[bool] Called when processing any authenticated request (except for logout requests). The module can return a bool to indicate whether the user has expired and should be locked out of their account, or None if the module wasn't able to figure it out. The user is represented 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 invalidate the user's access token. If multiple modules implement this callback, they will be considered in order. If a callback returns None, Synapse falls through to the next one. The value of the first callback that does not return None will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Account validity callbacks » is_user_expired","id":"282","title":"is_user_expired"},"283":{"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 operations to keep track of them. (e.g. add them to a database table). The user is represented 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":"283","title":"on_user_registration"},"284":{"body":"Password auth providers offer a way for server administrators to integrate their Synapse installation with an external authentication system. The callbacks can be registered 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":"284","title":"Password auth provider callbacks"},"285":{"body":"","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » Callbacks","id":"285","title":"Callbacks"},"286":{"body":"First introduced in Synapse v1.46.0 auth_checkers: Dict[Tuple[str,Tuple], Callable] A dict mapping from tuples of a login type identifier (such as m.login.password) and a tuple of field names (such as (\"password\", \"secret_thing\")) to authentication checking callbacks, which should be of the following form: async def check_auth( user: str, login_type: str, login_dict: \"synapse.module_api.JsonDict\",\n) -> Optional[ Tuple[ str, Optional[Callable[[\"synapse.module_api.LoginResponse\"], Awaitable[None]]] ]\n] The login type and field names should be provided by the user in the request to the /login API. The Matrix specification defines 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 the 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 instead. If the authentication is unsuccessful, the module must return None. If multiple modules register an auth checker for the same login type but with different fields, Synapse will refuse to start. If multiple modules register an auth checker for the same login type with the same fields, then the callbacks will be executed in order, until one returns a Matrix User ID (and optionally a callback). In that case, the return value of that callback will be accepted and subsequent callbacks will not be fired. If every callback returns None, then the authentication fails.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » auth_checkers","id":"286","title":"auth_checkers"},"287":{"body":"First introduced in Synapse v1.46.0 async def check_3pid_auth( medium: str, address: str, password: str,\n) -> Optional[ Tuple[ str, Optional[Callable[[\"synapse.module_api.LoginResponse\"], Awaitable[None]]] ]\n] Called when a user attempts to register or log in with a third party identifier, such as email. It is passed the medium (eg. email), an address (eg. jdoe@example.com) and 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. If 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 callback returns None, Synapse falls through to the next one. The value of the first callback that does not return None will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback. If every callback return None, the authentication is denied.","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » check_3pid_auth","id":"287","title":"check_3pid_auth"},"288":{"body":"First introduced in Synapse v1.46.0 async def on_logged_out( user_id: str, device_id: Optional[str], access_token: str\n) -> None Called during a logout request for a user. It is passed the qualified user ID, the ID of the deactivated device (if any: access tokens are occasionally created without an associated device ID), and the (now deactivated) access token. 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":"288","title":"on_logged_out"},"289":{"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\", ) -> Optional[ Tuple[ str, Optional[Callable[[\"synapse.module_api.LoginResponse\"], Awaitable[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) async def check_pass( self, username: str, login_type: str, login_dict: \"synapse.module_api.JsonDict\", ) -> Optional[ Tuple[ str, Optional[Callable[[\"synapse.module_api.LoginResponse\"], Awaitable[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)","breadcrumbs":"Configuration » Pluggable Modules » Writing a module » Password auth provider callbacks » Example","id":"289","title":"Example"},"29":{"body":"Synapse will refuse to set up a new database if it has the wrong values of COLLATE and CTYPE set, and will log warnings on existing databases. Using different locales can cause issues if the locale library is updated from underneath the database, or if a different version of the locale is used on any replicas. The safest way to fix the issue is to dump the database and recreate it with the correct locale parameter (as shown above). It is also possible to change the parameters on a live database and run a REINDEX on the entire database, however extreme care must be taken to avoid database corruption. Note that the above may fail with an error about duplicate rows if corruption has already occurred, and such duplicate rows will need to be manually removed.","breadcrumbs":"Using Postgres » Fixing incorrect COLLATE or CTYPE","id":"29","title":"Fixing incorrect COLLATE or CTYPE"},"290":{"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 from the ModuleApi class in the module's __init__ method (see this section for more info). Additionally, if the module is packaged with an additional web resource, the module should register this resource in its __init__ method using the register_web_resource method from the ModuleApi class (see this section for more info). There is no longer a get_db_schema_files callback provided for password auth provider modules. Any changes 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 use the new modules section in Synapse's configuration file (see this section for 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":"290","title":"Porting an existing module that uses the old interface"},"291":{"body":"For small instances it recommended to run Synapse in the default monolith mode. For larger instances where performance is a concern it can be helpful to split out functionality into multiple separate python processes. These processes are called 'workers', and are (eventually) intended to scale horizontally independently. Synapse's worker support is under active development and subject to change as we attempt to rapidly scale ever larger Synapse instances. However we are documenting it here to help admins needing a highly scalable Synapse instance similar to the one running matrix.org. All processes continue to share the same database instance, and as such, workers only work with PostgreSQL-based Synapse deployments. SQLite should only be used for demo purposes and any admin considering workers should already be running PostgreSQL. See also Matrix.org blog post for a higher level overview.","breadcrumbs":"Configuration » Workers » Scaling synapse via workers","id":"291","title":"Scaling synapse via workers"},"292":{"body":"The processes communicate with each other via a Synapse-specific protocol called 'replication' (analogous to MySQL- or Postgres-style database replication) which feeds streams of newly written data between processes so they can be kept in sync with the database state. When configured to do so, Synapse uses a Redis pub/sub channel to send the replication stream between all configured Synapse processes. Additionally, processes may make HTTP requests to each other, primarily for operations which need to wait for a reply ─ such as sending an event. Redis support was added in v1.13.0 with it becoming the recommended method in v1.18.0. It replaced the old direct TCP connections (which is deprecated as of v1.18.0) to the main process. With Redis, rather than all the workers connecting to the main process, all the workers and the main process connect to Redis, which relays replication commands between processes. This can give a significant cpu saving on the main process and will be a prerequisite for upcoming performance improvements. If Redis support is enabled Synapse will use it as a shared cache, as well as a pub/sub mechanism. See the Architectural diagram section at the end for a visualisation of what this looks like.","breadcrumbs":"Configuration » Workers » Main process/worker communication","id":"292","title":"Main process/worker communication"},"293":{"body":"A Redis server is required to manage the communication between the processes. The Redis server should be installed following the normal procedure for your distribution (e.g. apt install redis-server on Debian). It is safe to use an existing Redis deployment if you have one. Once installed, check that Redis is running and accessible from the host running Synapse, for example by executing echo PING | nc -q1 localhost 6379 and seeing a response of +PONG. The appropriate dependencies must also be installed for Synapse. If using a virtualenv, 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 packages from matrix.org and in the docker images at https://hub.docker.com/r/matrixdotorg/synapse/. To make effective use of the workers, you will need to configure an HTTP reverse-proxy such as nginx or haproxy, which will direct incoming requests to the correct worker, or to the main synapse instance. See the reverse proxy documentation for information on setting up a reverse proxy. When using workers, each worker process has its own configuration file which contains settings specific to that worker, such as the HTTP listener that it provides (if any), logging configuration, etc. Normally, the worker processes are configured to read from a shared configuration file as well as the worker-specific configuration files. This makes it easier to keep common configuration settings synchronised across all the processes. The main process is somewhat special in this respect: it does not normally need its own configuration file and can take all of its configuration from the shared configuration file.","breadcrumbs":"Configuration » Workers » Setting up workers","id":"293","title":"Setting up workers"},"294":{"body":"Normally, only a couple of changes are needed to make an existing configuration file suitable for use with workers. First, you need to enable an \"HTTP replication listener\" for the main process; and secondly, you need to enable redis-based replication. Optionally, a shared secret can 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 See the sample config for the full documentation of each option. Under no circumstances should the replication listener be exposed to the public internet; it has no authentication and is unencrypted.","breadcrumbs":"Configuration » Workers » Shared configuration","id":"294","title":"Shared configuration"},"295":{"body":"In the config file for each worker, you must specify the type of worker application (worker_app), and you should specify a unique name for the worker (worker_name). The currently available worker applications are listed below. You must also specify the HTTP replication endpoint that it should talk to on the main synapse process. worker_replication_host should specify the host of the main synapse and worker_replication_http_port should point to the HTTP replication port. If the worker will handle HTTP requests then the worker_listeners option should be set with a http listener, in the same way as the listeners option in the shared config. For example: worker_app: synapse.app.generic_worker\nworker_name: worker1 # The replication listener on the main synapse process.\nworker_replication_host: 127.0.0.1\nworker_replication_http_port: 9093 worker_listeners: - type: http port: 8083 resources: - names: - client - federation worker_log_config: /home/matrix/synapse/config/worker1_log_config.yaml ...is a full configuration for a generic worker instance, which will expose a plain 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 endpoints to the worker (localhost:8083 in the above example).","breadcrumbs":"Configuration » Workers » Worker configuration","id":"295","title":"Worker configuration"},"296":{"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 recommend 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":"296","title":"Running Synapse with workers"},"297":{"body":"","breadcrumbs":"Configuration » Workers » Available worker applications","id":"297","title":"Available worker applications"},"298":{"body":"This worker can handle API requests matching the following regular expressions: # Sync requests\n^/_matrix/client/(v2_alpha|r0)/sync$\n^/_matrix/client/(api/v1|v2_alpha|r0)/events$\n^/_matrix/client/(api/v1|r0)/initialSync$\n^/_matrix/client/(api/v1|r0)/rooms/[^/]+/initialSync$ # Federation requests\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/send_join/\n^/_matrix/federation/v2/send_join/\n^/_matrix/federation/v1/send_leave/\n^/_matrix/federation/v2/send_leave/\n^/_matrix/federation/v1/invite/\n^/_matrix/federation/v2/invite/\n^/_matrix/federation/v1/query_auth/\n^/_matrix/federation/v1/event_auth/\n^/_matrix/federation/v1/exchange_third_party_invite/\n^/_matrix/federation/v1/user/devices/\n^/_matrix/federation/v1/get_groups_publicised$\n^/_matrix/key/v2/query\n^/_matrix/federation/unstable/org.matrix.msc2946/spaces/\n^/_matrix/federation/unstable/org.matrix.msc2946/hierarchy/ # Inbound federation transaction request\n^/_matrix/federation/v1/send/ # Client API requests\n^/_matrix/client/(api/v1|r0|unstable)/createRoom$\n^/_matrix/client/(api/v1|r0|unstable)/publicRooms$\n^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/joined_members$\n^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/context/.*$\n^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/members$\n^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/state$\n^/_matrix/client/unstable/org.matrix.msc2946/rooms/.*/spaces$\n^/_matrix/client/unstable/org.matrix.msc2946/rooms/.*/hierarchy$\n^/_matrix/client/unstable/im.nheko.summary/rooms/.*/summary$\n^/_matrix/client/(api/v1|r0|unstable)/account/3pid$\n^/_matrix/client/(api/v1|r0|unstable)/devices$\n^/_matrix/client/(api/v1|r0|unstable)/keys/query$\n^/_matrix/client/(api/v1|r0|unstable)/keys/changes$\n^/_matrix/client/versions$\n^/_matrix/client/(api/v1|r0|unstable)/voip/turnServer$\n^/_matrix/client/(api/v1|r0|unstable)/joined_groups$\n^/_matrix/client/(api/v1|r0|unstable)/publicised_groups$\n^/_matrix/client/(api/v1|r0|unstable)/publicised_groups/\n^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/event/\n^/_matrix/client/(api/v1|r0|unstable)/joined_rooms$\n^/_matrix/client/(api/v1|r0|unstable)/search$ # Registration/login requests\n^/_matrix/client/(api/v1|r0|unstable)/login$\n^/_matrix/client/(r0|unstable)/register$\n^/_matrix/client/unstable/org.matrix.msc3231/register/org.matrix.msc3231.login.registration_token/validity$ # Event sending requests\n^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/redact\n^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/send\n^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/state/\n^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/(join|invite|leave|ban|unban|kick)$\n^/_matrix/client/(api/v1|r0|unstable)/join/\n^/_matrix/client/(api/v1|r0|unstable)/profile/ Additionally, the following REST endpoints can be handled for GET requests: ^/_matrix/federation/v1/groups/ Pagination requests can also be handled, but all requests for a given room must be routed to the same instance. Additionally, care must be taken to ensure that the purge history admin API is not used while pagination requests for the room are in flight: ^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/messages$ Additionally, the following endpoints should be included if Synapse is configured to use SSO (you only need to include the ones for whichever SSO provider you're using): # for all SSO providers\n^/_matrix/client/(api/v1|r0|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|unstable)/login/cas/ticket$ Ensure that all SSO logins go to a single process. For multiple workers not handling the SSO endpoints properly, see #7530 and #9427 . Note that a HTTP listener with client and federation resources must be configured in the worker_listeners option in the worker config. Load balancing It is possible to run multiple instances of this worker app, with incoming requests being load-balanced between them by the reverse-proxy. However, different endpoints have different characteristics and so admins may wish to run multiple groups of workers handling different endpoints so that load balancing can be done in different ways. For /sync and /initialSync requests it will be more efficient if all requests from a particular user are routed to a single instance. Extracting a user ID from the access token or Authorization header is currently left as an exercise for the reader. Admins may additionally wish to separate out /sync requests 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 when a user logs in on a new device and can be very resource intensive, so isolating these requests will stop them from interfering with other users ongoing syncs. Federation and client requests can be balanced via simple round robin. The inbound federation transaction request ^/_matrix/federation/v1/send/ should be balanced by source IP so that transactions from the same remote server go to the same process. Registration/login requests can be handled separately purely to help ensure that unexpected load doesn't affect new logins and sign ups. Finally, event sending requests can be balanced by the room ID in the URI (or the 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 of events, then a dedicated set of workers can be provisioned to limit the effects of bursts of events from that bridge on events sent by normal users. Stream writers Additionally, there is experimental support for moving writing of specific streams (such as events) off of the main process to a particular worker. (This is only supported with Redis-based replication.) Currently supported streams are events and typing. To enable this, the worker must have a HTTP replication listener configured, have a worker_name and be listed in the instance_map config. For example to move event persistence off to a dedicated worker, the shared configuration would include: instance_map: event_persister1: host: localhost port: 8034 stream_writers: events: event_persister1 The events stream also experimentally supports having multiple writers, where work is sharded between them by room ID. Note that you must restart all worker instances when adding or removing event persisters. An example stream_writers configuration with multiple writers: stream_writers: events: - event_persister1 - event_persister2 Background tasks There is also experimental support for moving background tasks to a separate worker. Background tasks are run periodically or started via replication. Exactly which tasks are configured to run depends on your Synapse configuration (e.g. if stats is enabled). To enable this, the worker must have a worker_name and can be configured to run background tasks. For example, to move background tasks to a dedicated worker, the shared configuration would include: run_background_tasks_on: background_worker You might also wish to investigate the update_user_directory and media_instance_running_background_jobs settings.","breadcrumbs":"Configuration » Workers » synapse.app.generic_worker","id":"298","title":"synapse.app.generic_worker"},"299":{"body":"Handles sending push notifications to sygnal and email. Doesn't handle any REST endpoints itself, but you should set start_pushers: False in the shared configuration file to stop the main synapse sending push notifications. To run multiple instances at once the pusher_instances option should list all pusher instances by their worker name, e.g.: pusher_instances: - pusher_worker1 - pusher_worker2","breadcrumbs":"Configuration » Workers » synapse.app.pusher","id":"299","title":"synapse.app.pusher"},"3":{"body":"Want to help keep Synapse going but don't know how to code? Synapse is a Matrix.org Foundation project. Consider becoming a supportor on Liberapay , Patreon or through PayPal via a one-time donation. If you are an organisation or enterprise and would like to sponsor development, reach out to us over email at: support (at) matrix.org","breadcrumbs":"Welcome and Overview » Donating to Synapse development","id":"3","title":"Donating to Synapse development"},"30":{"body":"Synapse uses Postgres sequences to generate IDs for various tables. A sequence and associated table can get out of sync if, for example, Synapse has been downgraded and then upgraded again. To fix the issue shut down Synapse (including any and all workers) and run the SQL command included in the error message. Once done Synapse should start successfully.","breadcrumbs":"Using Postgres » Fixing inconsistent sequences error","id":"30","title":"Fixing inconsistent sequences error"},"300":{"body":"Handles sending output traffic to Application Services. Doesn't handle any REST endpoints itself, but you should set notify_appservices: False in the shared 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":"300","title":"synapse.app.appservice"},"301":{"body":"Handles sending federation traffic to other servers. Doesn't handle any REST endpoints itself, but you should set send_federation: False in the shared configuration file to stop the main synapse sending this traffic. If running multiple federation senders then you must list each instance in the federation_sender_instances option by their worker_name. All instances must be stopped and started when adding or removing instances. For example: federation_sender_instances: - federation_sender1 - federation_sender2","breadcrumbs":"Configuration » Workers » synapse.app.federation_sender","id":"301","title":"synapse.app.federation_sender"},"302":{"body":"Handles the media repository. It can handle all endpoints starting with: /_matrix/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 in the shared configuration file to stop the main synapse running background jobs related to managing the media repository. Note that doing so will prevent the main process from being able to handle the above endpoints. In the media_repository worker configuration file, configure the http listener to expose the media resource. For example: worker_listeners: - type: http port: 8085 resources: - names: - media Note that if running multiple media repositories they must be on the same server and you must configure a single instance to run the background tasks, e.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":"302","title":"synapse.app.media_repository"},"303":{"body":"Handles searches in the user directory. It can handle REST endpoints matching the following regular expressions: ^/_matrix/client/(api/v1|r0|unstable)/user_directory/search$ When using this worker you must also set update_user_directory: False in the shared configuration file to stop the main synapse running background jobs related to updating the user directory.","breadcrumbs":"Configuration » Workers » synapse.app.user_dir","id":"303","title":"synapse.app.user_dir"},"304":{"body":"Proxies some frequently-requested client endpoints to add caching and remove load from the main synapse. It can handle REST endpoints matching the following regular expressions: ^/_matrix/client/(api/v1|r0|unstable)/keys/upload If use_presence is False in the homeserver config, it can also handle REST endpoints matching the following regular expressions: ^/_matrix/client/(api/v1|r0|unstable)/presence/[^/]+/status This \"stub\" presence handler will pass through GET request but make the PUT effectively a no-op. It will proxy any requests it cannot handle to the main synapse instance. It must therefore be configured with the location of the main instance, via the worker_main_http_uri setting in the frontend_proxy worker configuration file. For example: worker_main_http_uri: http://127.0.0.1:8008","breadcrumbs":"Configuration » Workers » synapse.app.frontend_proxy","id":"304","title":"synapse.app.frontend_proxy"},"305":{"body":"Note: Historically there used to be more apps, however they have been amalgamated into a single synapse.app.generic_worker app. The remaining apps are ones that do specific processing unrelated to requests, e.g. the pusher that handles sending out push notifications for new events. The intention is for all these to be folded into the generic_worker app and to use config to define which processes handle the various proccessing such as push notifications.","breadcrumbs":"Configuration » Workers » Historical apps","id":"305","title":"Historical apps"},"306":{"body":"There are two main independent changes that have been made: introducing Redis support and merging apps into synapse.app.generic_worker. Both these changes are backwards compatible and so no changes to the config are required, however server admins are encouraged to plan to migrate to Redis as the old style direct TCP replication config is deprecated. To migrate to Redis add the redis config as above, and optionally remove the TCP replication listener from master and worker_replication_port from worker config. 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. in systemd service files, but not required for synctl).","breadcrumbs":"Configuration » Workers » Migration from old config","id":"306","title":"Migration from old config"},"307":{"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":"307","title":"Architectural diagram"},"308":{"body":"If you want to use synctl to manage your synapse processes, you will need to create an an additional configuration file for the main synapse process. That configuration should look like this: worker_app: synapse.app.homeserver Additionally, each worker app must be configured with the name of a \"pid file\", to which it will write its process ID when it starts. For example, for a synchrotron, 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 commandline option to tell it to operate on all the worker configurations found in the given directory, e.g.: synctl -a $CONFIG/workers start Currently one should always restart all workers when restarting or upgrading synapse, unless you explicitly know it's safe not to. For instance, restarting synapse without restarting all the synchrotrons may result in broken typing notifications. 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":"308","title":"Using synctl with workers"},"309":{"body":"This is a setup for managing synapse with systemd, including support for managing workers. It provides a matrix-synapse service for the master, as well as a matrix-synapse-worker@ service template for any workers you require. Additionally, to group the required services, it sets up a matrix-synapse.target. See the folder system for the systemd unit files. The folder workers contains an example configuration for the federation_reader worker.","breadcrumbs":"Configuration » Workers » Systemd » Setting up Synapse with Workers and Systemd","id":"309","title":"Setting up Synapse with Workers and Systemd"},"31":{"body":"It is recommended to put a reverse proxy such as nginx , Apache , Caddy , HAProxy or relayd in front of Synapse. One advantage of doing so is that it means that you can expose the default https port (443) to Matrix clients without needing to run Synapse with root privileges. 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 necessarily need to connect to your server via the same server name or port. Indeed, clients will use port 443 by default, whereas servers default to port 8448. Where these are different, we refer to the 'client port' and the 'federation port'. See the Matrix specification for 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 the requested URI in any way (for example, by decoding %xx escapes). Beware 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 the reverse proxy and the homeserver.","breadcrumbs":"Configuring a Reverse Proxy » Using a reverse proxy with Synapse","id":"31","title":"Using a reverse proxy with Synapse"},"310":{"body":"See the worker documentation for information on how to set up the configuration files and reverse-proxy correctly. Below is a sample federation_reader worker configuration file. worker_app: synapse.app.federation_reader\nworker_name: federation_reader1 worker_replication_host: 127.0.0.1\nworker_replication_http_port: 9093 worker_listeners: - type: http port: 8011 resources: - names: [federation] worker_log_config: /etc/matrix-synapse/federation-reader-log.yaml Systemd manages daemonization itself, so ensure that none of the configuration files 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 the 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":"310","title":"Synapse configuration files"},"311":{"body":"Adjust synapse configuration files as above. Copy the *.service and *.target files in system to /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 synapse master process to be started as part of the matrix-synapse.target target. For each worker process to be enabled, run systemctl enable matrix-synapse-worker@.service. For each , there should 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":"311","title":"Set up"},"312":{"body":"Once the services are correctly set up, you can use the following commands to 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. federation_reader); the master is\n# unaffected by this.\nsystemctl restart matrix-synapse-worker@federation_reader.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":"312","title":"Usage"},"313":{"body":"Optional: If further hardening is desired, the file override-hardened.conf may be copied from contrib/systemd/override-hardened.conf in this repository to the location /etc/systemd/system/matrix-synapse.service.d/override-hardened.conf (the directory may have to be created). It enables certain sandboxing features in systemd to further secure the synapse service. You may read the comments to understand 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 (this directory may also have to be created) in order to apply the same hardening options to any worker processes. Once these files have been copied to their appropriate locations, simply reload systemd's manager config files and restart all Synapse services to apply the hardening options. They will automatically be applied at every restart as long as the override files are present at the specified 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 the changes being applied at a glance.","breadcrumbs":"Configuration » Workers » Systemd » Hardening","id":"313","title":"Hardening"},"314":{"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":"314","title":"Administration"},"315":{"body":"","breadcrumbs":"Administration » Admin API » The Admin API","id":"315","title":"The Admin API"},"316":{"body":"Many of the API calls in the admin api will require an access_token for a server admin. (Note that a server admin is distinct from a room admin.) A user can be marked as a server admin by updating the database directly, e.g.: 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 command. This is a script that is located in the scripts/ directory, or possibly already 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":"316","title":"Authenticate as a server admin"},"317":{"body":"Once you have your access_token, you will need to authenticate each request to an Admin API endpoint by providing 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 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":"317","title":"Making an Admin API request"},"318":{"body":"This API allows a server administrator to manage the validity of an account. To use it, you must enable the account validity feature (under account_validity) in Synapse's configuration.","breadcrumbs":"Administration » Admin API » Account Validity » Account validity API","id":"318","title":"Account validity API"},"319":{"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, which otherwise defaults to now + validity period. enable_renewal_emails is also an optional parameter and enables/disables sending renewal emails to the user. Defaults to true. The API returns with the new expiration date for this account, as a timestamp in milliseconds since epoch: { \"expiration_ts\": 0\n}","breadcrumbs":"Administration » Admin API » Account Validity » Renew account","id":"319","title":"Renew account"},"32":{"body":"The HTTP configuration will need to be updated for Synapse to correctly record client IP addresses and generate redirect URLs while behind a reverse proxy. In homeserver.yaml set x_forwarded: true in the port 8008 section and consider setting bind_addresses: ['127.0.0.1'] so that the server only listens to traffic on localhost. (Do not change bind_addresses to 127.0.0.1 when using a containerized Synapse, as that will prevent it from responding to proxied traffic.)","breadcrumbs":"Configuring a Reverse Proxy » Homeserver Configuration","id":"32","title":"Homeserver Configuration"},"320":{"body":"This API lets a server admin delete a local group. Doing so will kick all users out of the group so that their clients will correctly handle the group being deleted. The API is: POST /_synapse/admin/v1/delete_group/ To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API .","breadcrumbs":"Administration » Admin API » Delete Group » Delete a local group","id":"320","title":"Delete a local group"},"321":{"body":"This API returns information about reported events. The api is: GET /_synapse/admin/v1/event_reports?from=0&limit=10 To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API . 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 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 reports to paginate through. URL parameters: limit: integer - Is optional but is used for pagination, denoting the maximum number of items to return in this call. Defaults to 100. from: integer - Is optional but used for pagination, denoting the offset in the returned results. This should be treated as an opaque value and not explicitly set to anything 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 first (b) or the oldest first (f). Defaults to b. user_id: string - Is optional and filters to only return users with user IDs that contain this value. This is the user who reported the event and wrote the reason. room_id: string - Is optional and filters to only return rooms with room IDs that contain this value. 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 report 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 \"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 was reported. canonical_alias: string - The canonical alias of the room. null if the room does not have a canonical alias set. next_token: integer - Indication for pagination. See above. total: integer - Total number of event reports related to the query (user_id and room_id).","breadcrumbs":"Administration » Admin API » Event Reports » Show reported events","id":"321","title":"Show reported events"},"322":{"body":"This API returns information about a specific event report. The api is: GET /_synapse/admin/v1/event_reports/ To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API . 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\": \"matrix.org\", \"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 report 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 \"most offensive\" and 0 is \"inoffensive\". sender: string - This is the ID of the user who sent the original message/event that was reported. canonical_alias: string - The canonical alias of the room. null if the room does not have 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":"322","title":"Show details of a specific event report"},"323":{"body":"Querying media List all media in a room List all media uploaded by a user Quarantine media Quarantining media by ID Remove media from quarantine by ID Quarantining media in a room Quarantining all media of a user Protecting media from being quarantined Unprotecting media from being quarantined Delete local media Delete a specific local media Delete local media by date or size Delete media uploaded by a user Purge Remote Media API","breadcrumbs":"Administration » Admin API » Media » Contents","id":"323","title":"Contents"},"324":{"body":"These APIs allow extracting media information from the homeserver.","breadcrumbs":"Administration » Admin API » Media » Querying media","id":"324","title":"Querying media"},"325":{"body":"This API gets a list of known media in a room. However, it only shows media from unencrypted events or rooms. The API is: GET /_synapse/admin/v1/room//media To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API . 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":"325","title":"List all media in a room"},"326":{"body":"Listing all media that has been uploaded by a local user can be achieved through the use of the List media uploaded by a user Admin API.","breadcrumbs":"Administration » Admin API » Media » List all media uploaded by a user","id":"326","title":"List all media uploaded by a user"},"327":{"body":"Quarantining media means that it is marked as inaccessible by users. It applies to any local media, and any locally-cached copies of remote media. The media file itself (and any thumbnails) is not deleted from the server.","breadcrumbs":"Administration » Admin API » Media » Quarantine media","id":"327","title":"Quarantine media"},"328":{"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 form of abcdefg12345.... Response: {}","breadcrumbs":"Administration » Admin API » Media » Quarantining media by ID","id":"328","title":"Quarantining media by ID"},"329":{"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 form of abcdefg12345.... Response: {}","breadcrumbs":"Administration » Admin API » Media » Remove media from quarantine by ID","id":"329","title":"Remove media from quarantine by ID"},"33":{"body":"NOTE : You only need one of these.","breadcrumbs":"Configuring a Reverse Proxy » Reverse-proxy configuration examples","id":"33","title":"Reverse-proxy configuration examples"},"330":{"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. However, it is deprecated and may be removed in a future release.","breadcrumbs":"Administration » Admin API » Media » Quarantining media in a room","id":"330","title":"Quarantining media in a room"},"331":{"body":"This API quarantines all local media that a local user has uploaded. That is to say, if you would like to quarantine media uploaded by a user on a remote homeserver, you should instead 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":"331","title":"Quarantining all media of a user"},"332":{"body":"This API protects a single piece of local media from being quarantined using the above APIs. This is useful for sticker packs and other shared media which you do not 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":"332","title":"Protecting media from being quarantined"},"333":{"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":"333","title":"Unprotecting media from being quarantined"},"334":{"body":"This API deletes the local media from the disk of your own server. This includes any local thumbnails and copies of media downloaded from remote homeservers. This API will not affect media that has been uploaded to external media repositories (e.g https://github.com/turt2live/matrix-media-repo/). See also Purge Remote Media API .","breadcrumbs":"Administration » Admin API » Media » Delete local media","id":"334","title":"Delete local media"},"335":{"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":"335","title":"Delete a specific local media"},"336":{"body":"Request: POST /_synapse/admin/v1/media//delete?before_ts= {} URL Parameters server_name: string - The name of your local server (e.g matrix.org). before_ts: string representing a positive integer - Unix timestamp in milliseconds. Files that were last used before this timestamp will be deleted. It is the timestamp of last access, not the timestamp when the file was created. size_gt: Optional - string representing a positive integer - Size of the media in bytes. Files that are larger will be deleted. Defaults to 0. keep_profiles: Optional - string representing a boolean - Switch to also delete files that are still used in image data (e.g user profile, room avatar). If 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":"336","title":"Delete local media by date or size"},"337":{"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":"337","title":"Delete media uploaded by a user"},"338":{"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 unix_timestamp_in_ms: string representing a positive integer - Unix timestamp in milliseconds. All 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 To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API . If the user re-requests purged remote media, synapse will re-request the media from the originating server.","breadcrumbs":"Administration » Admin API » Media » Purge Remote Media API","id":"338","title":"Purge Remote Media API"},"339":{"body":"The purge history API allows server admins to purge historic events from their database, reclaiming disk space. Depending on the amount of history being purged a call to the API may take several minutes or longer. During this period users will not be able to paginate 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 delete the last message in a room. The API is: POST /_synapse/admin/v1/purge_history/[/] To use it, you will need to authenticate by providing an access_token for a server admin: Admin API By default, events sent by local users are not deleted, as they may represent the only copies of this content in existence. (Events sent by remote users are deleted.) 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 specified 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 id is given, that event (and others at the same graph depth) will be retained. If purge_up_to_ts is given, it should be a timestamp since the unix epoch, in milliseconds. The API starts the purge running, and returns immediately with a JSON body with a purge id: { \"purge_id\": \"\"\n}","breadcrumbs":"Administration » Admin API » Purge History » Purge History API","id":"339","title":"Purge History API"},"34":{"body":"server { listen 443 ssl http2; listen [::]:443 ssl http2; # For the federation port listen 8448 ssl http2 default_server; listen [::]:8448 ssl http2 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; 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; }\n}","breadcrumbs":"Configuring a Reverse Proxy » nginx","id":"34","title":"nginx"},"340":{"body":"It is possible to poll for updates on recent purges with a second API; GET /_synapse/admin/v1/purge_history_status/ Again, you will need to authenticate by providing an access_token for a server admin. This API returns a JSON body like the following: { \"status\": \"active\"\n} The status will be one of active, complete, or failed.","breadcrumbs":"Administration » Admin API » Purge History » Purge status query","id":"340","title":"Purge status query"},"341":{"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":"341","title":"Reclaim disk space (Postgres)"},"342":{"body":"This API allows for the creation of users in an administrative and non-interactive way. This is generally used for bootstrapping a Synapse instance with administrator accounts. To authenticate yourself to the server, you will need both the shared secret (registration_shared_secret in the homeserver configuration), and a one-time nonce. If the registration shared 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 body containing the nonce, username, password, whether they are an admin (optional, False by default), and a HMAC digest of the content. Also you can set 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 the shared secret and the content being the nonce, user, password, either the string \"admin\" or \"notadmin\", and optionally the user_type each separated by NULs. 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":"342","title":"Shared-Secret Registration"},"343":{"body":"This API allows you to manage tokens which can be used to authenticate registration requests, as proposed in MSC3231 . To use it, you will need to enable the registration_requires_token config option, and authenticate by providing an access_token for a server admin: see Admin API . Note that this API is still experimental; not all clients may support it yet.","breadcrumbs":"Administration » Admin API » Registration Tokens » Registration Tokens","id":"343","title":"Registration Tokens"},"344":{"body":"Most endpoints make use of JSON objects that contain details about tokens. These 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 registration before it becomes invalid. pending: The number of pending uses the token has. When someone uses the token to authenticate themselves, the pending counter is incremented so that the token is not used more than the permitted number of times. When the person completes registration the pending counter is decremented, and the completed counter is incremented. completed: The number of times the token has been used to successfully complete a registration. expiry_time: The latest time the token is valid. Given as the number of milliseconds since 1970-01-01 00:00:00 UTC (the start of the Unix epoch). To convert this into a human-readable form you can remove the milliseconds and use the date command. For example, date -d '@1625394937'.","breadcrumbs":"Administration » Admin API » Registration Tokens » Registration token objects","id":"344","title":"Registration token objects"},"345":{"body":"Lists all tokens and details about them. If the request is successful, the top level JSON object will have a registration_tokens key which is an array of registration token objects. GET /_synapse/admin/v1/registration_tokens Optional query parameters: valid: true or false. If true, only valid tokens are returned. If false, only tokens that have expired or have had all uses exhausted are returned. 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":"345","title":"List all tokens"},"346":{"body":"Get details about a single token. If the request is successful, the response body 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":"346","title":"Get one token"},"347":{"body":"Create a new registration token. If the request is successful, the newly created token 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 consists only of characters matched by the regex [A-Za-z0-9._~-]. Default: randomly generated. uses_allowed: The integer number of times the token can be used to complete a registration before it becomes invalid. Default: null (unlimited uses). expiry_time: The latest time the token is valid. Given as the number of milliseconds since 1970-01-01 00:00:00 UTC (the start of the Unix epoch). You could use, for example, date '+%s000' -d 'tomorrow'. Default: null (token does not expire). length: The length of the token randomly generated if token is not specified. 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":"347","title":"Create token"},"348":{"body":"Update the number of allowed uses or expiry time of a token. If the request is successful, the updated token will be returned as a registration token object in 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 a registration before it becomes invalid. By setting uses_allowed to 0 the token can be easily made invalid without deleting it. If null the token will have an unlimited number of uses. expiry_time: The latest time the token is valid. Given as the number of milliseconds since 1970-01-01 00:00:00 UTC (the start of the Unix epoch). If 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":"348","title":"Update token"},"349":{"body":"Delete a registration token. If the request is successful, the response body will 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":"349","title":"Delete token"},"35":{"body":"matrix.example.com { proxy /_matrix http://localhost:8008 { transparent } proxy /_synapse/client http://localhost:8008 { transparent }\n} example.com:8448 { proxy / http://localhost:8008 { transparent }\n}","breadcrumbs":"Configuring a Reverse Proxy » Caddy v1","id":"35","title":"Caddy v1"},"350":{"body":"If a request fails a \"standard error response\" will be returned as defined in the 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":"350","title":"Errors"},"351":{"body":"This API allows an administrator to join an user account with a given user_id to a room with a given room_id_or_alias. You can only modify the membership of local users. The server administrator must be in the room and have permission to invite users.","breadcrumbs":"Administration » Admin API » Manipulate Room Membership » Edit Room Membership API","id":"351","title":"Edit Room Membership API"},"352":{"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":"352","title":"Parameters"},"353":{"body":"POST /_synapse/admin/v1/join/ { \"user_id\": \"@user:server.com\"\n} To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API . Response: { \"room_id\": \"!636q39766251:server.com\"\n}","breadcrumbs":"Administration » Admin API » Manipulate Room Membership » Usage","id":"353","title":"Usage"},"354":{"body":"List Room API Room Details API Room Members API Room State API Delete Room API Undoing room shutdowns Make Room Admin API Forward Extremities Admin API Event Context API","breadcrumbs":"Administration » Admin API » Rooms » Contents","id":"354","title":"Contents"},"355":{"body":"The List Room admin API allows server admins to get a list of rooms on their server. There are various parameters available that allow for filtering and sorting the returned list. This API supports pagination. 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 this value to b will reverse the above sort order. Defaults to f. search_term - Filter rooms by their room name. Search term can be contained in any part of the room name. 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. offset - The current pagination offset in rooms. This parameter should be used instead of next_token for room offset as next_token is not intended to be parsed. total_rooms - The total number of rooms this query can return. Using this and offset, you have enough information to know the current progression through the list. next_batch - If this field is present, we know that there are potentially more rooms on the server that did not all fit into this response. We can use next_batch to get the \"next page\" of results. To do so, simply repeat your request, setting the from parameter to the value of next_batch. prev_batch - If this field is present, it is possible to paginate backwards. Use prev_batch for the from value in the next request to get 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 }, ... (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 } ], \"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 } ], \"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 }, ... (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 } ], \"offset\": 0, \"total_rooms\": 150 \"next_token\": 100\n} The presence of the next_token parameter tells us that there are more rooms than returned in this request, and we need to make another request to get them. To get the next batch of room results, we repeat our request, setting the from parameter 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 }, ... (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 } ], \"offset\": 100, \"prev_batch\": 0, \"total_rooms\": 150\n} Once the next_token parameter is no longer present, we know we've reached the end of the list.","breadcrumbs":"Administration » Admin API » Rooms » List Room API","id":"355","title":"List Room API"},"356":{"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. 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\n}","breadcrumbs":"Administration » Admin API » Rooms » Room Details API","id":"356","title":"Room Details API"},"357":{"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":"357","title":"Room Members API"},"358":{"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 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":"358","title":"Room State API"},"359":{"body":"The Delete Room admin API allows server admins to remove rooms from server and block these rooms. Shuts down a room. Moves all local users and room aliases automatically to a new room if new_room_user_id is set. Otherwise local users only leave the room without any information. The new room will be created with the user specified by the new_room_user_id parameter as room administrator and will contain a message explaining what happened. Users invited to the new room will have power level -10 by default, and thus be unable to speak. If block is True it prevents new joins to the old room. This API will remove all trace of the old room from your database after removing all local users. If purge is true (the default), all traces of the old room will be removed from your database after removing all local users. If you do not want this to happen, set purge to false. Depending on the amount of history being purged a call to the API may take several minutes or longer. The local server will only have the power to move local user and room aliases to the new room. Users on other servers will be unaffected. 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} To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API . 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} 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 as the creator and admin, and all users in the old room will be moved into that room. If not set, no new room will be created and the users will just be removed from the old room. The user ID must be on the local server, but does not necessarily have to belong to a registered user. room_name - Optional. A string representing the name of the room that new users will be invited 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 original 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, preventing future attempts to join the room. Defaults to false. purge - Optional. If set to true, it will remove all traces of the room from your database. Defaults to true. force_purge - Optional, and ignored unless purge is true. If set to true, it will force a purge to go ahead even if there are local users still in the room. Do not use this unless a regular purge operation fails, as it could leave those users' clients in a confused state. The JSON body must not be empty. The body must be at least {}. Response The following fields are returned in the JSON response body: 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 migrated from the old room to the new. new_room_id - A string representing the room ID of the new room.","breadcrumbs":"Administration » Admin API » Rooms » Delete Room API","id":"359","title":"Delete Room API"},"36":{"body":"matrix.example.com { reverse_proxy /_matrix/* http://localhost:8008 reverse_proxy /_synapse/client/* http://localhost:8008\n} example.com:8448 { reverse_proxy http://localhost:8008\n} Delegation example: (matrix-well-known-header) { # Headers header Access-Control-Allow-Origin \"*\" header Access-Control-Allow-Methods \"GET, POST, PUT, DELETE, OPTIONS\" header Access-Control-Allow-Headers \"Origin, X-Requested-With, Content-Type, Accept, Authorization\" header Content-Type \"application/json\"\n} example.com { handle /.well-known/matrix/server { import matrix-well-known-header respond `{\"m.server\":\"matrix.example.com:443\"}` } handle /.well-known/matrix/client { import matrix-well-known-header respond `{\"m.homeserver\":{\"base_url\":\"https://matrix.example.com\"},\"m.identity_server\":{\"base_url\":\"https://identity.example.com\"}}` }\n} matrix.example.com { reverse_proxy /_matrix/* http://localhost:8008 reverse_proxy /_synapse/client/* http://localhost:8008\n}","breadcrumbs":"Configuring a Reverse Proxy » Caddy v2","id":"36","title":"Caddy v2"},"360":{"body":"Note : This guide may be outdated by the time you read it. By nature of room deletions being performed at the database level, the 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 never happened - work has to be done to move forward instead of resetting the past. In fact, in some cases it might not be possible to 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 server (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 accomplished 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 been deleted, or redirected to the Content Violation room. These will need to be restored manually. Users on your server that were in the deleted room will have been kicked from the room. Consider whether you want to update their membership (possibly via the Edit Room Membership API ) or let them handle rejoining themselves. If new_room_user_id was given, a 'Content Violation' will have been created. Consider whether you want to delete that roomm.","breadcrumbs":"Administration » Admin API » Rooms » Undoing room deletions","id":"360","title":"Undoing room deletions"},"361":{"body":"The previous deprecated API will be removed in a future release, it was: POST /_synapse/admin/v1/rooms//delete It behaves the same way than the current endpoint except the path and the method.","breadcrumbs":"Administration » Admin API » Rooms » Deprecated endpoint","id":"361","title":"Deprecated endpoint"},"362":{"body":"Grants another user the highest power available to a local user who is in the room. If 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 optionally 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":"362","title":"Make Room Admin API"},"363":{"body":"Enables querying and deleting forward extremities from rooms. When a lot of forward extremities accumulate in a room, performance can become degraded. For details, see #1760 .","breadcrumbs":"Administration » Admin API » Rooms » Forward Extremities Admin API","id":"363","title":"Forward Extremities Admin API"},"364":{"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":"364","title":"Check for forward extremities"},"365":{"body":"WARNING : Please ensure you know what you're doing and have read the related issue #1760 . Under no situations should this API be executed as an automated maintenance task! If a room has lots of forward extremities, the extra can be deleted as follows: DELETE /_synapse/admin/v1/rooms//forward_extremities A response as follows will be returned, indicating the amount of forward extremities that were deleted. { \"deleted\": 1\n}","breadcrumbs":"Administration » Admin API » Rooms » Deleting forward extremities","id":"365","title":"Deleting forward extremities"},"366":{"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":"366","title":"Event Context API"},"367":{"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 ignored 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 can be used. See the server notices documentation for more information.","breadcrumbs":"Administration » Admin API » Server Notices » Server Notices","id":"367","title":"Server Notices"},"368":{"body":"Returns information about all local media usage of users. Gives the possibility to filter them by time and user. The API is: GET /_synapse/admin/v1/statistics/users/media To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API . 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 again 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 reports to paginate through. Parameters The following parameters should be set in the URL: limit: string representing a positive integer - Is optional but is used for pagination, denoting 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, denoting the offset in the returned results. This should be treated as an opaque value and not explicitly set to anything other than the return value of next_token from a previous 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. Smallest to largest. media_count - Users are ordered by number of uploaded media. Smallest to largest. from_ts - string representing a positive integer - Considers only files created at this timestamp or later. Unix timestamp in ms. until_ts - string representing a positive integer - Considers only files created at this timestamp or earlier. Unix timestamp in ms. search_term - string - Filter users by their user ID localpart or displayname. The search term can be found in any part of the string. Defaults to no filtering. dir - string - Direction of order. Either f for forwards or b for backwards. Setting 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 about 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":"368","title":"Users' media usage statistics"},"369":{"body":"","breadcrumbs":"Administration » Admin API » Users » User Admin API","id":"369","title":"User Admin API"},"37":{"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":"37","title":"Apache"},"370":{"body":"This API returns information about a specific user account. The api is: GET /_synapse/admin/v2/users/ To use it, you will need to authenticate by providing an access_token for a server admin: Admin API It returns a JSON body like the following: { \"displayname\": \"User\", \"threepids\": [ { \"medium\": \"email\", \"address\": \"\", \"added_at\": 1586458409743, \"validated_at\": 1586458409743 }, { \"medium\": \"email\", \"address\": \"\", \"added_at\": 1586458409743, \"validated_at\": 1586458409743 } ], \"avatar_url\": \"\", \"admin\": 0, \"deactivated\": 0, \"shadow_banned\": 0, \"password_hash\": \"$2b$12$p9B4GkqYdRTPGD\", \"creation_ts\": 1560432506, \"appservice_id\": null, \"consent_server_notice_sent\": null, \"consent_version\": null, \"external_ids\": [ { \"auth_provider\": \"\", \"external_id\": \"\" }, { \"auth_provider\": \"\", \"external_id\": \"\" } ], \"user_type\": null\n} URL parameters: user_id: fully-qualified user id: for example, @user:server.com.","breadcrumbs":"Administration » Admin API » Users » Query User Account","id":"370","title":"Query User Account"},"371":{"body":"This API allows an administrator to create or modify a user account with a specific user_id. This api is: PUT /_synapse/admin/v2/users/ with a body of: { \"password\": \"user_password\", \"displayname\": \"User\", \"threepids\": [ { \"medium\": \"email\", \"address\": \"\" }, { \"medium\": \"email\", \"address\": \"\" } ], \"external_ids\": [ { \"auth_provider\": \"\", \"external_id\": \"\" }, { \"auth_provider\": \"\", \"external_id\": \"\" } ], \"avatar_url\": \"\", \"admin\": false, \"deactivated\": false, \"user_type\": null\n} To use it, you will need to authenticate by providing an access_token for a server admin: Admin API Returns HTTP status code: 201 - When a new user object was created. 200 - When a user was modified. URL parameters: user_id: fully-qualified user id: for example, @user:server.com. Body parameters: password - string, optional. If provided, the user's password is updated and all devices are logged out. displayname - string, optional, defaults to the value of user_id. threepids - array, optional, allows setting the third-party IDs (email, msisdn) medium - string. Kind of third-party ID, either email or msisdn. address - string. Value of third-party ID. belonging to a user. external_ids - array, optional. Allow setting the identifier of the external identity provider for SSO (Single sign-on). Details in Sample Configuration File section sso and oidc_providers. auth_provider - string. ID of the external identity provider. Value of idp_id in homeserver configuration. external_id - string, user ID in the external identity provider. avatar_url - string, optional, must be a MXC URI . admin - bool, optional, defaults to false. deactivated - bool, optional. If unspecified, deactivation state will be left unchanged on existing accounts and set to false for new accounts. A user cannot be erased by deactivating with this API. For details on deactivating users see Deactivate Account . user_type - string or null, optional. If provided, the user type will be adjusted. If null given, the user type will be cleared. Other allowed options are: bot and support. If the user already exists then optional parameters default to the current value. In order to re-activate an account deactivated must be set to false. If users do not login via single-sign-on, a new password must be provided.","breadcrumbs":"Administration » Admin API » Users » Create or modify Account","id":"371","title":"Create or modify Account"},"372":{"body":"This API returns all local user accounts. By default, the response is ordered by ascending user ID. GET /_synapse/admin/v2/users?from=0&limit=10&guests=false To use it, you will need to authenticate by providing an access_token for a server admin: Admin API A response body like the following is returned: { \"users\": [ { \"name\": \"\", \"is_guest\": 0, \"admin\": 0, \"user_type\": null, \"deactivated\": 0, \"shadow_banned\": 0, \"displayname\": \"\", \"avatar_url\": null, \"creation_ts\": 1560432668000 }, { \"name\": \"\", \"is_guest\": 0, \"admin\": 1, \"user_type\": null, \"deactivated\": 0, \"shadow_banned\": 0, \"displayname\": \"\", \"avatar_url\": \"\", \"creation_ts\": 1561550621000 } ], \"next_token\": \"100\", \"total\": 200\n} To paginate, check for next_token and if present, call the endpoint again 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 users to 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 that 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. Defaults to true to include guest users. deactivated - string representing a bool - Is optional and if true will include deactivated users. Defaults to false to exclude deactivated users. limit - string representing a positive integer - Is optional but is used for pagination, denoting 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, denoting the offset in the returned results. This should be treated as an opaque value and not explicitly set to anything other than the return value of next_token from a previous call. Defaults to 0. order_by - The method by which to sort the returned list of users. If the ordered field has duplicates, the second order is always by ascending name, which 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. dir - Direction of media order. Either f for forwards or b for backwards. Setting this value to b will reverse the above sort order. Defaults to f. Caution. The database only has indexes on the columns name and creation_ts. This means that if a different sort order is used (is_guest, admin, user_type, deactivated, shadow_banned, avatar_url or displayname), this 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. User 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. This allows user type specific behaviour. There are also types support and bot. deactivated - bool - Status if that user has been marked as deactivated. 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. next_token: string representing a positive integer - Indication for pagination. See above. total - integer - Total number of media.","breadcrumbs":"Administration » Admin API » Users » List Accounts","id":"372","title":"List Accounts"},"373":{"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 API Whois . To use it, you will need to authenticate by providing an access_token for a server admin: Admin API 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":"373","title":"Query current sessions for a user"},"374":{"body":"This API deactivates an account. It removes active access tokens, resets the password, and deletes third-party IDs (to prevent the user requesting a password reset). It can also mark the user as GDPR-erased. This means messages sent by the user will still be visible by anyone that was in the room when these messages were sent, but hidden from users joining the room afterwards. The api is: POST /_synapse/admin/v1/deactivate/ with a body of: { \"erase\": true\n} To use it, you will need to authenticate by providing an access_token for a server admin: Admin API The erase parameter is optional and defaults to false. An empty body may be passed for backwards compatibility. The following actions are performed when deactivating an user: Try to unpind 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 The following additional actions are performed during deactivation if erase is set to true: Remove the user's display name Remove the user's avatar URL 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 Delete E2E cross-signing keys Remove the user's creation (registration) timestamp Remove rate limit overrides Remove from monthly active users","breadcrumbs":"Administration » Admin API » Users » Deactivate Account","id":"374","title":"Deactivate Account"},"375":{"body":"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} To use it, you will need to authenticate by providing an access_token for a server admin: Admin API The parameter new_password is required. The parameter logout_devices is optional and defaults to true.","breadcrumbs":"Administration » Admin API » Users » Reset password","id":"375","title":"Reset password"},"376":{"body":"The api is: GET /_synapse/admin/v1/users//admin To use it, you will need to authenticate by providing an access_token for a server admin: Admin API 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":"376","title":"Get whether a user is a server administrator or not"},"377":{"body":"Note that you cannot demote yourself. The api is: PUT /_synapse/admin/v1/users//admin with a body of: { \"admin\": true\n} To use it, you will need to authenticate by providing an access_token for a server admin: Admin API","breadcrumbs":"Administration » Admin API » Users » Change whether a user is a server administrator or not","id":"377","title":"Change whether a user is a server administrator or not"},"378":{"body":"Gets a list of all room_id that a specific user_id is member. The API is: GET /_synapse/admin/v1/users//joined_rooms To use it, you will need to authenticate by providing an access_token for a server admin: Admin API 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 are member. If the user is local, all the rooms of which the user is member 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 room memberships of a user","id":"378","title":"List room memberships of a user"},"379":{"body":"","breadcrumbs":"Administration » Admin API » Users » User media","id":"379","title":"User media"},"38":{"body":"frontend https bind :::443 v4v6 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 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 v4v6 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","breadcrumbs":"Configuring a Reverse Proxy » HAProxy","id":"38","title":"HAProxy"},"380":{"body":"Gets a list of all local media that a specific user_id has created. By default, the response is ordered by descending creation date and ascending media ID. The 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 To use it, you will need to authenticate by providing an access_token for a server admin: Admin API 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\" } ], \"next_token\": 3, \"total\": 2\n} To paginate, check for next_token and if present, call the endpoint again 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 reports 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, denoting 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, denoting the offset in the returned results. This should be treated as an opaque value and not explicitly set to anything other than the return value of next_token from a previous call. Defaults to 0. order_by - The method by which to sort the returned list of media. If the ordered field has duplicates, the second order is always by ascending media_id, which 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. Smallest to largest. This is the default. last_access_ts - Media are ordered by when the content was last accessed in ms. Smallest to largest. media_length - Media are ordered by length of the media in bytes. Smallest to largest. media_type - Media are ordered alphabetically by MIME-type. quarantined_by - Media are ordered alphabetically by the user ID that initiated the quarantine request for this media. safe_from_quarantine - Media are ordered by the status if this media is safe from quarantining. dir - Direction of media order. Either f for forwards or b for backwards. Setting 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 (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 (upload_name, last_access_ts, media_length, media_type, quarantined_by or safe_from_quarantine), this can cause a large load on the database, 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. Media objects contain the following fields: created_ts - integer - Timestamp when the content was uploaded in ms. last_access_ts - integer - Timestamp when the content was last accessed in ms. media_id - string - The id used to refer to the media. media_length - integer - Length of the media in bytes. media_type - string - The MIME-type of the media. quarantined_by - string - The user ID that initiated the quarantine request for this media. safe_from_quarantine - bool - Status if this media is safe from quarantining. upload_name - string - The name the media was uploaded with. 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":"380","title":"List media uploaded by a user"},"381":{"body":"This API deletes the local media from the disk of your own server that a specific user_id has created. This includes any local thumbnails. This API will not affect media that has been uploaded to external media 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. The 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 To use it, you will need to authenticate by providing an access_token for a server admin: Admin API 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 after deleting media the remaining media have a new order. Parameters This API has the same parameters as List media uploaded by a user . With the parameters you can for example limit the number of files to delete at once or delete largest/smallest or newest/oldest files first.","breadcrumbs":"Administration » Admin API » Users » Delete media uploaded by a user","id":"381","title":"Delete media uploaded by a user"},"382":{"body":"Get an access token that can be used to authenticate as that user. Useful for when 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 integer timestamp that specifies when the token should expire. By default tokens do not expire. 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 their /devices list, and in general the target user should not be able to tell 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 of their devices, but the token will not expire if the target user does the same.","breadcrumbs":"Administration » Admin API » Users » Login as a user","id":"382","title":"Login as a user"},"383":{"body":"","breadcrumbs":"Administration » Admin API » Users » User devices","id":"383","title":"User devices"},"384":{"body":"Gets information about all devices for a specific user_id. The API is: GET /_synapse/admin/v2/users//devices To use it, you will need to authenticate by providing an access_token for a server admin: Admin API A response body like the following is returned: { \"devices\": [ { \"device_id\": \"QBUAZIFURK\", \"display_name\": \"android\", \"last_seen_ip\": \"1.2.3.4\", \"last_seen_ts\": 1474491775024, \"user_id\": \"\" }, { \"device_id\": \"AUIECTSRND\", \"display_name\": \"ios\", \"last_seen_ip\": \"1.2.3.5\", \"last_seen_ts\": 1474491775025, \"user_id\": \"\" } ], \"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. Device objects contain the following fields: device_id - Identifier of device. display_name - Display name set by the user for this device. Absent if no name has been set. last_seen_ip - The IP address where this device was last seen. (May be a few minutes out of date, for efficiency reasons). last_seen_ts - The timestamp (in milliseconds since the unix epoch) when this devices was last seen. (May be a few minutes out of date, for efficiency reasons). user_id - Owner of device. total - Total number of user's devices.","breadcrumbs":"Administration » Admin API » Users » List all devices","id":"384","title":"List all devices"},"385":{"body":"Deletes the given devices for a specific user_id, and invalidates any access token associated with them. The API is: POST /_synapse/admin/v2/users//delete_devices { \"devices\": [ \"QBUAZIFURK\", \"AUIECTSRND\" ],\n} To use it, you will need to authenticate by providing an access_token for a server admin: Admin API 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":"385","title":"Delete multiple devices"},"386":{"body":"Gets information on a single device, by device_id for a specific user_id. The API is: GET /_synapse/admin/v2/users//devices/ To use it, you will need to authenticate by providing an access_token for a server admin: Admin API A response body like the following is returned: { \"device_id\": \"\", \"display_name\": \"android\", \"last_seen_ip\": \"1.2.3.4\", \"last_seen_ts\": 1474491775024, \"user_id\": \"