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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Open in desktop
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.
8 changes: 5 additions & 3 deletions docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -770,7 +770,7 @@ This setting has the following sub-options:

* `default_user_type` (string|null): The default user type to use for registering new users when no value has been specified. Defaults to none. Defaults to `null`.

* `extra_user_types` (list): Array of additional user types to allow. These are treated as real users. Defaults to `[]`.
* `extra_user_types` (array): Array of additional user types to allow. These are treated as real users. Defaults to `[]`.

Example configuration:
```yaml
Expand Down Expand Up @@ -3732,9 +3732,11 @@ encryption_enabled_by_default_for_room_type: invite

*(object)* This setting defines options related to the user directory.

*Warning: The Matrix spec requires homeservers to consider at least users the requesting user shares a room with and users who reside in public rooms known to the homeserver in directory searches. Some of the settings below aid performance but are in violation of this requirement.*

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 (which is not spec-compliant). 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.

Expand All @@ -3746,7 +3748,7 @@ This setting has the following sub-options:

* `prefer_local_users` (boolean): Defines whether to prefer local users in search query results. If set to true, local users are more likely to appear above remote users when searching the user directory. Defaults to `false`.

* `exclude_remote_users` (boolean): If set to true, the search will only return local users. Defaults to `false`.
* `exclude_remote_users` (boolean): If set to `true`, the search will only return local users (which is not spec-compliant). Defaults to `false`.

* `show_locked_users` (boolean): Defines whether to show locked users in search query results. Defaults to `false`.

Expand Down
17 changes: 13 additions & 4 deletions schema/synapse-config.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4643,13 +4643,20 @@ properties:
- invite
user_directory:
type: object
description: This setting defines options related to the user directory.
description: >-
This setting defines options related to the user directory.


*Warning: The Matrix spec requires homeservers to consider at least users
the requesting user shares a room with and users who reside in public
rooms known to the homeserver in directory searches. Some of the settings
below aid performance but are in violation of this requirement.*
properties:
enabled:
type: boolean
description: >-
Defines whether users can search the user directory. If false then
empty responses are returned to all queries.
Defines whether users can search the user directory. If `false`, then
empty responses are returned to all queries (which is not spec-compliant).
default: true
search_all_users:
type: boolean
Expand Down Expand Up @@ -4682,7 +4689,9 @@ properties:
default: false
exclude_remote_users:
type: boolean
description: If set to true, the search will only return local users.
description: >-
If set to `true`, the search will only return local users (which is not
spec-compliant).
default: false
show_locked_users:
type: boolean
Expand Down