summary refs log tree commit diff
path: root/docs/usage/configuration/config_documentation.md
diff options
context:
space:
mode:
authorHugh Nimmo-Smith <hughns@users.noreply.github.com>2025-06-03 12:34:40 +0100
committerGitHub <noreply@github.com>2025-06-03 11:34:40 +0000
commita4d8da7a1b6540652b3e0e1b4faa6c4d60b7b46c (patch)
treeb1f9ab3243500192bce614370a5d316195029f46 /docs/usage/configuration/config_documentation.md
parentMachine-readable config description (#17892) (diff)
downloadsynapse-a4d8da7a1b6540652b3e0e1b4faa6c4d60b7b46c.tar.xz
Make user_type extensible and allow default user_type to be set (#18456)
Diffstat (limited to 'docs/usage/configuration/config_documentation.md')
-rw-r--r--docs/usage/configuration/config_documentation.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md

index b9845dd78f..c014de794d 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md
@@ -762,6 +762,24 @@ Example configuration: max_event_delay_duration: 24h ``` --- +### `user_types` + +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 []. + +Example configuration: +```yaml +user_types: + default_user_type: "custom" + extra_user_types: + - "custom" + - "custom2" +``` + ## Homeserver blocking Useful options for Synapse admins.