Skip to content

Latest commit

 

History

History
73 lines (41 loc) · 5.43 KB

configuring-playbook-bridge-mautrix-discord.md

File metadata and controls

73 lines (41 loc) · 5.43 KB

Setting up Mautrix Discord bridging (optional)

Refer the common guide for configuring mautrix bridges: Setting up a Generic Mautrix Bridge

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

There are 2 ways to login to discord using this bridge, either by scanning a QR code using the Discord mobile app or by using a Discord token.

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.

Enable Appservice Double Puppet or Shared Secret Auth (optional)

If you want to set up Double Puppeting (hint: you most likely do) for this bridge automatically, you need to have enabled Appservice Double Puppet or Shared Secret Auth service for this playbook.

See this section on the common guide for configuring mautrix bridges for details about setting up Double Puppeting.

Note: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future.

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_discord_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, 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 @discordbot:example.com (where example.com is your base domain, not the matrix. domain).

You can then follow instructions on the bridge's official documentation on Authentication.

After logging in, the bridge will create portal rooms for some recent direct messages.

Bridge guilds

If you'd like to bridge guilds, send guilds status to see the list of guilds, then send guilds bridge GUILD_ID_HERE for each guild that you'd like bridged. Make sure to replace GUILD_ID_HERE with the guild's ID.

After bridging, spaces will be created automatically, and rooms will be created if necessary when messages are received. You can also pass --entire to the bridge command to immediately create all rooms.

If you want to manually bridge channels, invite the bot to the room you want to bridge, and run !discord bridge CHANNEL_ID_HERE to bridge the room. Make sure to replace CHANNEL_ID_HERE with the channel's ID.