mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-02-24 07:54:11 +01:00
Code Issues Packages Projects Releases Wiki Activity
matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-mx-puppet-discord.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

3.0 KiB
Raw Blame History

Setting up MX Puppet Discord bridging (optional)

Note: bridging to Discord can also happen via the matrix-appservice-discordand mautrix-discord bridges supported by the playbook.

  • For using as a Bot we recommend the Appservice Discord, because it supports plumbing.
  • For personal use with a discord account we recommend the mautrix-discord bridge, because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook.

The playbook can install and configure mx-puppet-discord 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 Discord bridge, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:

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

Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-discord documentation for more information about how to configure the bridge.

Once logged in, send list to the bot user to list the available rooms.

Clicking rooms in the list will result in you receiving an invitation to the bridged room.

Send help to the bot to see the available commands.