diff options
author | DMRobertson <DMRobertson@users.noreply.github.com> | 2021-11-17 15:30:55 +0000 |
---|---|---|
committer | DMRobertson <DMRobertson@users.noreply.github.com> | 2021-11-17 15:30:55 +0000 |
commit | 3182b1d3517d7b5184415333d50e71c87e47f901 (patch) | |
tree | 72c426de54448d30b49a48e2bdd5965191abae4d /develop/workers.html | |
parent | deploy: b76337fdf825282b7c75ebc38e9a64f0b00f7cf0 (diff) | |
download | synapse-3182b1d3517d7b5184415333d50e71c87e47f901.tar.xz |
deploy: d993c3bb1e89f77d91af6302bfb118494c6f6664
Diffstat (limited to '')
-rw-r--r-- | develop/workers.html | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/develop/workers.html b/develop/workers.html index 52e8e177a0..eb6a4e161a 100644 --- a/develop/workers.html +++ b/develop/workers.html @@ -319,10 +319,10 @@ recommend the use of <code>systemd</code> where available: for information on se <p>This worker can handle API requests matching the following regular expressions:</p> <pre><code># Sync requests -^/_matrix/client/(v2_alpha|r0)/sync$ -^/_matrix/client/(api/v1|v2_alpha|r0)/events$ -^/_matrix/client/(api/v1|r0)/initialSync$ -^/_matrix/client/(api/v1|r0)/rooms/[^/]+/initialSync$ +^/_matrix/client/(v2_alpha|r0|v3)/sync$ +^/_matrix/client/(api/v1|v2_alpha|r0|v3)/events$ +^/_matrix/client/(api/v1|r0|v3)/initialSync$ +^/_matrix/client/(api/v1|r0|v3)/rooms/[^/]+/initialSync$ # Federation requests ^/_matrix/federation/v1/event/ @@ -353,40 +353,40 @@ expressions:</p> ^/_matrix/federation/v1/send/ # Client API requests -^/_matrix/client/(api/v1|r0|unstable)/createRoom$ -^/_matrix/client/(api/v1|r0|unstable)/publicRooms$ -^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/joined_members$ -^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/context/.*$ -^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/members$ -^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/state$ +^/_matrix/client/(api/v1|r0|v3|unstable)/createRoom$ +^/_matrix/client/(api/v1|r0|v3|unstable)/publicRooms$ +^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/joined_members$ +^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/context/.*$ +^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/members$ +^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/state$ ^/_matrix/client/unstable/org.matrix.msc2946/rooms/.*/spaces$ ^/_matrix/client/unstable/org.matrix.msc2946/rooms/.*/hierarchy$ ^/_matrix/client/unstable/im.nheko.summary/rooms/.*/summary$ -^/_matrix/client/(api/v1|r0|unstable)/account/3pid$ -^/_matrix/client/(api/v1|r0|unstable)/devices$ -^/_matrix/client/(api/v1|r0|unstable)/keys/query$ -^/_matrix/client/(api/v1|r0|unstable)/keys/changes$ +^/_matrix/client/(api/v1|r0|v3|unstable)/account/3pid$ +^/_matrix/client/(api/v1|r0|v3|unstable)/devices$ +^/_matrix/client/(api/v1|r0|v3|unstable)/keys/query$ +^/_matrix/client/(api/v1|r0|v3|unstable)/keys/changes$ ^/_matrix/client/versions$ -^/_matrix/client/(api/v1|r0|unstable)/voip/turnServer$ -^/_matrix/client/(api/v1|r0|unstable)/joined_groups$ -^/_matrix/client/(api/v1|r0|unstable)/publicised_groups$ -^/_matrix/client/(api/v1|r0|unstable)/publicised_groups/ -^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/event/ -^/_matrix/client/(api/v1|r0|unstable)/joined_rooms$ -^/_matrix/client/(api/v1|r0|unstable)/search$ +^/_matrix/client/(api/v1|r0|v3|unstable)/voip/turnServer$ +^/_matrix/client/(api/v1|r0|v3|unstable)/joined_groups$ +^/_matrix/client/(api/v1|r0|v3|unstable)/publicised_groups$ +^/_matrix/client/(api/v1|r0|v3|unstable)/publicised_groups/ +^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/event/ +^/_matrix/client/(api/v1|r0|v3|unstable)/joined_rooms$ +^/_matrix/client/(api/v1|r0|v3|unstable)/search$ # Registration/login requests -^/_matrix/client/(api/v1|r0|unstable)/login$ -^/_matrix/client/(r0|unstable)/register$ +^/_matrix/client/(api/v1|r0|v3|unstable)/login$ +^/_matrix/client/(r0|v3|unstable)/register$ ^/_matrix/client/unstable/org.matrix.msc3231/register/org.matrix.msc3231.login.registration_token/validity$ # Event sending requests -^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/redact -^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/send -^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/state/ -^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/(join|invite|leave|ban|unban|kick)$ -^/_matrix/client/(api/v1|r0|unstable)/join/ -^/_matrix/client/(api/v1|r0|unstable)/profile/ +^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/redact +^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/send +^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/state/ +^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/(join|invite|leave|ban|unban|kick)$ +^/_matrix/client/(api/v1|r0|v3|unstable)/join/ +^/_matrix/client/(api/v1|r0|v3|unstable)/profile/ </code></pre> <p>Additionally, the following REST endpoints can be handled for GET requests:</p> <pre><code>^/_matrix/federation/v1/groups/ @@ -395,13 +395,13 @@ expressions:</p> room must be routed to the same instance. Additionally, care must be taken to ensure that the purge history admin API is not used while pagination requests for the room are in flight:</p> -<pre><code>^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/messages$ +<pre><code>^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/messages$ </code></pre> <p>Additionally, the following endpoints should be included if Synapse is configured to use SSO (you only need to include the ones for whichever SSO provider you're using):</p> <pre><code># for all SSO providers -^/_matrix/client/(api/v1|r0|unstable)/login/sso/redirect +^/_matrix/client/(api/v1|r0|v3|unstable)/login/sso/redirect ^/_synapse/client/pick_idp$ ^/_synapse/client/pick_username ^/_synapse/client/new_user_consent$ @@ -414,7 +414,7 @@ using):</p> ^/_synapse/client/saml2/authn_response$ # CAS requests. -^/_matrix/client/(api/v1|r0|unstable)/login/cas/ticket$ +^/_matrix/client/(api/v1|r0|v3|unstable)/login/cas/ticket$ </code></pre> <p>Ensure that all SSO logins go to a single process. For multiple workers not handling the SSO endpoints properly, see @@ -546,7 +546,7 @@ and you must configure a single instance to run the background tasks, e.g.:</p> <h3 id="synapseappuser_dir"><a class="header" href="#synapseappuser_dir"><code>synapse.app.user_dir</code></a></h3> <p>Handles searches in the user directory. It can handle REST endpoints matching the following regular expressions:</p> -<pre><code>^/_matrix/client/(api/v1|r0|unstable)/user_directory/search$ +<pre><code>^/_matrix/client/(api/v1|r0|v3|unstable)/user_directory/search$ </code></pre> <p>When using this worker you must also set <code>update_user_directory: False</code> in the shared configuration file to stop the main synapse running background @@ -555,11 +555,11 @@ jobs related to updating the user directory.</p> <p>Proxies some frequently-requested client endpoints to add caching and remove load from the main synapse. It can handle REST endpoints matching the following regular expressions:</p> -<pre><code>^/_matrix/client/(api/v1|r0|unstable)/keys/upload +<pre><code>^/_matrix/client/(api/v1|r0|v3|unstable)/keys/upload </code></pre> <p>If <code>use_presence</code> is False in the homeserver config, it can also handle REST endpoints matching the following regular expressions:</p> -<pre><code>^/_matrix/client/(api/v1|r0|unstable)/presence/[^/]+/status +<pre><code>^/_matrix/client/(api/v1|r0|v3|unstable)/presence/[^/]+/status </code></pre> <p>This "stub" presence handler will pass through <code>GET</code> request but make the <code>PUT</code> effectively a no-op.</p> |