mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
e22b71810e
The user directory sample config section was a little messy, and didn't adhere to our [recommended config format guidelines](https://github.com/matrix-org/synapse/blob/develop/docs/code_style.md#configuration-file-format). This PR cleans that up a bit.
70 lines
2.7 KiB
Python
70 lines
2.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2017 New Vector Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
from ._base import Config
|
|
|
|
|
|
class UserDirectoryConfig(Config):
|
|
"""User Directory Configuration
|
|
Configuration for the behaviour of the /user_directory API
|
|
"""
|
|
|
|
section = "userdirectory"
|
|
|
|
def read_config(self, config, **kwargs):
|
|
user_directory_config = config.get("user_directory") or {}
|
|
self.user_directory_search_enabled = user_directory_config.get("enabled", True)
|
|
self.user_directory_search_all_users = user_directory_config.get(
|
|
"search_all_users", False
|
|
)
|
|
self.user_directory_search_prefer_local_users = user_directory_config.get(
|
|
"prefer_local_users", False
|
|
)
|
|
|
|
def generate_config_section(self, config_dir_path, server_name, **kwargs):
|
|
return """
|
|
# User Directory configuration
|
|
#
|
|
user_directory:
|
|
# Defines whether users can search the user directory. If false then
|
|
# empty responses are returned to all queries. Defaults to true.
|
|
#
|
|
# Uncomment to disable the 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.
|
|
#
|
|
# If you set it true, you'll have to rebuild the user_directory search
|
|
# indexes, see:
|
|
# https://github.com/matrix-org/synapse/blob/master/docs/user_directory.md
|
|
#
|
|
# Uncomment to return search results containing all known users, even if that
|
|
# user does not share a room with the requester.
|
|
#
|
|
#search_all_users: true
|
|
|
|
# Defines whether to prefer local users in search query results.
|
|
# If True, local users are more likely to appear above remote users
|
|
# when searching the user directory. Defaults to false.
|
|
#
|
|
# Uncomment to prefer local over remote users in user directory search
|
|
# results.
|
|
#
|
|
#prefer_local_users: true
|
|
"""
|