mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2025-10-31 15:27:56 +01:00
170 lines
7.4 KiB
Plaintext
170 lines
7.4 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
|
# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members
|
|
# This file is distributed under the same license as the matrix-docker-ansible-deploy package.
|
|
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
|
#
|
|
#, fuzzy
|
|
msgid ""
|
|
msgstr ""
|
|
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
|
"Report-Msgid-Bugs-To: \n"
|
|
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
|
"MIME-Version: 1.0\n"
|
|
"Content-Type: text/plain; charset=UTF-8\n"
|
|
"Content-Transfer-Encoding: 8bit\n"
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:1
|
|
msgid "Setting up Buscarron (optional)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:3
|
|
msgid "The playbook can install and configure [Buscarron](https://github.com/etkecc/buscarron) for you."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:5
|
|
msgid "Buscarron is bot that receives HTTP POST submissions of web forms and forwards them to a Matrix room."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:7
|
|
msgid "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."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:9
|
|
msgid "Adjusting DNS records"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:11
|
|
msgid "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`."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:13
|
|
msgid "When setting, replace `example.com` with your own."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:15
|
|
msgid "Adjusting the playbook configuration"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:17
|
|
msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:40
|
|
msgid "Adjusting the Buscarron URL (optional)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:42
|
|
msgid "By tweaking the `matrix_bot_buscarron_hostname` and `matrix_bot_buscarron_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:44
|
|
msgid "Example additional configuration for your `vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:55
|
|
msgid "After changing the domain, **you may need to adjust your DNS** records to point the Buscarron domain to the Matrix server."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:57
|
|
msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:59
|
|
msgid "Extending the configuration"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:61
|
|
msgid "There are some additional things you may wish to configure about the bot."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:63
|
|
msgid "Take a look at:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:65
|
|
msgid "`roles/custom/matrix-bot-buscarron/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:67
|
|
msgid "Installing"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:69
|
|
msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:76
|
|
msgid "**Notes**:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:78
|
|
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:80
|
|
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:82
|
|
msgid "`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, you'd need to run `just setup-all`, or these components will still remain installed."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:84
|
|
msgid "If you change the bot password (`matrix_bot_buscarron_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_buscarron_password` to let the bot know its new password."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:86
|
|
msgid "Usage"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:88
|
|
msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.buscarron:example.com` where `example.com` is your base domain, not the `matrix.` domain)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:90
|
|
msgid "After the bot joins the room, anyone can call the web form via HTTP POST method."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:92
|
|
msgid "Here is an example for the `contact` form:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:100
|
|
msgid "**Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:102
|
|
msgid "you hit the homepage (HTTP `GET` request to `/`)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:103
|
|
msgid "you submit a form to the wrong URL (`POST` request to `/non-existing-form`)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:104
|
|
msgid "`hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:106
|
|
msgid "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."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:108
|
|
msgid "Troubleshooting"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:110
|
|
msgid "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`."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:112
|
|
msgid "Increase logging verbosity"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:114
|
|
msgid "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:"
|
|
msgstr ""
|