kaslo/synapse
1
0
Fork 0
Code Packages Releases 124 Wiki Activity

Document that some config options for the user directory are in violation of the Matrix spec (#18548)

Browse Source 
Fix #17534

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
This commit is contained in:
Johannes Marbach
2025-07-15 20:25:25 +02:00
committed by GitHub
parent 49cb78376e
commit b274d6561c
3 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/18548.doc Normal file
View File

@@ -0,0 +1 @@
Document that some config options for the user directory are in violation of the Matrix spec.

6
docs/usage/configuration/config_documentation.md
View File

@@ -3808,7 +3808,11 @@ encryption_enabled_by_default_for_room_type: invite
This setting has the following sub-options: This setting has the following sub-options:
* `enabled` (boolean): Defines whether users can search the user directory. If false then empty responses are returned to all queries. Defaults to `true`. * `enabled` (boolean): Defines whether users can search the user directory. If `false` then empty responses are returned to all queries.
*Warning: While the homeserver may determine which subset of users are searched, the Matrix specification requires homeservers to include (at minimum) users visible in public rooms and users sharing a room with the requester. Using `false` improves performance but violates this requirement.*
Defaults to `true`.
* `search_all_users` (boolean): Defines whether to search all users visible to your homeserver at the time the search is performed. If set to true, will return all users known to the homeserver matching the search query. If false, search results will only contain users visible in public rooms and users sharing a room with the requester. * `search_all_users` (boolean): Defines whether to search all users visible to your homeserver at the time the search is performed. If set to true, will return all users known to the homeserver matching the search query. If false, search results will only contain users visible in public rooms and users sharing a room with the requester.

9
schema/synapse-config.schema.yaml
View File

@@ -4719,8 +4719,15 @@ properties:
enabled: enabled:
type: boolean type: boolean
description: >- description: >-
Defines whether users can search the user directory. If false then Defines whether users can search the user directory. If `false` then
empty responses are returned to all queries. empty responses are returned to all queries.
*Warning: While the homeserver may determine which subset of users are
searched, the Matrix specification requires homeservers to include (at
minimum) users visible in public rooms and users sharing a room with
the requester. Using `false` improves performance but violates this
requirement.*
default: true default: true
search_all_users: search_all_users:
type: boolean type: boolean