summary refs log tree commit diff
diff options
context:
space:
mode:
authorDavid Teller <d.o.teller+github@gmail.com>2022-07-21 10:46:51 +0200
committerDavid Teller <d.o.teller+github@gmail.com>2022-07-21 10:46:51 +0200
commit26661d6c639efc620895ef339f8c99a2c19c9ffa (patch)
tree6453d9af1ed043957469cbc8b2515add86a82ac6
parentDocumenting `rc_invites.per_issuer`, resolves #13330. (diff)
downloadsynapse-yoric/throttling-invites-doc.tar.xz
-rw-r--r--changelog.d/13333.doc2
-rw-r--r--docs/usage/configuration/config_documentation.md5
2 files changed, 5 insertions, 2 deletions
diff --git a/changelog.d/13333.doc b/changelog.d/13333.doc
index 0649008c8d..57cbdf05c8 100644
--- a/changelog.d/13333.doc
+++ b/changelog.d/13333.doc
@@ -1 +1 @@
-Documenting the new `rc_invites.per_issuer` throttling option.
\ No newline at end of file
+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 f7dc8df1eb..11d1574484 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -1528,7 +1528,7 @@ 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.
 
-By opposition, 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.
+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
@@ -1543,6 +1543,9 @@ rc_invites:
     per_second: 0.5
     burst_count: 5
 ```
+
+_Changed in version 1.63:_ added the `per_issuer` limit.
+
 ---
 ### `rc_third_party_invite`