pub-solar/matrix-docker-ansible-deploy
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-mx-puppet-slack.md
Jim Myhrberg 7ae70c27e6
feat(mx-puppet-slack): add support for OAuth client ID/secret 
The OAuth credentials method seems to be the only viable way to
configure the mx-puppet-bridge now. Legacy tokens can no longer be
created, and the other methods (xoxs and xoxc tokens) come with warnings
about them being against Slack's terms of service.
2022-01-28 01:22:34 +00:00

1.8 KiB
Raw Blame History

Setting up MX Puppet Slack (optional)

Note: bridging to Slack can also happen via the matrix-appservice-slack bridge supported by the playbook.

The playbook can install and configure mx-puppet-slack for you.

See the project page to learn what it does and why it might be useful to you.

Setup

To enable the Slack bridge:

  1. Follow the OAuth credentials instructions to create a new Slack app, setting the redirect URL to https://matrix.YOUR_DOMAIN/slack/oauth.
  2. Update your vars.yml with the following: 
    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>"
  3. Run playbooks with setup-all and start tags: 
    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:YOUR_DOMAIN (where YOUR_DOMAIN is your base domain, not the matrix. domain).

Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-slack documentation 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.