add guide for common matrix moderation actions
This commit is contained in:
parent
8f07ad8ca4
commit
ddce7783db
2 changed files with 53 additions and 1 deletions
52
docs/guides/matrix-taking-moderation-action.md
Normal file
52
docs/guides/matrix-taking-moderation-action.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
title: "Matrix: Taking Moderation Action"
|
||||
---
|
||||
|
||||
!!! success "Goal"
|
||||
|
||||
Perform common moderation actions in Matrix using our moderation bot
|
||||
|
||||
See the [Matrix-Moderation](../concepts-and-configurations/matrix-moderation.md) Concept for an overview on how the moderation system functions.
|
||||
|
||||
All bot actions are triggered through the *CCCHH Moderation Management* room.
|
||||
|
||||
!!! warning "Warning"
|
||||
|
||||
Moderation actions should be triggered through the bot to avoid exposing members of the moderation team to harassment.
|
||||
Even if the bot is unwieldy, think before taking action with your personal account and do so on your own scrutiny.
|
||||
|
||||
## Banning a User
|
||||
|
||||
```
|
||||
!mjolnir ban general user <glob> <reason>
|
||||
```
|
||||
|
||||
- `<glob>` can be a user ID (e.g. `@example:matrix.org`) but also more sophisticated. Be careful when using actual glob syntax as whole servers can be banned even if just a single user is the intended target.
|
||||
- `<reason>` is technically optional but should always be supplied so that we know why a certain user was banned in retrospect. The bot supports parsing quotations so `"<reason>"` is usually what you want if more than one word is used.
|
||||
|
||||
## Banning a Server
|
||||
|
||||
```
|
||||
!mjolnir ban server <glob> <reason>
|
||||
```
|
||||
|
||||
- `<glob>` can be used to ban subdomains of a domain too, e.g. `*.example.com`. If used, an additional `--force` is required after the whole command.
|
||||
- `<reason>` should be supplied and supports quotation (`"<reason>") if more than one word is used
|
||||
- When a domain is banned, we usually also ban all subdomains too. This needs to be done in two separate commands.
|
||||
|
||||
## Redacting a single Message
|
||||
|
||||
```
|
||||
!mjolnir redact <permalink>
|
||||
```
|
||||
|
||||
- `<permalink>` is **not** the message ID but the actual *https://matrix.to/#blablabla* link that can be retrieved with most clients through a *Share* or *Copy link to Message* button on an individual message.
|
||||
|
||||
## Redacting all Messages of a User
|
||||
|
||||
```
|
||||
!mjolnir redact <user-id>
|
||||
```
|
||||
|
||||
- `user-id` the Matrix-ID of the user of whom all messages in all rooms should be redacted (e.g. `@bla:example.com`).
|
||||
|
||||
Loading…
Reference in a new issue