mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-02-24 16:04:09 +01:00
Code Issues Packages Projects Releases Wiki Activity
matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-mx-puppet-instagram.md
Suguru Hirahara 807da74334
Add license information to files for MX bridges 
As the future for the MX bridges in this playbook and by themselves seems uncertain, this commit adds license information in SPDX format to the files for those bridges, before the bridges would be deprecated and possibly get removed from the project.

Please note that .license files are added for the files which would be broken if such information are added as header, following the REUSE's specification.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-23 13:33:30 +09:00

2.5 KiB
Raw Blame History

Setting up MX Puppet Instagram bridging (optional)

The playbook can install and configure mx-puppet-instagram for you.

This allows you to bridge Instagram DirectMessages into Matrix.

Adjusting the playbook configuration

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

matrix_mx_puppet_instagram_enabled: true

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 Instagram Puppet Bridge with the handle @_instagrampuppet_bot:example.com (where example.com is your base domain, not the matrix. domain).

Send link <username> <password> to the bridge bot to link your instagram account.

The list commands shows which accounts are linked and which puppetId is associated.

For double-puppeting, you probably want to issue these commands:

  • settype $puppetId puppet to enable puppeting for the link (instead of relaying)
  • setautoinvite $puppetId 1 to automatically invite you to chats
  • setmatrixtoken $accessToken to set the access token to enable puppeting from the other side (the "double" in double puppeting)

If you are linking only one Instagram account, your $puppetId is probably 1, but use the list command find out.

Send help to the bot to see the available commands. At the time of writing, not every command is fully implemented.