diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2021-02-22 11:44:31 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-22 11:44:31 +0000 |
| commit | e22b71810ee60a24af39f95f35967e2156adc829 (patch) | |
| tree | 1f20de9c0f637cd57c6df221ccc789dd65250bed /docs | |
| parent | Ratelimit cross-user key sharing requests. (#8957) (diff) | |
| download | synapse-e22b71810ee60a24af39f95f35967e2156adc829.tar.xz | |
Clean up the user directory sample config section (#9385)
The user directory sample config section was a little messy, and didn't adhere to our [recommended config format guidelines](https://github.com/matrix-org/synapse/blob/develop/docs/code_style.md#configuration-file-format). This PR cleans that up a bit.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sample_config.yaml | 47 |
1 files changed, 29 insertions, 18 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index c660c62620..4dbef41b7e 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -2544,24 +2544,35 @@ spam_checker: # User Directory configuration # -# '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, rather than limiting to users visible -# in public rooms. Defaults to false. If you set it True, you'll have to -# rebuild the user_directory search indexes, see -# https://github.com/matrix-org/synapse/blob/master/docs/user_directory.md -# -# 'prefer_local_users' defines whether to prioritise local users in -# search query results. If True, local users are more likely to appear above -# remote users when searching the user directory. Defaults to false. -# -#user_directory: -# enabled: true -# search_all_users: false -# prefer_local_users: false +user_directory: + # Defines whether users can search the user directory. If false then + # empty responses are returned to all queries. Defaults to true. + # + # Uncomment to disable the user directory. + # + #enabled: false + + # Defines whether to search all users visible to your HS when searching + # the user directory, rather than limiting to users visible in public + # rooms. Defaults to false. + # + # If you set it true, you'll have to rebuild the user_directory search + # indexes, see: + # https://github.com/matrix-org/synapse/blob/master/docs/user_directory.md + # + # Uncomment to return search results containing all known users, even if that + # user does not share a room with the requester. + # + #search_all_users: true + + # Defines whether to prefer local users in search query results. + # If True, local users are more likely to appear above remote users + # when searching the user directory. Defaults to false. + # + # Uncomment to prefer local over remote users in user directory search + # results. + # + #prefer_local_users: true # User Consent configuration |