summary refs log tree commit diff
path: root/develop/usage
diff options
context:
space:
mode:
authorDMRobertson <DMRobertson@users.noreply.github.com>2022-07-19 11:45:57 +0000
committerDMRobertson <DMRobertson@users.noreply.github.com>2022-07-19 11:45:57 +0000
commite125d9f3e3043ea4aaf640c48b7628b5aa488bac (patch)
treeb5958026f198ee7b30ecff9d9b48d102b2a64f44 /develop/usage
parentdeploy: e9ce4d089bbb013f870bbc8d58ec796e8f315eb4 (diff)
downloadsynapse-e125d9f3e3043ea4aaf640c48b7628b5aa488bac.tar.xz
deploy: b9778673587941277e15b067ad39cdf084f7dde5
Diffstat (limited to 'develop/usage')
-rw-r--r--develop/usage/configuration/config_documentation.html13
1 files changed, 13 insertions, 0 deletions
diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html
index d77531fd01..848243cd04 100644
--- a/develop/usage/configuration/config_documentation.html
+++ b/develop/usage/configuration/config_documentation.html
@@ -1378,6 +1378,19 @@ can be more computationally expensive than restricting locally). Defaults to
     burst_count: 12
 </code></pre>
 <hr />
+<h3 id="rc_joins_per_room"><a class="header" href="#rc_joins_per_room"><code>rc_joins_per_room</code></a></h3>
+<p>This option allows admins to ratelimit joins to a room based on the number of recent
+joins (local or remote) to that room. It is intended to mitigate mass-join spam
+waves which target multiple homeservers.</p>
+<p>By default, one join is permitted to a room every second, with an accumulating
+buffer of up to ten instantaneous joins.</p>
+<p>Example configuration (default values):</p>
+<pre><code class="language-yaml">rc_joins_per_room:
+  per_second: 1
+  burst_count: 10
+</code></pre>
+<p><em>Added in Synapse 1.64.0.</em></p>
+<hr />
 <h3 id="rc_3pid_validation"><a class="header" href="#rc_3pid_validation"><code>rc_3pid_validation</code></a></h3>
 <p>This option ratelimits how often a user or IP can attempt to validate a 3PID.
 Defaults to <code>per_second: 0.003</code>, <code>burst_count: 5</code>.</p>