summary refs log tree commit diff
path: root/docs/usage
diff options
context:
space:
mode:
authorreivilibre <oliverw@element.io>2025-06-10 11:43:58 +0000
committerErik Johnston <erik@matrix.org>2025-06-10 12:45:31 +0100
commitcc6b4980efb281185a0f7dd958d121cf2d268855 (patch)
tree5b01145ffac6c45a7b219d6ae00b92af6010361a /docs/usage
parent1.132.0rc1 (diff)
downloadsynapse-cc6b4980efb281185a0f7dd958d121cf2d268855.tar.xz
Add config doc generation command to lint.sh and add missing config schema. (#18522)
Follows: #17892, #18456

<ol>
<li>

Add config doc generation command to lint.sh 

</li>
<li>

Add missing `user_types` config schema 

</li>
</ol>

---------

Signed-off-by: Olivier 'reivilibre <oliverw@matrix.org>
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/configuration/config_documentation.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md

index c014de794d..1e8953ae37 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md
@@ -764,22 +764,23 @@ max_event_delay_duration: 24h --- ### `user_types` -Configuration settings related to the user types feature. +*(object)* Configuration settings related to the user types feature. This setting has the following sub-options: -* `default_user_type`: The default user type to use for registering new users when no value has been specified. - Defaults to none. -* `extra_user_types`: Array of additional user types to allow. These are treated as real users. Defaults to []. + +* `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 `[]`. Example configuration: ```yaml user_types: - default_user_type: "custom" - extra_user_types: - - "custom" - - "custom2" + default_user_type: custom + extra_user_types: + - custom + - custom2 ``` - +--- ## Homeserver blocking Useful options for Synapse admins.