mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-22 20:45:48 +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
194 lines
8.8 KiB
Plaintext
194 lines
8.8 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-bridge-mautrix-signal.md:1
|
|
msgid "Setting up Mautrix Signal bridging (optional)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:3
|
|
msgid "The playbook can install and configure [mautrix-signal](https://github.com/mautrix/signal) for you."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:5
|
|
msgid "See the project's [documentation](https://docs.mau.fi/bridges/python/signal/index.html) to learn what it does and why it might be useful to you."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:7
|
|
msgid "**Note**: This revamped version of the [mautrix-signal (legacy)](configuring-playbook-bridge-mautrix-signal.md) may increase the CPU usage of your homeserver."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:9
|
|
msgid "Prerequisites (optional)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:11
|
|
msgid "Prepare Postgres database on external Postgres server"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:13
|
|
msgid "If you're running with the Postgres database server integrated by the playbook (which is the default), you don't need to do anything special and can easily proceed with installing."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:15
|
|
msgid "However, if you're [using an external Postgres server](configuring-playbook-external-postgres.md), you'd need to manually prepare a Postgres database for this bridge and adjust the variables related to that (`matrix_mautrix_signal_database_*`)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:17
|
|
msgid "Enable Appservice Double Puppet"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:19
|
|
msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:21
|
|
msgid "For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:23
|
|
msgid "Adjusting the playbook configuration"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:25
|
|
msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:31
|
|
msgid "There are some additional things you may wish to configure about the bridge before you continue."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:33
|
|
msgid "By default, any user on your homeserver will be able to use the bridge."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:35
|
|
msgid "Different levels of permission can be granted to users:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:37
|
|
msgid "relay - Allowed to be relayed through the bridge, no access to commands;"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:38
|
|
msgid "user - Use the bridge with puppeting;"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:39
|
|
msgid "admin - Use and administer the bridge."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:41
|
|
msgid "The permissions are following the sequence: nothing < relay < user < admin."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:43
|
|
msgid "The default permissions are set as follows:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:51
|
|
msgid "If you want to augment the preset permissions, you might want to set the additional permissions with the following settings in your `vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:60
|
|
msgid "This will add the admin permission to the specific user, while keeping the default permissions."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:62
|
|
msgid "In case you want to replace the default permissions settings **completely**, populate the following item within your `vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:70
|
|
msgid "You may wish to look at `roles/custom/matrix-bridge-mautrix-signal/templates/config.yaml.j2` to find more information on the permissions settings and other options you would like to configure."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:72
|
|
msgid "Installing"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:74
|
|
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:81
|
|
msgid "**Notes**:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:83
|
|
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:85
|
|
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:87
|
|
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-bridge-mautrix-signal.md:89
|
|
msgid "Usage"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:91
|
|
msgid "To use the bridge, you need to start a chat with `@signalbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:93
|
|
msgid "💡 Set up Double Puppeting"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:95
|
|
msgid "After successfully enabling bridging, you may wish to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:97
|
|
msgid "To set it up, you have 2 ways of going about it."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:99
|
|
msgid "Method 1: automatically, by enabling Appservice Double Puppet"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:101
|
|
msgid "The bridge automatically performs Double Puppeting if [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service is configured and enabled on the server for this playbook."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:103
|
|
msgid "This is the recommended way of setting up Double Puppeting, as it's easier to accomplish, works for all your users automatically, and has less of a chance of breaking in the future."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:105
|
|
msgid "Method 2: manually, by asking each user to provide a working access token"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:107
|
|
msgid "When using this method, **each user** that wishes to enable Double Puppeting needs to follow the following steps:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:109
|
|
msgid "retrieve a Matrix access token for yourself. Refer to the documentation on [how to do that](obtaining-access-tokens.md)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:111
|
|
msgid "send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:113
|
|
msgid "make sure you don't log out the `Mautrix-Signal` device some time in the future, as that would break the Double Puppeting feature"
|
|
msgstr ""
|