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

Linkify config documentation. #14003

Merged
merged 7 commits into from
Oct 4, 2022
Merged

Linkify config documentation. #14003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
857382c
Linkify config documentation.
exitflynn Oct 1, 2022
c331436
Linkify URL's in config documentation.
exitflynn Oct 1, 2022
08dba24
Merge branch 'matrix-org:develop' into develop
exitflynn Oct 3, 2022
d9118c5
add relative links to md files
exitflynn Oct 3, 2022
4953c6e
Update docs/usage/configuration/config_documentation.md
exitflynn Oct 3, 2022
6bc745d
Add some newlines to the 'search_all_users' sub-option description
anoadragon453 Oct 4, 2022
8bcfb49
Update docs/usage/configuration/config_documentation.md
anoadragon453 Oct 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/14003.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Linkify urls in config documentation.
12 changes: 7 additions & 5 deletions docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ 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](../../delegate.md) for more
information.

Example configuration:
Expand Down Expand Up @@ -2977,7 +2977,7 @@ Options for each entry include:

* `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](../../sso_mapping_providers.md#openid-mapping-providers)
for information on implementing a custom mapping provider.

* `config`: Configuration for the mapping provider module. This section will
Expand Down Expand Up @@ -3418,13 +3418,15 @@ This option has the following sub-options:
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
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
manually trigger a rebuild via the API following the instructions
[for running background updates](../administration/admin_api/background_updates.md#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.
If set to true, local users are more likely to appear above remote users when searching the
Expand Down