Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Always add local users to the user directory #10796

Merged
merged 5 commits into from
Sep 21, 2021
Merged

Always add local users to the user directory #10796

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
27aac3e
Always add local users to the user directory
Aug 31, 2021
d0695f7
Changelog
Sep 10, 2021
f0845a7
Update search_all_users config option docs
Sep 21, 2021
7d5d158
typo build -> built
Sep 21, 2021
ea2c973
update sample config
Sep 21, 2021
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
14 changes: 9 additions & 5 deletions docs/sample_config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2362,12 +2362,16 @@ user_directory:
#enabled: false

# 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.
# the user directory. If false, search results will only contain users
# visible in public rooms and users sharing a room with the requester.
# Defaults to false.
#
# If you set it true, you'll have to rebuild the user_directory search
# indexes, see:
# https://matrix-org.github.io/synapse/latest/user_directory.html
# NB. If you set this to true, and the last time the user_directory search
# indexes were (re)built was before Synapse 1.44, you'll have to
# rebuild the indexes in order to search through all known users.
# These indexes are build the first time Synapse starts; admins can
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# indexes were (re)built was before Synapse 1.44, you'll have to
# rebuild the indexes in order to search through all known users.
# These indexes are build the first time Synapse starts; admins can
# indices were (re)built was before Synapse 1.44, you'll have to
# rebuild the indices in order to search through all known users.
# These indices are built the first time Synapse starts; admins can

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indices was my instinct too, but "indexes" seems to be slightly more common. No strong opinions personally, but FWIW

(of course, postgres doesn't have a monopoly on the concept of a db index)

# manually trigger a rebuild following the instructions at
# https://matrix-org.github.io/synapse/latest/user_directory.html
#
# Uncomment to return search results containing all known users, even if that
# user does not share a room with the requester.
Expand Down
14 changes: 9 additions & 5 deletions synapse/config/user_directory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,16 @@ def generate_config_section(self, config_dir_path, server_name, **kwargs):
#enabled: false

# 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.
# the user directory. If false, search results will only contain users
# visible in public rooms and users sharing a room with the requester.
# Defaults to false.
#
# If you set it true, you'll have to rebuild the user_directory search
# indexes, see:
# https://matrix-org.github.io/synapse/latest/user_directory.html
# NB. If you set this to true, and the last time the user_directory search
# indexes were (re)built was before Synapse 1.44, you'll have to
# rebuild the indexes in order to search through all known users.
# These indexes are build the first time Synapse starts; admins can
DMRobertson marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# indexes were (re)built was before Synapse 1.44, you'll have to
# rebuild the indexes in order to search through all known users.
# These indexes are build the first time Synapse starts; admins can
# indices were (re)built was before Synapse 1.44, you'll have to
# rebuild the indices in order to search through all known users.
# These indices are built the first time Synapse starts; admins can

# manually trigger a rebuild following the instructions at
# https://matrix-org.github.io/synapse/latest/user_directory.html
#
# Uncomment to return search results containing all known users, even if that
# user does not share a room with the requester.
Expand Down