summary refs log tree commit diff
path: root/docs/usage
diff options
context:
space:
mode:
authorAndy Balaam <andy.balaam@matrix.org>2022-05-12 11:41:35 +0100
committerGitHub <noreply@github.com>2022-05-12 10:41:35 +0000
commitde1e599b9defdc9b541f14a03157f614cb688729 (patch)
tree48d1c2e38b70bd891ed0725e668b73b26d697ffd /docs/usage
parentFix reference to the wrong symbol in the media admin api docs (#12715) (diff)
downloadsynapse-de1e599b9defdc9b541f14a03157f614cb688729.tar.xz
add default_power_level_content_override config option. (#12618)
Co-authored-by: Matthew Hodgson <matthew@matrix.org>
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/configuration/config_documentation.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index f292b94fb0..2af1f284b1 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -3315,6 +3315,32 @@ room_list_publication_rules:
     room_id: "*"
     action: allow
 ```
+
+---
+Config option: `default_power_level_content_override`
+
+The `default_power_level_content_override` option controls the default power
+levels for rooms.
+
+Useful if you know that your users need special permissions in rooms
+that they create (e.g. to send particular types of state events without
+needing an elevated power level).  This takes the same shape as the
+`power_level_content_override` parameter in the /createRoom API, but
+is applied before that parameter.
+
+Note that each key provided inside a preset (for example `events` in the example
+below) will overwrite all existing defaults inside that key. So in the example
+below, newly-created private_chat rooms will have no rules for any event types
+except `com.example.foo`.
+
+Example configuration:
+```yaml
+default_power_level_content_override:
+   private_chat: { "events": { "com.example.foo" : 0 } }
+   trusted_private_chat: null
+   public_chat: null
+```
+
 ---
 ## Opentracing ##
 Configuration options related to Opentracing support.