matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-mautrix-whatsapp.md

Setting up Mautrix Whatsapp bridging (optional)

^{Refer the common guide for configuring mautrix bridges: Setting up a Generic Mautrix Bridge}

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.

Prerequisite (optional)

Enable Appservice Double Puppet or Shared Secret Auth

If you want to set up Double Puppeting (hint: you most likely do) for this bridge automatically, you need to have enabled Appservice Double Puppet or Shared Secret Auth service for this playbook.

See this section on the common guide for configuring mautrix bridges for details about setting up Double Puppeting.

Note: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future.

Adjusting the playbook configuration

To enable the bridge, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:

matrix_mautrix_whatsapp_enabled: true

Extending the configuration

There are some additional things you may wish to configure about the bridge.

See this section on the common guide for configuring mautrix bridges for details about variables that you can customize and the bridge's default configuration, including bridge permissions, encryption support, relay mode, bot's username, etc.

Installing

After configuring the playbook, run it with playbook tags as below:

ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start

Notes:

• The ensure-matrix-users-created playbook tag makes the playbook automatically create the bot's user account.

• The shortcut commands with the just program are also available: just install-all or just setup-all

  just install-all is useful for maintaining your setup quickly (2x-5x faster than just setup-all) when its components remain unchanged. If you adjust your vars.yml to remove other components, you'd need to run just setup-all, or these components will still remain installed.

Usage

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

You can then follow instructions on the bridge's official documentation on Authentication.

Approximately in a minute after logging in, the bridge will create portal rooms for recent chats.

Note: your linked devices will be logged out if you don’t use your phone for over 14 days (see the official FAQ entry here). The bridge will warn you if it doesn't receive any data from the phone over 12 days.