From 6c19bf509e7924f6ad792ec31a3b5628bc97915d Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 26 Dec 2024 12:02:03 -0500 Subject: [PATCH 1/3] Update docs/configuring-playbook-bot-buscarron.md: add the section "Extending the configuration" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-buscarron.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md index c7ed4f69d..691aa2468 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -54,6 +54,14 @@ After changing the domain, **you may need to adjust your DNS** records to point If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration. +### Extending the configuration + +There are some additional things you may wish to configure about the bot. + +Take a look at: + +- `roles/custom/matrix-bot-buscarron/defaults/main.yml` for some variables that you can customize via your `vars.yml` file + ## Installing After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: From 2a7111f287b011da7d88cf2be5462956f8e33f6d Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 25 Jan 2025 22:24:32 +0900 Subject: [PATCH 2/3] Update docs/configuring-playbook-bot-buscarron.md: add the common section "Troubleshooting" See roles/custom/matrix-bot-buscarron/defaults/main.yml at 601406ddda79b1ea4dd50ffe38d65ddada5ee62b for the default log value (INFO). Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-buscarron.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md index 691aa2468..f74bf2ea8 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -104,3 +104,15 @@ Here is an example for the `contact` form: If you get banned, you'd need to restart the process by running the playbook with `--tags=start` or running `systemctl restart matrix-bot-buscarron` on the server. You can also refer to the upstream [documentation](https://github.com/etkecc/buscarron). + +## 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-buscarron`. + +### 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 +matrix_bot_buscarron_loglevel: DEBUG +``` From 0dc566f1a3643112d439d7a91d16fd6bbdc34d27 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 25 Jan 2025 22:28:15 +0900 Subject: [PATCH 3/3] Update docs/configuring-playbook-bot-buscarron.md: add the common expression for linking to the documentation Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-buscarron.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md index f74bf2ea8..e2762ed94 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -4,6 +4,8 @@ The playbook can install and configure [Buscarron](https://github.com/etkecc/bus Buscarron is bot that receives HTTP POST submissions of web forms and forwards them to a Matrix room. +See the project's [documentation](https://github.com/etkecc/buscarron/blob/main/README.md) to learn what it does and why it might be useful to you. + ## Adjusting DNS records By default, this playbook installs Buscarron on the `buscarron.` subdomain (`buscarron.example.com`) and requires you to create a CNAME record for `buscarron`, which targets `matrix.example.com`. @@ -103,8 +105,6 @@ Here is an example for the `contact` form: If you get banned, you'd need to restart the process by running the playbook with `--tags=start` or running `systemctl restart matrix-bot-buscarron` on the server. -You can also refer to the upstream [documentation](https://github.com/etkecc/buscarron). - ## 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-buscarron`.