summary refs log tree commit diff
diff options
context:
space:
mode:
authorDavid Robertson <davidr@element.io>2022-07-21 11:27:08 +0100
committerDavid Robertson <davidr@element.io>2022-07-21 11:27:08 +0100
commit4f57ef0b1810bef6071d23e32785623de8b48fdf (patch)
tree2bb0b4932700de05892e91ae85acc6951621eec9
parentUpdate `get_pdu` to return the original, pristine `EventBase` (#13320) (diff)
parentDocument `rc_invites.per_issuer`, added in v1.63. (diff)
downloadsynapse-4f57ef0b1810bef6071d23e32785623de8b48fdf.tar.xz
Merge branch 'master' into develop
-rw-r--r--changelog.d/13333.doc1
-rw-r--r--docs/usage/configuration/config_documentation.md8
2 files changed, 9 insertions, 0 deletions
diff --git a/changelog.d/13333.doc b/changelog.d/13333.doc
new file mode 100644
index 0000000000..57cbdf05c8
--- /dev/null
+++ b/changelog.d/13333.doc
@@ -0,0 +1 @@
+Document the new `rc_invites.per_issuer` throttling option added in Synapse 1.63.
\ No newline at end of file
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 53e077d85b..11d1574484 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -1528,6 +1528,8 @@ The `rc_invites.per_user` limit applies to the *receiver* of the invite, rather
 sender, meaning that a `rc_invite.per_user.burst_count` of 5 mandates that a single user
 cannot *receive* more than a burst of 5 invites at a time.
 
+In contrast, the `rc_invites.per_issuer` limit applies to the *issuer* of the invite, meaning that a `rc_invite.per_issuer.burst_count` of 5 mandates that single user cannot *send* more than a burst of 5 invites at a time.
+
 Example configuration:
 ```yaml
 rc_invites:
@@ -1537,7 +1539,13 @@ rc_invites:
   per_user:
     per_second: 0.004
     burst_count: 3
+  per_issuer:
+    per_second: 0.5
+    burst_count: 5
 ```
+
+_Changed in version 1.63:_ added the `per_issuer` limit.
+
 ---
 ### `rc_third_party_invite`