bf5373479b
Overall the playbook uses the expression "Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:" with the heading "Adjusting the playbook configuration" for sections to explain what to be added as variables Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2.0 KiB
Setting up MX Puppet Discord (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 page to learn what it does and why it might be useful to you.
Note: we actually use the Beeper-maintained fork of mx-puppet-discord, because matrix-discord/mx-puppet-discord is a low-quality and poorly maintained project.
Adjusting the playbook configuration
To enable the Discord bridge, add the following configuration to your inventory/host_vars/matrix.DOMAIN/vars.yml file:
matrix_mx_puppet_discord_enabled: true
Usage
Once the bot is enabled you need to start a chat with Discord Puppet Bridge with
the handle @_discordpuppet_bot:YOUR_DOMAIN (where YOUR_DOMAIN 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.
Also send help to the bot to see the commands available.