Document `rc_invites.per_issuer`, added in v1.63.
Resolves #13330. Missed in #13125. Signed-off-by: David Teller <davidt@element.io>
This commit is contained in:
parent
93740cae57
commit
b909d5327b
|
@ -0,0 +1 @@
|
||||||
|
Document the new `rc_invites.per_issuer` throttling option added in Synapse 1.63.
|
|
@ -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
|
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.
|
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:
|
Example configuration:
|
||||||
```yaml
|
```yaml
|
||||||
rc_invites:
|
rc_invites:
|
||||||
|
@ -1513,7 +1515,13 @@ rc_invites:
|
||||||
per_user:
|
per_user:
|
||||||
per_second: 0.004
|
per_second: 0.004
|
||||||
burst_count: 3
|
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`
|
### `rc_third_party_invite`
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue