summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorAndrew Morgan <andrew@amorgan.xyz>2020-02-20 15:41:08 +0000
committerAndrew Morgan <andrew@amorgan.xyz>2020-02-20 15:41:08 +0000
commitd478a36ae473963f43452d16a5fc245fc3fd9784 (patch)
tree4edb5da471870f8033523a5b3674ca0b803cddae /docs
parentMerge pull request #5774 from matrix-org/erikj/fix_rejected_membership (diff)
parentRoom Complexity Client Implementation (#5783) (diff)
downloadsynapse-d478a36ae473963f43452d16a5fc245fc3fd9784.tar.xz
Room Complexity Client Implementation (#5783)
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 972c212f3d..76993fba43 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -285,6 +285,23 @@ listeners:
 # Used by phonehome stats to group together related servers.
 #server_context: context
 
+# Resource-constrained Homeserver Settings
+#
+# If limit_remote_rooms.enabled is True, the room complexity will be
+# checked before a user joins a new remote room. If it is above
+# limit_remote_rooms.complexity, it will disallow joining or
+# instantly leave.
+#
+# limit_remote_rooms.complexity_error can be set to customise the text
+# displayed to the user when a room above the complexity threshold has
+# its join cancelled.
+#
+# Uncomment the below lines to enable:
+#limit_remote_rooms:
+#  enabled: True
+#  complexity: 1.0
+#  complexity_error: "This room is too complex."
+
 # Whether to require a user to be in the room to add an alias to it.
 # Defaults to 'true'.
 #