diff --git a/develop/print.html b/develop/print.html
index de27e50afb..650ab5787f 100644
--- a/develop/print.html
+++ b/develop/print.html
@@ -7144,6 +7144,8 @@ published to the room list.
The first rule that matches decides if the request is allowed or denied. If no
rule matches, the request is denied. In particular, this means that configuring
an empty list of rules will deny every alias creation request.
+Requests to create a public (public as in published to the room directory) room which violates
+the configured rules will result in the room being created but not published to the room directory.
Each rule is a YAML object containing four fields, each of which is an optional string:
user_id: a glob pattern that matches against the user publishing the room.
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":"670","title":"Show details of a specific event report"},"671":{"body":"This API deletes a specific event report. If the request is successful, the response body will be an empty JSON object. The api is: DELETE /_synapse/admin/v1/event_reports/ URL parameters: report_id: string - The ID of the event report.","breadcrumbs":"Administration » Admin API » Event Reports » Delete a specific event report","id":"671","title":"Delete a specific event report"},"672":{"body":"This API allows a server administrator to enable or disable some experimental features on a per-user basis. The currently supported features are: MSC3026 : busy presence state enabled MSC3881 : enable remotely toggling push notifications for another client MSC3967 : do not require UIA when first uploading cross-signing keys. To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API .","breadcrumbs":"Administration » Admin API » Experimental Features » Experimental Features API","id":"672","title":"Experimental Features API"},"673":{"body":"This API allows a server administrator to enable experimental features for a given user. The request must provide a body containing the user id and listing the features to enable/disable in the following format: { \"features\": { \"msc3026\":true, \"msc3881\":true }\n} where true is used to enable the feature, and false is used to disable the feature. The API is: PUT /_synapse/admin/v1/experimental_features/","breadcrumbs":"Administration » Admin API » Experimental Features » Enabling/Disabling Features","id":"673","title":"Enabling/Disabling Features"},"674":{"body":"To list which features are enabled/disabled for a given user send a request to the following API: GET /_synapse/admin/v1/experimental_features/ It will return a list of possible features and indicate whether they are enabled or disabled for the user like so: { \"features\": { \"msc3026\": true, \"msc3881\": false, \"msc3967\": false }\n}","breadcrumbs":"Administration » Admin API » Experimental Features » Listing Enabled Features","id":"674","title":"Listing Enabled Features"},"675":{"body":"These APIs allow extracting media information from the homeserver. Details about the format of the media_id and storage of the media in the file system are documented under media repository . To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API .","breadcrumbs":"Administration » Admin API » Media » Querying media","id":"675","title":"Querying media"},"676":{"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 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":"676","title":"List all media in a room"},"677":{"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":"677","title":"List all media uploaded by a user"},"678":{"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":"678","title":"Quarantine media"},"679":{"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":"679","title":"Quarantining media by ID"},"68":{"body":"The minimum supported Rust version has been increased from v1.61.0 to v1.65.0. Users building from source will need to ensure their rustc version is up to date.","breadcrumbs":"Upgrading between Synapse Versions » Minimum supported Rust version","id":"68","title":"Minimum supported Rust version"},"680":{"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":"680","title":"Remove media from quarantine by ID"},"681":{"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":"681","title":"Quarantining media in a room"},"682":{"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":"682","title":"Quarantining all media of a user"},"683":{"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":"683","title":"Protecting media from being quarantined"},"684":{"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":"684","title":"Unprotecting media from being quarantined"},"685":{"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":"685","title":"Delete local media"},"686":{"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":"686","title":"Delete a specific local media"},"687":{"body":"Request: POST /_synapse/admin/v1/media/delete?before_ts= {} Deprecated in Synapse v1.78.0: This API is available at the deprecated endpoint: POST /_synapse/admin/v1/media//delete?before_ts= {} URL Parameters server_name: string - The name of your local server (e.g matrix.org). Deprecated in Synapse v1.78.0. before_ts: string representing a positive integer - Unix timestamp in milliseconds. 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":"687","title":"Delete local media by date or size"},"688":{"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":"688","title":"Delete media uploaded by a user"},"689":{"body":"The purge remote media API allows server admins to purge old cached remote media. The API is: POST /_synapse/admin/v1/purge_media_cache?before_ts= {} URL Parameters before_ts: string representing a positive integer - Unix timestamp in milliseconds. 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 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":"689","title":"Purge Remote Media API"},"69":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.93.0","id":"69","title":"Upgrading to v1.93.0"},"690":{"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. To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API . The API is: POST /_synapse/admin/v1/purge_history/[/] By default, events sent by local users are not deleted, as they may represent 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":"690","title":"Purge History API"},"691":{"body":"It is possible to poll for updates on recent purges with a second API; GET /_synapse/admin/v1/purge_history_status/ This API returns a JSON body like the following: { \"status\": \"active\"\n} The status will be one of active, complete, or failed. If status is failed there will be a string error with the error message.","breadcrumbs":"Administration » Admin API » Purge History » Purge status query","id":"691","title":"Purge status query"},"692":{"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":"692","title":"Reclaim disk space (Postgres)"},"693":{"body":"Note: This API is disabled when MSC3861 is enabled. See #15582 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. Here is an easy way to generate the HMAC digest if you have Bash and OpenSSL: # Update these values and then paste this code block into a bash terminal\nnonce='thisisanonce'\nusername='pepper_roni'\npassword='pizza'\nadmin='admin'\nsecret='shared_secret' printf '%s\\0%s\\0%s\\0%s' \"$nonce\" \"$username\" \"$password\" \"$admin\" | openssl sha1 -hmac \"$secret\" | awk '{print $2}' For an example of generation in Python: import hmac, hashlib def generate_mac(nonce, user, password, admin=False, user_type=None): mac = hmac.new( key=shared_secret, digestmod=hashlib.sha1, ) mac.update(nonce.encode('utf8')) mac.update(b\"\\x00\") mac.update(user.encode('utf8')) mac.update(b\"\\x00\") mac.update(password.encode('utf8')) mac.update(b\"\\x00\") mac.update(b\"admin\" if admin else b\"notadmin\") if user_type: mac.update(b\"\\x00\") mac.update(user_type.encode('utf8')) return mac.hexdigest()","breadcrumbs":"Administration » Admin API » Register Users » Shared-Secret Registration","id":"693","title":"Shared-Secret Registration"},"694":{"body":"Note: This API is disabled when MSC3861 is enabled. See #15582 This API allows you to manage tokens which can be used to authenticate registration requests, as proposed in MSC3231 and stabilised in version 1.2 of the Matrix specification. 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 .","breadcrumbs":"Administration » Admin API » Registration Tokens » Registration Tokens","id":"694","title":"Registration Tokens"},"695":{"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":"695","title":"Registration token objects"},"696":{"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":"696","title":"List all tokens"},"697":{"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":"697","title":"Get one token"},"698":{"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":"698","title":"Create token"},"699":{"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":"699","title":"Update token"},"7":{"body":"Prebuilt packages are available for a number of platforms. These are recommended for most users. Docker images and Ansible playbooks There is an official synapse image available at https://hub.docker.com/r/vectorim/synapse or at ghcr.io/element-hq/synapse which can be used with the docker-compose file available at contrib/docker . Further information on this including configuration options is available in the README on hub.docker.com. Alternatively, Andreas Peters (previously Silvio Fricke) has contributed a Dockerfile to automate a synapse server in a single Docker image, at https://hub.docker.com/r/avhost/docker-matrix/tags/ Slavi Pantaleev has created an Ansible playbook, which installs the official Docker image of Matrix Synapse along with many other Matrix-related services (Postgres database, Element, coturn, ma1sd, SSL support, etc.). For more details, see https://github.com/spantaleev/matrix-docker-ansible-deploy Debian/Ubuntu Matrix.org packages Matrix.org provides Debian/Ubuntu packages of Synapse, for the amd64 architecture via https://packages.matrix.org/debian/ . To install the latest release: TODO UPDATE ALL THIS sudo apt install -y lsb-release wget apt-transport-https\nsudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg\necho \"deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main\" | sudo tee /etc/apt/sources.list.d/matrix-org.list\nsudo apt update\nsudo apt install matrix-synapse-py3 Packages are also published for release candidates. To enable the prerelease channel, add prerelease to the sources.list line. For example: sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg\necho \"deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main prerelease\" | sudo tee /etc/apt/sources.list.d/matrix-org.list\nsudo apt update\nsudo apt install matrix-synapse-py3 The fingerprint of the repository signing key (as shown by gpg /usr/share/keyrings/matrix-org-archive-keyring.gpg) is AAF9AE843A7584B5A3E4CD2BCF45A512DE2DA058. When installing with Debian packages, you might prefer to place files in /etc/matrix-synapse/conf.d/ to override your configuration without editing the main configuration file at /etc/matrix-synapse/homeserver.yaml. By doing that, you won't be asked if you want to replace your configuration file when you upgrade the Debian package to a later version. Downstream Debian packages Andrej Shadura maintains a matrix-synapse package in the Debian repositories. For bookworm and sid, it can be installed simply with: sudo apt install matrix-synapse Synapse is also available in bullseye-backports. Please see the Debian documentation for information on how to use backports. matrix-synapse is no longer maintained for buster and older. Downstream Ubuntu packages We do not recommend using the packages in the default Ubuntu repository at this time, as they are old and suffer from known security vulnerabilities . The latest version of Synapse can be installed from our repository . Fedora Synapse is in the Fedora repositories as matrix-synapse : sudo dnf install matrix-synapse Additionally, Oleg Girko provides Fedora RPMs at https://obs.infoserver.lv/project/monitor/matrix-synapse OpenSUSE Synapse is in the OpenSUSE repositories as matrix-synapse : sudo zypper install matrix-synapse SUSE Linux Enterprise Server Unofficial package are built for SLES 15 in the openSUSE:Backports:SLE-15 repository at https://download.opensuse.org/repositories/openSUSE:/Backports:/SLE-15/standard/ ArchLinux The quickest way to get up and running with ArchLinux is probably with the package provided by ArchLinux https://archlinux.org/packages/extra/x86_64/matrix-synapse/ , which should pull in most of the necessary dependencies. pip may be outdated (6.0.7-1 and needs to be upgraded to 6.0.8-1 ): sudo pip install --upgrade pip If you encounter an error with lib bcrypt causing an Wrong ELF Class: ELFCLASS32 (x64 Systems), you may need to reinstall py-bcrypt to correctly compile it under the right architecture. (This should not be needed if installing under virtualenv): sudo pip uninstall py-bcrypt\nsudo pip install py-bcrypt Alpine Linux 6543 maintains Synapse packages for Alpine Linux in the community repository. Install with: sudo apk add synapse Void Linux Synapse can be found in the void repositories as 'synapse' : xbps-install -Su\nxbps-install -S synapse FreeBSD Synapse can be installed via FreeBSD Ports or Packages contributed by Brendan Molloy from: Ports: cd /usr/ports/net-im/py-matrix-synapse && make install clean Packages: pkg install py38-matrix-synapse OpenBSD As of OpenBSD 6.7 Synapse is available as a pre-compiled binary. The filesystem underlying the homeserver directory (defaults to /var/synapse) has to be mounted with wxallowed (cf. mount(8)), so creating a separate filesystem and mounting it to /var/synapse should be taken into consideration. Installing Synapse: doas pkg_add synapse NixOS Robin Lambertz has packaged Synapse for NixOS at: https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/matrix/synapse.nix","breadcrumbs":"Installation » Prebuilt packages","id":"7","title":"Prebuilt packages"},"70":{"body":"The minimum supported Rust version has been increased from v1.60.0 to v1.61.0. Users building from source will need to ensure their rustc version is up to date.","breadcrumbs":"Upgrading between Synapse Versions » Minimum supported Rust version","id":"70","title":"Minimum supported Rust version"},"700":{"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":"700","title":"Delete token"},"701":{"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":"701","title":"Errors"},"702":{"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. To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API .","breadcrumbs":"Administration » Admin API » Manipulate Room Membership » Edit Room Membership API","id":"702","title":"Edit Room Membership API"},"703":{"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":"703","title":"Parameters"},"704":{"body":"POST /_synapse/admin/v1/join/ { \"user_id\": \"@user:server.com\"\n} Response: { \"room_id\": \"!636q39766251:server.com\"\n}","breadcrumbs":"Administration » Admin API » Manipulate Room Membership » Usage","id":"704","title":"Usage"},"705":{"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. To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API . Parameters The following query parameters are available: from - Offset in the returned list. Defaults to 0. limit - Maximum amount of rooms to return. Defaults to 100. order_by - The method in which to sort the returned list of rooms. Valid values are: alphabetical - Same as name. This is deprecated. size - Same as joined_members. This is deprecated. name - Rooms are ordered alphabetically by room name. This is the default. canonical_alias - Rooms are ordered alphabetically by main alias address of the room. joined_members - Rooms are ordered by the number of members. Largest to smallest. joined_local_members - Rooms are ordered by the number of local members. Largest to smallest. version - Rooms are ordered by room version. Largest to smallest. creator - Rooms are ordered alphabetically by creator of the room. encryption - Rooms are ordered alphabetically by the end-to-end encryption algorithm. federatable - Rooms are ordered by whether the room is federatable. public - Rooms are ordered by visibility in room list. join_rules - Rooms are ordered alphabetically by join rules of the room. guest_access - Rooms are ordered alphabetically by guest access option of the room. history_visibility - Rooms are ordered alphabetically by visibility of history of the room. state_events - Rooms are ordered by number of state events. Largest to smallest. dir - Direction of room order. Either f for forwards or b for backwards. Setting this value to b will reverse the above sort order. Defaults to f. search_term - Filter rooms by their room name, canonical alias and room id. Specifically, rooms are selected if the search term is contained in the room's name, the local part of the room's canonical alias, or the complete (local and server part) room's id (case sensitive). Defaults to no filtering. Response The following fields are possible in the JSON response body: rooms - An array of objects, each containing information about a room. Room objects contain the following fields: room_id - The ID of the room. name - The name of the room. canonical_alias - The canonical (main) alias address of the room. joined_members - How many users are currently in the room. joined_local_members - How many local users are currently in the room. version - The version of the room as a string. creator - The user_id of the room creator. encryption - Algorithm of end-to-end encryption of messages. Is null if encryption is not active. federatable - Whether users on other servers can join this room. public - Whether the room is visible in room directory. join_rules - The type of rules used for users wishing to join this room. One of: [\"public\", \"knock\", \"invite\", \"private\"]. guest_access - Whether guests can join the room. One of: [\"can_join\", \"forbidden\"]. history_visibility - Who can see the room history. One of: [\"invited\", \"joined\", \"shared\", \"world_readable\"]. state_events - Total number of state_events of a room. Complexity of the room. room_type - The type of the room taken from the room's creation event; for example \"m.space\" if the room is a space. If the room does not define a type, the value will be null. offset - The current pagination offset in rooms. This parameter should be 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, \"room_type\": \"m.space\" }, ... (8 hidden items) ... { \"room_id\": \"!xYvNcQPhnkrdUmYczI:matrix.org\", \"name\": \"This Week In Matrix (TWIM)\", \"canonical_alias\": \"#twim:matrix.org\", \"joined_members\": 314, \"joined_local_members\": 20, \"version\": \"4\", \"creator\": \"@foo:matrix.org\", \"encryption\": \"m.megolm.v1.aes-sha2\", \"federatable\": true, \"public\": false, \"join_rules\": \"invite\", \"guest_access\": null, \"history_visibility\": \"shared\", \"state_events\": 8345, \"room_type\": null } ], \"offset\": 0, \"total_rooms\": 10\n} Filtering by room name: GET /_synapse/admin/v1/rooms?search_term=TWIM A response body like the following is returned: { \"rooms\": [ { \"room_id\": \"!xYvNcQPhnkrdUmYczI:matrix.org\", \"name\": \"This Week In Matrix (TWIM)\", \"canonical_alias\": \"#twim:matrix.org\", \"joined_members\": 314, \"joined_local_members\": 20, \"version\": \"4\", \"creator\": \"@foo:matrix.org\", \"encryption\": \"m.megolm.v1.aes-sha2\", \"federatable\": true, \"public\": false, \"join_rules\": \"invite\", \"guest_access\": null, \"history_visibility\": \"shared\", \"state_events\": 8, \"room_type\": null } ], \"offset\": 0, \"total_rooms\": 1\n} Paginating through a list of rooms: GET /_synapse/admin/v1/rooms?order_by=size A response body like the following is returned: { \"rooms\": [ { \"room_id\": \"!OGEhHVWSdvArJzumhm:matrix.org\", \"name\": \"Matrix HQ\", \"canonical_alias\": \"#matrix:matrix.org\", \"joined_members\": 8326, \"joined_local_members\": 2, \"version\": \"1\", \"creator\": \"@foo:matrix.org\", \"encryption\": null, \"federatable\": true, \"public\": true, \"join_rules\": \"invite\", \"guest_access\": null, \"history_visibility\": \"shared\", \"state_events\": 93534, \"room_type\": null }, ... (98 hidden items) ... { \"room_id\": \"!xYvNcQPhnkrdUmYczI:matrix.org\", \"name\": \"This Week In Matrix (TWIM)\", \"canonical_alias\": \"#twim:matrix.org\", \"joined_members\": 314, \"joined_local_members\": 20, \"version\": \"4\", \"creator\": \"@foo:matrix.org\", \"encryption\": \"m.megolm.v1.aes-sha2\", \"federatable\": true, \"public\": false, \"join_rules\": \"invite\", \"guest_access\": null, \"history_visibility\": \"shared\", \"state_events\": 8345, \"room_type\": \"m.space\" } ], \"offset\": 0, \"total_rooms\": 150, \"next_token\": 100\n} The presence of the next_token parameter tells us that there are more rooms 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, \"room_type\": \"m.space\" }, ... (48 hidden items) ... { \"room_id\": \"!twcBhHVdZlQWuuxBhN:termina.org.uk\", \"name\": \"weechat-matrix\", \"canonical_alias\": \"#weechat-matrix:termina.org.uk\", \"joined_members\": 137, \"joined_local_members\": 20, \"version\": \"4\", \"creator\": \"@foo:termina.org.uk\", \"encryption\": null, \"federatable\": true, \"public\": true, \"join_rules\": \"invite\", \"guest_access\": null, \"history_visibility\": \"shared\", \"state_events\": 8345, \"room_type\": null } ], \"offset\": 100, \"prev_batch\": 0, \"total_rooms\": 150\n} Once the next_token parameter is no longer present, we know we've reached the end of the list.","breadcrumbs":"Administration » Admin API » Rooms » List Room API","id":"705","title":"List Room API"},"706":{"body":"The Room Details admin API allows server admins to get all details of a room. The following fields are possible in the JSON response body: room_id - The ID of the room. name - The name of the room. topic - The topic of the room. avatar - The mxc URI to the avatar of the room. canonical_alias - The canonical (main) alias address of the room. joined_members - How many users are currently in the room. joined_local_members - How many local users are currently in the room. joined_local_devices - How many local devices are currently in the room. version - The version of the room as a string. creator - The user_id of the room creator. encryption - Algorithm of end-to-end encryption of messages. Is null if encryption is not active. federatable - Whether users on other servers can join this room. public - Whether the room is visible in room directory. join_rules - The type of rules used for users wishing to join this room. One of: [\"public\", \"knock\", \"invite\", \"private\"]. guest_access - Whether guests can join the room. One of: [\"can_join\", \"forbidden\"]. history_visibility - Who can see the room history. One of: [\"invited\", \"joined\", \"shared\", \"world_readable\"]. state_events - Total number of state_events of a room. Complexity of the room. room_type - The type of the room taken from the room's creation event; for example \"m.space\" if the room is a space. If the room does not define a type, the value will be null. forgotten - Whether all local users have forgotten 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, \"room_type\": \"m.space\", \"forgotten\": false\n} Changed in Synapse 1.66: Added the forgotten key to the response body.","breadcrumbs":"Administration » Admin API » Rooms » Room Details API","id":"706","title":"Room Details API"},"707":{"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":"707","title":"Room Members API"},"708":{"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":"708","title":"Room State API"},"709":{"body":"The Room Messages admin API allows server admins to get all messages sent to a room in a given timeframe. There are various parameters available that allow for filtering and ordering the returned list. This API supports pagination. To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API . This endpoint mirrors the Matrix Spec defined Messages API . The API is: GET /_synapse/admin/v1/rooms//messages Parameters The following path parameters are required: room_id - The ID of the room you wish you fetch messages from. The following query parameters are available: from (required) - The token to start returning events from. This token can be obtained from a prev_batch or next_batch token returned by the /sync endpoint, or from an end token returned by a previous request to this endpoint. to - The token to stop returning events at. limit - The maximum number of events to return. Defaults to 10. filter - A JSON RoomEventFilter to filter returned events with. dir - The direction to return events from. Either f for forwards or b for backwards. Setting this value to b will reverse the above sort order. Defaults to f. Response The following fields are possible in the JSON response body: chunk - A list of room events. The order depends on the dir parameter. Note that an empty chunk does not necessarily imply that no more events are available. Clients should continue to paginate until no end property is returned. end - A token corresponding to the end of chunk. This token can be passed back to this endpoint to request further events. If no further events are available, this property is omitted from the response. start - A token corresponding to the start of chunk. state - A list of state events relevant to showing the chunk. Example For more details on each chunk, read the Matrix specification . { \"chunk\": [ { \"content\": { \"body\": \"This is an example text message\", \"format\": \"org.matrix.custom.html\", \"formatted_body\": \"This is an example text message\", \"msgtype\": \"m.text\" }, \"event_id\": \"$143273582443PhrSn:example.org\", \"origin_server_ts\": 1432735824653, \"room_id\": \"!636q39766251:example.com\", \"sender\": \"@example:example.org\", \"type\": \"m.room.message\", \"unsigned\": { \"age\": 1234 } }, { \"content\": { \"name\": \"The room name\" }, \"event_id\": \"$143273582443PhrSn:example.org\", \"origin_server_ts\": 1432735824653, \"room_id\": \"!636q39766251:example.com\", \"sender\": \"@example:example.org\", \"state_key\": \"\", \"type\": \"m.room.name\", \"unsigned\": { \"age\": 1234 } }, { \"content\": { \"body\": \"Gangnam Style\", \"info\": { \"duration\": 2140786, \"h\": 320, \"mimetype\": \"video/mp4\", \"size\": 1563685, \"thumbnail_info\": { \"h\": 300, \"mimetype\": \"image/jpeg\", \"size\": 46144, \"w\": 300 }, \"thumbnail_url\": \"mxc://example.org/FHyPlCeYUSFFxlgbQYZmoEoe\", \"w\": 480 }, \"msgtype\": \"m.video\", \"url\": \"mxc://example.org/a526eYUSFFxlgbQYZmo442\" }, \"event_id\": \"$143273582443PhrSn:example.org\", \"origin_server_ts\": 1432735824653, \"room_id\": \"!636q39766251:example.com\", \"sender\": \"@example:example.org\", \"type\": \"m.room.message\", \"unsigned\": { \"age\": 1234 } } ], \"end\": \"t47409-4357353_219380_26003_2265\", \"start\": \"t47429-4392820_219380_26003_2265\"\n}","breadcrumbs":"Administration » Admin API » Rooms » Room Messages API","id":"709","title":"Room Messages API"},"71":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.90.0","id":"71","title":"Upgrading to v1.90.0"},"710":{"body":"The Room Timestamp to Event API endpoint fetches the event_id of the closest event to the given timestamp (ts query parameter) in the given direction (dir query parameter). Useful for cases like jump to date so you can start paginating messages from a given date in the archive. The API is: GET /_synapse/admin/v1/rooms//timestamp_to_event Parameters The following path parameters are required: room_id - The ID of the room you wish to check. The following query parameters are available: ts - a timestamp in milliseconds where we will find the closest event in the given direction. dir - can be f or b to indicate forwards and backwards in time from the given timestamp. Defaults to f. Response event_id - The event ID closest to the given timestamp. origin_server_ts - The timestamp of the event in milliseconds since the Unix epoch.","breadcrumbs":"Administration » Admin API » Rooms » Room Timestamp to Event API","id":"710","title":"Room Timestamp to Event API"},"711":{"body":"The Block Room admin API allows server admins to block and unblock rooms, and query to see if a given room is blocked. This API can be used to pre-emptively block a room, even if it's unknown to this homeserver. Users will be prevented from joining a blocked room.","breadcrumbs":"Administration » Admin API » Rooms » Block Room API","id":"711","title":"Block Room API"},"712":{"body":"The API is: PUT /_synapse/admin/v1/rooms//block with a body of: { \"block\": true\n} A response body like the following is returned: { \"block\": true\n} Parameters The following parameters should be set in the URL: room_id - The ID of the room. The following JSON body parameters are available: block - If true the room will be blocked and if false the room will be unblocked. Response The following fields are possible in the JSON response body: block - A boolean. true if the room is blocked, otherwise false","breadcrumbs":"Administration » Admin API » Rooms » Block or unblock a room","id":"712","title":"Block or unblock a room"},"713":{"body":"The API is: GET /_synapse/admin/v1/rooms//block A response body like the following is returned: { \"block\": true, \"user_id\": \"\"\n} Parameters The following parameters should be set in the URL: room_id - The ID of the room. Response The following fields are possible in the JSON response body: block - A boolean. true if the room is blocked, otherwise false user_id - An optional string. If the room is blocked (block is true) shows the user who has add the room to blocking list. Otherwise it is not displayed.","breadcrumbs":"Administration » Admin API » Rooms » Get block status","id":"713","title":"Get block status"},"714":{"body":"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 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, users will be prevented from joining the old room. This option can in Version 1 also be used to pre-emptively block a room, even if it's unknown to this homeserver. In this case, the room will be blocked, and no further action will be taken. If block is false, attempting to delete an unknown room is invalid and will be rejected as a bad request. This API will remove all trace of the old room from your database after removing 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.","breadcrumbs":"Administration » Admin API » Rooms » Delete Room API","id":"714","title":"Delete Room API"},"715":{"body":"This version works synchronously. That means you only get the response once the server has finished the action, which may take a long time. If you request the same action a second time, and the server has not finished the first one, the second request will block. This is fixed in version 2 of this API. The parameters are the same in both APIs. This API will become deprecated in the future. The API is: DELETE /_synapse/admin/v1/rooms/ with a body of: { \"new_room_user_id\": \"@someuser:example.com\", \"room_name\": \"Content Violation Notification\", \"message\": \"Bad Room has been shutdown due to content violations on this server. Please review our Terms of Service.\", \"block\": true, \"purge\": true\n} A response body like the following is returned: { \"kicked_users\": [ \"@foobar:example.com\" ], \"failed_to_kick_users\": [], \"local_aliases\": [ \"#badroom:example.com\", \"#evilsaloon:example.com\" ], \"new_room_id\": \"!newroomid:example.com\"\n} The parameters and response values have the same format as version 2 of the API.","breadcrumbs":"Administration » Admin API » Rooms » Version 1 (old version)","id":"715","title":"Version 1 (old version)"},"716":{"body":"Note : This API is new, experimental and \"subject to change\". This version works asynchronously, meaning you get the response from server immediately while the server works on that task in background. You can then request the status of the action to check if it has completed. The API is: DELETE /_synapse/admin/v2/rooms/ with a body of: { \"new_room_user_id\": \"@someuser:example.com\", \"room_name\": \"Content Violation Notification\", \"message\": \"Bad Room has been shutdown due to content violations on this server. Please review our Terms of Service.\", \"block\": true, \"purge\": true\n} The API starts the shut down and purge running, and returns immediately with a JSON body with a purge id: { \"delete_id\": \"\"\n} Parameters The following parameters should be set in the URL: room_id - The ID of the room. The following JSON body parameters are available: new_room_user_id - Optional. If set, a new room will be created with this user ID 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. Rooms can be blocked even if they're not yet known to the homeserver (only with Version 1 of the API). Defaults to false. purge - Optional. If set to true, it will remove all traces of the room from your database. 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 {}.","breadcrumbs":"Administration » Admin API » Rooms » Version 2 (new version)","id":"716","title":"Version 2 (new version)"},"717":{"body":"Note : This API is new, experimental and \"subject to change\". It is possible to query the status of the background task for deleting rooms. The status can be queried up to 24 hours after completion of the task, or until Synapse is restarted (whichever happens first).","breadcrumbs":"Administration » Admin API » Rooms » Status of deleting rooms","id":"717","title":"Status of deleting rooms"},"718":{"body":"With this API you can get the status of all active deletion tasks, and all those completed in the last 24h, for the given room_id. The API is: GET /_synapse/admin/v2/rooms//delete_status A response body like the following is returned: { \"results\": [ { \"delete_id\": \"delete_id1\", \"status\": \"failed\", \"error\": \"error message\", \"shutdown_room\": { \"kicked_users\": [], \"failed_to_kick_users\": [], \"local_aliases\": [], \"new_room_id\": null } }, { \"delete_id\": \"delete_id2\", \"status\": \"purging\", \"shutdown_room\": { \"kicked_users\": [ \"@foobar:example.com\" ], \"failed_to_kick_users\": [], \"local_aliases\": [ \"#badroom:example.com\", \"#evilsaloon:example.com\" ], \"new_room_id\": \"!newroomid:example.com\" } } ]\n} Parameters The following parameters should be set in the URL: room_id - The ID of the room.","breadcrumbs":"Administration » Admin API » Rooms » Query by room_id","id":"718","title":"Query by room_id"},"719":{"body":"With this API you can get the status of one specific task by delete_id. The API is: GET /_synapse/admin/v2/rooms/delete_status/ A response body like the following is returned: { \"status\": \"purging\", \"shutdown_room\": { \"kicked_users\": [ \"@foobar:example.com\" ], \"failed_to_kick_users\": [], \"local_aliases\": [ \"#badroom:example.com\", \"#evilsaloon:example.com\" ], \"new_room_id\": \"!newroomid:example.com\" }\n} Parameters The following parameters should be set in the URL: delete_id - The ID for this delete.","breadcrumbs":"Administration » Admin API » Rooms » Query by delete_id","id":"719","title":"Query by delete_id"},"72":{"body":"Synapse v1.81.0 deprecated application service authorization via query parameters as this is considered insecure - and from Synapse v1.71.0 forwards the application service token has also been sent via the Authorization header ], making the insecure query parameter authorization redundant. Since removing the ability to continue to use query parameters could break backwards compatibility it has now been put behind a configuration option, use_appservice_legacy_authorization. This option defaults to false, but can be activated by adding use_appservice_legacy_authorization: true to your configuration.","breadcrumbs":"Upgrading between Synapse Versions » App service query parameter authorization is now a configuration option","id":"72","title":"App service query parameter authorization is now a configuration option"},"720":{"body":"The following fields are returned in the JSON response body: results - An array of objects, each containing information about one task. This field is omitted from the result when you query by delete_id. Task objects contain the following fields: delete_id - The ID for this purge if you query by room_id. status - The status will be one of: shutting_down - The process is removing users from the room. purging - The process is purging the room and event data from database. complete - The process has completed successfully. failed - The process is aborted, an error has occurred. error - A string that shows an error message if status is failed. Otherwise this field is hidden. shutdown_room - An object containing information about the result of shutting down the room. Note: The result is shown after removing the room members. The delete process can still be running. Please pay attention to the status. kicked_users - An array of users (user_id) that were kicked. failed_to_kick_users - An array of users (user_id) that that were not kicked. local_aliases - An array of strings representing the local aliases that were migrated from the old room to the new. new_room_id - A string representing the room ID of the new room, or null if no such room was created.","breadcrumbs":"Administration » Admin API » Rooms » Response","id":"720","title":"Response"},"721":{"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":"721","title":"Undoing room deletions"},"722":{"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":"722","title":"Make Room Admin API"},"723":{"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":"723","title":"Forward Extremities Admin API"},"724":{"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":"724","title":"Check for forward extremities"},"725":{"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":"725","title":"Deleting forward extremities"},"726":{"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":"726","title":"Event Context API"},"727":{"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":"727","title":"Server Notices"},"728":{"body":"Returns information about all local media usage of users. Gives the possibility to filter them by time and user. To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API . The API is: GET /_synapse/admin/v1/statistics/users/media A response body like the following is returned: { \"users\": [ { \"displayname\": \"foo_user_0\", \"media_count\": 2, \"media_length\": 134, \"user_id\": \"@foo_user_0:test\" }, { \"displayname\": \"foo_user_1\", \"media_count\": 2, \"media_length\": 134, \"user_id\": \"@foo_user_1:test\" } ], \"next_token\": 3, \"total\": 10\n} To paginate, check for next_token and if present, call the endpoint 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":"728","title":"Users' media usage statistics"},"729":{"body":"Returns the 10 largest rooms and an estimate of how much space in the database they are taking. This does not include the size of any associated media associated with the room. Returns an error on SQLite. Note: This uses the planner statistics from PostgreSQL to do the estimates, which means that the returned information can vary widely from reality. However, it should be enough to get a rough idea of where database disk space is going. The API is: GET /_synapse/admin/v1/statistics/database/rooms A response body like the following is returned: { \"rooms\": [ { \"room_id\": \"!OGEhHVWSdvArJzumhm:matrix.org\", \"estimated_size\": 47325417353 } ],\n} Response The following fields are returned in the JSON response body: rooms - An array of objects, sorted by largest room first. Objects contain the following fields: room_id - string - The room ID. estimated_size - integer - Estimated disk space used in bytes by the room in the database. Added in Synapse 1.83.0","breadcrumbs":"Administration » Admin API » Statistics » Get largest rooms by size in database","id":"729","title":"Get largest rooms by size in database"},"73":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.89.0","id":"73","title":"Upgrading to v1.89.0"},"730":{"body":"To use it, you will need to authenticate by providing an access_token for a server admin: see Admin API .","breadcrumbs":"Administration » Admin API » Users » User Admin API","id":"730","title":"User Admin API"},"731":{"body":"This API returns information about a specific user account. The api is: GET /_synapse/admin/v2/users/ It returns a JSON body like the following: { \"name\": \"@user:example.com\", \"displayname\": \"User\", // can be null if not set \"threepids\": [ { \"medium\": \"email\", \"address\": \"\", \"added_at\": 1586458409743, \"validated_at\": 1586458409743 }, { \"medium\": \"email\", \"address\": \"\", \"added_at\": 1586458409743, \"validated_at\": 1586458409743 } ], \"avatar_url\": \"\", // can be null if not set \"is_guest\": 0, \"admin\": 0, \"deactivated\": 0, \"erased\": false, \"shadow_banned\": 0, \"creation_ts\": 1560432506, \"appservice_id\": null, \"consent_server_notice_sent\": null, \"consent_version\": null, \"consent_ts\": null, \"external_ids\": [ { \"auth_provider\": \"\", \"external_id\": \"\" }, { \"auth_provider\": \"\", \"external_id\": \"\" } ], \"user_type\": null, \"locked\": false\n} URL parameters: user_id: fully-qualified user id: for example, @user:server.com.","breadcrumbs":"Administration » Admin API » Users » Query User Account","id":"731","title":"Query User Account"},"732":{"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\", \"logout_devices\": false, \"displayname\": \"Alice Marigold\", \"avatar_url\": \"mxc://example.com/abcde12345\", \"threepids\": [ { \"medium\": \"email\", \"address\": \"alice@example.com\" }, { \"medium\": \"email\", \"address\": \"alice@domain.org\" } ], \"external_ids\": [ { \"auth_provider\": \"example\", \"external_id\": \"12345\" }, { \"auth_provider\": \"example2\", \"external_id\": \"abc54321\" } ], \"admin\": false, \"deactivated\": false, \"user_type\": null, \"locked\": false\n} Returns HTTP status code: 201 - When a new user object was created. 200 - When a user was modified. URL parameters: user_id - A fully-qualified user id. For example, @user:server.com. Body parameters: password - string , optional. If provided, the user's password is updated and all devices are logged out, unless logout_devices is set to false. logout_devices - bool , optional, defaults to true. If set to false, devices aren't logged out even when password is provided. displayname - string , optional. If set to an empty string (\"\"), the user's display name will be removed. avatar_url - string , optional. Must be a MXC URI . If set to an empty string (\"\"), the user's avatar is removed. threepids - array , optional. If provided, the user's third-party IDs (email, msisdn) are entirely replaced with the given list. Each item in the array is an object with the following fields: medium - string , required. The type of third-party ID, either email or msisdn (phone number). address - string , required. The third-party ID itself, e.g. alice@example.com for email or 447470274584 (for a phone number with country code \"44\") and 19254857364 (for a phone number with country code \"1\") for msisdn. Note: If a threepid is removed from a user via this option, Synapse will also attempt to remove that threepid from any identity servers it is aware has a binding for it. external_ids - array , optional. Allow setting the identifier of the external identity provider for SSO (Single sign-on). More details are in the configuration manual under the sections sso and oidc_providers . auth_provider - string , required. The unique, internal ID of the external identity provider. The same as idp_id from the homeserver configuration. Note that no error is raised if the provided value is not in the homeserver configuration. external_id - string , required. An identifier for the user in the external identity provider. When the user logs in to the identity provider, this must be the unique ID that they map to. admin - bool , optional, defaults to false. Whether the user is a homeserver administrator, granting them access to the Admin API, among other things. deactivated - bool , optional. If unspecified, deactivation state will be left unchanged. Note: For the password field there is no strict check of the necessity for its presence. It is possible to have active users without a password, e.g. when authenticating with OIDC is configured. You must check yourself whether a password is required when reactivating a user or not. It is not possible to set a password if the config option password_config.localdb_enabled is set false. Users' passwords are wiped upon account deactivation, hence the need to set a new one here. Note: a user cannot be erased with this API. For more details on deactivating and erasing users see Deactivate Account . locked - bool , optional. If unspecified, locked state will be left unchanged. user_type - string or null, optional. If not provided, the user type will be not be changed. If null is given, the user type will be cleared. Other allowed options are: bot and support.","breadcrumbs":"Administration » Admin API » Users » Create or modify account","id":"732","title":"Create or modify account"},"733":{"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 A response body like the following is returned: { \"users\": [ { \"name\": \"\", \"is_guest\": 0, \"admin\": 0, \"user_type\": null, \"deactivated\": 0, \"erased\": false, \"shadow_banned\": 0, \"displayname\": \"\", \"avatar_url\": null, \"creation_ts\": 1560432668000, \"locked\": false }, { \"name\": \"\", \"is_guest\": 0, \"admin\": 1, \"user_type\": null, \"deactivated\": 0, \"erased\": false, \"shadow_banned\": 0, \"displayname\": \"\", \"avatar_url\": \"\", \"creation_ts\": 1561550621000, \"locked\": false } ], \"next_token\": \"100\", \"total\": 200\n} To paginate, check for next_token and if present, call the endpoint again 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. This parameter is not supported when MSC3861 is enabled. See #15582 admins - Optional flag to filter admins. If true, only admins are queried. If false, admins are excluded from the query. When the flag is absent (the default), both admins and non-admins are included in the search results. deactivated - string representing a bool - Is optional and if true will include deactivated users. 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. last_seen_ts - Users are ordered by when the user was lastly seen in ms. dir - Direction of media order. Either f for forwards or b for backwards. Setting this value to b will reverse the above sort order. Defaults to f. not_user_type - Exclude certain user types, such as bot users, from the request. Can be provided multiple times. Possible values are bot, support or \"empty string\". \"empty string\" here means to exclude users without a type. locked - string representing a bool - Is optional and if true will include locked users. Defaults to false to exclude locked users. Note: Introduced in v1.93. 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. erased - bool - Status if that user has been marked as erased. shadow_banned - bool - Status if that user has been marked as shadow banned. displayname - string - The user's display name if they have set one. avatar_url - string - The user's avatar URL if they have set one. creation_ts - integer - The user's creation timestamp in ms. last_seen_ts - integer - The user's last activity timestamp in ms. locked - bool - Status if that user has been marked as locked. Note: Introduced in v1.93. next_token: string representing a positive integer - Indication for pagination. See above. total - integer - Total number of media. Added in Synapse 1.93: the locked query parameter and response field.","breadcrumbs":"Administration » Admin API » Users » List Accounts","id":"733","title":"List Accounts"},"734":{"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 . 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":"734","title":"Query current sessions for a user"},"735":{"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} 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 unbind 3PIDs from the identity server Remove all 3PIDs from the homeserver Delete all devices and E2EE keys Delete all access tokens Delete all pushers Delete the password hash Removal from all rooms the user is a member of Remove the user from the user directory Reject all pending invites Remove all account validity information related to the user Remove the arbitrary data store known as account data . For example, this includes: list of ignored users; push rules; secret storage keys; and cross-signing keys. The following additional actions are performed during deactivation if erase 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 Remove the user's creation (registration) timestamp Remove rate limit overrides Remove from monthly active users Remove user's consent information (consent version and timestamp)","breadcrumbs":"Administration » Admin API » Users » Deactivate Account","id":"735","title":"Deactivate Account"},"736":{"body":"Note: This API is disabled when MSC3861 is enabled. See #15582 Changes the password of another user. This will automatically log the user out of all their devices. The api is: POST /_synapse/admin/v1/reset_password/ with a body of: { \"new_password\": \"\", \"logout_devices\": true\n} The parameter new_password is required. The parameter logout_devices is optional and defaults to true.","breadcrumbs":"Administration » Admin API » Users » Reset password","id":"736","title":"Reset password"},"737":{"body":"Note: This API is disabled when MSC3861 is enabled. See #15582 The api is: GET /_synapse/admin/v1/users//admin A response body like the following is returned: { \"admin\": true\n}","breadcrumbs":"Administration » Admin API » Users » Get whether a user is a server administrator or not","id":"737","title":"Get whether a user is a server administrator or not"},"738":{"body":"Note: This API is disabled when MSC3861 is enabled. See #15582 Note that you cannot demote yourself. The api is: PUT /_synapse/admin/v1/users//admin with a body of: { \"admin\": true\n}","breadcrumbs":"Administration » Admin API » Users » Change whether a user is a server administrator or not","id":"738","title":"Change whether a user is a server administrator or not"},"739":{"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 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":"739","title":"List room memberships of a user"},"74":{"body":"Application services can no longer call /register with a user property to create new users. The standard username property should be used instead. See the Application Service specification for more information.","breadcrumbs":"Upgrading between Synapse Versions » Removal of unspecced user property for /register","id":"74","title":"Removal of unspecced user property for /register"},"740":{"body":"Gets information about account data for a specific user_id. The API is: GET /_synapse/admin/v1/users//accountdata A response body like the following is returned: { \"account_data\": { \"global\": { \"m.secret_storage.key.LmIGHTg5W\": { \"algorithm\": \"m.secret_storage.v1.aes-hmac-sha2\", \"iv\": \"fwjNZatxg==\", \"mac\": \"eWh9kNnLWZUNOgnc=\" }, \"im.vector.hide_profile\": { \"hide_profile\": true }, \"org.matrix.preview_urls\": { \"disable\": false }, \"im.vector.riot.breadcrumb_rooms\": { \"rooms\": [ \"!LxcBDAsDUVAfJDEo:matrix.org\", \"!MAhRxqasbItjOqxu:matrix.org\" ] }, \"m.accepted_terms\": { \"accepted\": [ \"https://example.org/somewhere/privacy-1.2-en.html\", \"https://example.org/somewhere/terms-2.0-en.html\" ] }, \"im.vector.setting.breadcrumbs\": { \"recent_rooms\": [ \"!MAhRxqasbItqxuEt:matrix.org\", \"!ZtSaPCawyWtxiImy:matrix.org\" ] } }, \"rooms\": { \"!GUdfZSHUJibpiVqHYd:matrix.org\": { \"m.fully_read\": { \"event_id\": \"$156334540fYIhZ:matrix.org\" } }, \"!tOZwOOiqwCYQkLhV:matrix.org\": { \"m.fully_read\": { \"event_id\": \"$xjsIyp4_NaVl2yPvIZs_k1Jl8tsC_Sp23wjqXPno\" } } } }\n} Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. Response The following fields are returned in the JSON response body: account_data - A map containing the account data for the user global - A map containing the global account data for the user rooms - A map containing the account data per room for the user","breadcrumbs":"Administration » Admin API » Users » Account Data","id":"740","title":"Account Data"},"741":{"body":"","breadcrumbs":"Administration » Admin API » Users » User media","id":"741","title":"User media"},"742":{"body":"Gets a list of all local media that a specific user_id has created. These are media that the user has uploaded themselves ( local media ), as well as URL preview images requested by the user if the feature is enabled . By default, the response is ordered by descending creation date and ascending media ID. 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 A response body like the following is returned: { \"media\": [ { \"created_ts\": 100400, \"last_access_ts\": null, \"media_id\": \"qXhyRzulkwLsNHTbpHreuEgo\", \"media_length\": 67, \"media_type\": \"image/png\", \"quarantined_by\": null, \"safe_from_quarantine\": false, \"upload_name\": \"test1.png\" }, { \"created_ts\": 200400, \"last_access_ts\": null, \"media_id\": \"FHfiSnzoINDatrXHQIXBtahw\", \"media_length\": 67, \"media_type\": \"image/png\", \"quarantined_by\": null, \"safe_from_quarantine\": false, \"upload_name\": \"test2.png\" }, { \"created_ts\": 300400, \"last_access_ts\": 300700, \"media_id\": \"BzYNLRUgGHphBkdKGbzXwbjX\", \"media_length\": 1337, \"media_type\": \"application/octet-stream\", \"quarantined_by\": null, \"safe_from_quarantine\": false, \"upload_name\": null } ], \"next_token\": 3, \"total\": 2\n} To paginate, check for next_token and if present, call the endpoint again 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 or null - Timestamp when the content was last accessed in ms. Null if there was no access, yet. media_id - string - The id used to refer to the media. Details about the format are documented under media repository . media_length - integer - Length of the media in bytes. media_type - string - The MIME-type of the media. quarantined_by - string or null - The user ID that initiated the quarantine request for this media. Null if not quarantined. safe_from_quarantine - bool - Status if this media is safe from quarantining. upload_name - string or null - The name the media was uploaded with. Null if not provided during upload. next_token: integer - Indication for pagination. See above. total - integer - Total number of media.","breadcrumbs":"Administration » Admin API » Users » List media uploaded by a user","id":"742","title":"List media uploaded by a user"},"743":{"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 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":"743","title":"Delete media uploaded by a user"},"744":{"body":"Note: This API is disabled when MSC3861 is enabled. See #15582 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. Note that this API does not allow a user to login as themselves (to create more tokens). A response body like the following is returned: { \"access_token\": \"\"\n} This API does not generate a new device for the user, and so will not appear 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":"744","title":"Login as a user"},"745":{"body":"This endpoint is not intended for server administrator usage; we describe it here for completeness. This API temporarily permits a user to replace their master cross-signing key without going through user-interactive authentication (UIA). This is useful when Synapse has delegated its authentication to the Matrix Authentication Service ; as Synapse cannot perform UIA is not possible in these circumstances. The API is POST /_synapse/admin/v1/users//_allow_cross_signing_replacement_without_uia\n{} If the user does not exist, or does exist but has no master cross-signing key, this will return with status code 404 Not Found. Otherwise, a response body like the following is returned, with status 200 OK: { \"updatable_without_uia_before_ms\": 1234567890\n} The response body is a JSON object with a single field: updatable_without_uia_before_ms: integer. The timestamp in milliseconds before which the user is permitted to replace their cross-signing key without going through UIA. Added in Synapse 1.97.0.","breadcrumbs":"Administration » Admin API » Users » Allow replacing master cross-signing key without User-Interactive Auth","id":"745","title":"Allow replacing master cross-signing key without User-Interactive Auth"},"746":{"body":"","breadcrumbs":"Administration » Admin API » Users » User devices","id":"746","title":"User devices"},"747":{"body":"Gets information about all devices for a specific user_id. The API is: GET /_synapse/admin/v2/users//devices A response body like the following is returned: { \"devices\": [ { \"device_id\": \"QBUAZIFURK\", \"display_name\": \"android\", \"last_seen_ip\": \"1.2.3.4\", \"last_seen_user_agent\": \"Mozilla/5.0 (X11; Linux x86_64; rv:103.0) Gecko/20100101 Firefox/103.0\", \"last_seen_ts\": 1474491775024, \"user_id\": \"\" }, { \"device_id\": \"AUIECTSRND\", \"display_name\": \"ios\", \"last_seen_ip\": \"1.2.3.5\", \"last_seen_user_agent\": \"Mozilla/5.0 (X11; Linux x86_64; rv:103.0) Gecko/20100101 Firefox/103.0\", \"last_seen_ts\": 1474491775025, \"user_id\": \"\" } ], \"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_user_agent - The user agent of the device when it 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":"747","title":"List all devices"},"748":{"body":"Creates a new device for a specific user_id and device_id. Does nothing if the device_id exists already. The API is: POST /_synapse/admin/v2/users//devices { \"device_id\": \"QBUAZIFURK\"\n} An empty JSON dict is returned. Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. The following fields are required in the JSON request body: device_id - The device ID to create.","breadcrumbs":"Administration » Admin API » Users » Create a device","id":"748","title":"Create a device"},"749":{"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} 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":"749","title":"Delete multiple devices"},"75":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.88.0","id":"75","title":"Upgrading to v1.88.0"},"750":{"body":"Gets information on a single device, by device_id for a specific user_id. The API is: GET /_synapse/admin/v2/users//devices/ A response body like the following is returned: { \"device_id\": \"\", \"display_name\": \"android\", \"last_seen_ip\": \"1.2.3.4\", \"last_seen_user_agent\": \"Mozilla/5.0 (X11; Linux x86_64; rv:103.0) Gecko/20100101 Firefox/103.0\", \"last_seen_ts\": 1474491775024, \"user_id\": \"\"\n} Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. device_id - The device to retrieve. Response The following fields are returned in the JSON response body: device_id - Identifier of device. display_name - Display name set by the user for this device. 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_user_agent - The user agent of the device when it 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.","breadcrumbs":"Administration » Admin API » Users » Show a device","id":"750","title":"Show a device"},"751":{"body":"Updates the metadata on the given device_id for a specific user_id. The API is: PUT /_synapse/admin/v2/users//devices/ { \"display_name\": \"My other phone\"\n} An empty JSON dict is returned. Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. device_id - The device to update. The following fields are required in the JSON request body: display_name - The new display name for this device. If not given, the display name is unchanged.","breadcrumbs":"Administration » Admin API » Users » Update a device","id":"751","title":"Update a device"},"752":{"body":"Deletes the given device_id for a specific user_id, and invalidates any access token associated with it. The API is: DELETE /_synapse/admin/v2/users//devices/ {} An empty JSON dict is returned. Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. device_id - The device to delete.","breadcrumbs":"Administration » Admin API » Users » Delete a device","id":"752","title":"Delete a device"},"753":{"body":"Gets information about all pushers for a specific user_id. The API is: GET /_synapse/admin/v1/users//pushers A response body like the following is returned: { \"pushers\": [ { \"app_display_name\":\"HTTP Push Notifications\", \"app_id\":\"m.http\", \"data\": { \"url\":\"example.com\" }, \"device_display_name\":\"pushy push\", \"kind\":\"http\", \"lang\":\"None\", \"profile_tag\":\"\", \"pushkey\":\"a@example.com\" } ], \"total\": 1\n} Parameters The following parameters should be set in the URL: user_id - fully qualified: for example, @user:server.com. Response The following fields are returned in the JSON response body: pushers - An array containing the current pushers for the user app_display_name - string - A string that will allow the user to identify what application owns this pusher. app_id - string - This is a reverse-DNS style identifier for the application. Max length, 64 chars. data - A dictionary of information for the pusher implementation itself. url - string - Required if kind is http. The URL to use to send notifications to. format - string - The format to use when sending notifications to the Push Gateway. device_display_name - string - A string that will allow the user to identify what device owns this pusher. profile_tag - string - This string determines which set of device specific rules this pusher executes. kind - string - The kind of pusher. \"http\" is a pusher that sends HTTP pokes. lang - string - The preferred language for receiving notifications (e.g. 'en' or 'en-US') profile_tag - string - This string determines which set of device specific rules this pusher executes. pushkey - string - This is a unique identifier for this pusher. Max length, 512 bytes. total - integer - Number of pushers. See also the Client-Server API Spec on pushers .","breadcrumbs":"Administration » Admin API » Users » List all pushers","id":"753","title":"List all pushers"},"754":{"body":"Shadow-banning is a useful tool for moderating malicious or egregiously abusive users. A shadow-banned users receives successful responses to their client-server API requests, but the events are not propagated into rooms. This can be an effective tool as it (hopefully) takes longer for the user to realise they are being moderated before pivoting to another account. Shadow-banning a user should be used as a tool of last resort and may lead to confusing or broken behaviour for the client. A shadow-banned user will not receive any notification and it is generally more appropriate to ban or kick abusive users. A shadow-banned user will be unable to contact anyone on the server. To shadow-ban a user the API is: POST /_synapse/admin/v1/users//shadow_ban To un-shadow-ban a user the API is: DELETE /_synapse/admin/v1/users//shadow_ban An empty JSON dict is returned in both cases. Parameters The following parameters should be set in the URL: user_id - The fully qualified MXID: for example, @user:server.com. The user must be local.","breadcrumbs":"Administration » Admin API » Users » Controlling whether a user is shadow-banned","id":"754","title":"Controlling whether a user is shadow-banned"},"755":{"body":"This API allows to override or disable ratelimiting for a specific user. There are specific APIs to set, get and delete a ratelimit.","breadcrumbs":"Administration » Admin API » Users » Override ratelimiting for users","id":"755","title":"Override ratelimiting for users"},"756":{"body":"The API is: GET /_synapse/admin/v1/users//override_ratelimit A response body like the following is returned: { \"messages_per_second\": 0, \"burst_count\": 0\n} Parameters The following parameters should be set in the URL: user_id - The fully qualified MXID: for example, @user:server.com. The user must be local. Response The following fields are returned in the JSON response body: messages_per_second - integer - The number of actions that can be performed in a second. 0 mean that ratelimiting is disabled for this user. burst_count - integer - How many actions that can be performed before being limited. If no custom ratelimit is set, an empty JSON dict is returned. {}","breadcrumbs":"Administration » Admin API » Users » Get status of ratelimit","id":"756","title":"Get status of ratelimit"},"757":{"body":"The API is: POST /_synapse/admin/v1/users//override_ratelimit A response body like the following is returned: { \"messages_per_second\": 0, \"burst_count\": 0\n} Parameters The following parameters should be set in the URL: user_id - The fully qualified MXID: for example, @user:server.com. The user must be local. Body parameters: messages_per_second - positive integer, optional. The number of actions that can be performed in a second. Defaults to 0. burst_count - positive integer, optional. How many actions that can be performed before being limited. Defaults to 0. To disable users' ratelimit set both values to 0. Response The following fields are returned in the JSON response body: messages_per_second - integer - The number of actions that can be performed in a second. burst_count - integer - How many actions that can be performed before being limited.","breadcrumbs":"Administration » Admin API » Users » Set ratelimit","id":"757","title":"Set ratelimit"},"758":{"body":"The API is: DELETE /_synapse/admin/v1/users//override_ratelimit An empty JSON dict is returned. {} Parameters The following parameters should be set in the URL: user_id - The fully qualified MXID: for example, @user:server.com. The user must be local.","breadcrumbs":"Administration » Admin API » Users » Delete ratelimit","id":"758","title":"Delete ratelimit"},"759":{"body":"Checks to see if a username is available, and valid, for the server. See the client-server API for more information. This endpoint will work even if registration is disabled on the server, unlike /_matrix/client/r0/register/available. The API is: GET /_synapse/admin/v1/username_available?username=$localpart The request and response format is the same as the /_matrix/client/r0/register/available API.","breadcrumbs":"Administration » Admin API » Users » Check username availability","id":"759","title":"Check username availability"},"76":{"body":"The minimum supported Python version has been increased from v3.7 to v3.8. You will need Python 3.8 to run Synapse v1.88.0 (due out July 18th, 2023). If you use current versions of the Matrix.org-distributed Debian packages or Docker images, no action is required.","breadcrumbs":"Upgrading between Synapse Versions » Minimum supported Python version","id":"76","title":"Minimum supported Python version"},"760":{"body":"The API is: GET /_synapse/admin/v1/auth_providers/$provider/users/$external_id When a user matched the given ID for the given provider, an HTTP code 200 with a response body like the following is returned: { \"user_id\": \"@hello:example.org\"\n} Parameters The following parameters should be set in the URL: provider - The ID of the authentication provider, as advertised by the GET /_matrix/client/v3/login API in the m.login.sso authentication method. external_id - The user ID from the authentication provider. Usually corresponds to the sub claim for OIDC providers, or to the uid attestation for SAML2 providers. The external_id may have characters that are not URL-safe (typically /, : or @), so it is advised to URL-encode those parameters. Errors Returns a 404 HTTP status code if no user was found, with a response body like this: { \"errcode\":\"M_NOT_FOUND\", \"error\":\"User not found\"\n} Added in Synapse 1.68.0.","breadcrumbs":"Administration » Admin API » Users » Find a user based on their ID in an auth provider","id":"760","title":"Find a user based on their ID in an auth provider"},"761":{"body":"The API is: GET /_synapse/admin/v1/threepid/$medium/users/$address When a user matched the given address for the given medium, an HTTP code 200 with a response body like the following is returned: { \"user_id\": \"@hello:example.org\"\n} Parameters The following parameters should be set in the URL: medium - Kind of third-party ID, either email or msisdn. address - Value of the third-party ID. The address may have characters that are not URL-safe, so it is advised to URL-encode those parameters. Errors Returns a 404 HTTP status code if no user was found, with a response body like this: { \"errcode\":\"M_NOT_FOUND\", \"error\":\"User not found\"\n} Added in Synapse 1.72.0.","breadcrumbs":"Administration » Admin API » Users » Find a user based on their Third Party ID (ThreePID or 3PID)","id":"761","title":"Find a user based on their Third Party ID (ThreePID or 3PID)"},"762":{"body":"This API returns the running Synapse version. This is useful when a Synapse instance is behind a proxy that does not forward the 'Server' header (which also contains Synapse version information). The api is: GET /_synapse/admin/v1/server_version It returns a JSON body like the following: { \"server_version\": \"0.99.2rc1 (b=develop, abcdef123)\"\n} Changed in Synapse 1.94.0: The python_version key was removed from the response body.","breadcrumbs":"Administration » Admin API » Server Version » Version API","id":"762","title":"Version API"},"763":{"body":"This API allows a server administrator to manage Synapse's federation with other homeservers. Note: This API is new, experimental and \"subject to change\".","breadcrumbs":"Administration » Admin API » Federation » Federation API","id":"763","title":"Federation API"},"764":{"body":"This API gets the current destination retry timing info for all remote servers. The list contains all the servers with which the server federates, regardless of whether an error occurred or not. If an error occurs, it may take up to 20 minutes for the error to be displayed here, as a complete retry must have failed. The API is: A standard request with no filtering: GET /_synapse/admin/v1/federation/destinations A response body like the following is returned: { \"destinations\":[ { \"destination\": \"matrix.org\", \"retry_last_ts\": 1557332397936, \"retry_interval\": 3000000, \"failure_ts\": 1557329397936, \"last_successful_stream_ordering\": null } ], \"total\": 1\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 destinations to paginate through. Parameters The following query parameters are available: from - Offset in the returned list. Defaults to 0. limit - Maximum amount of destinations to return. Defaults to 100. order_by - The method in which to sort the returned list of destinations. Valid values are: destination - Destinations are ordered alphabetically by remote server name. This is the default. retry_last_ts - Destinations are ordered by time of last retry attempt in ms. retry_interval - Destinations are ordered by how long until next retry in ms. failure_ts - Destinations are ordered by when the server started failing in ms. last_successful_stream_ordering - Destinations are ordered by the stream ordering of the most recent successfully-sent PDU. 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. Caution: The database only has an index on the column destination. This means that if a different sort order is used, this can cause a large load on the database, especially for large environments. Response The following fields are returned in the JSON response body: destinations - An array of objects, each containing information about a destination. Destination objects contain the following fields: destination - string - Name of the remote server to federate. retry_last_ts - integer - The last time Synapse tried and failed to reach the remote server, in ms. This is 0 if the last attempt to communicate with the remote server was successful. retry_interval - integer - How long since the last time Synapse tried to reach the remote server before trying again, in ms. This is 0 if no further retrying occurring. failure_ts - nullable integer - The first time Synapse tried and failed to reach the remote server, in ms. This is null if communication with the remote server has never failed. last_successful_stream_ordering - nullable integer - The stream ordering of the most recent successfully-sent PDU to this destination, or null if this information has not been tracked yet. next_token: string representing a positive integer - Indication for pagination. See above. total - integer - Total number of destinations.","breadcrumbs":"Administration » Admin API » Federation » List of destinations","id":"764","title":"List of destinations"},"765":{"body":"This API gets the retry timing info for a specific remote server. The API is: GET /_synapse/admin/v1/federation/destinations/ A response body like the following is returned: { \"destination\": \"matrix.org\", \"retry_last_ts\": 1557332397936, \"retry_interval\": 3000000, \"failure_ts\": 1557329397936, \"last_successful_stream_ordering\": null\n} Parameters The following parameters should be set in the URL: destination - Name of the remote server. Response The response fields are the same like in the destinations array in List of destinations response.","breadcrumbs":"Administration » Admin API » Federation » Destination Details API","id":"765","title":"Destination Details API"},"766":{"body":"This API gets the rooms that federate with a specific remote server. The API is: GET /_synapse/admin/v1/federation/destinations//rooms A response body like the following is returned: { \"rooms\":[ { \"room_id\": \"!OGEhHVWSdvArJzumhm:matrix.org\", \"stream_ordering\": 8326 }, { \"room_id\": \"!xYvNcQPhnkrdUmYczI:matrix.org\", \"stream_ordering\": 93534 } ], \"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 destinations to paginate through. Parameters The following parameters should be set in the URL: destination - Name of the remote server. The following query parameters are available: from - Offset in the returned list. Defaults to 0. limit - Maximum amount of destinations to return. Defaults to 100. dir - Direction of room order by room_id. Either f for forwards or b for backwards. Defaults to f. Response The following fields are returned in the JSON response body: rooms - An array of objects, each containing information about a room. Room objects contain the following fields: room_id - string - The ID of the room. stream_ordering - integer - The stream ordering of the most recent successfully-sent PDU to this destination in this room. next_token: string representing a positive integer - Indication for pagination. See above. total - integer - Total number of destinations.","breadcrumbs":"Administration » Admin API » Federation » Destination rooms","id":"766","title":"Destination rooms"},"767":{"body":"Synapse makes federation requests to other homeservers. If a federation request fails, Synapse will mark the destination homeserver as offline, preventing any future requests to that server for a \"cooldown\" period. This period grows over time if the server continues to fail its responses ( exponential backoff ). Admins can cancel the cooldown period with this API. This API resets the retry timing for a specific remote server and tries to connect to the remote server again. It does not wait for the next retry_interval. The connection must have previously run into an error and retry_last_ts ( Destination Details API ) must not be equal to 0. The connection attempt is carried out in the background and can take a while even if the API already returns the http status 200. The API is: POST /_synapse/admin/v1/federation/destinations//reset_connection {} Parameters The following parameters should be set in the URL: destination - Name of the remote server.","breadcrumbs":"Administration » Admin API » Federation » Reset connection timeout","id":"767","title":"Reset connection timeout"},"768":{"body":"The \"manhole\" allows server administrators to access a Python shell on a running Synapse installation. This is a very powerful mechanism for administration and debugging. Security Warning Note that this will give administrative access to synapse to all users with shell access to the server. It should therefore not be enabled in environments where untrusted users have shell access.","breadcrumbs":"Administration » Manhole » Using the synapse manhole","id":"768","title":"Using the synapse manhole"},"769":{"body":"To enable it, first add the manhole listener configuration in your homeserver.yaml. You can find information on how to do that in the configuration manual . The configuration is slightly different if you're using docker. Docker config If you are using Docker, set bind_addresses to ['0.0.0.0'] as shown: listeners: - port: 9000 bind_addresses: ['0.0.0.0'] type: manhole When using docker run to start the server, you will then need to change the command to the following to include the manhole port forwarding. The -p 127.0.0.1:9000:9000 below is important: it ensures that access to the manhole is only possible for local users. docker run -d --name synapse \\ --mount type=volume,src=synapse-data,dst=/data \\ -p 8008:8008 \\ -p 127.0.0.1:9000:9000 \\ vectorim/synapse:latest Native config If you are not using docker, set bind_addresses to ['::1', '127.0.0.1'] as shown. The bind_addresses in the example below is important: it ensures that access to the manhole is only possible for local users). listeners: - port: 9000 bind_addresses: ['::1', '127.0.0.1'] type: manhole","breadcrumbs":"Administration » Manhole » Configuring the manhole","id":"769","title":"Configuring the manhole"},"77":{"body":"As mentioned previously in Upgrading to v1.84.0 , the following deprecated settings are being removed in this release of Synapse: worker_replication_host worker_replication_http_port worker_replication_http_tls Please ensure that you have migrated to using main on your shared configuration's instance_map (or create one if necessary). This is required if you have any workers at all; administrators of single-process (monolith) installations don't need to do anything. For an illustrative example, please see Upgrading to v1.84.0 below.","breadcrumbs":"Upgrading between Synapse Versions » Removal of worker_replication_* settings","id":"77","title":"Removal of worker_replication_* settings"},"770":{"body":"The following config options are available: username - The username for the manhole (defaults to matrix) password - The password for the manhole (defaults to rabbithole) ssh_priv_key - The path to a private SSH key (defaults to a hardcoded value) ssh_pub_key - The path to a public SSH key (defaults to a hardcoded value) For example: manhole_settings: username: manhole password: mypassword ssh_priv_key: \"/home/synapse/manhole_keys/id_rsa\" ssh_pub_key: \"/home/synapse/manhole_keys/id_rsa.pub\"","breadcrumbs":"Administration » Manhole » Security settings","id":"770","title":"Security settings"},"771":{"body":"Then restart synapse, and point an ssh client at port 9000 on localhost, using the username and password configured in homeserver.yaml - with the default configuration, this would be: ssh -p9000 matrix@localhost Then enter the password when prompted (the default is rabbithole). This gives a Python REPL in which hs gives access to the synapse.server.HomeServer object - which in turn gives access to many other parts of the process. Note that, prior to Synapse 1.41, any call which returns a coroutine will need to be wrapped in ensureDeferred. As a simple example, retrieving an event from the database: >>> from twisted.internet import defer\n>>> defer.ensureDeferred(hs.get_datastores().main.get_event('$1416420717069yeQaw:matrix.org'))\n>","breadcrumbs":"Administration » Manhole » Accessing synapse manhole","id":"771","title":"Accessing synapse manhole"},"772":{"body":"Install Prometheus: Follow instructions at http://prometheus.io/docs/introduction/install/ Enable Synapse metrics: In homeserver.yaml, make sure enable_metrics is set to True. Enable the /_synapse/metrics Synapse endpoint that Prometheus uses to collect data: There are two methods of enabling the metrics endpoint in Synapse. The first serves the metrics as a part of the usual web server and can be enabled by adding the metrics resource to the existing listener as such as in this example: listeners: - port: 8008 tls: false type: http x_forwarded: true bind_addresses: ['::1', '127.0.0.1'] resources: # added \"metrics\" in this line - names: [client, federation, metrics] compress: false This provides a simple way of adding metrics to your Synapse installation, and serves under /_synapse/metrics. If you do not wish your metrics be publicly exposed, you will need to either filter it out at your load balancer, or use the second method. The second method runs the metrics server on a different port, in a different thread to Synapse. This can make it more resilient to heavy load meaning metrics cannot be retrieved, and can be exposed to just internal networks easier. The served metrics are available over HTTP only, and will be available at /_synapse/metrics. Add a new listener to homeserver.yaml as in this example: listeners: - port: 8008 tls: false type: http x_forwarded: true bind_addresses: ['::1', '127.0.0.1'] resources: - names: [client, federation] compress: false # beginning of the new metrics listener - port: 9000 type: metrics bind_addresses: ['::1', '127.0.0.1'] Restart Synapse. Add a Prometheus target for Synapse. It needs to set the metrics_path to a non-default value (under scrape_configs): - job_name: \"synapse\" scrape_interval: 15s metrics_path: \"/_synapse/metrics\" static_configs: - targets: [\"my.server.here:port\"] where my.server.here is the IP address of Synapse, and port is the listener port configured with the metrics resource. If your prometheus is older than 1.5.2, you will need to replace static_configs in the above with target_groups. Restart Prometheus. Consider using the grafana dashboard and required recording rules","breadcrumbs":"Administration » Monitoring » How to monitor Synapse metrics using Prometheus","id":"772","title":"How to monitor Synapse metrics using Prometheus"},"773":{"body":"To monitor a Synapse installation using workers , every worker needs to be monitored independently, in addition to the main homeserver process. This is because workers don't send their metrics to the main homeserver process, but expose them directly (if they are configured to do so). To allow collecting metrics from a worker, you need to add a metrics listener to its configuration, by adding the following under worker_listeners: - type: metrics bind_address: '' port: 9101 The bind_address and port parameters should be set so that the resulting listener can be reached by prometheus, and they don't clash with an existing worker. With this example, the worker's metrics would then be available on http://127.0.0.1:9101. Example Prometheus target for Synapse with workers: - job_name: \"synapse\" scrape_interval: 15s metrics_path: \"/_synapse/metrics\" static_configs: - targets: [\"my.server.here:port\"] labels: instance: \"my.server\" job: \"master\" index: 1 - targets: [\"my.workerserver.here:port\"] labels: instance: \"my.server\" job: \"generic_worker\" index: 1 - targets: [\"my.workerserver.here:port\"] labels: instance: \"my.server\" job: \"generic_worker\" index: 2 - targets: [\"my.workerserver.here:port\"] labels: instance: \"my.server\" job: \"media_repository\" index: 1 Labels (instance, job, index) can be defined as anything. The labels are used to group graphs in grafana.","breadcrumbs":"Administration » Monitoring » Monitoring workers","id":"773","title":"Monitoring workers"},"774":{"body":"Synapse 1.2 updates the Prometheus metrics to match the naming convention of the upstream prometheus_client. The old names are considered deprecated and will be removed in a future version of Synapse. The old names will be disabled by default in Synapse v1.71.0 and removed altogether in Synapse v1.73.0. New Name Old Name python_gc_objects_collected_total python_gc_objects_collected python_gc_objects_uncollectable_total python_gc_objects_uncollectable python_gc_collections_total python_gc_collections process_cpu_seconds_total process_cpu_seconds synapse_federation_client_sent_transactions_total synapse_federation_client_sent_transactions synapse_federation_client_events_processed_total synapse_federation_client_events_processed synapse_event_processing_loop_count_total synapse_event_processing_loop_count synapse_event_processing_loop_room_count_total synapse_event_processing_loop_room_count synapse_util_caches_cache_hits synapse_util_caches_cache:hits synapse_util_caches_cache_size synapse_util_caches_cache:size synapse_util_caches_cache_evicted_size synapse_util_caches_cache:evicted_size synapse_util_caches_cache synapse_util_caches_cache:total synapse_util_caches_response_cache_size synapse_util_caches_response_cache:size synapse_util_caches_response_cache_hits synapse_util_caches_response_cache:hits synapse_util_caches_response_cache_evicted_size synapse_util_caches_response_cache:evicted_size synapse_util_metrics_block_count_total synapse_util_metrics_block_count synapse_util_metrics_block_time_seconds_total synapse_util_metrics_block_time_seconds synapse_util_metrics_block_ru_utime_seconds_total synapse_util_metrics_block_ru_utime_seconds synapse_util_metrics_block_ru_stime_seconds_total synapse_util_metrics_block_ru_stime_seconds synapse_util_metrics_block_db_txn_count_total synapse_util_metrics_block_db_txn_count synapse_util_metrics_block_db_txn_duration_seconds_total synapse_util_metrics_block_db_txn_duration_seconds synapse_util_metrics_block_db_sched_duration_seconds_total synapse_util_metrics_block_db_sched_duration_seconds synapse_background_process_start_count_total synapse_background_process_start_count synapse_background_process_ru_utime_seconds_total synapse_background_process_ru_utime_seconds synapse_background_process_ru_stime_seconds_total synapse_background_process_ru_stime_seconds synapse_background_process_db_txn_count_total synapse_background_process_db_txn_count synapse_background_process_db_txn_duration_seconds_total synapse_background_process_db_txn_duration_seconds synapse_background_process_db_sched_duration_seconds_total synapse_background_process_db_sched_duration_seconds synapse_storage_events_persisted_events_total synapse_storage_events_persisted_events synapse_storage_events_persisted_events_sep_total synapse_storage_events_persisted_events_sep synapse_storage_events_state_delta_total synapse_storage_events_state_delta synapse_storage_events_state_delta_single_event_total synapse_storage_events_state_delta_single_event synapse_storage_events_state_delta_reuse_delta_total synapse_storage_events_state_delta_reuse_delta synapse_federation_server_received_pdus_total synapse_federation_server_received_pdus synapse_federation_server_received_edus_total synapse_federation_server_received_edus synapse_handler_presence_notified_presence_total synapse_handler_presence_notified_presence synapse_handler_presence_federation_presence_out_total synapse_handler_presence_federation_presence_out synapse_handler_presence_presence_updates_total synapse_handler_presence_presence_updates synapse_handler_presence_timers_fired_total synapse_handler_presence_timers_fired synapse_handler_presence_federation_presence_total synapse_handler_presence_federation_presence synapse_handler_presence_bump_active_time_total synapse_handler_presence_bump_active_time synapse_federation_client_sent_edus_total synapse_federation_client_sent_edus synapse_federation_client_sent_pdu_destinations_count_total synapse_federation_client_sent_pdu_destinations:count synapse_federation_client_sent_pdu_destinations_total synapse_federation_client_sent_pdu_destinations:total synapse_handlers_appservice_events_processed_total synapse_handlers_appservice_events_processed synapse_notifier_notified_events_total synapse_notifier_notified_events synapse_push_bulk_push_rule_evaluator_push_rules_invalidation_counter_total synapse_push_bulk_push_rule_evaluator_push_rules_invalidation_counter synapse_push_bulk_push_rule_evaluator_push_rules_state_size_counter_total synapse_push_bulk_push_rule_evaluator_push_rules_state_size_counter synapse_http_httppusher_http_pushes_processed_total synapse_http_httppusher_http_pushes_processed synapse_http_httppusher_http_pushes_failed_total synapse_http_httppusher_http_pushes_failed synapse_http_httppusher_badge_updates_processed_total synapse_http_httppusher_badge_updates_processed synapse_http_httppusher_badge_updates_failed_total synapse_http_httppusher_badge_updates_failed synapse_admin_mau_current synapse_admin_mau:current synapse_admin_mau_max synapse_admin_mau:max synapse_admin_mau_registered_reserved_users synapse_admin_mau:registered_reserved_users","breadcrumbs":"Administration » Monitoring » Renaming of metrics & deprecation of old names in 1.2","id":"774","title":"Renaming of metrics & deprecation of old names in 1.2"},"775":{"body":"The duplicated metrics deprecated in Synapse 0.27.0 have been removed. All time duration-based metrics have been changed to be seconds. This affects: msec -> sec metrics python_gc_time python_twisted_reactor_tick_time synapse_storage_query_time synapse_storage_schedule_time synapse_storage_transaction_time Several metrics have been changed to be histograms, which sort entries into buckets and allow better analysis. The following metrics are now histograms: Altered metrics python_gc_time python_twisted_reactor_pending_calls python_twisted_reactor_tick_time synapse_http_server_response_time_seconds synapse_storage_query_time synapse_storage_schedule_time synapse_storage_transaction_time","breadcrumbs":"Administration » Monitoring » Removal of deprecated metrics & time based counters becoming histograms in 0.31.0","id":"775","title":"Removal of deprecated metrics & time based counters becoming histograms in 0.31.0"},"776":{"body":"Synapse 0.27.0 begins the process of rationalising the duplicate *:count metrics reported for the resource tracking for code blocks and HTTP requests. At the same time, the corresponding *:total metrics are being renamed, as the :total suffix no longer makes sense in the absence of a corresponding :count metric. To enable a graceful migration path, this release just adds new names for the metrics being renamed. A future release will remove the old ones. The following table shows the new metrics, and the old metrics which they are replacing. New name Old name synapse_util_metrics_block_count synapse_util_metrics_block_timer:count synapse_util_metrics_block_count synapse_util_metrics_block_ru_utime:count synapse_util_metrics_block_count synapse_util_metrics_block_ru_stime:count synapse_util_metrics_block_count synapse_util_metrics_block_db_txn_count:count synapse_util_metrics_block_count synapse_util_metrics_block_db_txn_duration:count synapse_util_metrics_block_time_seconds synapse_util_metrics_block_timer:total synapse_util_metrics_block_ru_utime_seconds synapse_util_metrics_block_ru_utime:total synapse_util_metrics_block_ru_stime_seconds synapse_util_metrics_block_ru_stime:total synapse_util_metrics_block_db_txn_count synapse_util_metrics_block_db_txn_count:total synapse_util_metrics_block_db_txn_duration_seconds synapse_util_metrics_block_db_txn_duration:total synapse_http_server_response_count synapse_http_server_requests synapse_http_server_response_count synapse_http_server_response_time:count synapse_http_server_response_count synapse_http_server_response_ru_utime:count synapse_http_server_response_count synapse_http_server_response_ru_stime:count synapse_http_server_response_count synapse_http_server_response_db_txn_count:count synapse_http_server_response_count synapse_http_server_response_db_txn_duration:count synapse_http_server_response_time_seconds synapse_http_server_response_time:total synapse_http_server_response_ru_utime_seconds synapse_http_server_response_ru_utime:total synapse_http_server_response_ru_stime_seconds synapse_http_server_response_ru_stime:total synapse_http_server_response_db_txn_count synapse_http_server_response_db_txn_count:total synapse_http_server_response_db_txn_duration_seconds synapse_http_server_response_db_txn_duration:total","breadcrumbs":"Administration » Monitoring » Block and response metrics renamed for 0.27.0","id":"776","title":"Block and response metrics renamed for 0.27.0"},"777":{"body":"As of synapse version 0.18.2, the format of the process-wide metrics has been changed to fit prometheus standard naming conventions. Additionally the units have been changed to seconds, from milliseconds. New name Old name process_cpu_user_seconds_total process_resource_utime / 1000 process_cpu_system_seconds_total process_resource_stime / 1000 process_open_fds (no 'type' label) process_fds The python-specific counts of garbage collector performance have been renamed. New name Old name python_gc_time reactor_gc_time python_gc_unreachable_total reactor_gc_unreachable python_gc_counts reactor_gc_counts The twisted-specific reactor metrics have been renamed. New name Old name python_twisted_reactor_pending_calls reactor_pending_calls python_twisted_reactor_tick_time reactor_tick_time","breadcrumbs":"Administration » Monitoring » Standard Metric Names","id":"777","title":"Standard Metric Names"},"778":{"body":"When generating your Synapse configuration file, you are asked whether you would like to report usage statistics to Matrix.org. These statistics provide the foundation a glimpse into the number of Synapse homeservers participating in the network, as well as statistics such as the number of rooms being created and messages being sent. This feature is sometimes affectionately called \"phone home\" stats. Reporting is optional and the reporting endpoint can be configured , in case you would like to instead report statistics from a set of homeservers to your own infrastructure. This documentation aims to define the statistics available and the homeserver configuration options that exist to tweak it.","breadcrumbs":"Administration » Monitoring » Reporting Homeserver Usage Statistics » Reporting Homeserver Usage Statistics","id":"778","title":"Reporting Homeserver Usage Statistics"},"779":{"body":"The following statistics are sent to the configured reporting endpoint: Statistic Name Type Description homeserver string The homeserver's server name. memory_rss int The memory usage of the process (in kilobytes on Unix-based systems, bytes on MacOS). cpu_average int CPU time in % of a single core (not % of all cores). server_context string An arbitrary string used to group statistics from a set of homeservers. timestamp int The current time, represented as the number of seconds since the epoch. uptime_seconds int The number of seconds since the homeserver was last started. python_version string The Python version number in use (e.g \"3.7.1\"). Taken from sys.version_info. total_users int The number of registered users on the homeserver. total_nonbridged_users int The number of users, excluding those created by an Application Service. daily_user_type_native int The number of native users created in the last 24 hours. daily_user_type_guest int The number of guest users created in the last 24 hours. daily_user_type_bridged int The number of users created by Application Services in the last 24 hours. total_room_count int The total number of rooms present on the homeserver. daily_active_users int The number of unique users [1] that have used the homeserver in the last 24 hours. monthly_active_users int The number of unique users [1] that have used the homeserver in the last 30 days. daily_active_rooms int The number of rooms that have had a (state) event with the type m.room.message sent in them in the last 24 hours. daily_active_e2ee_rooms int The number of rooms that have had a (state) event with the type m.room.encrypted sent in them in the last 24 hours. daily_messages int The number of (state) events with the type m.room.message seen in the last 24 hours. daily_e2ee_messages int The number of (state) events with the type m.room.encrypted seen in the last 24 hours. daily_sent_messages int The number of (state) events sent by a local user with the type m.room.message seen in the last 24 hours. daily_sent_e2ee_messages int The number of (state) events sent by a local user with the type m.room.encrypted seen in the last 24 hours. r30v2_users_all int The number of 30 day retained users, with a revised algorithm. Defined as users that appear more than once in the past 60 days, and have more than 30 days between the most and least recent appearances in the past 60 days. Includes clients that do not fit into the below r30 client types. r30v2_users_android int The number of 30 day retained users, as defined above. Filtered only to clients with (\"riot\" or \"element\") and \"android\" (case-insensitive) in the user agent string. r30v2_users_ios int The number of 30 day retained users, as defined above. Filtered only to clients with (\"riot\" or \"element\") and \"ios\" (case-insensitive) in the user agent string. r30v2_users_electron int The number of 30 day retained users, as defined above. Filtered only to clients with (\"riot\" or \"element\") and \"electron\" (case-insensitive) in the user agent string. r30v2_users_web int The number of 30 day retained users, as defined above. Filtered only to clients with \"mozilla\" or \"gecko\" (case-insensitive) in the user agent string. cache_factor int The configured global factor value for caching. event_cache_size int The configured event_cache_size value for caching. database_engine string The database engine that is in use. Either \"psycopg2\" meaning PostgreSQL is in use, or \"sqlite3\" for SQLite3. database_server_version string The version of the database server. Examples being \"10.10\" for PostgreSQL server version 10.0, and \"3.38.5\" for SQLite 3.38.5 installed on the system. log_level string The log level in use. Examples are \"INFO\", \"WARNING\", \"ERROR\", \"DEBUG\", etc. Native matrix users and guests are always counted. If the track_puppeted_user_ips option is set to true, \"puppeted\" users (users that an Application Service have performed an action on behalf of ) will also be counted. Note that an Application Service can \"puppet\" any user in their user namespace , not only users that the Application Service has created. If this happens, the Application Service will additionally be counted as a user (irrespective of track_puppeted_user_ips).","breadcrumbs":"Administration » Monitoring » Reporting Homeserver Usage Statistics » Available Statistics","id":"779","title":"Available Statistics"},"78":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.86.0","id":"78","title":"Upgrading to v1.86.0"},"780":{"body":"If statistics reporting is enabled, the endpoint that Synapse sends metrics to is configured by the report_stats_endpoint config option. By default, statistics are sent to Matrix.org. If you would like to set up your own statistics collection server and send metrics there, you may consider using one of the following known implementations: Matrix.org's Panopticon Famedly's Barad-dûr Synapse Usage Exporter for Prometheus","breadcrumbs":"Administration » Monitoring » Reporting Homeserver Usage Statistics » Using a Custom Statistics Collection Server","id":"780","title":"Using a Custom Statistics Collection Server"},"781":{"body":"Synapse can be configured to record the number of monthly active users (also referred to as MAU) on a given homeserver. For clarity's sake, MAU only tracks local users. Please note that the metrics recorded by the Homeserver Usage Stats are calculated differently. The monthly_active_users from the usage stats does not take into account any of the rules below, and counts any users who have made a request to the homeserver in the last 30 days. See the configuration manual for details on how to configure MAU.","breadcrumbs":"Administration » Monthly Active Users » Monthly Active Users","id":"781","title":"Monthly Active Users"},"782":{"body":"Individual user activity is measured in active days. If a user performs an action, the exact time of that action is then recorded. When calculating the MAU figure, any users with a recorded action in the last 30 days are considered part of the cohort. Days are measured as a rolling window from the current system time to 30 days ago. So for example, if Synapse were to calculate the active users on the 15th July at 13:25, it would include any activity from 15th June 13:25 onwards. A user is never considered active if they are either: Part of the trial day cohort (described below) Owned by an application service. Note: This only covers users that are part of an application service namespaces.users registration. The namespace must also be marked as exclusive. Otherwise, any request to Synapse will mark the user as active. Please note that registration will not mark a user as active unless they register with a 3pid that is included in the config field mau_limits_reserved_threepids. The Prometheus metric for MAU is refreshed every 5 minutes. Once an hour, Synapse checks to see if any users are inactive (with only activity timestamps later than 30 days). These users are removed from the active users cohort. If they then become active, they are immediately restored to the cohort. It is important to note that deactivated users are not immediately removed from the pool of active users, but as these users won't perform actions they will eventually be removed from the cohort.","breadcrumbs":"Administration » Monthly Active Users » Calculating active users","id":"782","title":"Calculating active users"},"783":{"body":"If the config option mau_trial_days is set, a user must have been active this many days after registration to be active. A user is in the trial period if their registration timestamp (also known as the creation_ts) is less than mau_trial_days old. As an example, if mau_trial_days is set to 3 and a user is active after 3 days (72 hours from registration time) then they will be counted as active. The mau_appservice_trial_days config further extends this rule by applying different durations depending on the appservice_id of the user. Users registered by an application service will be recorded with an appservice_id matching the id key in the registration file for that service.","breadcrumbs":"Administration » Monthly Active Users » Trial days","id":"783","title":"Trial days"},"784":{"body":"If both config options limit_usage_by_mau and max_mau_value is set, and the current MAU value exceeds the maximum value, the homeserver will begin to block some actions. Individual users matching any of the below criteria never have their actions blocked: Considered part of the cohort of MAU users. Considered part of the trial period. Registered as a support user. Application service users if track_appservice_user_ips is NOT set. Please not that server admins are not exempt from blocking. The following actions are blocked when the MAU limit is exceeded: Logging in Sending events Creating rooms Syncing Registration is also blocked for all new signups unless the user is registering with a threepid included in the mau_limits_reserved_threepids config value. When a request is blocked, the response will have the errcode M_RESOURCE_LIMIT_EXCEEDED.","breadcrumbs":"Administration » Monthly Active Users » Limiting usage of the homeserver when the maximum MAU is reached","id":"784","title":"Limiting usage of the homeserver when the maximum MAU is reached"},"785":{"body":"Synapse records several different prometheus metrics for MAU. synapse_admin_mau_current records the current MAU figure for native (non-application-service) users. synapse_admin_mau_max records the maximum MAU as dictated by the max_mau_value config value. synapse_admin_mau_current_mau_by_service records the current MAU including application service users. The label app_service can be used to filter by a specific service ID. This also includes non-application-service users under app_service=native . synapse_admin_mau_registered_reserved_users records the number of users specified in mau_limits_reserved_threepids which have registered accounts on the homeserver.","breadcrumbs":"Administration » Monthly Active Users » Metrics","id":"785","title":"Metrics"},"786":{"body":"It is possible to monitor much of the internal state of Synapse using Prometheus metrics and Grafana . A guide for configuring Synapse to provide metrics is available here and information on setting up Grafana is here . In this setup, Prometheus will periodically scrape the information Synapse provides and store a record of it over time. Grafana is then used as an interface to query and present this information through a series of pretty graphs. Once you have grafana set up, and assuming you're using our grafana dashboard template , look for the following graphs when debugging a slow/overloaded Synapse:","breadcrumbs":"Administration » Understanding Synapse Through Grafana Graphs » Understanding Synapse through Grafana graphs","id":"786","title":"Understanding Synapse through Grafana graphs"},"787":{"body":"image This, along with the CPU and Memory graphs, is a good way to check the general health of your Synapse instance. It represents how long it takes for a user on your homeserver to send a message.","breadcrumbs":"Administration » Understanding Synapse Through Grafana Graphs » Message Event Send Time","id":"787","title":"Message Event Send Time"},"788":{"body":"image image These graphs show the database transactions that are occurring the most frequently, as well as those are that are taking the most amount of time to execute. image In the first graph, we can see obvious spikes corresponding to lots of get_user_by_id transactions. This would be useful information to figure out which part of the Synapse codebase is potentially creating a heavy load on the system. However, be sure to cross-reference this with Transaction Duration, which states that get_users_by_id is actually a very quick database transaction and isn't causing as much load as others, like persist_events: image Still, it's probably worth investigating why we're getting users from the database that often, and whether it's possible to reduce the amount of queries we make by adjusting our cache factor(s). The persist_events transaction is responsible for saving new room events to the Synapse database, so can often show a high transaction duration.","breadcrumbs":"Administration » Understanding Synapse Through Grafana Graphs » Transaction Count and Transaction Duration","id":"788","title":"Transaction Count and Transaction Duration"},"789":{"body":"The charts in the \"Federation\" section show information about incoming and outgoing federation requests. Federation data can be divided into two basic types: PDU (Persistent Data Unit) - room events: messages, state events (join/leave), etc. These are permanently stored in the database. EDU (Ephemeral Data Unit) - other data, which need not be stored permanently, such as read receipts, typing notifications. The \"Outgoing EDUs by type\" chart shows the EDUs within outgoing federation requests by type: m.device_list_update, m.direct_to_device, m.presence, m.receipt, m.typing. If you see a large number of m.presence EDUs and are having trouble with too much CPU load, you can disable presence in the Synapse config. See also #3971 .","breadcrumbs":"Administration » Understanding Synapse Through Grafana Graphs » Federation","id":"789","title":"Federation"},"79":{"body":"The minimum supported Rust version has been increased from v1.58.1 to v1.60.0. Users building from source will need to ensure their rustc version is up to date.","breadcrumbs":"Upgrading between Synapse Versions » Minimum supported Rust version","id":"79","title":"Minimum supported Rust version"},"790":{"body":"image image This is quite a useful graph. It shows how many times Synapse attempts to retrieve a piece of data from a cache which the cache did not contain, thus resulting in a call to the database. We can see here that the _get_joined_profile_from_event_id cache is being requested a lot, and often the data we're after is not cached. Cross-referencing this with the Eviction Rate graph, which shows that entries are being evicted from _get_joined_profile_from_event_id quite often: image we should probably consider raising the size of that cache by raising its cache factor (a multiplier value for the size of an individual cache). Information on doing so is available here (note that the configuration of individual cache factors through the configuration file is available in Synapse v1.14.0+, whereas doing so through environment variables has been supported for a very long time). Note that this will increase Synapse's overall memory usage.","breadcrumbs":"Administration » Understanding Synapse Through Grafana Graphs » Caches","id":"790","title":"Caches"},"791":{"body":"image Forward extremities are the leaf events at the end of a DAG in a room, aka events that have no children. The more that exist in a room, the more state resolution that Synapse needs to perform (hint: it's an expensive operation). While Synapse has code to prevent too many of these existing at one time in a room, bugs can sometimes make them crop up again. If a room has >10 forward extremities, it's worth checking which room is the culprit and potentially removing them using the SQL queries mentioned in #1760 .","breadcrumbs":"Administration » Understanding Synapse Through Grafana Graphs » Forward Extremities","id":"791","title":"Forward Extremities"},"792":{"body":"image Large spikes in garbage collection times (bigger than shown here, I'm talking in the multiple seconds range), can cause lots of problems in Synapse performance. It's more an indicator of problems, and a symptom of other problems though, so check other graphs for what might be causing it.","breadcrumbs":"Administration » Understanding Synapse Through Grafana Graphs » Garbage Collection","id":"792","title":"Garbage Collection"},"793":{"body":"If you're still having performance problems with your Synapse instance and you've tried everything you can, it may just be a lack of system resources. Consider adding more CPU and RAM, and make use of worker mode to make use of multiple CPU cores / multiple machines for your homeserver.","breadcrumbs":"Administration » Understanding Synapse Through Grafana Graphs » Final Thoughts","id":"793","title":"Final Thoughts"},"794":{"body":"","breadcrumbs":"Administration » Useful SQL for Admins » Some useful SQL queries for Synapse Admins","id":"794","title":"Some useful SQL queries for Synapse Admins"},"795":{"body":"SELECT pg_size_pretty( pg_database_size( 'matrix' ) );","breadcrumbs":"Administration » Useful SQL for Admins » Size of full matrix db","id":"795","title":"Size of full matrix db"},"796":{"body":"pg_size_pretty ---------------- 6420 MB\n(1 row)","breadcrumbs":"Administration » Useful SQL for Admins » Result example:","id":"796","title":"Result example:"},"797":{"body":"SELECT relname, n_live_tup AS \"rows\" FROM pg_stat_user_tables ORDER BY n_live_tup DESC LIMIT 20; This query is quick, but may be very approximate, for exact number of rows use: SELECT COUNT(*) FROM ;","breadcrumbs":"Administration » Useful SQL for Admins » Show top 20 larger tables by row count","id":"797","title":"Show top 20 larger tables by row count"},"798":{"body":"state_groups_state - 161687170\nevent_auth - 8584785\nevent_edges - 6995633\nevent_json - 6585916\nevent_reference_hashes - 6580990\nevents - 6578879\nreceived_transactions - 5713989\nevent_to_state_groups - 4873377\nstream_ordering_to_exterm - 4136285\ncurrent_state_delta_stream - 3770972\nevent_search - 3670521\nstate_events - 2845082\nroom_memberships - 2785854\ncache_invalidation_stream - 2448218\nstate_groups - 1255467\nstate_group_edges - 1229849\ncurrent_state_events - 1222905\nusers_in_public_rooms - 364059\ndevice_lists_stream - 326903\nuser_directory_search - 316433","breadcrumbs":"Administration » Useful SQL for Admins » Result example:","id":"798","title":"Result example:"},"799":{"body":"SELECT nspname || '.' || relname AS \"relation\", pg_size_pretty(pg_total_relation_size(c.oid)) AS \"total_size\" FROM pg_class c LEFT JOIN pg_namespace n ON (n.oid = c.relnamespace) WHERE nspname NOT IN ('pg_catalog', 'information_schema') AND c.relkind <> 'i' AND nspname !~ '^pg_toast' ORDER BY pg_total_relation_size(c.oid) DESC LIMIT 20;","breadcrumbs":"Administration » Useful SQL for Admins » Show top 20 larger tables by storage size","id":"799","title":"Show top 20 larger tables by storage size"},"8":{"body":"It's also possible to install Synapse as a Python module from PyPI. When following this route please make sure that the Platform-specific prerequisites are already installed. System requirements: POSIX-compliant system (tested on Linux & OS X) Python 3.8 or later, up to Python 3.11. At least 1GB of free RAM if you want to join large public rooms like #matrix:matrix.org If building on an uncommon architecture for which pre-built wheels are unavailable, you will need to have a recent Rust compiler installed. The easiest way of installing the latest version is to use rustup . To install the Synapse homeserver run: mkdir -p ~/synapse\nvirtualenv -p python3 ~/synapse/env\nsource ~/synapse/env/bin/activate\npip install --upgrade pip\npip install --upgrade setuptools\npip install matrix-synapse This will download Synapse from PyPI and install it, along with the python libraries it uses, into a virtual environment under ~/synapse/env. Feel free to pick a different directory if you prefer. This Synapse installation can then be later upgraded by using pip again with the update flag: source ~/synapse/env/bin/activate\npip install -U matrix-synapse Before you can start Synapse, you will need to generate a configuration file. To do this, run (in your virtualenv, as before): cd ~/synapse\npython -m synapse.app.homeserver \\ --server-name my.domain.name \\ --config-path homeserver.yaml \\ --generate-config \\ --report-stats=[yes|no] ... substituting an appropriate value for --server-name and choosing whether or not to report usage statistics (hostname, Synapse version, uptime, total users, etc.) to the developers via the --report-stats argument. This command will generate you a config file that you can then customise, but it will also generate a set of keys for you. These keys will allow your homeserver to identify itself to other homeserver, so don't lose or delete them. It would be wise to back them up somewhere safe. (If, for whatever reason, you do need to change your homeserver's keys, you may find that other homeserver have the old key cached. If you update the signing key, you should change the name of the key in the .signing.key file (the second word) to something different. See the spec for more information on key management). To actually run your new homeserver, pick a working directory for Synapse to run (e.g. ~/synapse), and: cd ~/synapse\nsource env/bin/activate\nsynctl start Platform-specific prerequisites Synapse is written in Python but some of the libraries it uses are written in C. So before we can install Synapse itself we need a working C compiler and the header files for Python C extensions. Debian/Ubuntu/Raspbian Installing prerequisites on Ubuntu or Debian: sudo apt install build-essential python3-dev libffi-dev \\ python3-pip python3-setuptools sqlite3 \\ libssl-dev virtualenv libjpeg-dev libxslt1-dev libicu-dev ArchLinux Installing prerequisites on ArchLinux: sudo pacman -S base-devel python python-pip \\ python-setuptools python-virtualenv sqlite3 icu CentOS/Fedora Installing prerequisites on CentOS or Fedora Linux: sudo dnf install libtiff-devel libjpeg-devel libzip-devel freetype-devel \\ libwebp-devel libxml2-devel libxslt-devel libpq-devel \\ python3-virtualenv libffi-devel openssl-devel python3-devel \\ libicu-devel\nsudo dnf groupinstall \"Development Tools\" macOS Installing prerequisites on macOS: You may need to install the latest Xcode developer tools: xcode-select --install Some extra dependencies may be needed. You can use Homebrew (https://brew.sh) for them. You may need to install icu, and make the icu binaries and libraries accessible. Please follow the official instructions of PyICU to do so. On ARM-based Macs you may also need to install libjpeg and libpq: brew install jpeg libpq On macOS Catalina (10.15) you may need to explicitly install OpenSSL via brew and inform pip about it so that psycopg2 builds: brew install openssl@1.1\nexport LDFLAGS=\"-L/usr/local/opt/openssl/lib\"\nexport CPPFLAGS=\"-I/usr/local/opt/openssl/include\" OpenSUSE Installing prerequisites on openSUSE: sudo zypper in -t pattern devel_basis\nsudo zypper in python-pip python-setuptools sqlite3 python-virtualenv \\ python-devel libffi-devel libopenssl-devel libjpeg62-devel \\ libicu-devel OpenBSD A port of Synapse is available under net/synapse. The filesystem underlying the homeserver directory (defaults to /var/synapse) has to be mounted with wxallowed (cf. mount(8)), so creating a separate filesystem and mounting it to /var/synapse should be taken into consideration. To be able to build Synapse's dependency on python the WRKOBJDIR (cf. bsd.port.mk(5)) for building python, too, needs to be on a filesystem mounted with wxallowed (cf. mount(8)). Creating a WRKOBJDIR for building python under /usr/local (which on a default OpenBSD installation is mounted with wxallowed): doas mkdir /usr/local/pobj_wxallowed Assuming PORTS_PRIVSEP=Yes (cf. bsd.port.mk(5)) and SUDO=doas are configured in /etc/mk.conf: doas chown _pbuild:_pbuild /usr/local/pobj_wxallowed Setting the WRKOBJDIR for building python: echo WRKOBJDIR_lang/python/3.7=/usr/local/pobj_wxallowed \\\\nWRKOBJDIR_lang/python/2.7=/usr/local/pobj_wxallowed >> /etc/mk.conf Building Synapse: cd /usr/ports/net/synapse\nmake install Windows Running Synapse natively on Windows is not officially supported. If you wish to run or develop Synapse on Windows, the Windows Subsystem for Linux provides a Linux environment which is capable of using the Debian, Fedora, or source installation methods. More information about WSL can be found at https://docs.microsoft.com/en-us/windows/wsl/install for Windows 10/11 and https://docs.microsoft.com/en-us/windows/wsl/install-on-server for Windows Server.","breadcrumbs":"Installation » Installing as a Python module from PyPI","id":"8","title":"Installing as a Python module from PyPI"},"80":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.85.0","id":"80","title":"Upgrading to v1.85.0"},"800":{"body":"public.state_groups_state - 27 GB\npublic.event_json - 9855 MB\npublic.events - 3675 MB\npublic.event_edges - 3404 MB\npublic.received_transactions - 2745 MB\npublic.event_reference_hashes - 1864 MB\npublic.event_auth - 1775 MB\npublic.stream_ordering_to_exterm - 1663 MB\npublic.event_search - 1370 MB\npublic.room_memberships - 1050 MB\npublic.event_to_state_groups - 948 MB\npublic.current_state_delta_stream - 711 MB\npublic.state_events - 611 MB\npublic.presence_stream - 530 MB\npublic.current_state_events - 525 MB\npublic.cache_invalidation_stream - 466 MB\npublic.receipts_linearized - 279 MB\npublic.state_groups - 160 MB\npublic.device_lists_remote_cache - 124 MB\npublic.state_group_edges - 122 MB","breadcrumbs":"Administration » Useful SQL for Admins » Result example:","id":"800","title":"Result example:"},"801":{"body":"You get the same information when you use the admin API and set parameter order_by=state_events. SELECT r.name, s.room_id, s.current_state_events FROM room_stats_current s LEFT JOIN room_stats_state r USING (room_id) ORDER BY current_state_events DESC LIMIT 20; and by state_group_events count: SELECT rss.name, s.room_id, COUNT(s.room_id) FROM state_groups_state s LEFT JOIN room_stats_state rss USING (room_id) GROUP BY s.room_id, rss.name ORDER BY COUNT(s.room_id) DESC LIMIT 20; plus same, but with join removed for performance reasons: SELECT s.room_id, COUNT(s.room_id) FROM state_groups_state s GROUP BY s.room_id ORDER BY COUNT(s.room_id) DESC LIMIT 20;","breadcrumbs":"Administration » Useful SQL for Admins » Show top 20 larger rooms by state events count","id":"801","title":"Show top 20 larger rooms by state events count"},"802":{"body":"SELECT e.room_id, r.name, COUNT(e.event_id) cnt FROM events e LEFT JOIN room_stats_state r USING (room_id) WHERE e.origin_server_ts >= DATE_PART('epoch', NOW() - INTERVAL '1 day') * 1000 GROUP BY e.room_id, r.name ORDER BY cnt DESC LIMIT 20;","breadcrumbs":"Administration » Useful SQL for Admins » Show top 20 rooms by new events count in last 1 day:","id":"802","title":"Show top 20 rooms by new events count in last 1 day:"},"803":{"body":"Caution. This query does not use any indexes, can be slow and create load on the database. SELECT COUNT(*), sender FROM events WHERE (type = 'm.room.encrypted' OR type = 'm.room.message') AND origin_server_ts >= DATE_PART('epoch', NOW() - INTERVAL '1 month') * 1000 GROUP BY sender ORDER BY COUNT(*) DESC LIMIT 20;","breadcrumbs":"Administration » Useful SQL for Admins » Show top 20 users on homeserver by sent events (messages) at last month:","id":"803","title":"Show top 20 users on homeserver by sent events (messages) at last month:"},"804":{"body":"SELECT e.room_id, r.name, e.event_id, e.type, e.content, j.json FROM events e LEFT JOIN event_json j USING (room_id) LEFT JOIN room_stats_state r USING (room_id) WHERE sender = '@LOGIN:example.com' AND e.type = 'm.room.message' ORDER BY stream_ordering DESC LIMIT 100;","breadcrumbs":"Administration » Useful SQL for Admins » Show last 100 messages from needed user, with room names:","id":"804","title":"Show last 100 messages from needed user, with room names:"},"805":{"body":"Sort and order with bash echo \"SELECT event_json.room_id, room_stats_state.name FROM event_json, room_stats_state \\\nWHERE room_stats_state.room_id = event_json.room_id\" | psql -d synapse -h localhost -U synapse_user -t \\\n| sort | uniq -c | sort -n Documentation for psql command line parameters: https://www.postgresql.org/docs/current/app-psql.html Sort and order with SQL SELECT COUNT(*), event_json.room_id, room_stats_state.name FROM event_json, room_stats_state WHERE room_stats_state.room_id = event_json.room_id GROUP BY event_json.room_id, room_stats_state.name ORDER BY COUNT(*) DESC LIMIT 50;","breadcrumbs":"Administration » Useful SQL for Admins » Show rooms with names, sorted by events in this rooms","id":"805","title":"Show rooms with names, sorted by events in this rooms"},"806":{"body":"9459 !FPUfgzXYWTKgIrwKxW:matrix.org | This Week in Matrix 9459 !FPUfgzXYWTKgIrwKxW:matrix.org | This Week in Matrix (TWIM) 17799 !iDIOImbmXxwNngznsa:matrix.org | Linux in Russian 18739 !GnEEPYXUhoaHbkFBNX:matrix.org | Riot Android 23373 !QtykxKocfZaZOUrTwp:matrix.org | Matrix HQ 39504 !gTQfWzbYncrtNrvEkB:matrix.org | ru.[matrix] 43601 !iNmaIQExDMeqdITdHH:matrix.org | Riot 43601 !iNmaIQExDMeqdITdHH:matrix.org | Riot Web/Desktop","breadcrumbs":"Administration » Useful SQL for Admins » Result example:","id":"806","title":"Result example:"},"807":{"body":"You get the same information when you use the admin API . SELECT rss.room_id, rss.name, rss.canonical_alias, rss.topic, rss.encryption, rsc.joined_members, rsc.local_users_in_room, rss.join_rules FROM room_stats_state rss LEFT JOIN room_stats_current rsc USING (room_id) WHERE room_id IN ( '!OGEhHVWSdvArJzumhm:matrix.org', '!YTvKGNlinIzlkMTVRl:matrix.org' );","breadcrumbs":"Administration » Useful SQL for Admins » Lookup room state info by list of room_id","id":"807","title":"Lookup room state info by list of room_id"},"808":{"body":"SELECT user_id, device_id, user_agent, TO_TIMESTAMP(last_seen / 1000) AS \"last_seen\" FROM devices WHERE last_seen < DATE_PART('epoch', NOW() - INTERVAL '3 month') * 1000;","breadcrumbs":"Administration » Useful SQL for Admins » Show users and devices that have not been online for a while","id":"808","title":"Show users and devices that have not been online for a while"},"809":{"body":"This blog post by Jackson Chen (Dec 2022) explains how to use many of the tools listed on this page. There is also an earlier blog by Victor Berger (June 2020), though this may be outdated in places.","breadcrumbs":"Administration » Database Maintenance Tools » List of useful tools and scripts for maintenance Synapse database:","id":"809","title":"List of useful tools and scripts for maintenance Synapse database:"},"81":{"body":"Application services should ensure they call the /register endpoint with a username property. The legacy user property is considered deprecated and should no longer be included. A future version of Synapse (v1.88.0 or later) will remove support for legacy application service login.","breadcrumbs":"Upgrading between Synapse Versions » Application service registration with \"user\" property deprecation","id":"81","title":"Application service registration with \"user\" property deprecation"},"810":{"body":"The purge remote media API allows server admins to purge old cached remote media.","breadcrumbs":"Administration » Database Maintenance Tools » Purge Remote Media API","id":"810","title":"Purge Remote Media API"},"811":{"body":"This API deletes the local media from the disk of your own server.","breadcrumbs":"Administration » Database Maintenance Tools » Purge Local Media API","id":"811","title":"Purge Local Media API"},"812":{"body":"The purge history API allows server admins to purge historic events from their database, reclaiming disk space.","breadcrumbs":"Administration » Database Maintenance Tools » Purge History API","id":"812","title":"Purge History API"},"813":{"body":"Tool for compressing (deduplicating) state_groups_state table.","breadcrumbs":"Administration » Database Maintenance Tools » synapse-compress-state","id":"813","title":"synapse-compress-state"},"814":{"body":"Some easy SQL that reports useful stats about your Synapse database.","breadcrumbs":"Administration » Database Maintenance Tools » SQL for analyzing Synapse PostgreSQL database stats","id":"814","title":"SQL for analyzing Synapse PostgreSQL database stats"},"815":{"body":"As a general rule, I encourage people who want to understand the deepest darkest secrets of the database schema to drop by #synapse-dev:matrix.org and ask questions. However, one question that comes up frequently is that of how \"state groups\" work, and why the state_groups_state table gets so big, so here's an attempt to answer that question. We need to be able to relatively quickly calculate the state of a room at any point in that room's history. In other words, we need to know the state of the room at each event in that room. This is done as follows: A sequence of events where the state is the same are grouped together into a state_group; the mapping is recorded in event_to_state_groups. (Technically speaking, since a state event usually changes the state in the room, we are recording the state of the room after the given event id: which is to say, to a handwavey simplification, the first event in a state group is normally a state event, and others in the same state group are normally non-state-events.) state_groups records, for each state group, the id of the room that we're looking at, and also the id of the first event in that group. (I'm not sure if that event id is used much in practice.) Now, if we stored all the room state for each state_group, that would be a huge amount of data. Instead, for each state group, we normally store the difference between the state in that group and some other state group, and only occasionally (every 100 state changes or so) record the full state. So, most state groups have an entry in state_group_edges (don't ask me why it's not a column in state_groups) which records the previous state group in the room, and state_groups_state records the differences in state since that previous state group. A full state group just records the event id for each piece of state in the room at that point.","breadcrumbs":"Administration » State Groups » How do State Groups work?","id":"815","title":"How do State Groups work?"},"816":{"body":"There are various reasons that we can end up creating many more state groups than we need: see https://github.com/matrix-org/synapse/issues/3364 for more details.","breadcrumbs":"Administration » State Groups » Known bugs with state groups","id":"816","title":"Known bugs with state groups"},"817":{"body":"There is a tool at https://github.com/matrix-org/rust-synapse-compress-state which can compress the state_groups_state on a room by-room basis (essentially, it reduces the number of \"full\" state groups). This can result in dramatic reductions of the storage used.","breadcrumbs":"Administration » State Groups » Compression tool","id":"817","title":"Compression tool"},"818":{"body":"HTTP request logs are written by synapse (see synapse/http/site.py for details). See the following for how to decode the dense data available from the default logging configuration. 2020-10-01 12:00:00,000 - synapse.access.http.8008 - 311 - INFO - PUT-1000- 192.168.0.1 - 8008 - {another-matrix-server.com} Processed request: 0.100sec/-0.000sec (0.000sec, 0.000sec) (0.001sec/0.090sec/3) 11B !200 \"PUT /_matrix/federation/v1/send/1600000000000 HTTP/1.1\" \"Synapse/1.20.1\" [0 dbevts]\n-AAAAAAAAAAAAAAAAAAAAA- -BBBBBBBBBBBBBBBBBBBBBB- -C- -DD- -EEEEEE- -FFFFFFFFF- -GG- -HHHHHHHHHHHHHHHHHHHHHHH- -IIIIII- -JJJJJJJ- -KKKKKK-, -LLLLLL- -MMMMMMM- -NNNNNN- O -P- -QQ- -RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR- -SSSSSSSSSSSS- -TTTTTT- Part Explanation AAAA Timestamp request was logged (not received) BBBB Logger name (synapse.access.(http\\|https)., where 'tag' is defined in the listeners config section, normally the port) CCCC Line number in code DDDD Log Level EEEE Request Identifier (This identifier is shared by related log lines) FFFF Source IP (Or X-Forwarded-For if enabled) GGGG Server Port HHHH Federated Server or Local User making request (blank if unauthenticated or not supplied).If this is of the form `@aaa:example.com IIII Total Time to process the request JJJJ Time to send response over network once generated (this may be negative if the socket is closed before the response is generated) KKKK Userland CPU time LLLL System CPU time MMMM Total time waiting for a free DB connection from the pool across all parallel DB work from this request NNNN Total time waiting for response to DB queries across all parallel DB work from this request OOOO Count of DB transactions performed PPPP Response body size QQQQ Response status codeSuffixed with ! if the socket was closed before the response was generated.A 499! status code indicates that Synapse also cancelled request processing after the socket was closed. RRRR Request SSSS User-agent TTTT Events fetched from DB to service this request (note that this does not include events fetched from the cache) MMMM / NNNN can be greater than IIII if there are multiple slow database queries running in parallel. Some actions can result in multiple identical http requests, which will return the same data, but only the first request will report time/transactions in KKKK/LLLL/MMMM/NNNN/OOOO - the others will be awaiting the first query to return a response and will simultaneously return with the first request, but with very small processing times.","breadcrumbs":"Administration » Request log format » Request log format","id":"818","title":"Request log format"},"819":{"body":"","breadcrumbs":"Administration » Admin FAQ » Admin FAQ","id":"819","title":"Admin FAQ"},"82":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.84.0","id":"82","title":"Upgrading to v1.84.0"},"820":{"body":"If your server already has an admin account you should use the User Admin API to promote other accounts to become admins. If you don't have any admin accounts yet you won't be able to use the admin API, so you'll have to edit the database manually. Manually editing the database is generally not recommended so once you have an admin account: use the admin APIs to make further changes. UPDATE users SET admin = 1 WHERE name = '@foo:bar.com';","breadcrumbs":"Administration » Admin FAQ » How do I become a server admin?","id":"820","title":"How do I become a server admin?"},"821":{"body":"Run this sql query on your db: SELECT * FROM destinations;","breadcrumbs":"Administration » Admin FAQ » What servers are my server talking to?","id":"821","title":"What servers are my server talking to?"},"822":{"body":"Run this sql query on your db: SELECT DISTINCT split_part(state_key, ':', 2)\nFROM current_state_events\nWHERE room_id = '!cURbafjkfsMDVwdRDQ:matrix.org' AND membership = 'join';","breadcrumbs":"Administration » Admin FAQ » What servers are currently participating in this room?","id":"822","title":"What servers are currently participating in this room?"},"823":{"body":"SELECT NAME from users;","breadcrumbs":"Administration » Admin FAQ » What users are registered on my server?","id":"823","title":"What users are registered on my server?"},"824":{"body":"Synapse includes a Python command to export data for a specific user. It takes the homeserver configuration file and the full Matrix ID of the user to export: python -m synapse.app.admin_cmd -c export-data --output-directory If you uses Poetry to run Synapse: poetry run python -m synapse.app.admin_cmd -c export-data --output-directory The directory to store the export data in can be customised with the --output-directory parameter; ensure that the provided directory is empty. If this parameter is not provided, Synapse defaults to creating a temporary directory (which starts with \"synapse-exfiltrate\") in /tmp, /var/tmp, or /usr/tmp, in that order. The exported data has the following layout: output-directory\n├───rooms\n│ └───\n│ ├───events\n│ ├───state\n│ ├───invite_state\n│ └───knock_state\n├───user_data\n│ ├───account_data\n│ │ ├───global\n│ │ └───\n│ ├───connections\n│ ├───devices\n│ └───profile\n└───media_ids └─── The media_ids folder contains only the metadata of the media uploaded by the user. It does not contain the media itself. Furthermore, only the media_ids that Synapse manages itself are exported. If another media repository (e.g. matrix-media-repo ) is used, the data must be exported separately. With the media_ids the media files can be downloaded. Media that have been sent in encrypted rooms are only retrieved in encrypted form. The following script can help with download the media files: #!/usr/bin/env bash # Parameters\n#\n# source_directory: Directory which contains the export with the media_ids.\n# target_directory: Directory into which all files are to be downloaded.\n# repository_url: Address of the media repository resp. media worker.\n# serverName: Name of the server (`server_name` from homeserver.yaml).\n#\n# Example:\n# ./download_media.sh /tmp/export_data/media_ids/ /tmp/export_data/media_files/ http://localhost:8008 matrix.example.com source_directory=$1\ntarget_directory=$2\nrepository_url=$3\nserverName=$4 mkdir -p $target_directory for file in $source_directory/*; do filename=$(basename ${file}) url=$repository_url/_matrix/media/v3/download/$serverName/$filename echo \"Downloading $filename - $url\" if ! wget -o /dev/null -P $target_directory $url; then echo \"Could not download $filename\" fi\ndone","breadcrumbs":"Administration » Admin FAQ » How can I export user data?","id":"824","title":"How can I export user data?"},"825":{"body":"Users can reset their password through their client. Alternatively, a server admin can reset a user's password using the admin API .","breadcrumbs":"Administration » Admin FAQ » Manually resetting passwords","id":"825","title":"Manually resetting passwords"},"826":{"body":"Deleting your database is unlikely to make anything better. It's easy to make the mistake of thinking that you can start again from a clean slate by dropping your database, but things don't work like that in a federated network: lots of other servers have information about your server. For example: other servers might think that you are in a room, your server will think that you are not, and you'll probably be unable to interact with that room in a sensible way ever again. In general, there are better solutions to any problem than dropping the database. Come and seek help in https://matrix.to/#/#synapse:matrix.org. There are two exceptions when it might be sensible to delete your database and start again: You have never joined any rooms which are federated with other servers. For instance, a local deployment which the outside world can't talk to. You are changing the server_name in the homeserver configuration. In effect this makes your server a completely new one from the point of view of the network, so in this case it makes sense to start with a clean database. (In both cases you probably also want to clear out the media_store.)","breadcrumbs":"Administration » Admin FAQ » I have a problem with my server. Can I just delete my database and start again?","id":"826","title":"I have a problem with my server. Can I just delete my database and start again?"},"827":{"body":"Using the following curl command: curl -H 'Authorization: Bearer ' -X DELETE https://matrix.org/_matrix/client/r0/directory/room/ - can be obtained in riot by looking in the riot settings, down the bottom is: Access Token: - the room alias, eg. #my_room:matrix.org this possibly needs to be URL encoded also, for example %23my_room%3Amatrix.org","breadcrumbs":"Administration » Admin FAQ » I've stuffed up access to my room, how can I delete it to free up the alias?","id":"827","title":"I've stuffed up access to my room, how can I delete it to free up the alias?"},"828":{"body":"Synapse tags each log line according to the HTTP request it is processing. When it finishes processing each request, it logs a line containing the words Processed request: . For example: 2019-02-14 22:35:08,196 - synapse.access.http.8008 - 302 - INFO - GET-37 - ::1 - 8008 - {@richvdh:localhost} Processed request: 0.173sec/0.001sec (0.002sec, 0.000sec) (0.027sec/0.026sec/2) 687B 200 \"GET /_matrix/client/r0/sync HTTP/1.1\" \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36\" [0 dbevts]\" Here we can see that the request has been tagged with GET-37. (The tag depends on the method of the HTTP request, so might start with GET-, PUT-, POST-, OPTIONS- or DELETE-.) So to find all lines corresponding to this request, we can do: grep 'GET-37' homeserver.log If you want to paste that output into a github issue or matrix room, please remember to surround it with triple-backticks (```) to make it legible (see quoting code ).","breadcrumbs":"Administration » Admin FAQ » How can I find the lines corresponding to a given HTTP request in my homeserver log?","id":"828","title":"How can I find the lines corresponding to a given HTTP request in my homeserver log?"},"829":{"body":"See Request log format .","breadcrumbs":"Administration » Admin FAQ » What do all those fields in the 'Processed' line mean?","id":"829","title":"What do all those fields in the 'Processed' line mean?"},"83":{"body":"When using workers, worker_replication_host worker_replication_http_port worker_replication_http_tls should now be removed from individual worker YAML configurations and the main process should instead be added to the instance_map in the shared YAML configuration, using the name main. The old worker_replication_* settings are now considered deprecated and are expected to be removed in Synapse v1.88.0.","breadcrumbs":"Upgrading between Synapse Versions » Deprecation of worker_replication_* configuration settings","id":"83","title":"Deprecation of worker_replication_* configuration settings"},"830":{"body":"SELECT s.canonical_alias, g.room_id, count(*) AS num_rows\nFROM state_groups_state AS g, room_stats_state AS s\nWHERE g.room_id = s.room_id\nGROUP BY s.canonical_alias, g.room_id\nORDER BY num_rows desc\nLIMIT 10; You can also use the List Room API and order_by state_events.","breadcrumbs":"Administration » Admin FAQ » What are the biggest rooms on my server?","id":"830","title":"What are the biggest rooms on my server?"},"831":{"body":"The typical failure mode here is that you send an invitation to someone to join a room or direct chat, but when they go to accept it, they get an error (typically along the lines of \"Invalid signature\"). They might see something like the following in their logs: 2019-09-11 19:32:04,271 - synapse.federation.transport.server - 288 - WARNING - GET-11752 - authenticate_request failed: 401: Invalid signature for server with key ed25519:a_EqML: Unable to verify signature for This is normally caused by a misconfiguration in your reverse-proxy. See the reverse proxy docs and double-check that your settings are correct.","breadcrumbs":"Administration » Admin FAQ » People can't accept room invitations from me","id":"831","title":"People can't accept room invitations from me"},"832":{"body":"First, ensure you are running the latest version of Synapse, using Python 3 with a PostgreSQL database . Synapse's architecture is quite RAM hungry currently - we deliberately cache a lot of recent room data and metadata in RAM in order to speed up common requests. We'll improve this in the future, but for now the easiest way to either reduce the RAM usage (at the risk of slowing things down) is to set the almost-undocumented SYNAPSE_CACHE_FACTOR environment variable. The default is 0.5, which can be decreased to reduce RAM usage in memory constrained environments, or increased if performance starts to degrade. However, degraded performance due to a low cache factor, common on machines with slow disks, often leads to explosions in memory use due backlogged requests. In this case, reducing the cache factor will make things worse. Instead, try increasing it drastically. 2.0 is a good starting value. Using libjemalloc can also yield a significant improvement in overall memory use, and especially in terms of giving back RAM to the OS. To use it, the library must simply be put in the LD_PRELOAD environment variable when launching Synapse. On Debian, this can be done by installing the libjemalloc1 package and adding this line to /etc/default/matrix-synapse: LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.1 This made a significant difference on Python 2.7 - it's unclear how much of an improvement it provides on Python 3.x. If you're encountering high CPU use by the Synapse process itself, you may be affected by a bug with presence tracking that leads to a massive excess of outgoing federation requests (see discussion ). If metrics indicate that your server is also issuing far more outgoing federation requests than can be accounted for by your users' activity, this is a likely cause. The misbehavior can be worked around by disabling presence in the Synapse config file: see here .","breadcrumbs":"Administration » Admin FAQ » Help!! Synapse is slow and eats all my RAM/CPU!","id":"832","title":"Help!! Synapse is slow and eats all my RAM/CPU!"},"833":{"body":"If Synapse runs out of file handles, it typically fails badly - live-locking at 100% CPU, and/or failing to accept new TCP connections (blocking the connecting client). Matrix currently can legitimately use a lot of file handles, thanks to busy rooms like #matrix:matrix.org containing hundreds of participating servers. The first time a server talks in a room it will try to connect simultaneously to all participating servers, which could exhaust the available file descriptors between DNS queries & HTTPS sockets, especially if DNS is slow to respond. (We need to improve the routing algorithm used to be better than full mesh, but as of March 2019 this hasn't happened yet). If you hit this failure mode, we recommend increasing the maximum number of open file handles to be at least 4096 (assuming a default of 1024 or 256). This is typically done by editing /etc/security/limits.conf Separately, Synapse may leak file handles if inbound HTTP requests get stuck during processing - e.g. blocked behind a lock or talking to a remote server etc. This is best diagnosed by matching up the 'Received request' and 'Processed request' log lines and looking for any 'Processed request' lines which take more than a few seconds to execute. Please let us know at #synapse:matrix.org if you see this failure mode so we can help debug it, however.","breadcrumbs":"Administration » Admin FAQ » Running out of File Handles","id":"833","title":"Running out of File Handles"},"834":{"body":"This document aims to get you started with contributing to Synapse!","breadcrumbs":"Contributing Guide » Contributing","id":"834","title":"Contributing"},"835":{"body":"Everyone is welcome to contribute code to Synapse , provided that they are willing to license their contributions to Element under a Contributor License Agreement (CLA). This ensures that their contribution will be made available under an OSI-approved open-source license, currently Affero General Public License v3 (AGPLv3). Please see the Element blog post for the full rationale.","breadcrumbs":"Contributing Guide » 1. Who can contribute to Synapse?","id":"835","title":"1. Who can contribute to Synapse?"},"836":{"body":"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 . Your Python also needs support for virtual environments . This is usually built-in, but some Linux distributions like Debian and Ubuntu split it out into its own package. Running sudo apt install python3-venv should be enough. A recent version of the Rust compiler is needed to build the native modules. The easiest way of installing the latest version is to use rustup . Synapse can connect to PostgreSQL via the psycopg2 Python library. Building this library from source requires access to PostgreSQL's C header files. On Debian or Ubuntu Linux, these can be installed with sudo apt install libpq-dev. Synapse has an optional, improved user search with better Unicode support. For that you need the development package of libicu. On Debian or Ubuntu Linux, this can be installed with sudo apt install libicu-dev. 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 .","breadcrumbs":"Contributing Guide » 2. What do I need?","id":"836","title":"2. What do I need?"},"837":{"body":"The preferred and easiest way to contribute changes is to fork the relevant project on GitHub, and then create a pull request to ask us to pull your changes into our repo. Please base your changes on the develop branch. git clone git@github.com:YOUR_GITHUB_USER_NAME/synapse.git\ngit 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.","breadcrumbs":"Contributing Guide » 3. Get the source.","id":"837","title":"3. Get the source."},"838":{"body":"Before installing the Python dependencies, make sure you have installed a recent version of Rust (see the \"What do I need?\" section above). The easiest way of installing the latest version is to use rustup . Synapse uses the poetry project to manage its dependencies and development environment. Once you have installed Python 3 and added the source, you should install poetry. Of their installation methods, we recommend installing poetry using pipx , pip install --user pipx\npipx install poetry==1.5.1 # Problems with Poetry 1.6, see https://github.com/matrix-org/synapse/issues/16147 but see poetry's installation instructions for other installation methods. Developing Synapse requires Poetry version 1.3.2 or later. Next, open a terminal and install dependencies as follows: cd path/where/you/have/cloned/the/repository\npoetry install --extras all This will install the runtime and developer dependencies for the project. Be sure to check that the poetry install step completed cleanly.","breadcrumbs":"Contributing Guide » 4. Install the dependencies","id":"838","title":"4. Install the dependencies"},"839":{"body":"To start a local instance of Synapse in the locked poetry environment, create a config file: cp docs/sample_config.yaml homeserver.yaml\ncp docs/sample_log_config.yaml log_config.yaml Now edit homeserver.yaml, things you might want to change include: Set a server_name Adjusting paths to be correct for your system like the log_config to point to the log config you just copied Using a PostgreSQL database instead of SQLite Adding a registration_shared_secret so you can use register_new_matrix_user command . And then run Synapse with the following command: poetry run python -m synapse.app.homeserver -c homeserver.yaml If you get an error like the following: importlib.metadata.PackageNotFoundError: matrix-synapse this probably indicates that the poetry install step did not complete cleanly - go back and resolve any issues and re-run until successful.","breadcrumbs":"Contributing Guide » Running Synapse via poetry","id":"839","title":"Running Synapse via poetry"},"84":{"body":"Before: Shared YAML instance_map: generic_worker1: host: localhost port: 5678 tls: false Worker YAML worker_app: synapse.app.generic_worker\nworker_name: generic_worker1 worker_replication_host: localhost\nworker_replication_http_port: 3456\nworker_replication_http_tls: false worker_listeners: - type: http port: 1234 resources: - names: [client, federation] - type: http port: 5678 resources: - names: [replication] worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml After: Shared YAML instance_map: main: host: localhost port: 3456 tls: false generic_worker1: host: localhost port: 5678 tls: false Worker YAML worker_app: synapse.app.generic_worker\nworker_name: generic_worker1 worker_listeners: - type: http port: 1234 resources: - names: [client, federation] - type: http port: 5678 resources: - names: [replication] worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml Notes: tls is optional but mirrors the functionality of worker_replication_http_tls","breadcrumbs":"Upgrading between Synapse Versions » Example change","id":"84","title":"Example change"},"840":{"body":"Join our developer community on Matrix: #synapse-dev:matrix.org !","breadcrumbs":"Contributing Guide » 5. Get in touch.","id":"840","title":"5. Get in touch."},"841":{"body":"Fix your favorite problem or perhaps find a Good First Issue to work on.","breadcrumbs":"Contributing Guide » 6. Pick an issue.","id":"841","title":"6. Pick an issue."},"842":{"body":"There is a growing amount of documentation located in the docs directory, with a rendered version available online . This documentation is intended primarily for sysadmins running their own Synapse instance, as well as developers interacting externally with Synapse. docs/development exists primarily to house documentation for Synapse developers. docs/admin_api houses documentation regarding Synapse's Admin API, which is used mostly by sysadmins and external service developers. Synapse's code style is documented here . Please follow it, including the conventions for configuration options and documentation . We welcome improvements and additions to our documentation itself! When writing new pages, please build docs to a book to check that your contributions render correctly. The docs are written in GitHub-Flavoured Markdown . When changes are made to any Rust code then you must call either poetry install or maturin develop (if installed) to rebuild the Rust code. Using maturin is quicker than poetry install, so is recommended when making frequent changes to the Rust code.","breadcrumbs":"Contributing Guide » 7. Turn coffee into code and documentation!","id":"842","title":"7. Turn coffee into code and documentation!"},"843":{"body":"While you're developing and before submitting a patch, you'll want to test your code.","breadcrumbs":"Contributing Guide » 8. Test, test, test!","id":"843","title":"8. Test, test, test!"},"844":{"body":"The linters look at your code and do two things: ensure that your code follows the coding style adopted by the project; catch a number of errors in your code. The linter takes no time at all to run as soon as you've downloaded the dependencies . poetry run ./scripts-dev/lint.sh Note that this script will modify your files to fix styling errors. Make sure that you have saved all your files. If you wish to restrict the linters to only the files changed since the last commit (much faster!), you can instead run: poetry run ./scripts-dev/lint.sh -d Or if you know exactly which files you wish to lint, you can instead run: poetry run ./scripts-dev/lint.sh path/to/file1.py path/to/file2.py path/to/folder","breadcrumbs":"Contributing Guide » Run the linters.","id":"844","title":"Run the linters."},"845":{"body":"The unit tests run parts of Synapse, including your changes, to see if anything was broken. They are slower than the linters but will typically catch more errors. poetry run trial tests You can run unit tests in parallel by specifying -jX argument to trial where X is the number of parallel runners you want. To use 4 cpu cores, you would run them like: poetry run trial -j4 tests If you wish to only run some unit tests, you may specify another module instead of tests - or a test class or a method: poetry run trial tests.rest.admin.test_room tests.handlers.test_admin.ExfiltrateData.test_invite If your tests fail, you may wish to look at the logs (the default log level is ERROR): less _trial_temp/test.log To increase the log level for the tests, set SYNAPSE_TEST_LOG_LEVEL: SYNAPSE_TEST_LOG_LEVEL=DEBUG poetry run trial tests By default, tests will use an in-memory SQLite database for test data. For additional help with debugging, one can use an on-disk SQLite database file instead, in order to review database state during and after running tests. This can be done by setting the SYNAPSE_TEST_PERSIST_SQLITE_DB environment variable. Doing so will cause the database state to be stored in a file named test.db under the trial process' working directory. Typically, this ends up being _trial_temp/test.db. For example: SYNAPSE_TEST_PERSIST_SQLITE_DB=1 poetry run trial tests The database file can then be inspected with: sqlite3 _trial_temp/test.db Note that the database file is cleared at the beginning of each test run. Thus it will always only contain the data generated by the last run test . Though generally when debugging, one is only running a single test anyway.","breadcrumbs":"Contributing Guide » Run the unit tests (Twisted trial).","id":"845","title":"Run the unit tests (Twisted trial)."},"846":{"body":"Invoking trial as above will use an in-memory SQLite database. This is great for quick development and testing. However, we recommend using a PostgreSQL database in production (and indeed, we have some code paths specific to each database). This means that we need to run our unit tests against PostgreSQL too. Our CI does this automatically for pull requests and release candidates, but it's sometimes useful to reproduce this locally. Using Docker The easiest way to do so is to run Postgres via a docker container. In one terminal: docker run --rm -e POSTGRES_PASSWORD=mysecretpassword -e POSTGRES_USER=postgres -e POSTGRES_DB=postgres -p 5432:5432 postgres:14 If you see an error like docker: Error response from daemon: driver failed programming external connectivity on endpoint nice_ride (b57bbe2e251b70015518d00c9981e8cb8346b5c785250341a6c53e3c899875f1): Error starting userland proxy: listen tcp4 0.0.0.0:5432: bind: address already in use. then something is already bound to port 5432. You're probably already running postgres locally. Once you have a postgres server running, invoke trial in a second terminal: SYNAPSE_POSTGRES=1 SYNAPSE_POSTGRES_HOST=127.0.0.1 SYNAPSE_POSTGRES_USER=postgres SYNAPSE_POSTGRES_PASSWORD=mysecretpassword poetry run trial tests Using an existing Postgres installation If you have postgres already installed on your system, you can run trial with the following environment variables matching your configuration: SYNAPSE_POSTGRES to anything nonempty SYNAPSE_POSTGRES_HOST (optional if it's the default: UNIX socket) SYNAPSE_POSTGRES_PORT (optional if it's the default: 5432) SYNAPSE_POSTGRES_USER (optional if using a UNIX socket) SYNAPSE_POSTGRES_PASSWORD (optional if using a UNIX socket) For example: export SYNAPSE_POSTGRES=1\nexport SYNAPSE_POSTGRES_HOST=localhost\nexport SYNAPSE_POSTGRES_USER=postgres\nexport SYNAPSE_POSTGRES_PASSWORD=mydevenvpassword\ntrial You don't need to specify the host, user, port or password if your Postgres server is set to authenticate you over the UNIX socket (i.e. if the psql command works without further arguments). Your Postgres account needs to be able to create databases; see the postgres docs for ALTER ROLE .","breadcrumbs":"Contributing Guide » Running tests under PostgreSQL","id":"846","title":"Running tests under PostgreSQL"},"847":{"body":"The integration tests are a more comprehensive suite of tests. They run a full version of Synapse, including your changes, to check if anything was broken. They are slower than the unit tests but will typically catch more errors. The following command will let you run the integration test with the most common configuration: $ docker run --rm -it -v /path/where/you/have/cloned/the/repository\\:/src:ro -v /path/to/where/you/want/logs\\:/logs matrixdotorg/sytest-synapse:focal (Note that the paths must be full paths! You could also write $(realpath relative/path) if needed.) This configuration should generally cover your needs. To run with Postgres, supply the -e POSTGRES=1 -e MULTI_POSTGRES=1 environment flags. To run with Synapse in worker mode, supply the -e WORKERS=1 -e REDIS=1 environment flags (in addition to the Postgres flags). For more details about other configurations, see the Docker-specific documentation in the SyTest repo .","breadcrumbs":"Contributing Guide » Run the integration tests ( Sytest ).","id":"847","title":"Run the integration tests ( Sytest )."},"848":{"body":"Complement is a suite of black box tests that can be run on any homeserver implementation. It can also be thought of as end-to-end (e2e) tests. It's often nice to develop on Synapse and write Complement tests at the same time. Here is how to run your local Synapse checkout against your local Complement checkout. (checkout complement alongside your synapse checkout) COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh To run a specific test file, you can pass the test name at the end of the command. The name passed comes from the naming structure in your Complement tests. If you're unsure of the name, you can do a full run and copy it from the test output: COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -run TestImportHistoricalMessages To run a specific test, you can specify the whole name structure: COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -run TestImportHistoricalMessages/parallel/Historical_events_resolve_in_the_correct_order The above will run a monolithic (single-process) Synapse with SQLite as the database. For other configurations, try: Passing POSTGRES=1 as an environment variable to use the Postgres database instead. Passing WORKERS=1 as an environment variable to use a workerised setup instead. This option implies the use of Postgres. If setting WORKERS=1, optionally set WORKER_TYPES= to declare which worker types you wish to test. A simple comma-delimited string containing the worker types defined from the WORKERS_CONFIG template in here . A safe example would be WORKER_TYPES=\"federation_inbound, federation_sender, synchrotron\". See the worker documentation for additional information on workers. Passing ASYNCIO_REACTOR=1 as an environment variable to use the Twisted asyncio reactor instead of the default one. Passing PODMAN=1 will use the podman container runtime, instead of docker. Passing UNIX_SOCKETS=1 will utilise Unix socket functionality for Synapse, Redis, and Postgres(when applicable). To increase the log level for the tests, set SYNAPSE_TEST_LOG_LEVEL, e.g: SYNAPSE_TEST_LOG_LEVEL=DEBUG COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -run TestImportHistoricalMessages","breadcrumbs":"Contributing Guide » Run the integration tests ( Complement ).","id":"848","title":"Run the integration tests ( Complement )."},"849":{"body":"If you want to format the output of the tests the same way as it looks in CI, install gotestfmt . You can then use this incantation to format the tests appropriately: COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -json | gotestfmt -hide successful-tests (Remove -hide successful-tests if you don't want to hide successful tests.)","breadcrumbs":"Contributing Guide » Prettier formatting with gotestfmt","id":"849","title":"Prettier formatting with gotestfmt"},"85":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.81.0","id":"85","title":"Upgrading to v1.81.0"},"850":{"body":"If you're curious what the database looks like after you run some tests, here are some steps to get you going in Synapse: In your Complement test comment out defer deployment.Destroy(t) and replace with defer time.Sleep(2 * time.Hour) to keep the homeserver running after the tests complete Start the Complement tests Find the name of the container, docker ps -f name=complement_ (this will filter for just the Compelement related Docker containers) Access the container replacing the name with what you found in the previous step: docker exec -it complement_1_hs_with_application_service.hs1_2 /bin/bash Install sqlite (database driver), apt-get update && apt-get install -y sqlite3 Then run sqlite3 and open the database .open /conf/homeserver.db (this db path comes from the Synapse homeserver.yaml)","breadcrumbs":"Contributing Guide » Access database for homeserver after Complement test runs.","id":"850","title":"Access database for homeserver after Complement test runs."},"851":{"body":"Once you're happy with your patch, it's time to prepare a Pull Request. To prepare a Pull Request, please: verify that all the tests pass , including the coding style; sign off your contribution; git push your commit to your fork of Synapse; on GitHub, create the Pull Request ; add a changelog entry and push it to your Pull Request; that's it for now, a non-draft pull request will automatically request review from the team; if you need to update your PR, please avoid rebasing and just add new commits to your branch.","breadcrumbs":"Contributing Guide » 9. Submit your patch.","id":"851","title":"9. Submit your patch."},"852":{"body":"All changes, even minor ones, need a corresponding changelog / newsfragment entry. These are managed by Towncrier . To create a changelog entry, make a new file in the changelog.d directory named in the format of PRnumber.type. The type can be one of the following: feature bugfix docker (for updates to the Docker image) doc (for updates to the documentation) removal (also used for deprecations) misc (for internal-only changes) This file will become part of our changelog at the next release, so the content of the file should be a short description of your change in the same style as the rest of the changelog. The file can contain Markdown formatting, and must end with a full stop (.) or an exclamation mark (!) for consistency. Adding credits to the changelog is encouraged, we value your contributions and would like to have you shouted out in the release notes! For example, a fix in PR #1234 would have its changelog entry in changelog.d/1234.bugfix, and contain content like: The security levels of Florbs are now validated when received via the /federation/florb endpoint. Contributed by Jane Matrix. If there are multiple pull requests involved in a single bugfix/feature/etc, then the content for each changelog.d file should be the same. Towncrier will merge the matching files together into a single changelog entry when we come to release.","breadcrumbs":"Contributing Guide » Changelog","id":"852","title":"Changelog"},"853":{"body":"Obviously, you don't know if you should call your newsfile 1234.bugfix or 5678.bugfix until you create the PR, which leads to a chicken-and-egg problem. There are two options for solving this: Open the PR without a changelog file, see what number you got, and then add the changelog file to your branch, or: Look at the list of all issues/PRs , add one to the highest number you see, and quickly open the PR before somebody else claims your number. This script might be helpful if you find yourself doing this a lot. Sorry, we know it's a bit fiddly, but it's really helpful for us when we come to put together a release!","breadcrumbs":"Contributing Guide » How do I know what to call the changelog file before I create the PR?","id":"853","title":"How do I know what to call the changelog file before I create the PR?"},"854":{"body":"Changes which affect the debian packaging files (in debian) are an exception to the rule that all changes require a changelog.d file. In this case, you will need to add an entry to the debian changelog for the next release. For this, run the following command: dch This will make up a new version number (if there isn't already an unreleased version in flight), and open an editor where you can add a new changelog entry. (Our release process will ensure that the version number and maintainer name is corrected for the release.) If your change affects both the debian packaging and files outside the debian directory, you will need both a regular newsfragment and an entry in the debian changelog. (Though typically such changes should be submitted as two separate pull requests.)","breadcrumbs":"Contributing Guide » Debian changelog","id":"854","title":"Debian changelog"},"855":{"body":"After you make a PR a comment from @CLAassistant will appear asking you to sign the CLA . This will link a page to allow you to confirm that you have read and agreed to the CLA by signing in with GitHub. Alternatively, you can sign off before opening a PR by going to https://cla-assistant.io/element-hq/synapse . We accept contributions under a legally identifiable name, such as your name on government documentation or common-law names (names claimed by legitimate usage or repute). Unfortunately, we cannot accept anonymous contributions at this time.","breadcrumbs":"Contributing Guide » Sign off","id":"855","title":"Sign off"},"856":{"body":"Once the Pull Request is opened, you will see a few things: our automated CI (Continuous Integration) pipeline will run (again) the linters, the unit tests, the integration tests and more; one or more of the developers will take a look at your Pull Request and offer feedback. From this point, you should: Look at the results of the CI pipeline. If there is any error, fix the error. If a developer has requested changes, make these changes and let us know if it is ready for a developer to review again. A pull request is a conversation, if you disagree with the suggestions, please respond and discuss it. Create a new commit with the changes. Please do NOT overwrite the history. New commits make the reviewer's life easier. Push this commits to your Pull Request. Back to 1. Once the pull request is ready for review again please re-request review from whichever developer did your initial review (or leave a comment in the pull request that you believe all required changes have been done). Once both the CI and the developers are happy, the patch will be merged into Synapse and released shortly!","breadcrumbs":"Contributing Guide » 10. Turn feedback into better code.","id":"856","title":"10. Turn feedback into better code."},"857":{"body":"By now, you know the drill!","breadcrumbs":"Contributing Guide » 11. Find a new issue.","id":"857","title":"11. Find a new issue."},"858":{"body":"There are some notes for those with commit access to the project on how we manage git here .","breadcrumbs":"Contributing Guide » Notes for maintainers on merging PRs etc","id":"858","title":"Notes for maintainers on merging PRs etc"},"859":{"body":"That's it! Matrix is a very open and collaborative project as you might expect given our obsession with open communication. If we're going to successfully matrix together all the fragmented communication technologies out there we are reliant on contributions and collaboration from the community to do so. So please get involved - and we hope you have as much fun hacking on Matrix as we do!","breadcrumbs":"Contributing Guide » Conclusion","id":"859","title":"Conclusion"},"86":{"body":"Synapse now attempts the versioned appservice paths before falling back to the legacy paths . Usage of the legacy routes should be considered deprecated. Additionally, Synapse has supported sending the application service access token via the Authorization header since v1.70.0. For backwards compatibility it is also sent as the access_token query parameter. This is insecure and should be considered deprecated. A future version of Synapse (v1.88.0 or later) will remove support for legacy application service routes and query parameter authorization.","breadcrumbs":"Upgrading between Synapse Versions » Application service path & authentication deprecations","id":"86","title":"Application service path & authentication deprecations"},"860":{"body":"","breadcrumbs":"Code Style » Code Style","id":"860","title":"Code Style"},"861":{"body":"The Synapse codebase uses a number of code formatting tools in order to quickly and automatically check for formatting (and sometimes logical) errors in code. The necessary tools are: black , a source code formatter; isort , which organises each file's imports; ruff , which can spot common errors; and mypy , a type checker. See the contributing guide for instructions on how to install the above tools and run the linters. It's worth noting that modern IDEs and text editors can run these tools automatically on save. It may be worth looking into whether this functionality is supported in your editor for a more convenient development workflow. It is not, however, recommended to run mypy on save as it takes a while and can be very resource intensive.","breadcrumbs":"Code Style » Formatting tools","id":"861","title":"Formatting tools"},"862":{"body":"Naming : Use CamelCase for class and type names Use underscores for function_names and variable_names. Docstrings : should follow the google code style . See the examples in the sphinx documentation. Imports : Imports should be sorted by isort as described above. Prefer to import classes and functions rather than packages or modules. Example: from synapse.types import UserID\n...\nuser_id = UserID(local, server) is preferred over: from synapse import types\n...\nuser_id = types.UserID(local, server) (or any other variant). This goes against the advice in the Google style guide, but it means that errors in the name are caught early (at import time). Avoid wildcard imports (from synapse.types import *) and relative imports (from .types import UserID).","breadcrumbs":"Code Style » General rules","id":"862","title":"General rules"},"863":{"body":"When adding a configuration option to the code, if several settings are grouped into a single dict, ensure that your code correctly handles the top-level option being set to None (as it will be if no sub-options are enabled). The configuration manual acts as a reference to Synapse's configuration options for server administrators. Remember that many readers will be unfamiliar with YAML and server administration in general, so it is important that when you add a configuration option the documentation be as easy to understand as possible, which includes following a consistent format. Some guidelines follow: Each option should be listed in the config manual with the following format: The name of the option, prefixed by ###. A comment which describes the default behaviour (i.e. what happens if the setting is omitted), as well as what the effect will be if the setting is changed. An example setting, using backticks to define the code block For boolean (on/off) options, convention is that this example should be the opposite to the default. For other options, the example should give some non-default value which is likely to be useful to the reader. There should be a horizontal rule between each option, which can be achieved by adding --- before and after the option. true and false are spelt thus (as opposed to True, etc.) Example:","breadcrumbs":"Code Style » Configuration code and documentation format","id":"863","title":"Configuration code and documentation format"},"864":{"body":"Use the module sub-option to add a module under modules to extend functionality. The module setting then has a sub-option, config, which can be used to define some configuration for the module. Defaults to none. Example configuration: modules: - module: my_super_module.MySuperClass config: do_thing: true - module: my_other_super_module.SomeClass config: {} Note that the sample configuration is generated from the synapse code and is maintained by a script, scripts-dev/generate_sample_config.sh. Making sure that the output from this script matches the desired format is left as an exercise for the reader!","breadcrumbs":"Code Style » modules","id":"864","title":"modules"},"865":{"body":"The Synapse team works off a shared review queue -- any new pull requests for Synapse (or related projects) has a review requested from the entire team. Team members should process this queue using the following rules: Any high urgency pull requests (e.g. fixes for broken continuous integration or fixes for release blockers); Follow-up reviews for pull requests which have previously received reviews; Any remaining pull requests. For the latter two categories above, older pull requests should be prioritised. It is explicit that there is no priority given to pull requests from the team (vs from the community). If a pull request requires a quick turn around, please explicitly communicate this via #synapse-dev:matrix.org or as a comment on the pull request. Once an initial review has been completed and the author has made additional changes, follow-up reviews should go back to the same reviewer. This helps build a shared context and conversation between author and reviewer. As a team we aim to keep the number of inflight pull requests to a minimum to ensure that ongoing work is finished before starting new work.","breadcrumbs":"Reviewing Code » Some notes on how we do reviews","id":"865","title":"Some notes on how we do reviews"},"866":{"body":"To communicate to the rest of the team the status of each pull request, team members should do the following: Assign themselves to the pull request (they should be left assigned to the pull request until it is merged, closed, or are no longer the reviewer); Review the pull request by leaving comments, questions, and suggestions; Mark the pull request appropriately (as needing changes or accepted). If you are unsure about a particular part of the pull request (or are not confident in your understanding of part of the code) then ask questions or request review from the team again. When requesting review from the team be sure to leave a comment with the rationale on why you're putting it back in the queue.","breadcrumbs":"Reviewing Code » Performing a review","id":"866","title":"Performing a review"},"867":{"body":"Releases of Synapse follow a two week release cycle with new releases usually occurring on Tuesdays: Day 0: Synapse N - 1 is released. Day 7: Synapse N release candidate 1 is released. Days 7 - 13: Synapse N release candidates 2+ are released, if bugs are found. Day 14: Synapse N is released. Note that this schedule might be modified depending on the availability of the Synapse team, e.g. releases may be skipped to avoid holidays. Release announcements can be found in the release category of the Matrix blog .","breadcrumbs":"Release Cycle » Synapse Release Cycle","id":"867","title":"Synapse Release Cycle"},"868":{"body":"If a bug is found after release that is deemed severe enough (by a combination of the impacted users and the impact on those users) then a bugfix release may be issued. This may be at any point in the release cycle.","breadcrumbs":"Release Cycle » Bugfix releases","id":"868","title":"Bugfix releases"},"869":{"body":"Security will sometimes be backported to the previous version and released immediately before the next release candidate. An example of this might be: Day 0: Synapse N - 1 is released. Day 7: Synapse (N - 1).1 is released as Synapse N - 1 + the security fix. Day 7: Synapse N release candidate 1 is released (including the security fix). Depending on the impact and complexity of security fixes, multiple fixes might be held to be released together. In some cases, a pre-disclosure of a security release will be issued as a notice to Synapse operators that there is an upcoming security release. These can be found in the security category of the Matrix blog .","breadcrumbs":"Release Cycle » Security releases","id":"869","title":"Security releases"},"87":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.80.0","id":"87","title":"Upgrading to v1.80.0"},"870":{"body":"","breadcrumbs":"Git Usage » Some notes on how we use git","id":"870","title":"Some notes on how we use git"},"871":{"body":"In an ideal world, our git commit history would be a linear progression of commits each of which contains a single change building on what came before. Here, by way of an arbitrary example, is the top of git log --graph b2dba0607: Note how the commit comment explains clearly what is changing and why. Also note the absence of merge commits, as well as the absence of commits called things like (to pick a few culprits): “pep8” , “fix broken test” , “oops” , “typo” , or “Who's the president?” . There are a number of reasons why keeping a clean commit history is a good thing: From time to time, after a change lands, it turns out to be necessary to revert it, or to backport it to a release branch. Those operations are much easier when the change is contained in a single commit. Similarly, it's much easier to answer questions like “is the fix for /publicRooms on the release branch?” if that change consists of a single commit. Likewise: “what has changed on this branch in the last week?” is much clearer without merges and “pep8” commits everywhere. Sometimes we need to figure out where a bug got introduced, or some behaviour changed. One way of doing that is with git bisect: pick an arbitrary commit between the known good point and the known bad point, and see how the code behaves. However, that strategy fails if the commit you chose is the middle of someone's epic branch in which they broke the world before putting it back together again. One counterargument is that it is sometimes useful to see how a PR evolved as it went through review cycles. This is true, but that information is always available via the GitHub UI (or via the little-known refs/pull namespace ). Of course, in reality, things are more complicated than that. We have release branches as well as develop and master, and we deliberately merge changes between them. Bugs often slip through and have to be fixed later. That's all fine: this not a cast-iron rule which must be obeyed, but an ideal to aim towards.","breadcrumbs":"Git Usage » On keeping the commit history clean","id":"871","title":"On keeping the commit history clean"},"872":{"body":"Ok, so that's what we'd like to achieve. How do we achieve it? The TL;DR is: when you come to merge a pull request, you probably want to “squash and merge”: squash and merge . (This applies whether you are merging your own PR, or that of another contributor.) “Squash and merge” 1 takes all of the changes in the PR, and bundles them into a single commit. GitHub gives you the opportunity to edit the commit message before you confirm, and normally you should do so, because the default will be useless (again: * woops typo is not a useful thing to keep in the historical record). The main problem with this approach comes when you have a series of pull requests which build on top of one another: as soon as you squash-merge the first PR, you'll end up with a stack of conflicts to resolve in all of the others. In general, it's best to avoid this situation in the first place by trying not to have multiple related PRs in flight at the same time. Still, sometimes that's not possible and doing a regular merge is the lesser evil. Another occasion in which a regular merge makes more sense is a PR where you've deliberately created a series of commits each of which makes sense in its own right. For example: a PR which gradually propagates a refactoring operation through the codebase , or a PR which is the culmination of several other PRs . In this case the ability to figure out when a particular change/bug was introduced could be very useful. Ultimately: this is not a hard-and-fast-rule . If in doubt, ask yourself “do each of the commits I am about to merge make sense in their own right”, but remember that we're just doing our best to balance “keeping the commit history clean” with other factors.","breadcrumbs":"Git Usage » Merges, squashes, rebases: wtf?","id":"872","title":"Merges, squashes, rebases: wtf?"},"873":{"body":"A lot of words have been written in the past about git branching models (no really, a lot ). I tend to think the whole thing is overblown. Fundamentally, it's not that complicated. Here's how we do it. Let's start with a picture: branching model It looks complicated, but it's really not. There's one basic rule: anyone is free to merge from any more-stable branch to any less-stable branch at any time 2 . (The principle behind this is that if a change is good enough for the more-stable branch, then it's also good enough go put in a less-stable branch.) Meanwhile, merging (or squashing, as per the above) from a less-stable to a more-stable branch is a deliberate action in which you want to publish a change or a set of changes to (some subset of) the world: for example, this happens when a PR is landed, or as part of our release process. So, what counts as a more- or less-stable branch? A little reflection will show that our active branches are ordered thus, from more-stable to less-stable: master (tracks our last release). release-vX.Y (the branch where we prepare the next release) 3 . PR branches which are targeting the release. develop (our \"mainline\" branch containing our bleeding-edge). regular PR branches. The corollary is: if you have a bugfix that needs to land in both release-vX.Y and develop, then you should base your PR on release-vX.Y, get it merged there, and then merge from release-vX.Y to develop. (If a fix lands in develop and we later need it in a release-branch, we can of course cherry-pick it, but landing it in the release branch first helps reduce the chance of annoying conflicts.) [1]: “Squash and merge” is GitHub's term for this operation. Given that there is no merge involved, I'm not convinced it's the most intuitive name. ^ [2]: Well, anyone with commit access. ^ [3]: Very, very occasionally (I think this has happened once in the history of Synapse), we've had two releases in flight at once. Obviously, release-v1.2 is more-stable than release-v1.3. ^","breadcrumbs":"Git Usage » Git branching model","id":"873","title":"Git branching model"},"874":{"body":"DO NOT USE THESE DEMO SERVERS IN PRODUCTION Requires you to have a Synapse development environment setup . The demo setup allows running three federation Synapse servers, with server names localhost:8480, localhost:8481, and localhost:8482. You can access them via any Matrix client over HTTP at localhost:8080, localhost:8081, and localhost:8082 or over HTTPS at localhost:8480, localhost:8481, and localhost:8482. To enable the servers to communicate, self-signed SSL certificates are generated and the servers are configured in a highly insecure way, including: Not checking certificates over federation. Not verifying keys. The servers are configured to store their data under demo/8080, demo/8081, and demo/8082. This includes configuration, logs, SQLite databases, and media. Note that when joining a public room on a different homeserver via \"#foo:bar.net\", then you are (in the current implementation) joining a room with room_id \"foo\". This means that it won't work if your homeserver already has a room with that name.","breadcrumbs":"Testing » Demo scripts » Synapse demo setup","id":"874","title":"Synapse demo setup"},"875":{"body":"There's three main scripts with straightforward purposes: start.sh will start the Synapse servers, generating any missing configuration. This accepts a single parameter --no-rate-limit to \"disable\" rate limits (they actually still exist, but are very high). stop.sh will stop the Synapse servers. clean.sh will delete the configuration, databases, log files, etc. To start a completely new set of servers, run: ./demo/stop.sh; ./demo/clean.sh && ./demo/start.sh","breadcrumbs":"Testing » Demo scripts » Using the demo scripts","id":"875","title":"Using the demo scripts"},"876":{"body":"","breadcrumbs":"OpenTracing » OpenTracing","id":"876","title":"OpenTracing"},"877":{"body":"OpenTracing is a semi-standard being adopted by a number of distributed tracing platforms. It is a common api for facilitating vendor-agnostic tracing instrumentation. That is, we can use the OpenTracing api and select one of a number of tracer implementations to do the heavy lifting in the background. Our current selected implementation is Jaeger. OpenTracing is a tool which gives an insight into the causal relationship of work done in and between servers. The servers each track events and report them to a centralised server - in Synapse's case: Jaeger. The basic unit used to represent events is the span. The span roughly represents a single piece of work that was done and the time at which it occurred. A span can have child spans, meaning that the work of the child had to be completed for the parent span to complete, or it can have follow-on spans which represent work that is undertaken as a result of the parent but is not depended on by the parent to in order to finish. Since this is undertaken in a distributed environment a request to another server, such as an RPC or a simple GET, can be considered a span (a unit or work) for the local server. This causal link is what OpenTracing aims to capture and visualise. In order to do this metadata about the local server's span, i.e the 'span context', needs to be included with the request to the remote. It is up to the remote server to decide what it does with the spans it creates. This is called the sampling policy and it can be configured through Jaeger's settings. For OpenTracing concepts see https://opentracing.io/docs/overview/what-is-tracing/ . For more information about Jaeger's implementation see https://www.jaegertracing.io/docs/","breadcrumbs":"OpenTracing » Background","id":"877","title":"Background"},"878":{"body":"To receive OpenTracing spans, start up a Jaeger server. This can be done using docker like so: docker run -d --name jaeger \\ -p 6831:6831/udp \\ -p 6832:6832/udp \\ -p 5778:5778 \\ -p 16686:16686 \\ -p 14268:14268 \\ jaegertracing/all-in-one:1 By default, Synapse will publish traces to Jaeger on localhost. If Jaeger is hosted elsewhere, point Synapse to the correct host by setting opentracing.jaeger_config.local_agent.reporting_host in the Synapse configuration or by setting the JAEGER_AGENT_HOST environment variable to the desired address. Latest documentation is probably at https://www.jaegertracing.io/docs/latest/getting-started.","breadcrumbs":"OpenTracing » Setting up OpenTracing","id":"878","title":"Setting up OpenTracing"},"879":{"body":"OpenTracing is not enabled by default. It must be enabled in the homeserver config by adding the opentracing option to your config file. You can find documentation about how to do this in the config manual under the header 'Opentracing' . See below for an example Opentracing configuration: opentracing: enabled: true homeserver_whitelist: - \"mytrustedhomeserver.org\" - \"*.myotherhomeservers.com\"","breadcrumbs":"OpenTracing » Enable OpenTracing in Synapse","id":"879","title":"Enable OpenTracing in Synapse"},"88":{"body":"Before this update, the POST /_matrix/client/v3/rooms/{roomId}/report/{eventId} endpoint would return a 403 if a user attempted to report an event that they did not have access to. This endpoint will now return a 404 in this case instead. Clients that implement event reporting should check that their error handling code will handle this change.","breadcrumbs":"Upgrading between Synapse Versions » Reporting events error code change","id":"88","title":"Reporting events error code change"},"880":{"body":"The homeserver whitelist is configured using regular expressions. A list of regular expressions can be given and their union will be compared when propagating any spans contexts to another homeserver. Though it's mostly safe to send and receive span contexts to and from untrusted users since span contexts are usually opaque ids it can lead to two problems, namely: If the span context is marked as sampled by the sending homeserver the receiver will sample it. Therefore two homeservers with wildly different sampling policies could incur higher sampling counts than intended. Sending servers can attach arbitrary data to spans, known as 'baggage'. For safety this has been disabled in Synapse but that doesn't prevent another server sending you baggage which will be logged to OpenTracing's logs.","breadcrumbs":"OpenTracing » Homeserver whitelisting","id":"880","title":"Homeserver whitelisting"},"881":{"body":"Sampling strategies can be set as in this document: https://www.jaegertracing.io/docs/latest/sampling/ .","breadcrumbs":"OpenTracing » Configuring Jaeger","id":"881","title":"Configuring Jaeger"},"882":{"body":"Synapse's database schema is stored in the synapse.storage.schema module.","breadcrumbs":"Database Schemas » Synapse database schema files","id":"882","title":"Synapse database schema files"},"883":{"body":"Synapse supports splitting its datastore across multiple physical databases (which can be useful for large installations), and the schema files are therefore split according to the logical database they apply to. At the time of writing, the following \"logical\" databases are supported: state - used to store Matrix room state (more specifically, state_groups, their relationships and contents). main - stores everything else. Additionally, the common directory contains schema files for tables which must be present on all physical databases.","breadcrumbs":"Database Schemas » Logical databases","id":"883","title":"Logical databases"},"884":{"body":"Synapse manages its database schema via \"schema versions\". These are mainly used to help avoid confusion if the Synapse codebase is rolled back after the database is updated. They work as follows: The Synapse codebase defines a constant synapse.storage.schema.SCHEMA_VERSION which represents the expectations made about the database by that version. For example, as of Synapse v1.36, this is 59. The database stores a \"compatibility version\" in schema_compat_version.compat_version which defines the SCHEMA_VERSION of the oldest version of Synapse which will work with the database. On startup, if compat_version is found to be newer than SCHEMA_VERSION, Synapse will refuse to start. Synapse automatically updates this field from synapse.storage.schema.SCHEMA_COMPAT_VERSION. Whenever a backwards-incompatible change is made to the database format (normally via a delta file), synapse.storage.schema.SCHEMA_COMPAT_VERSION is also updated so that administrators can not accidentally roll back to a too-old version of Synapse. Generally, the goal is to maintain compatibility with at least one or two previous releases of Synapse, so any substantial change tends to require multiple releases and a bit of forward-planning to get right. As a worked example: we want to remove the room_stats_historical table. Here is how it might pan out. Replace any code that reads from room_stats_historical with alternative implementations, but keep writing to it in case of rollback to an earlier version. Also, increase synapse.storage.schema.SCHEMA_VERSION. In this instance, there is no existing code which reads from room_stats_historical, so our starting point is: v1.36.0: SCHEMA_VERSION=59, SCHEMA_COMPAT_VERSION=59 Next (say in Synapse v1.37.0): remove the code that writes to room_stats_historical, but don’t yet remove the table in case of rollback to v1.36.0. Again, we increase synapse.storage.schema.SCHEMA_VERSION, but because we have not broken compatibility with v1.36, we do not yet update SCHEMA_COMPAT_VERSION. We now have: v1.37.0: SCHEMA_VERSION=60, SCHEMA_COMPAT_VERSION=59. Later (say in Synapse v1.38.0): we can remove the table altogether. This will break compatibility with v1.36.0, so we must update SCHEMA_COMPAT_VERSION accordingly. There is no need to update synapse.storage.schema.SCHEMA_VERSION, since there is no change to the Synapse codebase here. So we end up with: v1.38.0: SCHEMA_VERSION=60, SCHEMA_COMPAT_VERSION=60. If in doubt about whether to update SCHEMA_VERSION or not, it is generally best to lean towards doing so.","breadcrumbs":"Database Schemas » Synapse schema versions","id":"884","title":"Synapse schema versions"},"885":{"body":"In the full_schemas directories, only the most recently-numbered snapshot is used (54 at the time of writing). Older snapshots (eg, 16) are present for historical reference only.","breadcrumbs":"Database Schemas » Full schema dumps","id":"885","title":"Full schema dumps"},"886":{"body":"If you want to recreate these schemas, they need to be made from a database that 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/ NB at the time of writing, this script predates the split into separate state/main databases so will require updates to handle that correctly.","breadcrumbs":"Database Schemas » Building full schema dumps","id":"886","title":"Building full schema dumps"},"887":{"body":"Delta files define the steps required to upgrade the database from an earlier version. They can be written as either a file containing a series of SQL statements, or a Python module. Synapse remembers which delta files it has applied to a database (they are stored in the applied_schema_deltas table) and will not re-apply them (even if a given file is subsequently updated). Delta files should be placed in a directory named synapse/storage/schema//delta//. They are applied in alphanumeric order, so by convention the first two characters of the filename should be an integer such as 01, to put the file in the right order.","breadcrumbs":"Database Schemas » Delta files","id":"887","title":"Delta files"},"888":{"body":"These should be named *.sql, or — for changes which should only be applied for a given database engine — *.sql.posgres or *.sql.sqlite. For example, a delta which adds a new column to the foo table might be called 01add_bar_to_foo.sql. Note that our SQL parser is a bit simple - it understands comments (-- and /*...*/), but complex statements which require a ; in the middle of them (such as CREATE TRIGGER) are beyond it and you'll have to use a Python delta file.","breadcrumbs":"Database Schemas » SQL delta files","id":"888","title":"SQL delta files"},"889":{"body":"For more flexibility, a delta file can take the form of a python module. These should be named *.py. Note that database-engine-specific modules are not supported here – instead you can write if isinstance(database_engine, PostgresEngine) or similar. A Python delta module should define either or both of the following functions: import synapse.config.homeserver\nimport synapse.storage.engines\nimport synapse.storage.types def run_create( cur: synapse.storage.types.Cursor, database_engine: synapse.storage.engines.BaseDatabaseEngine,\n) -> None: \"\"\"Called whenever an existing or new database is to be upgraded\"\"\" ... def run_upgrade( cur: synapse.storage.types.Cursor, database_engine: synapse.storage.engines.BaseDatabaseEngine, config: synapse.config.homeserver.HomeServerConfig,\n) -> None: \"\"\"Called whenever an existing database is to be upgraded.\"\"\" ...","breadcrumbs":"Database Schemas » Python delta files","id":"889","title":"Python delta files"},"89":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.79.0","id":"89","title":"Upgrading to v1.79.0"},"890":{"body":"It is sometimes appropriate to perform database migrations as part of a background process (instead of blocking Synapse until the migration is done). In particular, this is useful for migrating data when adding new columns or tables. Pending background updates stored in the background_updates table and are denoted by a unique name, the current status (stored in JSON), and some dependency information: Whether the update requires a previous update to be complete. A rough ordering for which to complete updates. A new background updates needs to be added to the background_updates table: INSERT INTO background_updates (ordering, update_name, depends_on, progress_json) VALUES (7706, 'my_background_update', 'a_previous_background_update' '{}'); And then needs an associated handler in the appropriate datastore: self.db_pool.updates.register_background_update_handler( \"my_background_update\", update_handler=self._my_background_update,\n) There are a few types of updates that can be performed, see the BackgroundUpdater: register_background_update_handler: A generic handler for custom SQL register_background_index_update: Create an index in the background register_background_validate_constraint: Validate a constraint in the background (PostgreSQL-only) register_background_validate_constraint_and_delete_rows: Similar to register_background_validate_constraint, but deletes rows which don't fit the constraint. For register_background_update_handler, the generic handler must track progress and then finalize the background update: async def _my_background_update(self, progress: JsonDict, batch_size: int) -> int: def _do_something(txn: LoggingTransaction) -> int: ... self.db_pool.updates._background_update_progress_txn( txn, \"my_background_update\", {\"last_processed\": last_processed} ) return last_processed - prev_last_processed num_processed = await self.db_pool.runInteraction(\"_do_something\", _do_something) await self.db_pool.updates._end_background_update(\"my_background_update\") return num_processed Synapse will attempt to rate-limit how often background updates are run via the given batch-size and the returned number of processed entries (and how long the function took to run). See background update controller callbacks .","breadcrumbs":"Database Schemas » Background updates","id":"890","title":"Background updates"},"891":{"body":"Boolean columns require special treatment, since SQLite treats booleans the same as integers. Any new boolean column must be added to the BOOLEAN_COLUMNS list in synapse/_scripts/synapse_port_db.py. This tells the port script to cast the integer value from SQLite to a boolean before writing the value to the postgres database.","breadcrumbs":"Database Schemas » Boolean columns","id":"891","title":"Boolean columns"},"892":{"body":"event_id's can be considered globally unique although there has been a lot of debate on this topic in places like MSC2779 and MSC2848 which has no resolution yet (as of 2022-09-01). There are several places in Synapse and even in the Matrix APIs like GET /_matrix/federation/v1/event/{eventId} where we assume that event IDs are globally unique. When scoping event_id in a database schema, it is often nice to accompany it with room_id (PRIMARY KEY (room_id, event_id) and a FOREIGN KEY(room_id) REFERENCES rooms(room_id)) which makes flexible lookups easy. For example it makes it very easy to find and clean up everything in a room when it needs to be purged (no need to use sub-select query or join from the events table). A note on collisions: In room versions 1 and 2 it's possible to end up with two events with the same event_id (in the same or different rooms). After room version 3, that can only happen with a hash collision, which we basically hope will never happen (SHA256 has a massive big key space).","breadcrumbs":"Database Schemas » event_id global uniqueness","id":"892","title":"event_id global uniqueness"},"893":{"body":"Some migrations need to be performed gradually. A prime example of this is anything which would need to do a large table scan — including adding columns, indices or NOT NULL constraints to non-empty tables — such a migration should be done as a background update where possible, at least on Postgres. We can afford to be more relaxed about SQLite databases since they are usually used on smaller deployments and SQLite does not support the same concurrent DDL operations as Postgres. We also typically insist on having at least one Synapse version's worth of backwards compatibility, so that administrators can roll back Synapse if an upgrade did not go smoothly. This sometimes results in having to plan a migration across multiple versions of Synapse. This section includes an example and may include more in the future.","breadcrumbs":"Database Schemas » Worked examples of gradual migrations","id":"893","title":"Worked examples of gradual migrations"},"894":{"body":"This example illustrates how you would introduce a new column, write data into it based on data from an old column and then drop the old column. We are aiming for semantic equivalence to: ALTER TABLE mytable ADD COLUMN new_column INTEGER;\nUPDATE mytable SET new_column = old_column * 100;\nALTER TABLE mytable ALTER COLUMN new_column ADD CONSTRAINT NOT NULL;\nALTER TABLE mytable DROP COLUMN old_column; Synapse version N SCHEMA_VERSION = S\nSCHEMA_COMPAT_VERSION = ... # unimportant at this stage Invariants: old_column is read by Synapse and written to by Synapse. Synapse version N + 1 SCHEMA_VERSION = S + 1\nSCHEMA_COMPAT_VERSION = ... # unimportant at this stage Changes: ALTER TABLE mytable ADD COLUMN new_column INTEGER; Invariants: old_column is read by Synapse and written to by Synapse. new_column is written to by Synapse. Notes: new_column can't have a NOT NULL NOT VALID constraint yet, because the previous Synapse version did not write to the new column (since we haven't bumped the SCHEMA_COMPAT_VERSION yet, we still need to be compatible with the previous version). Synapse version N + 2 SCHEMA_VERSION = S + 2\nSCHEMA_COMPAT_VERSION = S + 1 # this signals that we can't roll back to a time before new_column existed Changes: On Postgres, add a NOT VALID constraint to ensure new rows are compliant. SQLite does not have such a construct, but it would be unnecessary anyway since there is no way to concurrently perform this migration on SQLite. ALTER TABLE mytable ADD CONSTRAINT CHECK new_column_not_null (new_column IS NOT NULL) NOT VALID; Start a background update to perform migration: it should gradually run e.g. UPDATE mytable SET new_column = old_column * 100 WHERE 0 < mytable_id AND mytable_id <= 5; This background update is technically pointless on SQLite, but you must schedule it anyway so that the portdb script to migrate to Postgres still works. Upon completion of the background update, you should run VALIDATE CONSTRAINT on Postgres to turn the NOT VALID constraint into a valid one. ALTER TABLE mytable VALIDATE CONSTRAINT new_column_not_null; This will take some time but does NOT hold an exclusive lock over the table. Invariants: old_column is read by Synapse and written to by Synapse. new_column is written to by Synapse and new rows always have a non-NULL value in this field. Notes: If you wish, you can convert the CHECK (new_column IS NOT NULL) to a NOT NULL constraint free of charge in Postgres by adding the NOT NULL constraint and then dropping the CHECK constraint, because Postgres can statically verify that the NOT NULL constraint is implied by the CHECK constraint without performing a table scan. It might be tempting to make version N + 2 redundant by moving the background update to N + 1 and delaying adding the NOT NULL constraint to N + 3, but that would mean the constraint would always be validated in the foreground in N + 3. Whereas if the N + 2 step is kept, the migration in N + 3 would be fast in the happy case. Synapse version N + 3 SCHEMA_VERSION = S + 3\nSCHEMA_COMPAT_VERSION = S + 1 # we can't roll back to a time before new_column existed Changes: (Postgres) Update the table to populate values of new_column in case the background update had not completed. Additionally, VALIDATE CONSTRAINT to make the check fully valid. -- you ideally want an index on `new_column` or e.g. `(new_column) WHERE new_column IS NULL` first, or perhaps you can find a way to skip this if the `NOT NULL` constraint has already been validated.\nUPDATE mytable SET new_column = old_column * 100 WHERE new_column IS NULL; -- this is a no-op if it already ran as part of the background update\nALTER TABLE mytable VALIDATE CONSTRAINT new_column_not_null; (SQLite) Recreate the table by precisely following the 12-step procedure for SQLite table schema changes . During this table rewrite, you should recreate new_column as NOT NULL and populate any outstanding NULL values at the same time. Unfortunately, you can't drop old_column yet because it must be present for compatibility with the Postgres schema, as needed by portdb. (Otherwise you could do this all in one go with SQLite!) Invariants: old_column is written to by Synapse (but no longer read by Synapse!). new_column is read by Synapse and written to by Synapse. Moreover, all rows have a non-NULL value in this field, as guaranteed by a schema constraint. Notes: We can't drop old_column yet, or even stop writing to it, because that would break a rollback to the previous version of Synapse. Application code can now rely on new_column being populated. The remaining steps are only motivated by the wish to clean-up old columns. Synapse version N + 4 SCHEMA_VERSION = S + 4\nSCHEMA_COMPAT_VERSION = S + 3 # we can't roll back to a time before new_column was entirely non-NULL Invariants: old_column exists but is not written to or read from by Synapse. new_column is read by Synapse and written to by Synapse. Moreover, all rows have a non-NULL value in this field, as guaranteed by a schema constraint. Notes: We can't drop old_column yet because that would break a rollback to the previous version of Synapse. TODO: It may be possible to relax this and drop the column straight away as long as the previous version of Synapse detected a rollback occurred and stopped attempting to write to the column. This could possibly be done by checking whether the database's schema compatibility version was S + 3. Synapse version N + 5 SCHEMA_VERSION = S + 5\nSCHEMA_COMPAT_VERSION = S + 4 # we can't roll back to a time before old_column was no longer being touched Changes: ALTER TABLE mytable DROP COLUMN old_column;","breadcrumbs":"Database Schemas » Transforming a column into another one, with NOT NULL constraints","id":"894","title":"Transforming a column into another one, with NOT NULL constraints"},"895":{"body":"It can be desirable to implement \"experimental\" features which are disabled by default and must be explicitly enabled via the Synapse configuration. This is applicable for features which: Are unstable in the Matrix spec (e.g. those defined by an MSC that has not yet been merged). Developers are not confident in their use by general Synapse administrators/users (e.g. a feature is incomplete, buggy, performs poorly, or needs further testing). Note that this only really applies to features which are expected to be desirable to a broad audience. The module infrastructure should instead be investigated for non-standard features. Guarding experimental features behind configuration flags should help with some of the following scenarios: Ensure that clients do not assume that unstable features exist (failing gracefully if they do not). Unstable features do not become de-facto standards and can be removed aggressively (since only those who have opted-in will be affected). Ease finding the implementation of unstable features in Synapse (for future removal or stabilization). Ease testing a feature (or removal of feature) due to enabling/disabling without code changes. It also becomes possible to ask for wider testing, if desired. Experimental configuration flags should be disabled by default (requiring Synapse administrators to explicitly opt-in), although there are situations where it makes sense (from a product point-of-view) to enable features by default. This is expected and not an issue. It is not a requirement for experimental features to be behind a configuration flag, but one should be used if unsure. New experimental configuration flags should be added under the experimental configuration key (see the synapse.config.experimental file) and either explain (briefly) what is being enabled, or include the MSC number.","breadcrumbs":"Experimental features » Implementing experimental features in Synapse","id":"895","title":"Implementing experimental features in Synapse"},"896":{"body":"This is a quick cheat sheet for developers on how to use poetry .","breadcrumbs":"Dependency management » Managing dependencies with Poetry","id":"896","title":"Managing dependencies with Poetry"},"897":{"body":"See the contributing guide . Developers should use Poetry 1.3.2 or higher. If you encounter problems related to poetry, please double-check your poetry version .","breadcrumbs":"Dependency management » Installing","id":"897","title":"Installing"},"898":{"body":"Synapse uses a variety of third-party Python packages to function as a homeserver. Some of these are direct dependencies, listed in pyproject.toml under the [tool.poetry.dependencies] section. The rest are transitive dependencies (the things that our direct dependencies themselves depend on, and so on recursively.) We maintain a locked list of all our dependencies (transitive included) so that we can track exactly which version of each dependency appears in a given release. See here for discussion of why we wanted this for Synapse. We chose to use poetry to manage this locked list; see this comment for the reasoning. The locked dependencies get included in our \"self-contained\" releases: namely, our docker images and our debian packages. We also use the locked dependencies in development and our continuous integration. Separately, our \"broad\" dependencies—the version ranges specified in pyproject.toml—are included as metadata in our \"sdists\" and \"wheels\" uploaded to PyPI . Installing from PyPI or from the Synapse source tree directly will not use the locked dependencies; instead, they'll pull in the latest version of each package available at install time.","breadcrumbs":"Dependency management » Background","id":"898","title":"Background"},"899":{"body":"An example may help. We have a broad dependency on phonenumbers , as declared in this snippet from pyproject.toml as of Synapse 1.57 : [tool.poetry.dependencies]\n# ...\nphonenumbers = \">=8.2.0\" In our lockfile this is pinned to version 8.12.44, even though newer versions are available . [[package]]\nname = \"phonenumbers\"\nversion = \"8.12.44\"\ndescription = \"Python version of Google's common library for parsing, formatting, storing and validating international phone numbers.\"\ncategory = \"main\"\noptional = false\npython-versions = \"*\" The lockfile also includes a cryptographic checksum of the sdists and wheels provided for this version of phonenumbers. [metadata.files]\n# ...\nphonenumbers = [ {file = \"phonenumbers-8.12.44-py2.py3-none-any.whl\", hash = \"sha256:cc1299cf37b309ecab6214297663ab86cb3d64ae37fd5b88e904fe7983a874a6\"}, {file = \"phonenumbers-8.12.44.tar.gz\", hash = \"sha256:26cfd0257d1704fe2f88caff2caabb70d16a877b1e65b6aae51f9fbbe10aa8ce\"},\n] We can see this pinned version inside the docker image for that release: $ docker pull vectorim/synapse:v1.97.0\n...\n$ docker run --entrypoint pip vectorim/synapse:v1.97.0 show phonenumbers\nName: phonenumbers\nVersion: 8.12.44\nSummary: Python version of Google's common library for parsing, formatting, storing and validating international phone numbers.\nHome-page: https://github.com/daviddrysdale/python-phonenumbers\nAuthor: David Drysdale\nAuthor-email: dmd@lurklurk.org\nLicense: Apache License 2.0\nLocation: /usr/local/lib/python3.9/site-packages\nRequires:\nRequired-by: matrix-synapse Whereas the wheel metadata just contains the broad dependencies: $ cd /tmp\n$ wget https://files.pythonhosted.org/packages/ca/5e/d722d572cc5b3092402b783d6b7185901b444427633bd8a6b00ea0dd41b7/matrix_synapse-1.57.0rc1-py3-none-any.whl\n...\n$ unzip -c matrix_synapse-1.57.0rc1-py3-none-any.whl matrix_synapse-1.57.0rc1.dist-info/METADATA | grep phonenumbers\nRequires-Dist: phonenumbers (>=8.2.0)","breadcrumbs":"Dependency management » Example dependency","id":"899","title":"Example dependency"},"9":{"body":"Once you have installed synapse as above, you will need to configure it.","breadcrumbs":"Installation » Setting up Synapse","id":"9","title":"Setting up Synapse"},"90":{"body":"Synapse v1.79.0 deprecates the on_threepid_bind \"third-party rules\" Synapse module callback method in favour of a new module method, on_add_user_third_party_identifier . on_threepid_bind will be removed in a future version of Synapse. You should check whether any Synapse modules in use in your deployment are making use of on_threepid_bind, and update them where possible. The arguments and functionality of the new method are the same. The justification behind the name change is that the old method's name, on_threepid_bind, was misleading. A user is considered to \"bind\" their third-party ID to their Matrix ID only if they do so via an identity server (so that users on other homeservers may find them). But this method was not called in that case - it was only called when a user added a third-party identifier on the local homeserver. Module developers may also be interested in the related on_remove_user_third_party_identifier module callback method that was also added in Synapse v1.79.0. This new method is called when a user removes a third-party identifier from their account.","breadcrumbs":"Upgrading between Synapse Versions » The on_threepid_bind module callback method has been deprecated","id":"90","title":"The on_threepid_bind module callback method has been deprecated"},"900":{"body":"direnv is a tool for activating environments in your shell inside a given directory. Its support for poetry is unofficial (a community wiki recipe only), but works solidly in our experience. We thoroughly recommend it for daily use. To use it: Install direnv - it's likely packaged for your system already. Teach direnv about poetry. The shell config here needs to be added to ~/.config/direnv/direnvrc (or more generally $XDG_CONFIG_HOME/direnv/direnvrc). Mark the synapse checkout as a poetry project: echo layout poetry > .envrc. Convince yourself that you trust this .envrc configuration and project. Then formally confirm this to direnv by running direnv allow. Then whenever you navigate to the synapse checkout, you should be able to run e.g. mypy instead of poetry run mypy; python instead of poetry run python; and your shell commands will automatically run in the context of poetry's venv, without having to run poetry shell beforehand.","breadcrumbs":"Dependency management » Tooling recommendation: direnv","id":"900","title":"Tooling recommendation: direnv"},"901":{"body":"","breadcrumbs":"Dependency management » How do I...","id":"901","title":"How do I..."},"902":{"body":"poetry install --all-extras --sync","breadcrumbs":"Dependency management » ...reset my venv to the locked environment?","id":"902","title":"...reset my venv to the locked environment?"},"903":{"body":"# Stop the current virtualenv if active\n$ deactivate # Remove all of the files from the current environment.\n# Don't worry, even though it says \"all\", this will only\n# remove the Poetry virtualenvs for the current project.\n$ poetry env remove --all # Reactivate Poetry shell to create the virtualenv again\n$ poetry shell\n# Install everything again\n$ poetry install --extras all","breadcrumbs":"Dependency management » ...delete everything and start over from scratch?","id":"903","title":"...delete everything and start over from scratch?"},"904":{"body":"Use poetry run cmd args when you need the python virtualenv context. To avoid typing poetry run all the time, you can run poetry shell to start a new shell in the poetry virtualenv context. Within poetry shell, python, pip, mypy, trial, etc. are all run inside the project virtualenv and isolated from the rest o the system. Roughly speaking, the translation from a traditional virtualenv is: env/bin/activate -> poetry shell, and deactivate -> close the terminal (Ctrl-D, exit, etc.) See also the direnv recommendation above, which makes poetry run and poetry shell unnecessary.","breadcrumbs":"Dependency management » ...run a command in the poetry virtualenv?","id":"904","title":"...run a command in the poetry virtualenv?"},"905":{"body":"Some suggestions: # Current env only\npoetry env info\n# All envs: this allows you to have e.g. a poetry managed venv for Python 3.7,\n# and another for Python 3.10.\npoetry env list --full-path\npoetry run pip list Note that poetry show describes the abstract lock file rather than your on-disk environment. With that said, poetry show --tree can sometimes be useful.","breadcrumbs":"Dependency management » ...inspect the poetry virtualenv?","id":"905","title":"...inspect the poetry virtualenv?"},"906":{"body":"Either: manually update pyproject.toml; then poetry lock --no-update; or else poetry add packagename. See poetry add --help; note the --dev, --extras and --optional flags in particular. Include the updated pyproject.toml and poetry.lock files in your commit.","breadcrumbs":"Dependency management » ...add a new dependency?","id":"906","title":"...add a new dependency?"},"907":{"body":"This is not done often and is untested, but poetry remove packagename ought to do the trick. Alternatively, manually update pyproject.toml and poetry lock --no-update. Include the updated pyproject.toml and poetry.lock files in your commit.","breadcrumbs":"Dependency management » ...remove a dependency?","id":"907","title":"...remove a dependency?"},"908":{"body":"Best done by manually editing pyproject.toml, then poetry lock --no-update. Include the updated pyproject.toml and poetry.lock in your commit.","breadcrumbs":"Dependency management » ...update the version range for an existing dependency?","id":"908","title":"...update the version range for an existing dependency?"},"909":{"body":"Use poetry update packagename to use the latest version of packagename in the locked environment, without affecting the broad dependencies listed in the wheel. There doesn't seem to be a way to do this whilst locking a specific version of packagename. We can workaround this (crudely) as follows: poetry add packagename==1.2.3\n# This should update pyproject.lock. # Now undo the changes to pyproject.toml. For example\n# git restore pyproject.toml # Get poetry to recompute the content-hash of pyproject.toml without changing\n# the locked package versions.\npoetry lock --no-update Either way, include the updated poetry.lock file in your commit.","breadcrumbs":"Dependency management » ...update a dependency in the locked environment?","id":"909","title":"...update a dependency in the locked environment?"},"91":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.78.0","id":"91","title":"Upgrading to v1.78.0"},"910":{"body":"poetry export --extras all Be wary of bugs in poetry export and pip install -r requirements.txt.","breadcrumbs":"Dependency management » ...export a requirements.txt file?","id":"910","title":"...export a requirements.txt file?"},"911":{"body":"I usually use poetry run pip install build && poetry run python -m build because build is a standardish tool which doesn't require poetry. (It's what we use in CI too). However, you could try poetry build too.","breadcrumbs":"Dependency management » ...build a test wheel?","id":"911","title":"...build a test wheel?"},"912":{"body":"Synapse uses Dependabot to keep the poetry.lock and Cargo.lock file up-to-date with the latest releases of our dependencies. The changelog check is omitted for Dependabot PRs; the release script will include them in the changelog. When reviewing a dependabot PR, ensure that: the lockfile changes look reasonable; the upstream changelog file (linked in the description) doesn't include any breaking changes; continuous integration passes. In particular, any updates to the type hints (usually packages which start with types-) should be safe to merge if linting passes.","breadcrumbs":"Dependency management » ...handle a Dependabot pull request?","id":"912","title":"...handle a Dependabot pull request?"},"913":{"body":"","breadcrumbs":"Dependency management » Troubleshooting","id":"913","title":"Troubleshooting"},"914":{"body":"The minimum version of poetry supported by Synapse is 1.3.2. It can also be useful to check the version of poetry-core in use. If you've installed poetry with pipx, try pipx runpip poetry list | grep poetry-core.","breadcrumbs":"Dependency management » Check the version of poetry with poetry --version.","id":"914","title":"Check the version of poetry with poetry --version."},"915":{"body":"Poetry caches a bunch of information about packages that isn't readily available from PyPI. (This is what makes poetry seem slow when doing the first poetry install.) Try poetry cache list and poetry cache clear --all to see if that fixes things.","breadcrumbs":"Dependency management » Clear caches: poetry cache clear --all pypi.","id":"915","title":"Clear caches: poetry cache clear --all pypi."},"916":{"body":"Delete the matrix_synapse.egg-info/ directory from the root of your Synapse install. This stores some cached information about dependencies and often conflicts with letting Poetry do the right thing.","breadcrumbs":"Dependency management » Remove outdated egg-info","id":"916","title":"Remove outdated egg-info"},"917":{"body":"Sometimes useful to see what poetry's internal logic is.","breadcrumbs":"Dependency management » Try --verbose or --dry-run arguments.","id":"917","title":"Try --verbose or --dry-run arguments."},"918":{"body":"Sometimes, requests take a long time to service and clients disconnect before Synapse produces a response. To avoid wasting resources, Synapse can cancel request processing for select endpoints marked with the @cancellable decorator. Synapse makes use of Twisted's Deferred.cancel() feature to make cancellation work. The @cancellable decorator does nothing by itself and merely acts as a flag, signalling to developers and other code alike that a method can be cancelled.","breadcrumbs":"Synapse Architecture » Cancellation » Cancellation","id":"918","title":"Cancellation"},"919":{"body":"Check that the endpoint method, and any async functions in its call tree handle cancellation correctly. See Handling cancellation correctly for a list of things to look out for. Add the @cancellable decorator to the on_GET/POST/PUT/DELETE method. It's not recommended to make non-GET methods cancellable, since cancellation midway through some database updates is less likely to be handled correctly.","breadcrumbs":"Synapse Architecture » Cancellation » Enabling cancellation for an endpoint","id":"919","title":"Enabling cancellation for an endpoint"},"92":{"body":"Synapse 1.78.0 replaces the /_synapse/admin/v1/media//delete admin API with an identical endpoint at /_synapse/admin/v1/media/delete. Please update your tooling to use the new endpoint. The deprecated version will be removed in a future release.","breadcrumbs":"Upgrading between Synapse Versions » Deprecate the /_synapse/admin/v1/media//delete admin API","id":"92","title":"Deprecate the /_synapse/admin/v1/media//delete admin API"},"920":{"body":"There are two stages to cancellation: downward propagation of a cancel() call, followed by upwards propagation of a CancelledError out of a blocked await. Both Twisted and asyncio have a cancellation mechanism. Method Exception Exception inherits from Twisted Deferred.cancel() twisted.internet.defer.CancelledError Exception (!) asyncio Task.cancel() asyncio.CancelledError BaseException","breadcrumbs":"Synapse Architecture » Cancellation » Mechanics","id":"920","title":"Mechanics"},"921":{"body":"When Synapse starts handling a request, it runs the async method responsible for handling it using defer.ensureDeferred, which returns a Deferred. For example: def do_something() -> Deferred[None]: ... @cancellable\nasync def on_GET() -> Tuple[int, JsonDict]: d = make_deferred_yieldable(do_something()) await d return 200, {} request = defer.ensureDeferred(on_GET()) When a client disconnects early, Synapse checks for the presence of the @cancellable decorator on on_GET. Since on_GET is cancellable, Deferred.cancel() is called on the Deferred from defer.ensureDeferred, ie. request. Twisted knows which Deferred request is waiting on and passes the cancel() call on to d. The Deferred being waited on, d, may have its own handling for cancel() and pass the call on to other Deferreds. Eventually, a Deferred handles the cancel() call by resolving itself with a CancelledError.","breadcrumbs":"Synapse Architecture » Cancellation » Deferred.cancel()","id":"921","title":"Deferred.cancel()"},"922":{"body":"The CancelledError gets raised out of the await and bubbles up, as per normal Python exception handling.","breadcrumbs":"Synapse Architecture » Cancellation » CancelledError","id":"922","title":"CancelledError"},"923":{"body":"In general, when writing code that might be subject to cancellation, two things must be considered: The effect of CancelledErrors raised out of awaits. The effect of Deferreds being cancel()ed. Examples of code that handles cancellation incorrectly include: try-except blocks which swallow CancelledErrors. Code that shares the same Deferred, which may be cancelled, between multiple requests. Code that starts some processing that's exempt from cancellation, but uses a logging context from cancellable code. The logging context will be finished upon cancellation, while the uncancelled processing is still using it. Some common patterns are listed below in more detail.","breadcrumbs":"Synapse Architecture » Cancellation » Handling cancellation correctly","id":"923","title":"Handling cancellation correctly"},"924":{"body":"Most functions in Synapse are relatively straightforward from a cancellation standpoint: they don't do anything with Deferreds and purely call and await other async functions. An async function handles cancellation correctly if its own code handles cancellation correctly and all the async function it calls handle cancellation correctly. For example: async def do_two_things() -> None: check_something() await do_something() await do_something_else() do_two_things handles cancellation correctly if do_something and do_something_else handle cancellation correctly. That is, when checking whether a function handles cancellation correctly, its implementation and all its async function calls need to be checked, recursively. As check_something is not async, it does not need to be checked.","breadcrumbs":"Synapse Architecture » Cancellation » async function calls","id":"924","title":"async function calls"},"925":{"body":"Because Twisted's CancelledErrors are Exceptions, it's easy to accidentally catch and suppress them. Care must be taken to ensure that CancelledErrors are allowed to propagate upwards. Bad : try: await do_something()\nexcept Exception: # `CancelledError` gets swallowed here. logger.info(...) Good : try: await do_something()\nexcept CancelledError: raise\nexcept Exception: logger.info(...) OK : try: check_something() # A `CancelledError` won't ever be raised here.\nexcept Exception: logger.info(...) Good : try: await do_something()\nexcept ValueError: logger.info(...) defer.gatherResults defer.gatherResults produces a Deferred which: broadcasts cancel() calls to every Deferred being waited on. wraps the first exception it sees in a FirstError. Together, this means that CancelledErrors will be wrapped in a FirstError unless unwrapped. Such FirstErrors are liable to be swallowed, so they must be unwrapped. Bad : async def do_something() -> None: await make_deferred_yieldable( defer.gatherResults([...], consumeErrors=True) ) try: await do_something()\nexcept CancelledError: raise\nexcept Exception: # `FirstError(CancelledError)` gets swallowed here. logger.info(...) Good : async def do_something() -> None: await make_deferred_yieldable( defer.gatherResults([...], consumeErrors=True) ).addErrback(unwrapFirstError) try: await do_something()\nexcept CancelledError: raise\nexcept Exception: logger.info(...)","breadcrumbs":"Synapse Architecture » Cancellation » CancelledErrors","id":"925","title":"CancelledErrors"},"926":{"body":"If a function creates a Deferred, the effect of cancelling it must be considered. Deferreds that get shared are likely to have unintended behaviour when cancelled. Bad : cache: Dict[str, Deferred[None]] = {} def wait_for_room(room_id: str) -> Deferred[None]: deferred = cache.get(room_id) if deferred is None: deferred = Deferred() cache[room_id] = deferred # `deferred` can have multiple waiters. # All of them will observe a `CancelledError` # if any one of them is cancelled. return make_deferred_yieldable(deferred) # Request 1\nawait wait_for_room(\"!aAAaaAaaaAAAaAaAA:matrix.org\")\n# Request 2\nawait wait_for_room(\"!aAAaaAaaaAAAaAaAA:matrix.org\") Good : cache: Dict[str, Deferred[None]] = {} def wait_for_room(room_id: str) -> Deferred[None]: deferred = cache.get(room_id) if deferred is None: deferred = Deferred() cache[room_id] = deferred # `deferred` will never be cancelled now. # A `CancelledError` will still come out of # the `await`. # `delay_cancellation` may also be used. return make_deferred_yieldable(stop_cancellation(deferred)) # Request 1\nawait wait_for_room(\"!aAAaaAaaaAAAaAaAA:matrix.org\")\n# Request 2\nawait wait_for_room(\"!aAAaaAaaaAAAaAaAA:matrix.org\") Good : cache: Dict[str, List[Deferred[None]]] = {} def wait_for_room(room_id: str) -> Deferred[None]: if room_id not in cache: cache[room_id] = [] # Each request gets its own `Deferred` to wait on. deferred = Deferred() cache[room_id]].append(deferred) return make_deferred_yieldable(deferred) # Request 1\nawait wait_for_room(\"!aAAaaAaaaAAAaAaAA:matrix.org\")\n# Request 2\nawait wait_for_room(\"!aAAaaAaaaAAAaAaAA:matrix.org\")","breadcrumbs":"Synapse Architecture » Cancellation » Creation of Deferreds","id":"926","title":"Creation of Deferreds"},"927":{"body":"Some async functions may kick off some async processing which is intentionally protected from cancellation, by stop_cancellation or other means. If the async processing inherits the logcontext of the request which initiated it, care must be taken to ensure that the logcontext is not finished before the async processing completes. Bad : cache: Optional[ObservableDeferred[None]] = None async def do_something_else( to_resolve: Deferred[None]\n) -> None: await ... logger.info(\"done!\") to_resolve.callback(None) async def do_something() -> None: if not cache: to_resolve = Deferred() cache = ObservableDeferred(to_resolve) # `do_something_else` will never be cancelled and # can outlive the `request-1` logging context. run_in_background(do_something_else, to_resolve) await make_deferred_yieldable(cache.observe()) with LoggingContext(\"request-1\"): await do_something() Good : cache: Optional[ObservableDeferred[None]] = None async def do_something_else( to_resolve: Deferred[None]\n) -> None: await ... logger.info(\"done!\") to_resolve.callback(None) async def do_something() -> None: if not cache: to_resolve = Deferred() cache = ObservableDeferred(to_resolve) run_in_background(do_something_else, to_resolve) # We'll wait until `do_something_else` is # done before raising a `CancelledError`. await make_deferred_yieldable( delay_cancellation(cache.observe()) ) else: await make_deferred_yieldable(cache.observe()) with LoggingContext(\"request-1\"): await do_something() OK : cache: Optional[ObservableDeferred[None]] = None async def do_something_else( to_resolve: Deferred[None]\n) -> None: await ... logger.info(\"done!\") to_resolve.callback(None) async def do_something() -> None: if not cache: to_resolve = Deferred() cache = ObservableDeferred(to_resolve) # `do_something_else` will get its own independent # logging context. `request-1` will not count any # metrics from `do_something_else`. run_as_background_process( \"do_something_else\", do_something_else, to_resolve, ) await make_deferred_yieldable(cache.observe()) with LoggingContext(\"request-1\"): await do_something()","breadcrumbs":"Synapse Architecture » Cancellation » Uncancelled processing","id":"927","title":"Uncancelled processing"},"928":{"body":"To help track the processing of individual requests, synapse uses a 'log context' to track which request it is handling at any given moment. This is done via a thread-local variable; a logging.Filter is then used to fish the information back out of the thread-local variable and add it to each log record. Logcontexts are also used for CPU and database accounting, so that we can track which requests were responsible for high CPU use or database activity. The synapse.logging.context module provides facilities for managing the current log context (as well as providing the LoggingContextFilter class). Asynchronous functions make the whole thing complicated, so this document describes how it all works, and how to write code which follows the rules. In this document, \"awaitable\" refers to any object which can be awaited. In the context of Synapse, that normally means either a coroutine or a Twisted Deferred .","breadcrumbs":"Synapse Architecture » Log Contexts » Log Contexts","id":"928","title":"Log Contexts"},"929":{"body":"In the absence of any asynchronous voodoo, things are simple enough. As with any code of this nature, the rule is that our function should leave things as it found them: from synapse.logging import context # omitted from future snippets def handle_request(request_id): request_context = context.LoggingContext() calling_context = context.set_current_context(request_context) try: request_context.request = request_id do_request_handling() logger.debug(\"finished\") finally: context.set_current_context(calling_context) def do_request_handling(): logger.debug(\"phew\") # this will be logged against request_id LoggingContext implements the context management methods, so the above can be written much more succinctly as: def handle_request(request_id): with context.LoggingContext() as request_context: request_context.request = request_id do_request_handling() logger.debug(\"finished\") def do_request_handling(): logger.debug(\"phew\")","breadcrumbs":"Synapse Architecture » Log Contexts » Logcontexts without asynchronous code","id":"929","title":"Logcontexts without asynchronous code"},"93":{"body":"","breadcrumbs":"Upgrading between Synapse Versions » Upgrading to v1.76.0","id":"93","title":"Upgrading to v1.76.0"},"930":{"body":"Awaitables break the linear flow of code so that there is no longer a single entry point where we should set the logcontext and a single exit point where we should remove it. Consider the example above, where do_request_handling needs to do some blocking operation, and returns an awaitable: async def handle_request(request_id): with context.LoggingContext() as request_context: request_context.request = request_id await do_request_handling() logger.debug(\"finished\") In the above flow: The logcontext is set do_request_handling is called, and returns an awaitable handle_request awaits the awaitable Execution of handle_request is suspended So we have stopped processing the request (and will probably go on to start processing the next), without clearing the logcontext. To circumvent this problem, synapse code assumes that, wherever you have an awaitable, you will want to await it. To that end, wherever functions return awaitables, we adopt the following conventions: Rules for functions returning awaitables: If the awaitable is already complete, the function returns with the same logcontext it started with. If the awaitable is incomplete, the function clears the logcontext before returning; when the awaitable completes, it restores the logcontext before running any callbacks. That sounds complicated, but actually it means a lot of code (including the example above) \"just works\". There are two cases: If do_request_handling returns a completed awaitable, then the logcontext will still be in place. In this case, execution will continue immediately after the await; the \"finished\" line will be logged against the right context, and the with block restores the original context before we return to the caller. If the returned awaitable is incomplete, do_request_handling clears the logcontext before returning. The logcontext is therefore clear when handle_request awaits the awaitable. Once do_request_handling's awaitable completes, it will reinstate the logcontext, before running the second half of handle_request, so again the \"finished\" line will be logged against the right context, and the with block restores the original context. As an aside, it's worth noting that handle_request follows our rules though that only matters if the caller has its own logcontext which it cares about. The following sections describe pitfalls and helpful patterns when implementing these rules.","breadcrumbs":"Synapse Architecture » Log Contexts » Using logcontexts with awaitables","id":"930","title":"Using logcontexts with awaitables"},"931":{"body":"Whenever you get an awaitable back from a function, you should await on it as soon as possible. Do not pass go; do not do any logging; do not call any other functions. async def fun(): logger.debug(\"starting\") await do_some_stuff() # just like this coro = more_stuff() result = await coro # also fine, of course return result Provided this pattern is followed all the way back up to the callchain to where the logcontext was set, this will make things work out ok: provided do_some_stuff and more_stuff follow the rules above, then so will fun. It's all too easy to forget to await: for instance if we forgot that do_some_stuff returned an awaitable, we might plough on regardless. This leads to a mess; it will probably work itself out eventually, but not before a load of stuff has been logged against the wrong context. (Normally, other things will break, more obviously, if you forget to await, so this tends not to be a major problem in practice.) Of course sometimes you need to do something a bit fancier with your awaitable - not all code follows the linear A-then-B-then-C pattern. Notes on implementing more complex patterns are in later sections.","breadcrumbs":"Synapse Architecture » Log Contexts » Always await your awaitables","id":"931","title":"Always await your awaitables"},"932":{"body":"Most of the time, an awaitable comes from another synapse function. Sometimes, though, we need to make up a new awaitable, or we get an awaitable back from external code. We need to make it follow our rules. The easy way to do it is by using context.make_deferred_yieldable. Suppose we want to implement sleep, which returns a deferred which will run its callbacks after a given number of seconds. That might look like: # not a logcontext-rules-compliant function\ndef get_sleep_deferred(seconds): d = defer.Deferred() reactor.callLater(seconds, d.callback, None) return d That doesn't follow the rules, but we can fix it by calling it through context.make_deferred_yieldable: async def sleep(seconds): return await context.make_deferred_yieldable(get_sleep_deferred(seconds))","breadcrumbs":"Synapse Architecture » Log Contexts » Where you create a new awaitable, make it follow the rules","id":"932","title":"Where you create a new awaitable, make it follow the rules"},"933":{"body":"Sometimes you want to fire off a chain of execution, but not wait for its result. That might look a bit like this: async def do_request_handling(): await foreground_operation() # *don't* do this background_operation() logger.debug(\"Request handling complete\") async def background_operation(): await first_background_step() logger.debug(\"Completed first step\") await second_background_step() logger.debug(\"Completed second step\") The above code does a couple of steps in the background after do_request_handling has finished. The log lines are still logged against the request_context logcontext, which may or may not be desirable. There are two big problems with the above, however. The first problem is that, if background_operation returns an incomplete awaitable, it will expect its caller to await immediately, so will have cleared the logcontext. In this example, that means that 'Request handling complete' will be logged without any context. The second problem, which is potentially even worse, is that when the awaitable returned by background_operation completes, it will restore the original logcontext. There is nothing waiting on that awaitable, so the logcontext will leak into the reactor and possibly get attached to some arbitrary future operation. There are two potential solutions to this. One option is to surround the call to background_operation with a PreserveLoggingContext call. That will reset the logcontext before starting background_operation (so the context restored when the deferred completes will be the empty logcontext), and will restore the current logcontext before continuing the foreground process: async def do_request_handling(): await foreground_operation() # start background_operation off in the empty logcontext, to # avoid leaking the current context into the reactor. with PreserveLoggingContext(): background_operation() # this will now be logged against the request context logger.debug(\"Request handling complete\") Obviously that option means that the operations done in background_operation would be not be logged against a logcontext (though that might be fixed by setting a different logcontext via a with LoggingContext(...) in background_operation). The second option is to use context.run_in_background, which wraps a function so that it doesn't reset the logcontext even when it returns an incomplete awaitable, and adds a callback to the returned awaitable to reset the logcontext. In other words, it turns a function that follows the Synapse rules about logcontexts and awaitables into one which behaves more like an external function --- the opposite operation to that described in the previous section. It can be used like this: async def do_request_handling(): await foreground_operation() context.run_in_background(background_operation) # this will now be logged against the request context logger.debug(\"Request handling complete\")","breadcrumbs":"Synapse Architecture » Log Contexts » Fire-and-forget","id":"933","title":"Fire-and-forget"},"934":{"body":"A typical example of this is where we want to collect together two or more awaitables via defer.gatherResults: a1 = operation1()\na2 = operation2()\na3 = defer.gatherResults([a1, a2]) This is really a variation of the fire-and-forget problem above, in that we are firing off a1 and a2 without awaiting on them. The difference is that we now have third-party code attached to their callbacks. Anyway either technique given in the Fire-and-forget section will work. Of course, the new awaitable returned by gather needs to be wrapped in order to make it follow the logcontext rules before we can yield it, as described in Where you create a new awaitable, make it follow the rules . So, option one: reset the logcontext before starting the operations to be gathered: async def do_request_handling(): with PreserveLoggingContext(): a1 = operation1() a2 = operation2() result = await defer.gatherResults([a1, a2]) In this case particularly, though, option two, of using context.run_in_background almost certainly makes more sense, so that operation1 and operation2 are both logged against the original logcontext. This looks like: async def do_request_handling(): a1 = context.run_in_background(operation1) a2 = context.run_in_background(operation2) result = await make_deferred_yieldable(defer.gatherResults([a1, a2]))","breadcrumbs":"Synapse Architecture » Log Contexts » Passing synapse deferreds into third-party functions","id":"934","title":"Passing synapse deferreds into third-party functions"},"935":{"body":"It turns out that our logcontext rules do not play nicely with awaitable chains which get orphaned and garbage-collected. Imagine we have some code that looks like this: listener_queue = [] def on_something_interesting(): for d in listener_queue: d.callback(\"foo\") async def await_something_interesting(): new_awaitable = defer.Deferred() listener_queue.append(new_awaitable) with PreserveLoggingContext(): await new_awaitable Obviously, the idea here is that we have a bunch of things which are waiting for an event. (It's just an example of the problem here, but a relatively common one.) Now let's imagine two further things happen. First of all, whatever was waiting for the interesting thing goes away. (Perhaps the request times out, or something even more interesting happens.) Secondly, let's suppose that we decide that the interesting thing is never going to happen, and we reset the listener queue: def reset_listener_queue(): listener_queue.clear() So, both ends of the awaitable chain have now dropped their references, and the awaitable chain is now orphaned, and will be garbage-collected at some point. Note that await_something_interesting is a coroutine, which Python implements as a generator function. When Python garbage-collects generator functions, it gives them a chance to clean up by making the await (or yield) raise a GeneratorExit exception. In our case, that means that the __exit__ handler of PreserveLoggingContext will carefully restore the request context, but there is now nothing waiting for its return, so the request context is never cleared. To reiterate, this problem only arises when both ends of a awaitable chain are dropped. Dropping the the reference to an awaitable you're supposed to be awaiting is bad practice, so this doesn't actually happen too much. Unfortunately, when it does happen, it will lead to leaked logcontexts which are incredibly hard to track down.","breadcrumbs":"Synapse Architecture » Log Contexts » A note on garbage-collection of awaitable chains","id":"935","title":"A note on garbage-collection of awaitable chains"},"936":{"body":"","breadcrumbs":"Synapse Architecture » Replication » Replication Architecture","id":"936","title":"Replication Architecture"},"937":{"body":"We'd like to be able to split some of the work that synapse does into multiple python processes. In theory multiple synapse processes could share a single postgresql database and we'd scale up by running more synapse processes. However much of synapse assumes that only one process is interacting with the database, both for assigning unique identifiers when inserting into tables, notifying components about new updates, and for invalidating its caches. So running multiple copies of the current code isn't an option. One way to run multiple processes would be to have a single writer process and multiple reader processes connected to the same database. In order to do this we'd need a way for the reader process to invalidate its in-memory caches when an update happens on the writer. One way to do this is for the writer to present an append-only log of updates which the readers can consume to invalidate their caches and to push updates to listening clients or pushers. Synapse already stores much of its data as an append-only log so that it can correctly respond to /sync requests so the amount of code changes needed to expose the append-only log to the readers should be fairly minimal.","breadcrumbs":"Synapse Architecture » Replication » Motivation","id":"937","title":"Motivation"},"938":{"body":"","breadcrumbs":"Synapse Architecture » Replication » Architecture","id":"938","title":"Architecture"},"939":{"body":"See the TCP replication documentation .","breadcrumbs":"Synapse Architecture » Replication » The Replication Protocol","id":"939","title":"The Replication Protocol"},"94":{"body":"When joining a room for the first time, Synapse 1.76.0 will request a partial join from the other server by default. Previously, server admins had to opt-in to this using an experimental config flag. Server admins can opt out of this feature for the time being by setting experimental: faster_joins: false in their server config.","breadcrumbs":"Upgrading between Synapse Versions » Faster joins are enabled by default","id":"94","title":"Faster joins are enabled by default"},"940":{"body":"Information about how the tcp replication module is structured, including how the classes interact, can be found in synapse/replication/tcp/__init__.py","breadcrumbs":"Synapse Architecture » Replication » The TCP Replication Module","id":"940","title":"The TCP Replication Module"},"941":{"body":"Synapse has a concept of \"streams\", which are roughly described in id_generators.py . Generally speaking, streams are a series of notifications that something in Synapse's database has changed that the application might need to respond to. For example: The events stream reports new events (PDUs) that Synapse creates, or that Synapse accepts from another homeserver. The account data stream reports changes to users' account data . The to-device stream reports when a device has a new to-device message . See synapse.replication.tcp.streams for the full list of streams. It is very helpful to understand the streams mechanism when working on any part of Synapse that needs to respond to changes—especially if those changes are made by different workers. To that end, let's describe streams formally, paraphrasing from the docstring of AbstractStreamIdGenerator .","breadcrumbs":"Synapse Architecture » Streams » Streams","id":"941","title":"Streams"},"942":{"body":"A stream is an append-only log T1, T2, ..., Tn, ... of facts [1] which grows over time. Only \"writers\" can add facts to a stream, and there may be multiple writers. Each fact has an ID, called its \"stream ID\". Readers should only process facts in ascending stream ID order. Roughly speaking, each stream is backed by a database table. It should have a stream_id (or similar) bigint column holding stream IDs, plus additional columns as necessary to describe the fact. Typically, a fact is expressed with a single row in its backing table. [2] Within a stream, no two facts may have the same stream_id. Aside . Some additional notes on streams' backing tables. Rich would like to ditch the backing tables . The backing tables may have other uses. > For example, the events table serves backs the events stream, and is read when processing new events. > But old rows are read from the table all the time, whenever Synapse needs to lookup some facts about an event. Rich suspects that sometimes the stream is backed by multiple tables, so the stream proper is the union of those tables. Stream writers can \"reserve\" a stream ID, and then later mark it as having being completed. Stream writers need to track the completion of each stream fact. In the happy case, completion means a fact has been written to the stream table. But unhappy cases (e.g. transaction rollback due to an error) also count as completion. Once completed, the rows written with that stream ID are fixed, and no new rows will be inserted with that ID.","breadcrumbs":"Synapse Architecture » Streams » Definition","id":"942","title":"Definition"},"943":{"body":"For any given stream reader (including writers themselves), we may define a per-writer current stream ID: A current stream ID for a writer W is the largest stream ID such that all transactions added by W with equal or smaller ID have completed. Similarly, there is a \"linear\" notion of current stream ID: A \"linear\" current stream ID is the largest stream ID such that all facts (added by any writer) with equal or smaller ID have completed. Because different stream readers A and B learn about new facts at different times, A and B may disagree about current stream IDs. Put differently: we should think of stream readers as being independent of each other, proceeding through a stream of facts at different rates. The above definition does not give a unique current stream ID, in fact there can be a range of current stream IDs. Synapse uses both the minimum and maximum IDs for different purposes. Most often the maximum is used, as its generally beneficial for workers to advance their IDs as soon as possible. However, the minimum is used in situations where e.g. another worker is going to wait until the stream advances past a position. NB. For both senses of \"current\", that if a writer opens a transaction that never completes, the current stream ID will never advance beyond that writer's last written stream ID. For single-writer streams, the per-writer current ID and the linear current ID are the same. Both senses of current ID are monotonic, but they may \"skip\" or jump over IDs because facts complete out of order. Example . Consider a single-writer stream which is initially at ID 1. Action Current stream ID Notes 1 Reserve 2 1 Reserve 3 1 Complete 3 1 current ID unchanged, waiting for 2 to complete Complete 2 3 current ID jumps from 1 -> 3 Reserve 4 3 Reserve 5 3 Reserve 6 3 Complete 5 3 Complete 4 5 current ID jumps 3->5, even though 6 is pending Complete 6 6","breadcrumbs":"Synapse Architecture » Streams » Current stream ID","id":"943","title":"Current stream ID"},"944":{"body":"There are two ways to view a multi-writer stream. Treat it as a collection of distinct single-writer streams, one for each writer. Treat it as a single stream. The single stream (option 2) is conceptually simpler, and easier to represent (a single stream id). However, it requires each reader to know about the entire set of writers, to ensures that readers don't erroneously advance their current stream position too early and miss a fact from an unknown writer. In contrast, multiple parallel streams (option 1) are more complex, requiring more state to represent (map from writer to stream id). The payoff for doing so is that readers can \"peek\" ahead to facts that completed on one writer no matter the state of the others, reducing latency. Note that a multi-writer stream can be viewed in both ways. For example, the events stream is treated as multiple single-writer streams (option 1) by the sync handler, so that events are sent to clients as soon as possible. But the background process that works through events treats them as a single linear stream. Another useful example is the cache invalidation stream. The facts this stream holds are instructions to \"you should now invalidate these cache entries\". We only ever treat this as a multiple single-writer streams as there is no important ordering between cache invalidations. (Invalidations are self-contained facts; and the invalidations commute/are idempotent).","breadcrumbs":"Synapse Architecture » Streams » Multi-writer streams","id":"944","title":"Multi-writer streams"},"945":{"body":"Writers need to track: track their current position (i.e. its own per-writer stream ID). their facts currently awaiting completion. At startup, the current position of that writer can be found by querying the database (which suggests that facts need to be written to the database atomically, in a transaction); and there are no facts awaiting completion. To reserve a stream ID, call nextval on the appropriate postgres sequence. To write a fact to the stream: insert the appropriate rows to the appropriate backing table. To complete a fact, first remove it from your map of facts currently awaiting completion. Then, if no earlier fact is awaiting completion, the writer can advance its current position in that stream. Upon doing so it should emit an RDATA message [3] , once for every fact between the old and the new stream ID.","breadcrumbs":"Synapse Architecture » Streams » Writing to streams","id":"945","title":"Writing to streams"},"946":{"body":"Readers need to track the current position of every writer. At startup, they can find this by contacting each writer with a REPLICATE message, requesting that all writers reply describing their current position in their streams. Writers reply with a POSITION message. To learn about new facts, readers should listen for RDATA messages and process them to respond to the new fact. The RDATA itself is not a self-contained representation of the fact; readers will have to query the stream tables for the full details. Readers must also advance their record of the writer's current position for that stream.","breadcrumbs":"Synapse Architecture » Streams » Subscribing to streams","id":"946","title":"Subscribing to streams"},"947":{"body":"In a nutshell: we have an append-only log with a \"buffer/scratchpad\" at the end where we have to wait for the sequence to be linear and contiguous. we use the word fact here for two reasons. Firstly, the word \"event\" is already heavily overloaded (PDUs, EDUs, account data, ...) and we don't need to make that worse. Secondly, \"fact\" emphasises that the things we append to a stream cannot change after the fact. A fact might be expressed with 0 rows, e.g. if we opened a transaction to persist an event, but failed and rolled the transaction back before marking the fact as completed. In principle a fact might be expressed with 2 or more rows; if so, each of those rows should share the fact's stream ID. This communication used to happen directly with the writers over TCP ; nowadays it's done via Redis's Pubsub.","breadcrumbs":"Synapse Architecture » Streams » Summary","id":"947","title":"Summary"},"948":{"body":"","breadcrumbs":"Synapse Architecture » TCP Replication » TCP Replication","id":"948","title":"TCP Replication"},"949":{"body":"Previously the workers used an HTTP long poll mechanism to get updates from the master, which had the problem of causing a lot of duplicate work on the server. This TCP protocol replaces those APIs with the aim of increased efficiency.","breadcrumbs":"Synapse Architecture » TCP Replication » Motivation","id":"949","title":"Motivation"},"95":{"body":"Synapse has changed the format of the account data and devices replication streams (between workers). This is a forwards- and backwards-incompatible change: v1.75 workers cannot process account data replicated by v1.76 workers, and vice versa. Once all workers are upgraded to v1.76 (or downgraded to v1.75), account data and device replication will resume as normal.","breadcrumbs":"Upgrading between Synapse Versions » Changes to the account data replication streams","id":"95","title":"Changes to the account data replication streams"},"950":{"body":"The protocol is based on fire and forget, line based commands. An example flow would be (where '>' indicates master to worker and '<' worker to master flows): > SERVER example.com\n< REPLICATE\n> POSITION events master 53 53\n> RDATA events master 54 [\"$foo1:bar.com\", ...]\n> RDATA events master 55 [\"$foo4:bar.com\", ...] The example shows the server accepting a new connection and sending its identity with the SERVER command, followed by the client server to respond with the position of all streams. The server then periodically sends RDATA commands which have the format RDATA , where the format of is defined by the individual streams. The is the name of the Synapse process that generated the data (usually \"master\"). We expect an RDATA for every row in the DB. Error reporting happens by either the client or server sending an ERROR command, and usually the connection will be closed. Since the protocol is a simple line based, its possible to manually connect to the server using a tool like netcat. A few things should be noted when manually using the protocol: The federation stream is only available if federation sending has been disabled on the main process. The server will only time connections out that have sent a PING command. If a ping is sent then the connection will be closed if no further commands are received within 15s. Both the client and server protocol implementations will send an initial PING on connection and ensure at least one command every 5s is sent (not necessarily PING). RDATA commands usually include a numeric token, however if the stream has multiple rows to replicate per token the server will send multiple RDATA commands, with all but the last having a token of batch. See the documentation on commands.RdataCommand for further details.","breadcrumbs":"Synapse Architecture » TCP Replication » Overview","id":"950","title":"Overview"},"951":{"body":"The basic structure of the protocol is line based, where the initial word of each line specifies the command. The rest of the line is parsed based on the command. For example, the RDATA command is defined as: RDATA (Note that