Procházet zdrojové kódy

Update docs for Draupnir and Mjolnir: move the instruction to obtain an access token for the admin account above the one about running the curl command

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3966/head
Suguru Hirahara před 1 rokem
rodič
revize
163a2766cf
V databázi nebyl nalezen žádný známý klíč pro tento podpis ID GPG klíče: E4F9743DAB4B7B75
2 změnil soubory, kde provedl 8 přidání a 6 odebrání
  1. +4
    -4
      docs/configuring-playbook-bot-draupnir.md
  2. +4
    -2
      docs/configuring-playbook-bot-mjolnir.md

+ 4
- 4
docs/configuring-playbook-bot-draupnir.md Zobrazit soubor

@@ -92,6 +92,10 @@ To expose the APIs publicly, add the following configuration to your `vars.yml`
matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true
```

#### Obtain an access token for admin account

Manual access to Synapse's Admin APIs requires an access token for a homeserver admin account. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).

#### 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:
@@ -100,10 +104,6 @@ To discharge rate limiting, run the following command on systems that ship curl
curl --header "Authorization: Bearer <access_token>" -X POST https://matrix.example.com/_synapse/admin/v1/users/@bot.draupnir:example.com/override_ratelimit
```

### Obtain an access token

Manual access to Synapse's Admin APIs requires an access token. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).

### Abuse Reports

Draupnir can receive reports in the management room.


+ 4
- 2
docs/configuring-playbook-bot-mjolnir.md Zobrazit soubor

@@ -44,6 +44,10 @@ To expose the APIs publicly, add the following configuration to your `inventory/
matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true
```

#### Obtain an access token for admin account

Manual access to Synapse's Admin APIs requires an access token for a homeserver admin account. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md). If you have made Mjolnir an admin, you can just use the Mjolnir token.

#### 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:
@@ -52,8 +56,6 @@ To discharge rate limiting, run the following command on systems that ship curl
curl --header "Authorization: Bearer <access_token>" -X POST https://matrix.example.com/_synapse/admin/v1/users/@bot.mjolnir:example.com/override_ratelimit
```

You can obtain an access token for a homeserver admin account in the same way as you can do so for Mjolnir itself. If you have made Mjolnir an admin, you can just use the Mjolnir token.

### 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.


Načítá se…
Zrušit
Uložit