diff --git a/docs/configuring-playbook-bridge-appservice-kakaotalk.md b/docs/configuring-playbook-bridge-appservice-kakaotalk.md index 88f8bfbd1..72b8e61d7 100644 --- a/docs/configuring-playbook-bridge-appservice-kakaotalk.md +++ b/docs/configuring-playbook-bridge-appservice-kakaotalk.md @@ -6,8 +6,13 @@ The playbook can install and configure [matrix-appservice-kakaotalk](https://src See the project's [documentation](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) to learn what it does and why it might be useful to you. +## Prerequisite (optional) -## Installing +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 [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) + +## Adjusting the playbook configuration To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: @@ -17,17 +22,6 @@ matrix_appservice_kakaotalk_enabled: true You may optionally wish to add some [Additional configuration](#additional-configuration), or to [prepare for double-puppeting](#set-up-double-puppeting) before the initial installation. -## Installing - -After configuring the playbook, run the [installation](installing.md) command: - -```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start -``` - -To make use of the Kakaotalk bridge, see [Usage](#usage) below. - - ### Additional configuration There are some additional things you may wish to configure about the bridge. @@ -37,21 +31,34 @@ Take a look at: - `roles/custom/matrix-bridge-appservice-kakaotalk/defaults/main.yml` for some variables that you can customize via your `vars.yml` file - `roles/custom/matrix-bridge-appservice-kakaotalk/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_kakaotalk_configuration_extension_yaml` variable +## Installing -### Set up Double Puppeting +After configuring the playbook, run the [installation](installing.md) command: -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +## Usage + +Start a chat with `@kakaotalkbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). + +Send `login --save EMAIL_OR_PHONE_NUMBER` to the bridge bot to enable bridging for your Kakaotalk account. The `--save` flag may be omitted, if you'd rather not save your password. + +### 💡 Set up Double Puppeting + +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 Shared Secret Auth -The bridge will automatically perform Double Puppeting if you enable [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook. +The bridge automatically performs Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook. 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. #### Method 2: manually, by asking each user to provide a working access token -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)). - 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 do that](obtaining-access-tokens.md). @@ -59,12 +66,3 @@ When using this method, **each user** that wishes to enable Double Puppeting nee - send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE` - make sure you don't log out the `Appservice-Kakaotalk` device some time in the future, as that would break the Double Puppeting feature - - -## Usage - -Start a chat with `@kakaotalkbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). - -Send `login --save EMAIL_OR_PHONE_NUMBER` to the bridge bot to enable bridging for your Kakaotalk account. The `--save` flag may be omitted, if you'd rather not save your password. - -After successfully enabling bridging, you may wish to [set up Double Puppeting](#set-up-double-puppeting), if you haven't already done so. diff --git a/docs/configuring-playbook-bridge-beeper-linkedin.md b/docs/configuring-playbook-bridge-beeper-linkedin.md index fb6591043..67133e50d 100644 --- a/docs/configuring-playbook-bridge-beeper-linkedin.md +++ b/docs/configuring-playbook-bridge-beeper-linkedin.md @@ -39,7 +39,7 @@ After configuring the playbook, run the [installation](installing.md) command: ` ## Set up Double Puppeting by enabling Appservice Double Puppet or Shared Secret Auth -The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service or the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook. +The bridge automatically performs Double Puppeting if [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook. Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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. diff --git a/docs/configuring-playbook-bridge-mautrix-discord.md b/docs/configuring-playbook-bridge-mautrix-discord.md index be5eb3969..4938a975e 100644 --- a/docs/configuring-playbook-bridge-mautrix-discord.md +++ b/docs/configuring-playbook-bridge-mautrix-discord.md @@ -15,6 +15,12 @@ There are 2 ways to login to discord using this bridge, either by [scanning a QR If this is a dealbreaker for you, consider using one of the other Discord bridges supported by the playbook: [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) or [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md). These come with their own complexity and limitations, however, so we recommend that you proceed with this one if possible. +### Enable Appservice Double Puppet or Shared Secret Auth (optional) + +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) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) + ## Adjusting the playbook configuration To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: @@ -25,17 +31,6 @@ matrix_mautrix_discord_enabled: true You may optionally wish to add some [Additional configuration](#additional-configuration), or to [prepare for double-puppeting](#set-up-double-puppeting) before the initial installation. -## Installing - -After configuring the playbook, run the [installation](installing.md) command: - -```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start -``` - -To make use of the bridge, see [Usage](#usage) below. - - ### Additional configuration There are some additional things you may wish to configure about the bridge. @@ -45,31 +40,13 @@ Take a look at: - `roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml` for some variables that you can customize via your `vars.yml` file - `roles/custom/matrix-bridge-mautrix-discord/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_mautrix_discord_configuration_extension_yaml` variable +## Installing -### Set up Double Puppeting - -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. - -#### Method 1: automatically, by enabling Appservice Double Puppet or Shared Secret Auth - -The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service or the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook. - -Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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 double puppeting by enabling the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service works 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 - -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)). - -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 do that](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 `Mautrix-Discord` device some time in the future, as that would break the Double Puppeting feature +After configuring the playbook, run the [installation](installing.md) command: +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` ## Usage @@ -97,3 +74,27 @@ To acquire the token, open Discord in a private browser window. Then open the de - send `guilds status` to see the list of guilds - for each guild that you'd like bridged, send `guilds bridge GUILD_ID --entire` 8. You may wish to uninstall the Discord app from your phone now. It's not needed for the bridge to function. + +### 💡 Set up Double Puppeting + +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 + +The bridge automatically performs Double Puppeting if [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook. + +Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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 double puppeting by enabling the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service works 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 do that](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 `Mautrix-Discord` device some time in the future, as that would break the Double Puppeting feature diff --git a/docs/configuring-playbook-bridge-mautrix-facebook.md b/docs/configuring-playbook-bridge-mautrix-facebook.md index 0741d9f6e..77bc5447d 100644 --- a/docs/configuring-playbook-bridge-mautrix-facebook.md +++ b/docs/configuring-playbook-bridge-mautrix-facebook.md @@ -6,6 +6,12 @@ The playbook can install and configure [mautrix-facebook](https://github.com/mau See the project's [documentation](https://github.com/mautrix/facebook/blob/master/ROADMAP.md) to learn what it does and why it might be useful to you. +## Prerequisite (optional) + +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 [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) + ## Adjusting the playbook configuration To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: @@ -51,29 +57,6 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-facebook/templates/c After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` -## Set up Double Puppeting - -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. - -### Method 1: automatically, by enabling Shared Secret Auth - -The bridge will automatically perform Double Puppeting if you enable [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook. - -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. - -### Method 2: manually, by asking each user to provide a working access token - -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)). - -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 do that](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 `Mautrix-Facebook` device some time in the future, as that would break the Double Puppeting feature - - ## Usage You then need to start a chat with `@facebookbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). @@ -82,8 +65,27 @@ Send `login YOUR_FACEBOOK_EMAIL_ADDRESS` to the bridge bot to enable bridging fo If you run into trouble, check the [Troubleshooting](#troubleshooting) section below. -After successfully enabling bridging, you may wish to [set up Double Puppeting](#set-up-double-puppeting), if you haven't already done so. +### 💡 Set up Double Puppeting +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 Shared Secret Auth + +The bridge automatically performs Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook. + +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. + +#### 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 do that](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 `Mautrix-Facebook` device some time in the future, as that would break the Double Puppeting feature ## Troubleshooting diff --git a/docs/configuring-playbook-bridge-mautrix-gmessages.md b/docs/configuring-playbook-bridge-mautrix-gmessages.md index d4913bb11..00984faf5 100644 --- a/docs/configuring-playbook-bridge-mautrix-gmessages.md +++ b/docs/configuring-playbook-bridge-mautrix-gmessages.md @@ -4,6 +4,12 @@ The playbook can install and configure [mautrix-gmessages](https://github.com/ma See the project's [documentation](https://docs.mau.fi/bridges/go/gmessages/index.html) to learn what it does and why it might be useful to you. +## Prerequisite (optional) + +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) for this playbook. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) + ## Adjusting the playbook configuration To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: @@ -16,19 +22,23 @@ matrix_mautrix_gmessages_enabled: true After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` -## Set up Double Puppeting +## Usage -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. +You then need to start a chat with `@gmessagesbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). -### Method 1: automatically, by enabling Appservice Double Puppet +### 💡 Set up Double Puppeting -The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook. +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). -Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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. +To set it up, you have 2 ways of going about it. -### Method 2: manually, by asking each user to provide a working access token +#### Method 1: automatically, by enabling Appservice Double Puppet -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)). +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. + +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. + +#### 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: @@ -37,8 +47,3 @@ When using this method, **each user** that wishes to enable Double Puppeting nee - send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE` - make sure you don't log out the `Mautrix-gmessages` device some time in the future, as that would break the Double Puppeting feature - - -## Usage - -You then need to start a chat with `@gmessagesbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-googlechat.md b/docs/configuring-playbook-bridge-mautrix-googlechat.md index 505fecd41..0569276b6 100644 --- a/docs/configuring-playbook-bridge-mautrix-googlechat.md +++ b/docs/configuring-playbook-bridge-mautrix-googlechat.md @@ -4,6 +4,12 @@ The playbook can install and configure [mautrix-googlechat](https://github.com/m See the project's [documentation](https://docs.mau.fi/bridges/python/googlechat/index.html) to learn what it does and why it might be useful to you. +## Prerequisite (optional) + +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) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) + ## Adjusting the playbook configuration To enable the [Google Chat](https://chat.google.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: @@ -16,32 +22,6 @@ matrix_mautrix_googlechat_enabled: true After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` -## Set up Double Puppeting - -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. - -### Method 1: automatically, by enabling Appservice Double Puppet or Shared Secret Auth - -The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service or the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook. - -Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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 double puppeting by enabling the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service works 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 - -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)). - -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 do that](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 `Mautrix-googlechat` device some time in the future, as that would break the Double Puppeting feature - - ## Usage Once the bot is enabled you need to start a chat with `googlechat bridge bot` with handle `@googlechatbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). @@ -54,4 +34,27 @@ Once logged in, recent chats should show up as new conversations automatically. You can learn more about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/googlechat/authentication.html). -After successfully enabling bridging, you may wish to [set up Double Puppeting](#set-up-double-puppeting), if you haven't already done so. +### 💡 Set up Double Puppeting + +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 + +The bridge automatically performs Double Puppeting if [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook. + +Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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 double puppeting by enabling the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service works 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 do that](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 `Mautrix-googlechat` device some time in the future, as that would break the Double Puppeting feature diff --git a/docs/configuring-playbook-bridge-mautrix-hangouts.md b/docs/configuring-playbook-bridge-mautrix-hangouts.md index 3a4a11736..26177adf0 100644 --- a/docs/configuring-playbook-bridge-mautrix-hangouts.md +++ b/docs/configuring-playbook-bridge-mautrix-hangouts.md @@ -6,6 +6,12 @@ The playbook can install and configure [mautrix-hangouts](https://github.com/mau See the project's [documentation](https://docs.mau.fi/bridges/python/hangouts/index.html) to learn what it does and why it might be useful to you. +## Prerequisite (optional) + +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 [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) + ## Adjusting the playbook configuration To enable the [Google Hangouts](https://hangouts.google.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: @@ -18,30 +24,6 @@ matrix_mautrix_hangouts_enabled: true After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` -## Set up Double Puppeting - -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. - -### Method 1: automatically, by enabling Shared Secret Auth - -The bridge will automatically perform Double Puppeting if you enable [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook. - -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. - - -### Method 2: manually, by asking each user to provide a working access token - -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)). - -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 do that](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 `Mautrix-Hangouts` device some time in the future, as that would break the Double Puppeting feature - - ## Usage Once the bot is enabled you need to start a chat with `Hangouts bridge bot` with handle `@hangoutsbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). @@ -54,4 +36,24 @@ Once logged in, recent chats should show up as new conversations automatically. You can learn more about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/hangouts/authentication.html). -After successfully enabling bridging, you may wish to [set up Double Puppeting](#set-up-double-puppeting), if you haven't already done so. +### 💡 Set up Double Puppeting + +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 Shared Secret Auth + +The bridge automatically performs Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook. + +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. + +#### 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 do that](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 `Mautrix-Hangouts` device some time in the future, as that would break the Double Puppeting feature diff --git a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md index 9b2b44313..cb39b400d 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md @@ -6,8 +6,9 @@ Since this bridge component can bridge to both [Messenger](https://messenger.com This documentation page only deals with the bridge's ability to bridge to Instagram. For bridging to Facebook/Messenger, see [Setting up Messenger bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-messenger.md). +## Prerequisites -## Migrating from the old mautrix-instagram bridge +### Migrating from the old mautrix-instagram bridge If you've been using the [mautrix-instagram](./configuring-playbook-bridge-mautrix-instagram.md) bridge, **you'd better get rid of it first** or the 2 bridges will be in conflict: @@ -18,6 +19,11 @@ To do so, send a `clean-rooms` command to the management room with the old bridg Then, consider disabling the old bridge in your configuration, so it won't recreate the portals when you receive new messages. +### Enable Appservice Double Puppet (optional) + +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. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) ## Adjusting the playbook configuration @@ -64,19 +70,23 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-meta-instagram/templ After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` -## Set up Double Puppeting +## Usage -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. +You then need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). -### Method 1: automatically, by enabling Appservice Double Puppet +### 💡 Set up Double Puppeting -The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook. +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). -Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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. +To set it up, you have 2 ways of going about it. -### Method 2: manually, by asking each user to provide a working access token +#### Method 1: automatically, by enabling Appservice Double Puppet -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)). +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. + +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. + +#### 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: @@ -85,8 +95,3 @@ When using this method, **each user** that wishes to enable Double Puppeting nee - 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 - - -## Usage - -You then need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md index 571805bbe..ab788408c 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md @@ -6,8 +6,9 @@ Since this bridge component can bridge to both [Messenger](https://messenger.com This documentation page only deals with the bridge's ability to bridge to Facebook Messenger. For bridging to Instagram, see [Setting up Instagram bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-instagram.md). +## Prerequisites -## Migrating from the old mautrix-facebook bridge +### Migrating from the old mautrix-facebook bridge If you've been using the [mautrix-facebook](./configuring-playbook-bridge-mautrix-facebook.md) bridge, it's possible to migrate the database using [instructions from the bridge documentation](https://docs.mau.fi/bridges/go/meta/facebook-migration.html) (advanced). @@ -17,6 +18,12 @@ Then, consider disabling the old bridge in your configuration, so it won't recre **Note**: the user ID of the new bridge bot is `@messengerbot:example.com`, not `@facebookbot:example.com`. After disabling the old bridge, its bot user will stop responding to a command. +### Enable Appservice Double Puppet (optional) + +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. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) + ## Adjusting the playbook configuration To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: @@ -77,19 +84,27 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-meta-messenger/templ After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` -## Set up Double Puppeting +## Usage -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. +You then need to start a chat with `@messengerbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). Note that the user ID of the bridge's bot is not `@facebookbot:example.com`. -### Method 1: automatically, by enabling Appservice Double Puppet +You then need to send a `login` command and follow the bridge bot's instructions. -The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook. +Given that the bot is configured in `messenger` [bridge mode](#bridge-mode) by default, you will need to log in to [messenger.com](https://messenger.com/) (not `facebook.com`!) and obtain the cookies from there as per [the bridge's authentication instructions](https://docs.mau.fi/bridges/go/meta/authentication.html). -Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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. +### 💡 Set up Double Puppeting -### Method 2: manually, by asking each user to provide a working access token +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). -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)). +To set it up, you have 2 ways of going about it. + +#### Method 1: automatically, by enabling Appservice Double Puppet + +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. + +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. + +#### 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: @@ -98,12 +113,3 @@ When using this method, **each user** that wishes to enable Double Puppeting nee - 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 - - -## Usage - -You then need to start a chat with `@messengerbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). Note that the user ID of the bridge's bot is not `@facebookbot:example.com`. - -You then need to send a `login` command and follow the bridge bot's instructions. - -Given that the bot is configured in `messenger` [bridge mode](#bridge-mode) by default, you will need to log in to [messenger.com](https://messenger.com/) (not `facebook.com`!) and obtain the cookies from there as per [the bridge's authentication instructions](https://docs.mau.fi/bridges/go/meta/authentication.html). diff --git a/docs/configuring-playbook-bridge-mautrix-signal.md b/docs/configuring-playbook-bridge-mautrix-signal.md index 07b9638ac..3b486d171 100644 --- a/docs/configuring-playbook-bridge-mautrix-signal.md +++ b/docs/configuring-playbook-bridge-mautrix-signal.md @@ -4,10 +4,22 @@ The playbook can install and configure [mautrix-signal](https://github.com/mautr 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. -**Note/Prerequisite**: 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. 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_*`). - **Note**: This revamped version of the [mautrix-signal (legacy)](configuring-playbook-bridge-mautrix-signal.md) may increase the CPU usage of your homeserver. +## Prerequisites (optional) + +### Prepare Postgres database on external Postgres server + +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. + +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_*`). + +### Enable Appservice Double Puppet + +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. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) + ## Adjusting the playbook configuration To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: @@ -58,19 +70,23 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-signal/templates/con After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` -## Set up Double Puppeting +## Usage -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. +You then need to start a chat with `@signalbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). -### Method 1: automatically, by enabling Appservice Double Puppet +### 💡 Set up Double Puppeting -The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook. +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 + +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. 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. -### Method 2: manually, by asking each user to provide a working access token - -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)). +#### 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: @@ -79,8 +95,3 @@ When using this method, **each user** that wishes to enable Double Puppeting nee - send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE` - make sure you don't log out the `Mautrix-Signal` device some time in the future, as that would break the Double Puppeting feature - - -## Usage - -You then need to start a chat with `@signalbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-slack.md b/docs/configuring-playbook-bridge-mautrix-slack.md index 9065ec0b4..1653dd816 100644 --- a/docs/configuring-playbook-bridge-mautrix-slack.md +++ b/docs/configuring-playbook-bridge-mautrix-slack.md @@ -17,6 +17,11 @@ For using this bridge, you would need to authenticate by **providing your userna Note that neither of these methods are officially supported by Slack. [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) uses a Slack bot account which is the only officially supported method for bridging a Slack channel. +### Enable Appservice Double Puppet (optional) + +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. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) ## Adjusting the playbook configuration @@ -28,17 +33,6 @@ matrix_mautrix_slack_enabled: true You may optionally wish to add some [Additional configuration](#additional-configuration), or to [prepare for double-puppeting](#set-up-double-puppeting) before the initial installation. -## Installing - -After configuring the playbook, run the [installation](installing.md) command: - -```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start -``` - -To make use of the bridge, see [Usage](#usage) below. - - ### Additional configuration There are some additional options you may wish to configure with the bridge. @@ -48,29 +42,13 @@ Take a look at: - `roles/custom/matrix-bridge-mautrix-slack/defaults/main.yml` for some variables that you can customize via your `vars.yml` file - `roles/custom/matrix-bridge-mautrix-slack/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_mautrix_slack_configuration_extension_yaml` variable +## Installing -### Set up Double Puppeting - -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. - -#### Method 1: automatically, by enabling Appservice Double Puppet - -The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook. - -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. - -#### Method 2: manually, by asking each user to provide a working access token - -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)). - -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 do that](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 `Mautrix-Slack` device some time in the future, as that would break the Double Puppeting feature +After configuring the playbook, run the [installation](installing.md) command: +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` ## Usage @@ -79,3 +57,25 @@ When using this method, **each user** that wishes to enable Double Puppeting nee 3. The bot should respond with "Successfully logged into for team " 4. Now that you're logged in, you can send a `help` command to the bot again, to see additional commands you have access to. 5. Slack channels should automatically begin bridging if you authenticated using a token. Otherwise, you must wait to receive a message in the channel if you used password authentication. + +### 💡 Set up Double Puppeting + +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 + +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. + +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. + +#### 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 do that](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 `Mautrix-Slack` device some time in the future, as that would break the Double Puppeting feature diff --git a/docs/configuring-playbook-bridge-mautrix-telegram.md b/docs/configuring-playbook-bridge-mautrix-telegram.md index 344a45c31..7c1426ff8 100644 --- a/docs/configuring-playbook-bridge-mautrix-telegram.md +++ b/docs/configuring-playbook-bridge-mautrix-telegram.md @@ -4,6 +4,12 @@ The playbook can install and configure [mautrix-telegram](https://github.com/mau See the project's [documentation](https://docs.mau.fi/bridges/python/telegram/index.html) to learn what it does and why it might be useful to you. +## Prerequisite (optional) + +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) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) + ## Adjusting the playbook configuration You'll need to obtain API keys from [https://my.telegram.org/apps](https://my.telegram.org/apps) and then add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: @@ -18,31 +24,6 @@ matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` -## Set up Double Puppeting - -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. - -### Method 1: automatically, by enabling Appservice Double Puppet or Shared Secret Auth - -The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service or the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook. - -Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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 double puppeting by enabling the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service works 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 - -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging. - -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 do that](obtaining-access-tokens.md). - -- send `login-matrix` to the bot and follow instructions about how to send the access token to it - -- make sure you don't log out the `Mautrix-Telegram` device some time in the future, as that would break the Double Puppeting feature - - ## Usage You then need to start a chat with `@telegrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). @@ -71,3 +52,29 @@ If you like to exclude all groups from syncing and use the Telgeram-Bridge only ```yaml matrix_mautrix_telegram_filter_mode: whitelist ``` + +### 💡 Set up Double Puppeting + +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 + +The bridge automatically performs Double Puppeting if [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook. + +Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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 double puppeting by enabling the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service works 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 + +**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging. + +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 do that](obtaining-access-tokens.md). + +- send `login-matrix` to the bot and follow instructions about how to send the access token to it + +- make sure you don't log out the `Mautrix-Telegram` device some time in the future, as that would break the Double Puppeting feature diff --git a/docs/configuring-playbook-bridge-mautrix-twitter.md b/docs/configuring-playbook-bridge-mautrix-twitter.md index 6e3c82838..5f7480cc8 100644 --- a/docs/configuring-playbook-bridge-mautrix-twitter.md +++ b/docs/configuring-playbook-bridge-mautrix-twitter.md @@ -6,6 +6,12 @@ The playbook can install and configure [mautrix-twitter](https://github.com/maut See the project's [documentation](https://github.com/mautrix/twitter) to learn what it does and why it might be useful to you. +## Prerequisite (optional) + +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) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) + ## Adjusting the playbook configuration To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: @@ -18,22 +24,6 @@ matrix_mautrix_twitter_enabled: true After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` -## Set up Double Puppeting - -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. - -### Method 1: automatically, by enabling Appservice Double Puppet or Shared Secret Auth - -The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service or the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook. - -Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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 double puppeting by enabling the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service works 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 - -This method is currently not available for the Mautrix-Twitter bridge, but is on the [roadmap](https://github.com/mautrix/twitter/blob/master/ROADMAP.md) under Misc/Manual login with `login-matrix` - ## Usage 1. You then need to start a chat with `@twitterbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). @@ -41,4 +31,20 @@ This method is currently not available for the Mautrix-Twitter bridge, but is on You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/twitter/authentication.html). -After successfully enabling bridging, you may wish to [set up Double Puppeting](#set-up-double-puppeting), if you haven't already done so. +### 💡 Set up Double Puppeting + +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 + +The bridge automatically performs Double Puppeting if [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook. + +Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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 double puppeting by enabling the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service works 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 + +This method is currently not available for the Mautrix-Twitter bridge, but is on the [roadmap](https://github.com/mautrix/twitter/blob/master/ROADMAP.md) under Misc/Manual login with `login-matrix` diff --git a/docs/configuring-playbook-bridge-mautrix-whatsapp.md b/docs/configuring-playbook-bridge-mautrix-whatsapp.md index c5533da8f..e2f73918f 100644 --- a/docs/configuring-playbook-bridge-mautrix-whatsapp.md +++ b/docs/configuring-playbook-bridge-mautrix-whatsapp.md @@ -4,6 +4,12 @@ The playbook can install and configure [mautrix-whatsapp](https://github.com/mau See the project's [documentation](https://docs.mau.fi/bridges/go/whatsapp/index.html) to learn what it does and why it might be useful to you. +## Prerequisite (optional) + +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) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook. + +For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting) + ## Adjusting the playbook configuration To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: @@ -32,21 +38,25 @@ If you want to activate the relay bot in a room, send `!wa set-relay`. To deacti After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` -## Set up Double Puppeting +## Usage -If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. +You then need to start a chat with `@whatsappbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). -### Method 1: automatically, by enabling Appservice Double Puppet or Shared Secret Auth +### 💡 Set up Double Puppeting -The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service or the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook. +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 + +The bridge automatically performs Double Puppeting if [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook. Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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 double puppeting by enabling the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service works 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 - -**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)). +#### 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: @@ -55,8 +65,3 @@ When using this method, **each user** that wishes to enable Double Puppeting nee - send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE` - make sure you don't log out the `Mautrix-Whatsapp` device some time in the future, as that would break the Double Puppeting feature - - -## Usage - -You then need to start a chat with `@whatsappbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-mautrix-bridges.md b/docs/configuring-playbook-mautrix-bridges.md index 1747b079a..87482e039 100644 --- a/docs/configuring-playbook-mautrix-bridges.md +++ b/docs/configuring-playbook-mautrix-bridges.md @@ -99,7 +99,7 @@ After configuring the playbook, run the [installation](installing.md) command: ` 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 will automatically perform Double Puppeting if you enable [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook by adding +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 ```yaml matrix_appservice_double_puppet_enabled: true