Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 15, 2025
+14 −2
Merged

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

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2a170f5
Document that some config options for the user directory are in viola…
Johennes Jun 13, 2025
f63b896
Improve wording
Johennes Jul 14, 2025
58c3b01
Revert superfluous disclaimer
Johennes Jul 14, 2025
aa8ca77
Move disclaimer to enabled property
Johennes Jul 14, 2025
c1f5802
Regenerate docs
Johennes Jul 14, 2025
e7f99cf
Merge branch 'develop' into johannes/user-directory-config-spec-compl…
Johennes Jul 14, 2025
1a2a5db
Add missing blank line
Johennes Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/18548.doc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document that some config options for the user directory are in violation of the Matrix spec.
6 changes: 5 additions & 1 deletion docs/usage/configuration/config_documentation.md
View file
Original file line number Diff line number Diff line change
@@ -3778,7 +3778,11 @@ encryption_enabled_by_default_for_room_type: invite

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.

9 changes: 8 additions & 1 deletion schema/synapse-config.schema.yaml
View file
Original file line number Diff line number Diff line change
@@ -4689,8 +4689,15 @@ properties:
enabled:
type: boolean
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.
*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
search_all_users:
type: boolean