mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2025-10-31 15:27:56 +01:00
154 lines
6.9 KiB
Plaintext
154 lines
6.9 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-go-neb.md:1
|
|
msgid "Setting up Go-NEB (optional, unmaintained)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:3
|
|
msgid "**Note**: [Go-NEB](https://github.com/matrix-org/go-neb) is now an archived (**unmaintained**) project. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bot instead of this one."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:5
|
|
msgid "The playbook can install and configure [Go-NEB](https://github.com/matrix-org/go-neb) for you."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:7
|
|
msgid "Go-NEB is a Matrix bot written in Go. It is the successor to Matrix-NEB, the original Matrix bot written in Python."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:9
|
|
msgid "See the project's [documentation](https://github.com/matrix-org/go-neb/blob/master/README.md) to learn what it does and why it might be useful to you."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:11
|
|
msgid "Prerequisites"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:13
|
|
msgid "Register the bot account"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:15
|
|
msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:17
|
|
msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:19
|
|
msgid "You can use the playbook to [register a new user](registering-users.md):"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:25
|
|
msgid "Obtain an access token"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:27
|
|
msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:29
|
|
msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:32
|
|
msgid "Adjusting DNS records"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:34
|
|
msgid "By default, this playbook installs Go-NEB on the `goneb.` subdomain (`goneb.example.com`) and requires you to create a CNAME record for `goneb`, which targets `matrix.example.com`."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:36
|
|
msgid "When setting, replace `example.com` with your own."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:38
|
|
msgid "Adjusting the playbook configuration"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:40
|
|
msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_FOR_GONEB_HERE` and `ACCESS_TOKEN_FOR_ANOTHER_GONEB_HERE` with the ones created [above](#obtain-an-access-token)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:204
|
|
msgid "Adjusting the Go-NEB URL (optional)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:206
|
|
msgid "By tweaking the `matrix_bot_go_neb_hostname` and `matrix_bot_go_neb_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-go-neb.md:208
|
|
msgid "Example additional configuration for your `vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:219
|
|
msgid "After changing the domain, **you may need to adjust your DNS** records to point the Go-NEB domain to the Matrix server."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:221
|
|
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-go-neb.md:223
|
|
msgid "Installing"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:225
|
|
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-go-neb.md:232
|
|
msgid "**Notes**:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:234
|
|
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:236
|
|
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-go-neb.md:238
|
|
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-go-neb.md:240
|
|
msgid "Usage"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:242
|
|
msgid "To use the bot, invite it to any existing Matrix room (`/invite @bot.go-neb:example.com` where `example.com` is your base domain, not the `matrix.` domain). Make sure you are granted with the sufficient permission if you are not the room owner."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:244
|
|
msgid "Basic usage is like this: `!echo hi` or `!imgur puppies` or `!giphy matrix`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:246
|
|
msgid "If you enabled the github_cmd service, send `!github help` to the bot in the room to see the available commands."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bot-go-neb.md:248
|
|
msgid "You can also refer to the upstream [Documentation](https://github.com/matrix-org/go-neb)."
|
|
msgstr ""
|