From 51a8c6b121e2e639a0d818ff36e5bb82c98bd89b Mon Sep 17 00:00:00 2001 From: reivilibre Date: Tue, 28 May 2024 12:35:50 +0000 Subject: deploy: f35bc08d3933416d2c7a0c566f895214e9ffd88e --- .../usage/configuration/config_documentation.html | 36 ++++++++++++++++++++++ 1 file changed, 36 insertions(+) (limited to 'latest/usage/configuration/config_documentation.html') diff --git a/latest/usage/configuration/config_documentation.html b/latest/usage/configuration/config_documentation.html index 4ccbdda5f2..6ef0c401fb 100644 --- a/latest/usage/configuration/config_documentation.html +++ b/latest/usage/configuration/config_documentation.html @@ -1207,6 +1207,23 @@ the same whitelist.

- syd.example.com
+

federation_whitelist_endpoint_enabled

+

Enables an endpoint for fetching the federation whitelist config.

+

The request method and path is GET /_synapse/client/v1/config/federation_whitelist, and the +response format is:

+
{
+    "whitelist_enabled": true,  // Whether the federation whitelist is being enforced
+    "whitelist": [  // Which server names are allowed by the whitelist
+        "example.com"
+    ]
+}
+
+

If whitelist_enabled is false then the server is permitted to federate with all others.

+

The endpoint requires authentication.

+

Example configuration:

+
federation_whitelist_endpoint_enabled: true
+
+

federation_metrics_domains

Report prometheus metrics on the age of PDUs being sent to and received from the given domains. This can be used to give an idea of "delay" on inbound @@ -2314,6 +2331,10 @@ federated servers if autocreate_auto_join_rooms_federated is true (

  • "trusted_private_chat": an invitation is required to join this room and the invitee is assigned a power level of 100 upon joining the room.
    • +

    Each preset will set up a room in the same manner as if it were provided as the preset parameter when +calling the +POST /_matrix/client/v3/createRoom +Client-Server API endpoint.

    If a value of "private_chat" or "trusted_private_chat" is used then auto_join_mxid_localpart must also be configured.

    Defaults to "public_chat".

    @@ -3182,6 +3203,19 @@ All of the listed attributes must match for the login to be permitted.

    users. This allows the CAS SSO flow to be limited to sign in only, rather than automatically registering users that have a valid SSO login but do not have a pre-registered account. Defaults to true.

    + +
  • +

    allow_numeric_ids: set to 'true' allow numeric user IDs (default false). +This allows CAS SSO flow to provide user IDs composed of numbers only. +These identifiers will be prefixed by the letter "u" by default. +The prefix can be configured using the "numeric_ids_prefix" option. +Be careful to choose the prefix correctly to avoid any possible conflicts +(e.g. user 1234 becomes u1234 when a user u1234 already exists).

    +
    • +
  • +

    numeric_ids_prefix: the prefix you wish to add in front of a numeric user ID +when the "allow_numeric_ids" option is set to "true". +By default, the prefix is the letter "u" and only alphanumeric characters are allowed.

    Added in Synapse 1.93.0.

    • @@ -3195,6 +3229,8 @@ a pre-registered account. Defaults to true.

    userGroup: "staff" department: None enable_registration: true + allow_numeric_ids: true + numeric_ids_prefix: "numericuser"

    sso

    -- cgit 1.5.1