From aa8ce525fa4a944d2564eedd7533bd4bbcc47c86 Mon Sep 17 00:00:00 2001 From: anoadragon453 Date: Tue, 4 Oct 2022 09:04:16 +0000 Subject: deploy: 1613857b90663aad042de39632f6db90b6f7f6f7 --- .../usage/configuration/config_documentation.html | 36 +++++++++++++--------- 1 file changed, 21 insertions(+), 15 deletions(-) (limited to 'develop/usage') diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html index e94c848052..1e36efd593 100644 --- a/develop/usage/configuration/config_documentation.html +++ b/develop/usage/configuration/config_documentation.html @@ -288,7 +288,7 @@ be inconvenient in some environments.

option configures Synapse to serve a file at https://<server_name>/.well-known/matrix/server. This will tell other servers to send traffic to port 443 instead.

This option currently defaults to false.

-

See https://matrix-org.github.io/synapse/latest/delegate.html for more +

See Delegation of incoming federation traffic for more information.

Example configuration:

serve_server_wellknown: true
@@ -2615,7 +2615,7 @@ sub-properties:

  • module: The class name of a custom mapping module. Default is synapse.handlers.oidc.JinjaOidcMappingProvider. -See https://matrix-org.github.io/synapse/latest/sso_mapping_providers.html#openid-mapping-providers +See OpenID Mapping Providers for information on implementing a custom mapping provider.

  • @@ -3052,23 +3052,29 @@ will also not affect rooms created by other servers.

    This setting defines options related to the user directory.

    This option has the following sub-options:

      -
    • enabled: Defines whether users can search the user directory. If false then -empty responses are returned to all queries. Defaults to true.
    • -
    • search_all_users: Defines whether to search all users visible to your HS when searching +
    • +

      enabled: Defines whether users can search the user directory. If false then +empty responses are returned to all queries. Defaults to true.

      +
    • +
    • +

      search_all_users: Defines whether to search all users visible to your HS when searching the user directory. If false, search results will only contain users visible in public rooms and users sharing a room with the requester. -Defaults to false. -NB. If you set this to true, and the last time the user_directory search +Defaults to false.

      +

      NB. If you set this to true, and the last time the user_directory search indexes were (re)built was before Synapse 1.44, you'll have to -rebuild the indexes in order to search through all known users. -These indexes are built the first time Synapse starts; admins can -manually trigger a rebuild via API following the instructions at -https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/background_updates.html#run -Set to true to return search results containing all known users, even if that -user does not share a room with the requester.

    • -
    • prefer_local_users: Defines whether to prefer local users in search query results. +rebuild the indexes in order to search through all known users.

      +

      These indexes are built the first time Synapse starts; admins can +manually trigger a rebuild via the API following the instructions +for running background updates, +set to true to return search results containing all known users, even if that +user does not share a room with the requester.

      +
    • +
    • +

      prefer_local_users: Defines whether to prefer local users in search query results. If set to true, local users are more likely to appear above remote users when searching the -user directory. Defaults to false.

    • +user directory. Defaults to false.

      +

    Example configuration:

    user_directory:
    -- 
    cgit 1.5.1