ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-12-22 20:45:48 +00:00
Code Issues Projects Releases Wiki Activity
a31400ed4a
matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-mx-puppet-instagram.md
Suguru Hirahara bc1849d7ff
Edit installing instructions (#3844) 
* Replace "just run-tags install-all/setup-all,start" with "just install-all/setup-all"

Thanks to the tip by Slavi that the overhead of ensure-matrix-users-created is negligible.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Edit installing instructions

- Move the anchor links to docs/just.md
- Add note about running "ensure-matrix-users-created" tags, if ansible-playbook's tags not "setup-all,ensure-matrix-users-created,start", ie. either "setup-all,start", "setup-email2matrix,start", "setup-aux-files,setup-corporal,start", or "setup-matrix-user-verification-service,start"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update descriptions about installation

- Introduce the most conservative and stable raw ansible-playbook command.
- Introduce the just commands on installing.md and maintenance-upgrading-services.md, not on quick-start.md, since it is too early for quick start guide readers who are just starting to climb learning curve to use the shortcuts.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-etherpad.md: remove the note about ensure-matrix-users-created

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-01 17:04:54 +02:00

2.3 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 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

Once the bot is enabled, 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.

The help command shows which commands are available, though at the time of writing, not every command is fully implemented.