From 0dc566f1a3643112d439d7a91d16fd6bbdc34d27 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 25 Jan 2025 22:28:15 +0900 Subject: [PATCH] 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`.