summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorErik Johnston <erikj@jki.re>2019-03-20 16:47:15 +0000
committerGitHub <noreply@github.com>2019-03-20 16:47:15 +0000
commit263f2c9ce18b8dbf041ad65fb225bc587c590159 (patch)
treefb196c16cbe328f6f81326a699d65655ca6a9e17 /docs
parentBatching in the user directory import (#4900) (diff)
parentAdd test (diff)
downloadsynapse-263f2c9ce18b8dbf041ad65fb225bc587c590159.tar.xz
Merge pull request #4895 from matrix-org/erikj/disable_user_search
Add option to disable searching in the user dir
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index d72b90a37b..f6f6aec7cf 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -962,6 +962,10 @@ password_config:
 
 # 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 run
@@ -969,6 +973,7 @@ password_config:
 # on your database to tell it to rebuild the user_directory search indexes.
 #
 #user_directory:
+#  enabled: true
 #  search_all_users: false