matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-appservice-discord.md

# Setting up Appservice Discord (optional)

The playbook can install and configure [matrix-appservice-discord](https://github.com/Half-Shot/matrix-appservice-discord) for you.

See the project's [documentation](https://github.com/Half-Shot/matrix-appservice-discord/blob/master/README.md) to learn what it does and why it might be useful to you.

Setup Instructions:

loosely based on [this](https://github.com/Half-Shot/matrix-appservice-discord#setting-up)

1. Create a Discord Application [here](https://discordapp.com/developers/applications/me/create).
2. Retrieve Client ID and Bot token from this Application.
3. Enable the bridge with the following configuration in your `vars.yml` file:

```yaml
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"
```

4. 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](configuring-playbook.md) and then with [Installing](installing.md). Get back to this guide once ready.
5. 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`)
6. Invite the Bot to Discord servers you wish to bridge. Administrator permission is recommended.
7. Join the rooms by following this syntax `#_discord_guildid_channelid` - can be easily retrieved by logging into Discord in a browser and opening the desired channel. URL will have this format: `discordapp.com/channels/guild_id/channel_id`

Other configuration options are available via the `matrix_appservice_discord_configuration_extension_yaml` variable.
Add matrix-appservice-discord bridge Bridge is setup to work on the matrix side with this, but the discord invite link is not automatically generated. 2019-03-03 17:22:52 +00:00			`# Setting up Appservice Discord (optional)`

			`The playbook can install and configure [matrix-appservice-discord](https://github.com/Half-Shot/matrix-appservice-discord) for you.`

			`See the project's [documentation](https://github.com/Half-Shot/matrix-appservice-discord/blob/master/README.md) to learn what it does and why it might be useful to you.`
add documentation 2019-03-03 18:34:30 +00:00
Make Discord bridging instructions more detailed It didn't mention `matrix_appservice_discord_client_id` and `matrix_appservice_discord_bot_token`, which makes it hard for beginners. Related to #105 (Github Pull Request). 2019-03-05 07:08:22 +00:00			`Setup Instructions:`
add documentation 2019-03-03 18:34:30 +00:00
			`loosely based on [this](https://github.com/Half-Shot/matrix-appservice-discord#setting-up)`

			`1. Create a Discord Application [here](https://discordapp.com/developers/applications/me/create).`
			`2. Retrieve Client ID and Bot token from this Application.`
Make Discord bridging instructions more detailed It didn't mention `matrix_appservice_discord_client_id` and `matrix_appservice_discord_bot_token`, which makes it hard for beginners. Related to #105 (Github Pull Request). 2019-03-05 07:08:22 +00:00			3. Enable the bridge with the following configuration in your `vars.yml` file:

			```yaml
			`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"`
			```

			4. 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](configuring-playbook.md) and then with [Installing](installing.md). Get back to this guide once ready.
Make Discord bridge configuration playbook-managed Well, `config.yaml` has been playbook-managed for a long time. It's now extended to match the default sample config of the Discord bridge. With this patch, we also make `registration.yaml` playbook-managed, which leads us to consistency with all other bridges. Along with that, we introduce `./config` and `./data` separation, like we do for the other bridges. 2019-06-26 07:30:51 +00:00			5. 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`)
add documentation 2019-03-03 18:34:30 +00:00			`6. Invite the Bot to Discord servers you wish to bridge. Administrator permission is recommended.`
Make Discord bridge configuration playbook-managed Well, `config.yaml` has been playbook-managed for a long time. It's now extended to match the default sample config of the Discord bridge. With this patch, we also make `registration.yaml` playbook-managed, which leads us to consistency with all other bridges. Along with that, we introduce `./config` and `./data` separation, like we do for the other bridges. 2019-06-26 07:30:51 +00:00			7. Join the rooms by following this syntax `#_discord_guildid_channelid` - can be easily retrieved by logging into Discord in a browser and opening the desired channel. URL will have this format: `discordapp.com/channels/guild_id/channel_id`
add documentation 2019-03-03 18:34:30 +00:00
Make Discord bridging instructions more detailed It didn't mention `matrix_appservice_discord_client_id` and `matrix_appservice_discord_bot_token`, which makes it hard for beginners. Related to #105 (Github Pull Request). 2019-03-05 07:08:22 +00:00			Other configuration options are available via the `matrix_appservice_discord_configuration_extension_yaml` variable.