Browse Source

Update files for Mjolnir: add the common section "Troubleshooting"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/4020/head
Suguru Hirahara 1 year ago
parent
commit
42694883e6
No known key found for this signature in database GPG Key ID: E4F9743DAB4B7B75
2 changed files with 16 additions and 3 deletions
  1. +14
    -0
      docs/configuring-playbook-bot-mjolnir.md
  2. +2
    -3
      roles/custom/matrix-bot-mjolnir/templates/production.yaml.j2

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

@@ -194,3 +194,17 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
## Usage

You can refer to the upstream [documentation](https://github.com/matrix-org/mjolnir) for additional ways to use and configure Mjolnir. Check out their [quickstart guide](https://github.com/matrix-org/mjolnir#quickstart-guide) for some basic commands you can give to the bot.

## Troubleshooting

As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-mjolnir`.

### Increase logging verbosity

The default logging level for this component is `INFO`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:

```yaml
# Valid values: ERROR, WARN, INFO, DEBUG
matrix_bot_mjolnir_configuration_extension_yaml: |
logLevel: "DEBUG"
```

+ 2
- 3
roles/custom/matrix-bot-mjolnir/templates/production.yaml.j2 View File

@@ -57,10 +57,9 @@ managementRoom: {{ matrix_bot_mjolnir_management_room | to_json }}
# mainly involves "all-OK" messages, and debugging messages for when mjolnir checks bans in a room.
verboseLogging: false

# The log level of terminal (or container) output,
# can be one of DEBUG, INFO, WARN and ERROR, in increasing order of importance and severity.
# The log level of terminal (or container) output.
#
# This should be at INFO or DEBUG in order to get support for Mjolnir problems.
# Valid values: ERROR, WARN, INFO, DEBUG
logLevel: "INFO"

# Whether or not Mjolnir should synchronize policy lists immediately after startup.


Loading…
Cancel
Save