36d8ea281c
* Allow the mautrix whatsapp relaybot to be enable with a variable This allows a user to enable the relaybot by setting a variable in `vars.yml` in the same way that the mautrix signal relaybot is configured. * Correct default values for mautrix whatsapp relaybot variables * Add documentation for using the relaybot with mautrix whatsapp * Adjust variable names to better reflect what they do * Set default variables properly and use to_json in template
2.9 KiB
Setting up Mautrix Whatsapp (optional)
The playbook can install and configure mautrix-whatsapp for you.
See the project's documentation to learn what it does and why it might be useful to you.
Use the following playbook configuration:
matrix_mautrix_whatsapp_enabled: true
Whatsapp multidevice beta is required, now it is enough if Whatsapp is connected to the Internet every 2 weeks.
The relay bot functionality is off by default. If you would like to enable the relay bot, add the following to your vars.yml file:
matrix_mautrix_whatsapp_bridge_relay_enabled: true
By default, only admins are allowed to set themselves as relay users. To allow anyone on your homeserver to set themselves as relay users add this to your vars.yml file:
matrix_mautrix_whatsapp_bridge_relay_admin_only: false
If you want to activate the relay bot in a room, use !whatsapp set-relay.
Use !whatsapp unset-relay to deactivate.
Enable backfilling history
This requires a server with MSC2716 support, which is currently an experimental feature in synapse. Note that as of Synapse 1.46, there are still some bugs with the implementation, especially if using event persistence workers. Use the following playbook configuration:
matrix_synapse_configuration_extension_yaml: |
experimental_features:
msc2716_enabled: true
matrix_mautrix_whatsapp_configuration_extension_yaml:
bridge:
history_sync:
backfill: true
Set up Double Puppeting
If you'd like to use Double Puppeting (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 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).
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.
-
send the access token to the bot. Example:
login-matrix MATRIX_ACCESS_TOKEN_HERE -
make sure you don't log out the
Mautrix-Whatsappdevice some time in the future, as that would break the Double Puppeting feature
Usage
You then need to start a chat with @whatsappbot:YOUR_DOMAIN (where YOUR_DOMAIN is your base domain, not the matrix. domain).