mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-27 03:18:31 +01:00
85ccd143ac
The transition to the Beeper fork (https://gitlab.com/beeper/mx-puppet-monorepo) has been reverted with 894669eca2 on May 15, 2022, after https://github.com/Sorunome/mx-puppet-slack was archived on Apr 19, 2022 and migrated to https://gitlab.com/mx-puppet/slack/mx-puppet-slack.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
44 lines
1.9 KiB
Markdown
44 lines
1.9 KiB
Markdown
# Setting up MX Puppet Slack bridging (optional)
|
|
|
|
**Note**: bridging to [Slack](https://slack.com) can also happen via the
|
|
[matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) and [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) bridges supported by the playbook.
|
|
|
|
The playbook can install and configure [mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack) for you.
|
|
|
|
See the project page to learn what it does and why it might be useful to you.
|
|
|
|
## Prerequisite
|
|
|
|
Follow the [OAuth credentials](https://gitlab.com/mx-puppet/slack/mx-puppet-slack#option-2-oauth) instructions to create a new Slack app, setting the redirect URL to `https://matrix.example.com/slack/oauth`.
|
|
|
|
## Adjusting the playbook configuration
|
|
|
|
To enable the [Slack](https://slack.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
|
|
|
```yaml
|
|
matrix_mx_puppet_slack_enabled: true
|
|
# Client ID must be quoted so YAML does not parse it as a float.
|
|
matrix_mx_puppet_slack_oauth_client_id: "<SLACK_APP_CLIENT_ID>"
|
|
matrix_mx_puppet_slack_oauth_client_secret: "<SLACK_APP_CLIENT_SECRET>"
|
|
```
|
|
|
|
## Installing
|
|
|
|
After configuring the playbook, run the [installation](installing.md) command:
|
|
|
|
```
|
|
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
|
```
|
|
|
|
## Usage
|
|
|
|
Once the bot is enabled you need to start a chat with `Slack Puppet Bridge` with the handle `@_slackpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
|
|
|
Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-slack [documentation](https://gitlab.com/mx-puppet/slack/mx-puppet-slack) 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.
|