diff options
| author | David Teller <d.o.teller+github@gmail.com> | 2022-07-20 11:04:54 +0200 |
|---|---|---|
| committer | David Teller <d.o.teller+github@gmail.com> | 2022-07-20 11:11:38 +0200 |
| commit | 951de33cb516d04462967d8b68d1f306580cf754 (patch) | |
| tree | 46964594b6afb140e9bca06ed1dd60fbcc18ab47 | |
| parent | Fix spurious warning when fetching state after a missing prev event (#13258) (diff) | |
| download | synapse-951de33cb516d04462967d8b68d1f306580cf754.tar.xz | |
Documenting `rc_invites.per_issuer`, resolves #13330.
Signed-off-by: David Teller <davidt@element.io>
| -rw-r--r-- | changelog.d/13333.doc | 1 | ||||
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 5 |
2 files changed, 6 insertions, 0 deletions
diff --git a/changelog.d/13333.doc b/changelog.d/13333.doc new file mode 100644 index 0000000000..0649008c8d --- /dev/null +++ b/changelog.d/13333.doc @@ -0,0 +1 @@ +Documenting the new `rc_invites.per_issuer` throttling option. \ No newline at end of file diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 53e077d85b..f7dc8df1eb 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -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. +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. + Example configuration: ```yaml rc_invites: @@ -1537,6 +1539,9 @@ rc_invites: per_user: per_second: 0.004 burst_count: 3 + per_issuer: + per_second: 0.5 + burst_count: 5 ``` --- ### `rc_third_party_invite` |