mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-03-04 04:56:15 +00:00

Slavi Pantaleev 852b9ebdc1 Adjust "installed using this playbook" links when linking to specific components

We previously made "this playbook" a link to some specific component.
This is somewhat misleading. Reading the text and seeing that "this playbook"
is a link, one might think that "this playbook" actually links to the
playbook's home page or something, not to the specific component which
could be "installed using this playbook".

This patch adjusts the markup so that the whole phrase "installed using this playbook"
is turned into a link (to the specific component's page). This makes it
more obvious where we're linking.

This work was initially done for the Email2Matrix docs page in
1b05343aba. This patch brings the same
change to all other instances.

2025-02-26 08:01:27 +02:00

3.8 KiB

Raw Blame History

Setting up Mautrix Instagram bridging (optional, deprecated)

^{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-instagram for you.

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

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_instagram_enabled: true

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 then need to send login YOUR_INSTAGRAM_EMAIL_ADDRESS YOUR_INSTAGRAM_PASSWORD to the bridge bot to enable bridging for your instagram/Messenger account.

Troubleshooting

As with all other services, you can find the logs in systemd-journald by logging in to the server with SSH and running journalctl -fu matrix-mautrix-instagram.

Increase logging verbosity

The default logging level for this component is WARNING. If you want to increase the verbosity, add the following configuration to your vars.yml file and re-run the playbook:

matrix_mautrix_instagram_logging_level: DEBUG

3.8 KiB Raw Blame History