summary refs log tree commit diff
path: root/docs/usage/configuration
diff options
context:
space:
mode:
authorDavid Teller <d.o.teller+github@gmail.com>2022-07-20 11:04:54 +0200
committerDavid Robertson <davidr@element.io>2022-07-21 11:26:34 +0100
commitb909d5327b06af20505a8c02e34765625f215bfe (patch)
tree1b81822577d6304e39dfc2d61390f2892b5e1960 /docs/usage/configuration
parent1.63.1 (diff)
downloadsynapse-b909d5327b06af20505a8c02e34765625f215bfe.tar.xz
Document `rc_invites.per_issuer`, added in v1.63.
Resolves #13330.
Missed in #13125.

Signed-off-by: David Teller <davidt@element.io>
Diffstat (limited to 'docs/usage/configuration')
-rw-r--r--docs/usage/configuration/config_documentation.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 6d7d700a13..601fdeb09e 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -1504,6 +1504,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:
@@ -1513,7 +1515,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`