mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-23 13:05:47 +00:00
d4f8d0918a
Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3841 Most of the preparation for this was done by Suguru Hirahara (https://github.com/luixxiul). I've merely reorganized/polished the scripts and instructions in the `i18n/` directory. While translations can happen even now, more work is necessary to - make the translation flow better (integrating Weblate), etc. - restore the Github Actions workflows that Suguru Hirahara had already developed to adapt them to our new workflow
130 lines
5.9 KiB
Plaintext
130 lines
5.9 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
|
# Copyright (C) 2018-2024, 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: 2024-12-20 07:23+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 "Adjusting the playbook configuration"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:9
|
|
msgid "To enable Buscarron, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:32
|
|
msgid "Adjusting the Buscarron URL"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:34
|
|
msgid "By default, this playbook installs Buscarron on the `buscarron.` subdomain (`buscarron.example.com`) and requires you to [adjust your DNS records](#adjusting-dns-records)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:36
|
|
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:38
|
|
msgid "Example additional configuration for your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:49
|
|
msgid "Adjusting DNS records"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:51
|
|
msgid "Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the Buscarron domain to the Matrix server."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:53
|
|
msgid "By default, you will need to create a CNAME record for `buscarron`. See [Configuring DNS](configuring-dns.md) for details about DNS changes."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:55
|
|
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:57
|
|
msgid "Installing"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:59
|
|
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:66
|
|
msgid "**Notes**:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:68
|
|
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:70
|
|
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:72
|
|
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:74
|
|
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:76
|
|
msgid "Usage"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:78
|
|
msgid "To use the bot, invite the `@bot.buscarron:example.com` to the room you specified in a config, after that any point your form to the form url, example for the `contact` form:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:86
|
|
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:88
|
|
msgid "if you hit the homepage (HTTP `GET` request to `/`)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:89
|
|
msgid "if you submit a form to the wrong URL (`POST` request to `/non-existing-form`)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-buscarron.md:90
|
|
msgid "if `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:92
|
|
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:94
|
|
msgid "You can also refer to the upstream [documentation](https://github.com/etkecc/buscarron)."
|
|
msgstr ""
|