Refer the common guide for configuring mautrix bridges: Setting up a Generic Mautrix Bridge
Note: This bridge has been deprecated in favor of the mautrix-meta Messenger/Instagram bridge, which can be installed using this playbook. Consider using that bridge instead of this one.
The playbook can install and configure mautrix-facebook for you.
See the project's documentation to learn what it does and why it might be useful to you.
If you want to set up Double Puppeting (hint: you most likely do) for this bridge automatically, you need to have enabled Shared Secret Auth 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.
To enable the bridge, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml
file:
matrix_mautrix_facebook_enabled: true
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.
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
orjust setup-all
just install-all
is useful for maintaining your setup quickly (2x-5x faster thanjust setup-all
) when its components remain unchanged. If you adjust yourvars.yml
to remove other components, you'd need to runjust setup-all
, or these components will still remain installed.
To use the bridge, you need to start a chat with @facebookbot:example.com
(where example.com
is your base domain, not the matrix.
domain).
You then need to send login YOUR_FACEBOOK_EMAIL_ADDRESS
to the bridge bot to enable bridging for your Facebook Messenger account.
If you run into trouble, check the Troubleshooting section below.
If your Matrix server is in a wildly different location than where you usually use your Facebook account from, the bridge's login attempts may be outright rejected by Facebook. Along with that, Facebook may even force you to change the account's password.
If you happen to run into this problem while setting up bridging, try to first get a successful session up by logging in to Facebook through the Matrix server's IP address.
The easiest way to do this may be to use sshuttle to proxy your traffic through the Matrix server.
Example command for proxying your traffic through the Matrix server:
sshuttle -r root@matrix.example.com:22 0/0
Once connected, you should be able to verify that you're browsing the web through the Matrix server's IP by checking icanhazip.
Then proceed to log in to Facebook/Messenger.
Once logged in, proceed to set up bridging.
If that doesn't work, enable 2FA (see: Facebook help page on enabling 2FA) and try to login again with a new password, and entering the 2FA code when prompted, it may take more then one try, in between attempts, check facebook.com to see if they are requiring another password change