Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 1613857

Browse files
authored
Linkify config documentation. (#14003)
1 parent 70a4317 commit 1613857

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

changelog.d/14003.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Linkify urls in config documentation.

docs/usage/configuration/config_documentation.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ This will tell other servers to send traffic to port 443 instead.
179179

180180
This option currently defaults to false.
181181

182-
See https://matrix-org.github.io/synapse/latest/delegate.html for more
182+
See [Delegation of incoming federation traffic](../../delegate.md) for more
183183
information.
184184

185185
Example configuration:
@@ -2977,7 +2977,7 @@ Options for each entry include:
29772977

29782978
* `module`: The class name of a custom mapping module. Default is
29792979
`synapse.handlers.oidc.JinjaOidcMappingProvider`.
2980-
See https://matrix-org.github.io/synapse/latest/sso_mapping_providers.html#openid-mapping-providers
2980+
See [OpenID Mapping Providers](../../sso_mapping_providers.md#openid-mapping-providers)
29812981
for information on implementing a custom mapping provider.
29822982

29832983
* `config`: Configuration for the mapping provider module. This section will
@@ -3418,13 +3418,15 @@ This option has the following sub-options:
34183418
the user directory. If false, search results will only contain users
34193419
visible in public rooms and users sharing a room with the requester.
34203420
Defaults to false.
3421+
34213422
NB. If you set this to true, and the last time the user_directory search
34223423
indexes were (re)built was before Synapse 1.44, you'll have to
34233424
rebuild the indexes in order to search through all known users.
3425+
34243426
These indexes are built the first time Synapse starts; admins can
3425-
manually trigger a rebuild via API following the instructions at
3426-
https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/background_updates.html#run
3427-
Set to true to return search results containing all known users, even if that
3427+
manually trigger a rebuild via the API following the instructions
3428+
[for running background updates](../administration/admin_api/background_updates.md#run),
3429+
set to true to return search results containing all known users, even if that
34283430
user does not share a room with the requester.
34293431
* `prefer_local_users`: Defines whether to prefer local users in search query results.
34303432
If set to true, local users are more likely to appear above remote users when searching the

0 commit comments

Comments
 (0)