diff options
author | babolivier <babolivier@users.noreply.github.com> | 2022-02-08 13:26:46 +0000 |
---|---|---|
committer | babolivier <babolivier@users.noreply.github.com> | 2022-02-08 13:26:46 +0000 |
commit | 9061d49ebbefffeee2de5178461086224f178a24 (patch) | |
tree | b20ba4051e5894c6bca4d513d0d8ace864bf8b8b /latest/usage | |
parent | deploy: 1aa2231e271f1b0b08757fc6f94c7c69c2993b25 (diff) | |
download | synapse-9061d49ebbefffeee2de5178461086224f178a24.tar.xz |
deploy: 0b561a0ea1384db214c274f45b160c538d2ab65d
Diffstat (limited to 'latest/usage')
-rw-r--r-- | latest/usage/administration/admin_api/federation.html | 81 | ||||
-rw-r--r-- | latest/usage/configuration/homeserver_sample_config.html | 34 |
2 files changed, 109 insertions, 6 deletions
diff --git a/latest/usage/administration/admin_api/federation.html b/latest/usage/administration/admin_api/federation.html index 7e40251d64..db48793600 100644 --- a/latest/usage/administration/admin_api/federation.html +++ b/latest/usage/administration/admin_api/federation.html @@ -258,7 +258,7 @@ to this destination, or <code>null</code> if this information has not been track <li><code>next_token</code>: string representing a positive integer - Indication for pagination. See above.</li> <li><code>total</code> - integer - Total number of destinations.</li> </ul> -<h1 id="destination-details-api"><a class="header" href="#destination-details-api">Destination Details API</a></h1> +<h2 id="destination-details-api"><a class="header" href="#destination-details-api">Destination Details API</a></h2> <p>This API gets the retry timing info for a specific remote server.</p> <p>The API is:</p> <pre><code>GET /_synapse/admin/v1/federation/destinations/<destination> @@ -272,9 +272,88 @@ to this destination, or <code>null</code> if this information has not been track "last_successful_stream_ordering": null } </code></pre> +<p><strong>Parameters</strong></p> +<p>The following parameters should be set in the URL:</p> +<ul> +<li><code>destination</code> - Name of the remote server.</li> +</ul> <p><strong>Response</strong></p> <p>The response fields are the same like in the <code>destinations</code> array in <a href="#list-of-destinations">List of destinations</a> response.</p> +<h2 id="destination-rooms"><a class="header" href="#destination-rooms">Destination rooms</a></h2> +<p>This API gets the rooms that federate with a specific remote server.</p> +<p>The API is:</p> +<pre><code>GET /_synapse/admin/v1/federation/destinations/<destination>/rooms +</code></pre> +<p>A response body like the following is returned:</p> +<pre><code class="language-json">{ + "rooms":[ + { + "room_id": "!OGEhHVWSdvArJzumhm:matrix.org", + "stream_ordering": 8326 + }, + { + "room_id": "!xYvNcQPhnkrdUmYczI:matrix.org", + "stream_ordering": 93534 + } + ], + "total": 2 +} +</code></pre> +<p>To paginate, check for <code>next_token</code> and if present, call the endpoint again +with <code>from</code> set to the value of <code>next_token</code>. This will return a new page.</p> +<p>If the endpoint does not return a <code>next_token</code> then there are no more destinations +to paginate through.</p> +<p><strong>Parameters</strong></p> +<p>The following parameters should be set in the URL:</p> +<ul> +<li><code>destination</code> - Name of the remote server.</li> +</ul> +<p>The following query parameters are available:</p> +<ul> +<li><code>from</code> - Offset in the returned list. Defaults to <code>0</code>.</li> +<li><code>limit</code> - Maximum amount of destinations to return. Defaults to <code>100</code>.</li> +<li><code>dir</code> - Direction of room order by <code>room_id</code>. Either <code>f</code> for forwards or <code>b</code> for +backwards. Defaults to <code>f</code>.</li> +</ul> +<p><strong>Response</strong></p> +<p>The following fields are returned in the JSON response body:</p> +<ul> +<li><code>rooms</code> - An array of objects, each containing information about a room. +Room objects contain the following fields: +<ul> +<li><code>room_id</code> - string - The ID of the room.</li> +<li><code>stream_ordering</code> - integer - The stream ordering of the most recent +successfully-sent <a href="understanding_synapse_through_grafana_graphs.html#federation">PDU</a> +to this destination in this room.</li> +</ul> +</li> +<li><code>next_token</code>: string representing a positive integer - Indication for pagination. See above.</li> +<li><code>total</code> - integer - Total number of destinations.</li> +</ul> +<h2 id="reset-connection-timeout"><a class="header" href="#reset-connection-timeout">Reset connection timeout</a></h2> +<p>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 +(<a href="https://en.wikipedia.org/wiki/Exponential_backoff">exponential backoff</a>).</p> +<p>Admins can cancel the cooldown period with this API.</p> +<p>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 <code>retry_interval</code>. +The connection must have previously run into an error and <code>retry_last_ts</code> +(<a href="#destination-details-api">Destination Details API</a>) must not be equal to <code>0</code>.</p> +<p>The connection attempt is carried out in the background and can take a while +even if the API already returns the http status 200.</p> +<p>The API is:</p> +<pre><code>POST /_synapse/admin/v1/federation/destinations/<destination>/reset_connection + +{} +</code></pre> +<p><strong>Parameters</strong></p> +<p>The following parameters should be set in the URL:</p> +<ul> +<li><code>destination</code> - Name of the remote server.</li> +</ul> </main> diff --git a/latest/usage/configuration/homeserver_sample_config.html b/latest/usage/configuration/homeserver_sample_config.html index 7ad314e896..089fd78826 100644 --- a/latest/usage/configuration/homeserver_sample_config.html +++ b/latest/usage/configuration/homeserver_sample_config.html @@ -233,11 +233,11 @@ a fresh config using Synapse by following the instructions in # documentation on how to configure or create custom modules for Synapse. # modules: - # - module: my_super_module.MySuperClass - # config: - # do_thing: true - # - module: my_other_super_module.SomeClass - # config: {} + #- module: my_super_module.MySuperClass + # config: + # do_thing: true + #- module: my_other_super_module.SomeClass + # config: {} ## Server ## @@ -663,6 +663,20 @@ limit_remote_rooms: # #allow_per_room_profiles: false +# The largest allowed file size for a user avatar. Defaults to no restriction. +# +# Note that user avatar changes will not work if this is set without +# using Synapse's media repository. +# +#max_avatar_size: 10M + +# The MIME types allowed for user avatars. Defaults to no restriction. +# +# Note that user avatar changes will not work if this is set without +# using Synapse's media repository. +# +#allowed_avatar_mimetypes: ["image/png", "image/jpeg", "image/gif"] + # How long to keep redacted events in unredacted form in the database. After # this period redacted events get replaced with their redacted form in the DB. # @@ -1620,6 +1634,16 @@ account_threepid_delegates: # #auto_join_rooms_for_guests: false +# Whether to inhibit errors raised when registering a new account if the user ID +# already exists. If turned on, that requests to /register/available will always +# show a user ID as available, and Synapse won't raise an error when starting +# a registration with a user ID that already exists. However, Synapse will still +# raise an error if the registration completes and the username conflicts. +# +# Defaults to false. +# +#inhibit_user_in_use_error: true + ## Metrics ### |