mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-29 04:17:17 +01:00
98 lines
5.1 KiB
Plaintext
98 lines
5.1 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 09:53+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-matrix-registration-bot.md:1
|
|
msgid "Setting up matrix-registration-bot (optional)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:3
|
|
msgid "The playbook can install and configure [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) for you."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:5
|
|
msgid "The bot allows you to easily **create and manage registration tokens** aka. invitation codes. It can be used for an invitation-based server, where you invite someone by sending them a registration token (tokens look like this: `rbalQ0zkaDSRQCOp`). They can register as per normal but have to provide a valid registration token in the final step of the registration process."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:7
|
|
msgid "See the project's [documentation](https://github.com/moan0s/matrix-registration-bot/blob/master/README.md) to learn what it does and why it might be useful to you."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:9
|
|
msgid "Configuration"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:11
|
|
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-matrix-registration-bot.md:30
|
|
msgid "The bot account will be created automatically."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:32
|
|
msgid "Installing"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:34
|
|
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:41
|
|
msgid "**Notes**:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:43
|
|
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:45
|
|
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-matrix-registration-bot.md:47
|
|
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-matrix-registration-bot.md:49
|
|
msgid "If you change the bot password (`matrix_bot_matrix_registration_bot_bot_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_matrix_registration_bot_bot_password` to let the bot know its new password."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:51
|
|
msgid "Usage"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:53
|
|
msgid "To use the bot, start a chat with `@bot.matrix-registration-bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:55
|
|
msgid "In this room send `help` and the bot will reply with all options."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:57
|
|
msgid "You can also refer to the upstream [Usage documentation](https://github.com/moan0s/matrix-registration-bot#supported-commands)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:59
|
|
msgid "If you have any questions, or if you need help setting it up, read the [troublshooting guide](https://github.com/moan0s/matrix-registration-bot/blob/main/docs/troubleshooting.md) or join [#matrix-registration-bot:hyteck.de](https://matrix.to/#/#matrix-registration-bot:hyteck.de)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:61
|
|
msgid "To clean the cache (session & encryption data) after you changed the bot's username, changed the login method from access_token to password etc… you can use:"
|
|
msgstr ""
|