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 '8c02f7b79b'
${ noResults }
matrix-docker-ansible-deploy/docs/configuring-playbook-bridge...

3.7 KiB
Raw Blame History

Setting up Appservice Discord (optional)

Note: bridging to Discord can also happen via the mx-puppet-discord bridge supported by the playbook.

The playbook can install and configure matrix-appservice-discord for you.

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

Setup Instructions

Instructions loosely based on this.

  1. Create a Discord Application here.
  2. Retrieve Client ID.
  3. Create a bot from the Bot tab and retrieve the Bot token.
  4. From the Bot tab, enable all checkboxes related to Privileged Gateway Intents (you can skip this step if you're not using matrix_appservice_discord_auth_usePrivilegedIntents: true below)
  5. Enable the bridge with the following configuration in your vars.yml file:
matrix_appservice_discord_enabled: true
matrix_appservice_discord_client_id: "YOUR DISCORD APP CLIENT ID"
matrix_appservice_discord_bot_token: "YOUR DISCORD APP BOT TOKEN"
matrix_appservice_discord_auth_usePrivilegedIntents: true
  1. If you've already installed Matrix services using the playbook before, you'll need to re-run it (--tags=setup-all,start). If not, proceed with configuring other playbook services and then with Installing. Get back to this guide once ready.
  2. Retrieve Discord invite link from the {{ matrix_appservice_discord_config_path }}/invite_link file on the server (this defaults to /matrix/appservice-discord/config/invite_link). You need to peek at the file on the server via SSH, etc., because it's not available via HTTP(S).
  3. Invite the Bot to Discord servers you wish to bridge. Administrator permission is recommended.
  4. Room addresses follow this syntax: #_discord_guildid_channelid. You can easily find the guild and channel ids by logging into Discord in a browser and opening the desired channel. The URL will have this format: discordapp.com/channels/guild_id/channel_id. Once you have figured out the appropriate room addrss, you can join by doing /join #_discord_guildid_channelid in your Matrix client.

Other configuration options are available via the matrix_appservice_discord_configuration_extension_yaml variable.

Getting Administrator access in a room

By default, you won't have Administrator access in rooms created by the bridge.

To adjust room access privileges or do various other things (change the room name subsequently, etc.), you'd wish to become an Administrator.

There's the Discord bridge's guide for setting privileges on bridge managed rooms. To do the same with our container setup, run the following command on the server:

docker exec -it matrix-appservice-discord /bin/sh -c 'cp /build/tools/adminme.js /tmp/adminme.js && cp /cfg/registration.yaml /tmp/discord-registration.yaml && cd /tmp && node /tmp/adminme.js -c /cfg/config.yaml -r "!ROOM_ID:SERVER" -u "@USER:SERVER" -p 100'

Adjusting room access privileges

All rooms created by the bridge are listed publicly in your server's directory and joinable by everyone by default.

To get more control of them, make yourself a room Administrator first.

You can then unlist the room from the directory and change the join rules.