better doc

This commit is contained in:
Matthew Hodgson 2017-12-04 17:51:33 +00:00
parent 7b86c1fdcd
commit b11dca2025

View File

@ -32,9 +32,12 @@ class UserDirectoryConfig(Config):
def default_config(self, config_dir_path, server_name, **kwargs): def default_config(self, config_dir_path, server_name, **kwargs):
return """ return """
# User Directory configuration # User Directory configuration
#
# 'search_all_users' defines whether to search all users visible to your HS # 'search_all_users' defines whether to search all users visible to your HS
# when searching the user directory, rather than limiting to users visible # when searching the user directory, rather than limiting to users visible
# in public rooms. Defaults to false. # in public rooms. Defaults to false. If you set it True, you'll have to run
# UPDATE user_directory_stream_pos SET stream_id = NULL;
# on your database to tell it to rebuild the user_directory search indexes.
# #
#user_directory: #user_directory:
# search_all_users: false # search_all_users: false