Просмотр исходного кода

Update docs/configuring-playbook-mautrix-bridges.md: move the section "Set up Double Puppeting" to "Usage"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3913/head
Suguru Hirahara 1 год назад
Родитель
Сommit
caee3737c5
Не найден GPG ключ соответствующий данной подписи Идентификатор GPG ключа: E4F9743DAB4B7B75
1 измененных файлов: 9 добавлений и 9 удалений
  1. +9
    -9
      docs/configuring-playbook-mautrix-bridges.md

+ 9
- 9
docs/configuring-playbook-mautrix-bridges.md Просмотреть файл

@@ -129,7 +129,15 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

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

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

To use the bridge, you need to start a chat with `@SERVICENAMEbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).

Send `login` to the bridge bot to get started. You can learn more here about authentication from the bridge's official documentation on Authentication: https://docs.mau.fi/bridges/python/SERVICENAME/authentication.html

If you run into trouble, check the [Troubleshooting](#troubleshooting) section below.

### Set up Double Puppeting (optional)

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.

@@ -141,14 +149,6 @@ 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.

## Usage

To use the bridge, you need to start a chat with `@SERVICENAMEbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).

Send `login` to the bridge bot to get started. You can learn more here about authentication from the bridge's official documentation on Authentication: https://docs.mau.fi/bridges/python/SERVICENAME/authentication.html

If you run into trouble, check the [Troubleshooting](#troubleshooting) section below.

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


Загрузка…
Отмена
Сохранить