Преглед изворни кода

Update docs/configuring-playbook-bridge-mautrix-bridges.md: add the manual step for setting up Double Puppetting

Based on other documents for mautrix bridges like docs/configuring-playbook-bridge-mautrix-discord.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3913/head
Suguru Hirahara пре 1 година
родитељ
комит
3331b35627
No known key found for this signature in database GPG Key ID: E4F9743DAB4B7B75
1 измењених фајлова са 18 додато и 0 уклоњено
  1. +18
    -0
      docs/configuring-playbook-bridge-mautrix-bridges.md

+ 18
- 0
docs/configuring-playbook-bridge-mautrix-bridges.md Прегледај датотеку

@@ -139,6 +139,12 @@ If you run into trouble, check the [Troubleshooting](#troubleshooting) section b


### Set up Double Puppeting (optional) ### Set up Double Puppeting (optional)


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).

To set it up, you have 2 ways of going about it.

#### Method 1: automatically, by enabling Appservice Double Puppet (or Shared Secret Auth)

To set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook. To set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook.


The bridge automatically performs Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) is configured and enabled on the server for this playbook by adding the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: The bridge automatically performs Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) is configured and enabled on the server for this playbook by adding the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
@@ -149,6 +155,18 @@ matrix_appservice_double_puppet_enabled: true


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. 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.


Enabling the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service works for some bridges at the time of writing, but is deprecated and will stop working in the future.

#### Method 2: manually, by asking each user to provide a working access token

When using this method, **each user** that wishes to enable Double Puppeting needs to follow the following steps:

- retrieve a Matrix access token for yourself. Refer to the documentation on [how to obtain one](obtaining-access-tokens.md).

- send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE`

- make sure you don't log out the session for which you obtained an access token some time in the future, as that would break the Double Puppeting feature

## Troubleshooting ## Troubleshooting


For troubleshooting information with a specific bridge, please see the playbook documentation about it (some other document in in `docs/`) and the upstream ([mautrix](https://github.com/mautrix)) bridge documentation for that specific bridge. For troubleshooting information with a specific bridge, please see the playbook documentation about it (some other document in in `docs/`) and the upstream ([mautrix](https://github.com/mautrix)) bridge documentation for that specific bridge.


Loading…
Откажи
Сачувај