Browse Source

Apply suggestions from code review

Co-authored-by: Catalan Lover <48515417+FSG-Cat@users.noreply.github.com>
pull/3966/head
Suguru Hirahara 1 year ago
committed by GitHub
parent
commit
4c17f9cfff
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 4 deletions
  1. +2
    -2
      docs/configuring-playbook-bot-draupnir.md
  2. +2
    -2
      docs/configuring-playbook-bot-mjolnir.md

+ 2
- 2
docs/configuring-playbook-bot-draupnir.md View File

@@ -189,7 +189,7 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju

`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components ([Pantalaimon](#disable-pantalaimon-for-draupnir-since-v2-0-0), for example), you'd need to run `just setup-all`, or these components will still remain installed.

### Discharge rate limiting for Draupnir (recommended)
### Disable rate limiting for Draupnir (recommended)

If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a heavily recomended step. If you do not configure it, Draupnir performance will be degraded.**

@@ -219,7 +219,7 @@ Manual access to Synapse's Admin APIs requires an access token for a homeserver

#### Run the `curl` command

After applying the configuration to the server and obtaining the access token for the admin account, run the following command on systems that ship curl to discharge rate limiting.
After applying the configuration to the server and obtaining the access token for the admin account, run the following command on systems that ship curl to disable rate limiting.

Before running it, make sure to replace:
- `ADMIN_ACCESS_TOKEN_HERE` with the access token of the admin account


+ 2
- 2
docs/configuring-playbook-bot-mjolnir.md View File

@@ -147,7 +147,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

- If you change the Pantalaimon's password (`matrix_bot_mjolnir_pantalaimon_password` in your `vars.yml` file) subsequently, its credentials on the homeserver won't be updated automatically. If you'd like to change the password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_mjolnir_pantalaimon_password` to let Pantalaimon know its new password.

### Discharge rate limiting for Mjolnir
### Disable rate limiting for Mjolnir

If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a required step. If you do not configure it, Mjolnir will crash.**

@@ -179,7 +179,7 @@ If you have made Mjolnir an admin, you can just use the Mjolnir token.

#### Run the `curl` command

After applying the configuration to the server and obtaining the access token for the admin account, run the following command on systems that ship curl to discharge rate limiting.
After applying the configuration to the server and obtaining the access token for the admin account, run the following command on systems that ship curl to disable rate limiting.

Before running it, make sure to replace:
- `ADMIN_ACCESS_TOKEN_HERE` with the access token of the admin account


Loading…
Cancel
Save