From 320667a47977ebbc9a1c0f320a06c80f953a4f86 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Tue, 19 Mar 2019 16:40:19 +0000 Subject: Add option to disable searching in the user dir We still populate it, as it can still be accessed via the admin API. --- synapse/config/user_directory.py | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'synapse/config/user_directory.py') diff --git a/synapse/config/user_directory.py b/synapse/config/user_directory.py index fab3a7d1c8..e3c063c148 100644 --- a/synapse/config/user_directory.py +++ b/synapse/config/user_directory.py @@ -22,9 +22,13 @@ class UserDirectoryConfig(Config): """ def read_config(self, config): + self.user_directory_search_enabled = True self.user_directory_search_all_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) ) @@ -33,6 +37,8 @@ class UserDirectoryConfig(Config): return """ # User Directory configuration # + # 'enabled' defines whether users can search the user directory, + # 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 run @@ -40,5 +46,6 @@ class UserDirectoryConfig(Config): # on your database to tell it to rebuild the user_directory search indexes. # #user_directory: + # enabled: true # search_all_users: false """ -- cgit 1.4.1 From ab20f85c59c4b7ef1a5248c2a9af37899dbfa280 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Wed, 20 Mar 2019 14:33:11 +0000 Subject: Update synapse/config/user_directory.py Co-Authored-By: erikjohnston --- synapse/config/user_directory.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'synapse/config/user_directory.py') diff --git a/synapse/config/user_directory.py b/synapse/config/user_directory.py index e3c063c148..9dd83b794d 100644 --- a/synapse/config/user_directory.py +++ b/synapse/config/user_directory.py @@ -38,7 +38,7 @@ class UserDirectoryConfig(Config): # User Directory configuration # # 'enabled' defines whether users can search the user directory, - # defaults to True. + # 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 run -- cgit 1.4.1 From cd8c5b91addf716ad76c315462a6d09e87241b25 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Wed, 20 Mar 2019 14:35:41 +0000 Subject: Fix up sample config --- docs/sample_config.yaml | 6 ++++-- synapse/config/user_directory.py | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) (limited to 'synapse/config/user_directory.py') diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index f242b1ffbc..93aa6a6754 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -954,8 +954,10 @@ password_config: # User Directory configuration # -# 'enabled' defines whether users can search the user directory, -# defaults to True. +# '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 run diff --git a/synapse/config/user_directory.py b/synapse/config/user_directory.py index 9dd83b794d..142754a7dc 100644 --- a/synapse/config/user_directory.py +++ b/synapse/config/user_directory.py @@ -37,8 +37,10 @@ class UserDirectoryConfig(Config): return """ # User Directory configuration # - # 'enabled' defines whether users can search the user directory, - # Defaults to true. + # '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 run -- cgit 1.4.1