bc1849d7ff
* Replace "just run-tags install-all/setup-all,start" with "just install-all/setup-all" Thanks to the tip by Slavi that the overhead of ensure-matrix-users-created is negligible. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit installing instructions - Move the anchor links to docs/just.md - Add note about running "ensure-matrix-users-created" tags, if ansible-playbook's tags not "setup-all,ensure-matrix-users-created,start", ie. either "setup-all,start", "setup-email2matrix,start", "setup-aux-files,setup-corporal,start", or "setup-matrix-user-verification-service,start" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update descriptions about installation - Introduce the most conservative and stable raw ansible-playbook command. - Introduce the just commands on installing.md and maintenance-upgrading-services.md, not on quick-start.md, since it is too early for quick start guide readers who are just starting to climb learning curve to use the shortcuts. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-etherpad.md: remove the note about ensure-matrix-users-created Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> --------- Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2.8 KiB
Setting up MX Puppet Slack bridging (optional)
Note: bridging to Slack can also happen via the matrix-appservice-slack and mautrix-slack bridges supported by the playbook. Note that matrix-appservice-slack is not available for new installation unless you have already created a classic Slack application, because the creation of classic Slack applications, which this bridge makes use of, has been discontinued.
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.
Prerequisite
Follow the OAuth credentials 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 bridge, add the following configuration to your inventory/host_vars/matrix.example.com/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 it with playbook tags as below:
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
Notes:
-
The
ensure-matrix-users-createdplaybook tag makes the playbook automatically create the bot's user account. -
The shortcut commands with the
justprogram are also available:just install-allorjust setup-alljust install-allis useful for maintaining your setup quickly when its components remain unchanged. If you adjust yourvars.ymlto remove other components, you'd need to runjust setup-all, or these components will still remain installed.
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 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.