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>
This commit is contained in:
Suguru Hirahara
2025-01-19 13:08:08 +09:00
parent 3bd5ae8ddd
commit 163a2766cf
2 changed files with 8 additions and 6 deletions

View File

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