Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 951de33

Browse files
committed
Documenting rc_invites.per_issuer, resolves #13330.
Signed-off-by: David Teller <[email protected]>
1 parent 172ce29 commit 951de33

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

changelog.d/13333.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Documenting the new `rc_invites.per_issuer` throttling option.

docs/usage/configuration/config_documentation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1528,6 +1528,8 @@ The `rc_invites.per_user` limit applies to the *receiver* of the invite, rather
15281528
sender, meaning that a `rc_invite.per_user.burst_count` of 5 mandates that a single user
15291529
cannot *receive* more than a burst of 5 invites at a time.
15301530

1531+
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.
1532+
15311533
Example configuration:
15321534
```yaml
15331535
rc_invites:
@@ -1537,6 +1539,9 @@ rc_invites:
15371539
per_user:
15381540
per_second: 0.004
15391541
burst_count: 3
1542+
per_issuer:
1543+
per_second: 0.5
1544+
burst_count: 5
15401545
```
15411546
---
15421547
### `rc_third_party_invite`

0 commit comments

Comments
 (0)