summary refs log tree commit diff
diff options
context:
space:
mode:
authordevonh <devon.dmytro@gmail.com>2024-06-24 17:16:09 +0000
committerGitHub <noreply@github.com>2024-06-24 17:16:09 +0000
commit3c61ddbbc9ee313447c16fa7f19bdc29ce647a32 (patch)
tree3887dfbdd987ab3c77d7ed52bc01f5be4579ded7
parentFix room `type` typo in mailer (#17336) (diff)
downloadsynapse-3c61ddbbc9ee313447c16fa7f19bdc29ce647a32.tar.xz
Add default values for rc_invites per_issuer to docs (#17347)
A simple change to update the docs where default values were missing.

### Pull Request Checklist

<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->

* [X] Pull request is based on the develop branch
* [X] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog).
The entry should:
- Be a short description of your change which makes sense to users.
"Fixed a bug that prevented receiving messages from other servers."
instead of "Moved X method from `EventStore` to `EventWorkerStore`.".
  - Use markdown where necessary, mostly for `code blocks`.
  - End with either a period (.) or an exclamation mark (!).
  - Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by
@github_username." or "Contributed by [Your Name]." to the end of the
entry.
* [X] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))

---------

Co-authored-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
-rw-r--r--changelog.d/17347.doc1
-rw-r--r--docs/usage/configuration/config_documentation.md5
2 files changed, 4 insertions, 2 deletions
diff --git a/changelog.d/17347.doc b/changelog.d/17347.doc
new file mode 100644
index 0000000000..6cd41be60f
--- /dev/null
+++ b/changelog.d/17347.doc
@@ -0,0 +1 @@
+Add default values for `rc_invites.per_issuer` to docs.
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 22c545359d..b3db078703 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -1759,8 +1759,9 @@ rc_3pid_validation:
 ### `rc_invites`
 
 This option sets ratelimiting how often invites can be sent in a room or to a
-specific user. `per_room` defaults to `per_second: 0.3`, `burst_count: 10` and
-`per_user` defaults to `per_second: 0.003`, `burst_count: 5`.
+specific user. `per_room` defaults to `per_second: 0.3`, `burst_count: 10`,
+`per_user` defaults to `per_second: 0.003`, `burst_count: 5`, and `per_issuer` 
+defaults to `per_second: 0.3`, `burst_count: 10`.
 
 Client requests that invite user(s) when [creating a
 room](https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3createroom)