From 9b509a5ac6c6c7186ba54a321c3afba586281666 Mon Sep 17 00:00:00 2001 From: reivilibre Date: Tue, 4 Jul 2023 16:40:11 +0000 Subject: [PATCH] deploy: 1294d10c704a891392caf8c358fa8e00b1492874 --- latest/admin_api/rooms.html | 2 +- .../synapse_architecture/faster_joins.html | 2 +- latest/modules/spam_checker_callbacks.html | 27 +++++++++ latest/print.html | 57 +++++++++++++++++-- latest/searchindex.js | 2 +- latest/searchindex.json | 2 +- .../configuration/config_documentation.html | 23 ++++++++ latest/workers.html | 1 - 8 files changed, 107 insertions(+), 9 deletions(-) diff --git a/latest/admin_api/rooms.html b/latest/admin_api/rooms.html index b4583c8936..0e06e4f4cc 100644 --- a/latest/admin_api/rooms.html +++ b/latest/admin_api/rooms.html @@ -523,7 +523,7 @@ for a server admin: see Admin API
  • 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 spot returning events at.
    • +
  • 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 diff --git a/latest/development/synapse_architecture/faster_joins.html b/latest/development/synapse_architecture/faster_joins.html index 925ba53fe7..1c77bbc91f 100644 --- a/latest/development/synapse_architecture/faster_joins.html +++ b/latest/development/synapse_architecture/faster_joins.html @@ -153,7 +153,7 @@
  • record the rationale behind our choices.

    • See also MSC3902.

    -

    The key idea is described by MSC706. This allows servers to +

    The key idea is described by MSC3706. This allows servers to request a lightweight response to the federation /send_join endpoint. This is called a faster join, also known as a partial join. In these notes we'll usually use the word "partial" as it matches the database schema.

    diff --git a/latest/modules/spam_checker_callbacks.html b/latest/modules/spam_checker_callbacks.html index 7f816cf92c..3522dc4334 100644 --- a/latest/modules/spam_checker_callbacks.html +++ b/latest/modules/spam_checker_callbacks.html @@ -452,6 +452,33 @@ doing.

    callback returns False, Synapse falls through to the next one. The value of the first callback that does not return False will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.

    +

    check_login_for_spam

    +

    First introduced in Synapse v1.87.0

    +
    async def check_login_for_spam(
+    user_id: str,
+    device_id: Optional[str],
+    initial_display_name: Optional[str],
+    request_info: Collection[Tuple[Optional[str], str]],
+    auth_provider_id: Optional[str] = None,
+) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes"]
+
    +

    Called when a user logs in.

    +

    The arguments passed to this callback are:

    + +

    If multiple modules implement this callback, they will be considered in order. If a +callback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one. +The value of the first callback that does not return synapse.module_api.NOT_SPAM will +be used. If this happens, Synapse will not call any of the subsequent implementations of +this callback.

    +

    Note: This will not be called when a user registers.

    Example

    The example below is a module that implements the spam checker callback check_event_for_spam to deny any message sent by users whose Matrix user IDs are diff --git a/latest/print.html b/latest/print.html index 6e1e9d1859..300c12be4b 100644 --- a/latest/print.html +++ b/latest/print.html @@ -4663,6 +4663,29 @@ on this homeserver.

    allow_device_name_lookup_over_federation: true
    +

    federation

    +

    The federation section defines some sub-options related to federation.

    +

    The following options are related to configuring timeout and retry logic for one request, +independently of the others. +Short retry algorithm is used when something or someone will wait for the request to have an +answer, while long retry is used for requests that happen in the background, +like sending a federation transaction.

    + +

    Example configuration:

    +
    federation:
+  client_timeout: 180s
+  max_short_retry_delay: 7s
+  max_long_retry_delay: 100s
+  max_short_retries: 5
+  max_long_retries: 20
+
    +

    Caching

    Options related to caching.

    @@ -9926,6 +9949,33 @@ doing.

    callback returns False, Synapse falls through to the next one. The value of the first callback that does not return False will be used. If this happens, Synapse will not call any of the subsequent implementations of this callback.

    +

    check_login_for_spam

    +

    First introduced in Synapse v1.87.0

    +
    async def check_login_for_spam(
+    user_id: str,
+    device_id: Optional[str],
+    initial_display_name: Optional[str],
+    request_info: Collection[Tuple[Optional[str], str]],
+    auth_provider_id: Optional[str] = None,
+) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes"]
+
    +

    Called when a user logs in.

    +

    The arguments passed to this callback are:

    + +

    If multiple modules implement this callback, they will be considered in order. If a +callback returns synapse.module_api.NOT_SPAM, Synapse falls through to the next one. +The value of the first callback that does not return synapse.module_api.NOT_SPAM will +be used. If this happens, Synapse will not call any of the subsequent implementations of +this callback.

    +

    Note: This will not be called when a user registers.

    Example

    The example below is a module that implements the spam checker callback check_event_for_spam to deny any message sent by users whose Matrix user IDs are @@ -10926,7 +10976,6 @@ information.

    ^/_matrix/client/v1/rooms/.*/hierarchy$ ^/_matrix/client/(v1|unstable)/rooms/.*/relations/ ^/_matrix/client/v1/rooms/.*/threads$ -^/_matrix/client/unstable/org.matrix.msc2716/rooms/.*/batch_send$ ^/_matrix/client/unstable/im.nheko.summary/rooms/.*/summary$ ^/_matrix/client/(r0|v3|unstable)/account/3pid$ ^/_matrix/client/(r0|v3|unstable)/account/whoami$ @@ -12889,7 +12938,7 @@ for a server admin: see A