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

Setting up Instagram bridging via Mautrix Meta (optional)

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

The playbook can install and configure the mautrix-meta Messenger/Instagram bridge for you.

See the project's documentation to learn what it does and why it might be useful to you.

Since this bridge component can bridge to both Messenger and Instagram and you may wish to do both at the same time, the playbook makes it available via 2 different Ansible roles (matrix-bridge-mautrix-meta-messenger and matrix-bridge-mautrix-meta-instagram). The latter is a reconfigured copy of the first one (created by just rebuild-mautrix-meta-instagram and bin/rebuild-mautrix-meta-instagram.sh).

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.

Prerequisites

Migrating from the old mautrix-instagram bridge

If you've been using the mautrix-instagram bridge, you'd better get rid of it first or the 2 bridges will be in conflict:

• both trying to use @instagrambot:example.com as their username. This conflict may be resolved by adjusting matrix_mautrix_instagram_appservice_bot_username or matrix_mautrix_meta_instagram_appservice_username
• both trying to bridge the same DMs

To do so, send a clean-rooms command to the management room with the old bridge bot (@instagrambot:example.com). It gives you a list of portals and groups of portals you may purge. Proceed with sending commands like clean recommended, etc.

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 (hint: you most likely do) for this bridge automatically, you need to have enabled Appservice Double Puppet service for this playbook.

See this section on the common guide for configuring mautrix bridges for details about setting 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:

matrix_mautrix_meta_instagram_enabled: true

Before proceeding to re-running the playbook, you may wish to adjust the configuration further. See below.

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 @instagrambot: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.

After logging in, the bridge will sync recent chats.