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 /synapse | |
| 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 'synapse')
| -rw-r--r-- | synapse/config/user_directory.py | 69 |
1 files changed, 37 insertions, 32 deletions
diff --git a/synapse/config/user_directory.py b/synapse/config/user_directory.py index 89dbebd148..8d05ef173c 100644 --- a/synapse/config/user_directory.py +++ b/synapse/config/user_directory.py @@ -24,41 +24,46 @@ class UserDirectoryConfig(Config): section = "userdirectory" def read_config(self, config, **kwargs): - self.user_directory_search_enabled = True - self.user_directory_search_all_users = False - self.user_directory_search_prefer_local_users = False - user_directory_config = config.get("user_directory", None) - if user_directory_config: - self.user_directory_search_enabled = user_directory_config.get( - "enabled", True - ) - self.user_directory_search_all_users = user_directory_config.get( - "search_all_users", False - ) - self.user_directory_search_prefer_local_users = user_directory_config.get( - "prefer_local_users", False - ) + user_directory_config = config.get("user_directory") or {} + self.user_directory_search_enabled = user_directory_config.get("enabled", True) + self.user_directory_search_all_users = user_directory_config.get( + "search_all_users", False + ) + self.user_directory_search_prefer_local_users = user_directory_config.get( + "prefer_local_users", False + ) def generate_config_section(self, config_dir_path, server_name, **kwargs): return """ # 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 """ |