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

Commit

Permalink
Tweak phrasing; note the version adding the option
Browse files Browse the repository at this point in the history
  • Loading branch information
David Robertson committed Jul 8, 2022
1 parent dcb1683 commit 4da8f29
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/usage/configuration/config_documentation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1382,7 +1382,7 @@ rc_joins:
---
### `rc_joins_per_room`

This option allows for ratelimiting joins to a room based on the number of recent
This option allows admins to ratelimit joins to a room based on the number of recent
joins (local or remote) to that room. It is intended to mitigate mass-join spam
waves which target multiple homeservers.

Expand All @@ -1395,6 +1395,9 @@ rc_joins_per_room:
per_second: 1
burst_count: 10
```

This comment has been minimized.

Sign in to view

Copy link
@H-Shay

H-Shay Jul 8, 2022

Contributor

I envisioned this being below the rc_joins_per_room and above the description (like around line 1384) but I don't think it makes a huge difference so I will leave that up to you!

This comment has been minimized.

Sign in to view

Copy link
@DMRobertson

DMRobertson Jul 8, 2022

Contributor

FWIW I was emulating what Python does in its docs, e.g. see the bottom of https://docs.python.org/3/library/functools.html?highlight=singledispatch#functools.update_wrapper for example

This comment has been minimized.

Sign in to view

Copy link
@H-Shay

H-Shay Jul 8, 2022

Contributor

Awesome sounds good to me!
_Added in Synapse 1.63.0._

---
### `rc_3pid_validation`

Expand Down

0 comments on commit 4da8f29

Please sign in to comment.