mirror of
				https://github.com/spantaleev/matrix-docker-ansible-deploy.git
				synced 2025-10-30 23:07:57 +01:00 
			
		
		
		
	Update docs for mautrix and kakaotalk bridges: add prerequisite(s) section for instructing to install Appservice Double Puppet and/or Shared Secret Auth service
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
		| @@ -6,6 +6,11 @@ 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) | ||||
|  | ||||
| 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 | ||||
|  | ||||
| @@ -48,7 +53,7 @@ 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. | ||||
|  | ||||
|   | ||||
| @@ -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 you enable [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [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. | ||||
|  | ||||
|   | ||||
| @@ -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: | ||||
| @@ -77,7 +83,7 @@ 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 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. | ||||
|  | ||||
|   | ||||
| @@ -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: | ||||
| @@ -67,7 +73,7 @@ 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. | ||||
|  | ||||
|   | ||||
| @@ -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: | ||||
| @@ -28,7 +34,7 @@ To set it up, 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. | ||||
| 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. | ||||
|  | ||||
| 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. | ||||
|  | ||||
|   | ||||
| @@ -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: | ||||
| @@ -36,7 +42,7 @@ 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 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. | ||||
|  | ||||
|   | ||||
| @@ -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: | ||||
| @@ -38,7 +44,7 @@ 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. | ||||
|  | ||||
|   | ||||
| @@ -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 | ||||
|  | ||||
| @@ -76,7 +82,7 @@ To set it up, 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. | ||||
| 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. | ||||
|  | ||||
| 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. | ||||
|  | ||||
|   | ||||
| @@ -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: | ||||
| @@ -93,7 +100,7 @@ To set it up, 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. | ||||
| 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. | ||||
|  | ||||
| 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. | ||||
|  | ||||
|   | ||||
| @@ -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: | ||||
| @@ -70,7 +82,7 @@ To set it up, 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. | ||||
| 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. | ||||
|  | ||||
|   | ||||
| @@ -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 | ||||
|  | ||||
| @@ -61,7 +66,7 @@ To set it up, 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. | ||||
| 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. | ||||
|  | ||||
|   | ||||
| @@ -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: | ||||
| @@ -55,7 +61,7 @@ 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 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. | ||||
|  | ||||
|   | ||||
| @@ -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: | ||||
| @@ -33,7 +39,7 @@ 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 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. | ||||
|  | ||||
|   | ||||
| @@ -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: | ||||
| @@ -44,7 +50,7 @@ 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 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. | ||||
|  | ||||
|   | ||||
| @@ -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 | ||||
|   | ||||
		Reference in New Issue
	
	Block a user