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

Document rc_invites.per_issuer #13333

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/13333.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document the new `rc_invites.per_issuer` throttling option added in Synapse 1.63.
8 changes: 8 additions & 0 deletions docs/usage/configuration/config_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -1537,7 +1539,13 @@ rc_invites:
per_user:
per_second: 0.004
burst_count: 3
per_issuer:
per_second: 0.5
burst_count: 5
```
DMRobertson marked this conversation as resolved.
Show resolved Hide resolved

_Changed in version 1.63:_ added the `per_issuer` limit.

---
### `rc_third_party_invite`

Expand Down