Setting up Mautrix Facebook (optional)

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.

matrix_mautrix_facebook_enabled: true

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

Encryption support is off by default. If you would like to enable encryption, add the following to your vars.yml file:

matrix_mautrix_facebook_configuration_extension_yaml: |
  bridge:
    encryption:
      allow: true
      default: true

If you would like to be able to administrate the bridge from your account it can be configured like this:

matrix_mautrix_facebook_configuration_extension_yaml: |
  bridge:
    permissions:
      '@YOUR_USERNAME:YOUR_DOMAIN': admin

You may wish to look at roles/matrix-bridge-mautrix-facebook/templates/config.yaml.j2 to find other things you would like to configure.

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. You can use the following command:

curl \
--data '{"identifier": {"type": "m.id.user", "user": "YOUR_MATRIX_USERNAME" }, "password": "YOUR_MATRIX_PASSWORD", "type": "m.login.password", "device_id": "Mautrix-Facebook", "initial_device_display_name": "Mautrix-Facebook"}' \
https://matrix.DOMAIN/_matrix/client/r0/login

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:YOUR_DOMAIN (where YOUR_DOMAIN is your base domain, not the matrix. domain).

Send login YOUR_FACEBOOK_EMAIL_ADDRESS to the bridge bot to enable bridging for your Facebook Messenger account. You can learn more here about authentication from the bridge's official documentation on Authentication.

If you run into trouble, check the Troubleshooting section below.

After successfully enabling bridging, you may wish to set up Double Puppeting, if you haven't already done so.

Set up community-grouping

This is an optional feature that you may wish to enable.

The Facebook bridge can create a Matrix community for you, which would contain all your chats and contacts.

For this to work, the bridge's bot needs to have permissions to create communities (also referred to as groups). Since the bot is a non-admin user, you need to enable such group-creation for non-privileged users in Synapse's settings.

Here's an example configuration:

matrix_synapse_configuration_extension_yaml: |
  enable_group_creation: true
  group_creation_prefix: "unofficial/"  

matrix_mautrix_facebook_configuration_extension_yaml: |
  bridge:
    community_template: "unofficial/facebook_{localpart}={server}"

Once the bridge is restarted, it would create a community and invite you to it. You need to accept the community invitation manually. If you don't see all your contacts, you may wish to send a sync message to the bot.

Troubleshooting

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.DOMAIN: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.

5.2 KiB Raw Blame History