2020-04-12 14:17:30 +00:00
# Setting up MX Puppet Slack (optional)
2022-01-28 01:00:27 +00:00
**Note**: bridging to [Slack ](https://slack.com ) can also happen via the
2023-01-11 08:38:54 +00:00
[matrix-appservice-slack ](configuring-playbook-bridge-appservice-slack.md ) and [mautrix-slack ](configuring-playbook-bridge-mautrix-slack.md ) bridges supported by the playbook.
2021-05-19 10:32:05 +00:00
2022-03-17 20:16:17 +00:00
The playbook can install and configure [Beeper ](https://www.beeper.com/ )-maintained fork of
[mx-puppet-slack ](https://gitlab.com/beeper/mx-puppet-monorepo ) for you.
2020-04-12 14:17:30 +00:00
See the project page to learn what it does and why it might be useful to you.
2024-10-12 11:48:24 +00:00
## Prerequisite
2024-10-17 13:17:56 +00:00
Follow the [OAuth credentials ](https://github.com/Sorunome/mx-puppet-slack#option-2-oauth ) instructions to create a new Slack app, setting the redirect URL to `https://matrix.example.com/slack/oauth` .
2024-10-12 11:48:24 +00:00
## Adjusting the playbook configuration
2024-10-17 13:17:56 +00:00
To enable the [Slack ](https://slack.com/ ) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
2024-10-12 11:48:24 +00:00
```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
```
2020-04-12 14:17:30 +00:00
## Usage
Once the bot is enabled you need to start a chat with `Slack Puppet Bridge` with
2024-10-17 13:23:06 +00:00
the handle `@_slackpuppet_bot:example.com` (where `example.com` is your base
2020-04-12 14:17:30 +00:00
domain, not the `matrix.` domain).
Three authentication methods are available, Legacy Token, OAuth and xoxc token.
See mx-puppet-slack [documentation ](https://github.com/Sorunome/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.