瀏覽代碼

Add some documentation around the `rc_invites` option to the config docs (#12759)

tags/v1.60.0rc1
Andrew Morgan 2 年之前
committed by GitHub
父節點
當前提交
deca250e3f
沒有發現已知的金鑰在資料庫的簽署中 GPG Key ID: 4AEE18F83AFDEB23
共有 2 個文件被更改,包括 15 次插入0 次删除
  1. +1
    -0
      changelog.d/12759.doc
  2. +14
    -0
      docs/usage/configuration/config_documentation.md

+ 1
- 0
changelog.d/12759.doc 查看文件

@@ -0,0 +1 @@
Add information regarding the `rc_invites` ratelimiting option to the configuration docs.

+ 14
- 0
docs/usage/configuration/config_documentation.md 查看文件

@@ -1357,6 +1357,20 @@ 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`.

Client requests that invite user(s) when [creating a
room](https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3createroom)
will count against the `rc_invites.per_room` limit, whereas
client requests to [invite a single user to a
room](https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3roomsroomidinvite)
will count against both the `rc_invites.per_user` and `rc_invites.per_room` limits.

Federation requests to invite a user will count against the `rc_invites.per_user`
limit only, as Synapse presumes ratelimiting by room will be done by the sending server.

The `rc_invites.per_user` limit applies to the *receiver* of the invite, rather than the
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.

Example configuration:
```yaml
rc_invites:


Loading…
取消
儲存