浏览代码

Update docs for Draupnir and Mjolnir: the instructions for running the curl command

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3966/head
Suguru Hirahara 1年前
父节点
当前提交
de5b241c4b
找不到此签名对应的密钥 GPG 密钥 ID: E4F9743DAB4B7B75
共有 2 个文件被更改,包括 18 次插入4 次删除
  1. +9
    -2
      docs/configuring-playbook-bot-draupnir.md
  2. +9
    -2
      docs/configuring-playbook-bot-mjolnir.md

+ 9
- 2
docs/configuring-playbook-bot-draupnir.md 查看文件

@@ -98,12 +98,19 @@ Manual access to Synapse's Admin APIs requires an access token for a homeserver

#### Run the `curl` command

To discharge rate limiting, run the following command on systems that ship curl (note that it does not work on outdated Windows 10). Even if the APIs are not exposed to the internet, you should still be able to run the command on the homeserver locally. Before running it, make sure to replace `@bot.draupnir:example.com` with the MXID of your Draupnir:
To discharge rate limiting, run the following command on systems that ship curl (note that it does not work on outdated Windows 10).

Before running it, make sure to replace:
- `ADMIN_ACCESS_TOKEN_HERE` with the access token of the admin account
- `example.com` with your base domain
- `@bot.draupnir:example.com` with the MXID of your Draupnir

```sh
curl --header "Authorization: Bearer <access_token>" -X POST https://matrix.example.com/_synapse/admin/v1/users/@bot.draupnir:example.com/override_ratelimit
curl --header "Authorization: Bearer ADMIN_ACCESS_TOKEN_HERE" -X POST https://matrix.example.com/_synapse/admin/v1/users/@bot.draupnir:example.com/override_ratelimit
```

**Note**: even if the APIs are not exposed to the internet, you should still be able to run the command on the homeserver locally.

### Abuse Reports

Draupnir can receive reports in the management room.


+ 9
- 2
docs/configuring-playbook-bot-mjolnir.md 查看文件

@@ -50,12 +50,19 @@ Manual access to Synapse's Admin APIs requires an access token for a homeserver

#### Run the `curl` command

To discharge rate limiting, run the following command on systems that ship curl (note that it does not work on outdated Windows 10). Even if the APIs are not exposed to the internet, you should still be able to run the command on the homeserver locally. Before running it, make sure to replace `@bot.mjolnir:example.com` with the MXID of your Mjolnir:
To discharge rate limiting, run the following command on systems that ship curl (note that it does not work on outdated Windows 10).

Before running it, make sure to replace:
- `ADMIN_ACCESS_TOKEN_HERE` with the access token of the admin account
- `example.com` with your base domain
- `@bot.mjolnir:example.com` with the MXID of your Mjolnir

```sh
curl --header "Authorization: Bearer <access_token>" -X POST https://matrix.example.com/_synapse/admin/v1/users/@bot.mjolnir:example.com/override_ratelimit
curl --header "Authorization: Bearer ADMIN_ACCESS_TOKEN_HERE" -X POST https://matrix.example.com/_synapse/admin/v1/users/@bot.mjolnir:example.com/override_ratelimit
```

**Note**: even if the APIs are not exposed to the internet, you should still be able to run the command on the homeserver locally.

### Create a management room

Using your own account, create a new invite only room that you will use to manage the bot. This is the room where you will see the status of the bot and where you will send commands to the bot, such as the command to ban a user from another room.


正在加载...
取消
保存