diff options
author | anoadragon453 <anoadragon453@users.noreply.github.com> | 2022-10-04 09:04:16 +0000 |
---|---|---|
committer | anoadragon453 <anoadragon453@users.noreply.github.com> | 2022-10-04 09:04:16 +0000 |
commit | aa8ce525fa4a944d2564eedd7533bd4bbcc47c86 (patch) | |
tree | b067d7b78025f4553a7029073d47c4a3455155d2 /develop/usage | |
parent | deploy: b381701f8c07444fb86d80a79f561c8468a6c0b7 (diff) | |
download | synapse-aa8ce525fa4a944d2564eedd7533bd4bbcc47c86.tar.xz |
deploy: 1613857b90663aad042de39632f6db90b6f7f6f7
Diffstat (limited to 'develop/usage')
-rw-r--r-- | develop/usage/configuration/config_documentation.html | 36 |
1 files changed, 21 insertions, 15 deletions
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.</p> option configures Synapse to serve a file at <code>https://<server_name>/.well-known/matrix/server</code>. This will tell other servers to send traffic to port 443 instead.</p> <p>This option currently defaults to false.</p> -<p>See https://matrix-org.github.io/synapse/latest/delegate.html for more +<p>See <a href="../../delegate.html">Delegation of incoming federation traffic</a> for more information.</p> <p>Example configuration:</p> <pre><code class="language-yaml">serve_server_wellknown: true @@ -2615,7 +2615,7 @@ sub-properties:</p> <li> <p><code>module</code>: The class name of a custom mapping module. Default is <code>synapse.handlers.oidc.JinjaOidcMappingProvider</code>. -See https://matrix-org.github.io/synapse/latest/sso_mapping_providers.html#openid-mapping-providers +See <a href="../../sso_mapping_providers.html#openid-mapping-providers">OpenID Mapping Providers</a> for information on implementing a custom mapping provider.</p> </li> <li> @@ -3052,23 +3052,29 @@ will also not affect rooms created by other servers.</p> <p>This setting defines options related to the user directory.</p> <p>This option has the following sub-options:</p> <ul> -<li><code>enabled</code>: Defines whether users can search the user directory. If false then -empty responses are returned to all queries. Defaults to true.</li> -<li><code>search_all_users</code>: Defines whether to search all users visible to your HS when searching +<li> +<p><code>enabled</code>: Defines whether users can search the user directory. If false then +empty responses are returned to all queries. Defaults to true.</p> +</li> +<li> +<p><code>search_all_users</code>: 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.</p> +<p>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.</li> -<li><code>prefer_local_users</code>: Defines whether to prefer local users in search query results. +rebuild the indexes in order to search through all known users.</p> +<p>These indexes are built the first time Synapse starts; admins can +manually trigger a rebuild via the API following the instructions +<a href="../administration/admin_api/background_updates.html#run">for running background updates</a>, +set to true to return search results containing all known users, even if that +user does not share a room with the requester.</p> +</li> +<li> +<p><code>prefer_local_users</code>: 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.</li> +user directory. Defaults to false.</p> +</li> </ul> <p>Example configuration:</p> <pre><code class="language-yaml">user_directory: |