titanz
/
matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'da4a82c48b'
${ noResults }
matrix-docker-ansible-deploy/docs/configuring-playbook-bridge...

5.0 KiB
Raw Blame History

Setting up Mautrix Discord (optional)

Note: bridging to Discord can also happen via the mx-puppet-discord and matrix-appservice-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 (the one being discussed here), because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook. The mautrix-discord bridge (the one being discussed here) is the most fully-featured and stable of the 3 Discord bridges supported by the playbook, so it's the one we recommend.

The playbook can install and configure mautrix-discord for you.

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

Prerequisites

For using this bridge, you would need to authenticate by scanning a QR code with the Discord app on your phone or by using discord account token.

You can delete the Discord app after the authentication process.

If this is a dealbreaker for you, consider using one of the other Discord bridges supported by the playbook: mx-puppet-discord or matrix-appservice-discord. These come with their own complexity and limitations, however, so we recommend that you proceed with this one if possible.

Installing

To enable the bridge, add this to your vars.yml file:

matrix_mautrix_discord_enabled: true

You may optionally wish to add some Additional configuration, or to prepare for double-puppeting before the initial installation.

After adjusting your vars.yml file, re-run the playbook and restart all services: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start

To make use of the bridge, see Usage below.

Additional configuration

There are some additional things you may wish to configure about the bridge.

Take a look at:

  • roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml for some variables that you can customize via your vars.yml file
  • roles/custom/matrix-bridge-mautrix-discord/templates/config.yaml.j2 for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the matrix_mautrix_discord_configuration_extension_yaml variable

Set up Double Puppeting

If you'd like to use Double Puppeting (hint: you most likely do), you have 2 ways of going about it.

Method 1: automatically, by enabling Shared Secret Auth

The bridge will automatically perform Double Puppeting if you enable Shared Secret Auth for this playbook.

This is the recommended way of setting up Double Puppeting, as it's easier to accomplish, works for all your users automatically, and has less of a chance of breaking in the future.

Method 2: manually, by asking each user to provide a working access token

Note: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see Usage).

When using this method, each user that wishes to enable Double Puppeting needs to follow the following steps:

  • retrieve a Matrix access token for yourself. Refer to the documentation on how to do that.

  • send the access token to the bot. Example: login-matrix MATRIX_ACCESS_TOKEN_HERE

  • make sure you don't log out the Mautrix-Discord device some time in the future, as that would break the Double Puppeting feature

Usage

  1. Start a chat with @discordbot:YOUR_DOMAIN (where YOUR_DOMAIN is your base domain, not the matrix. domain).
  2. If you would like to login to Discord using a token, send login-token command, otherwise, send login-qr command.
  3. You'll see a QR code which you need to scan with the Discord app on your phone. You can scan it with the camera app too, which will open Discord, which will then instruct you to scan it a 2nd time in the Discord app.
  4. After confirming (in the Discord app) that you'd like to allow this login, the bot should respond with "Succcessfully authenticated as ..."
  5. Now that you're logged in, you can send a help command to the bot again, to see additional commands you have access to
  6. Some Direct Messages from Discord should start syncing automatically
  7. If you'd like to bridge guilds:
  • send guilds status to see the list of guilds
  • for each guild that you'd like bridged, send guilds bridge GUILD_ID --entire
  1. You may wish to uninstall the Discord app from your phone now. It's not needed for the bridge to function.