bf5373479b
Overall the playbook uses the expression "Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:" with the heading "Adjusting the playbook configuration" for sections to explain what to be added as variables Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2.0 KiB
Setting up MX Puppet Slack (optional)
Note: bridging to Slack can also happen via the matrix-appservice-slack and mautrix-slack bridges supported by the playbook.
The playbook can install and configure Beeper-maintained fork of 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 instructions to create a new Slack app, setting the redirect URL to https://matrix.DOMAIN/slack/oauth.
Adjusting the playbook configuration
To enable the Slack bridge, add the following configuration to your inventory/host_vars/matrix.DOMAIN/vars.yml file:
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 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: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.