From 9a75758bbe0668d3b46a19d6799cec5af5b6ae16 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Wed, 16 Oct 2024 00:35:07 +0900 Subject: [PATCH] Update docs/configuring-playbook-bridge-appservice-slack.md: fix indentation Signed-off-by: Suguru Hirahara --- ...guring-playbook-bridge-appservice-slack.md | 72 ++++++++++--------- 1 file changed, 39 insertions(+), 33 deletions(-) diff --git a/docs/configuring-playbook-bridge-appservice-slack.md b/docs/configuring-playbook-bridge-appservice-slack.md index 6c2f830ee..7c40a4986 100644 --- a/docs/configuring-playbook-bridge-appservice-slack.md +++ b/docs/configuring-playbook-bridge-appservice-slack.md @@ -15,35 +15,35 @@ be done in Element by making a message, opening the options for that message and room ID will be displayed near the top. 2. Enable the bridge with the following configuration in your `vars.yml` file: -```yaml -matrix_appservice_slack_enabled: true -matrix_appservice_slack_control_room_id: "Your matrix admin room id" -``` + ```yaml + matrix_appservice_slack_enabled: true + matrix_appservice_slack_control_room_id: "Your matrix admin room id" + ``` 3. Enable puppeting (optional, but recommended) -```yaml -matrix_appservice_slack_puppeting_enabled: true -matrix_appservice_slack_puppeting_slackapp_client_id: "Your Classic Slack App Client ID" -matrix_appservice_slack_puppeting_slackapp_client_secret: "Your Classic Slack App Client Secret" -``` + ```yaml + matrix_appservice_slack_puppeting_enabled: true + matrix_appservice_slack_puppeting_slackapp_client_id: "Your Classic Slack App Client ID" + matrix_appservice_slack_puppeting_slackapp_client_secret: "Your Classic Slack App Client Secret" + ``` 4. Enable Team Sync (optional) -```yaml -matrix_appservice_slack_team_sync_enabled: true -``` + ```yaml + matrix_appservice_slack_team_sync_enabled: true + ``` See https://matrix-appservice-slack.readthedocs.io/en/latest/team_sync/ 4. If you've already installed Matrix services using the playbook before, you'll need to re-run it (`--tags=setup-all,start`). If not, proceed with [configuring other playbook services](configuring-playbook.md) and then with [Installing](installing.md). Get back to this guide once ready. 5. Invite the bridge bot user into the admin room: -``` + ``` /invite @slackbot:MY.DOMAIN -``` + ``` -Note that the bot's domain is your server's domain **without the `matrix.` prefix.** + Note that the bot's domain is your server's domain **without the `matrix.` prefix.** 6. Create a Classic Slack App [here](https://api.slack.com/apps?new_classic_app=1). @@ -88,25 +88,31 @@ Note that the bot's domain is your server's domain **without the `matrix.` prefi * Issue a link command in the administration control room with these collected values as arguments: with file bridging: - ``` - link --channel_id CHANNELID --room !the-matrix:room.id --slack_bot_token xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx --slack_user_token xoxp-xxxxxxxx-xxxxxxxxx-xxxxxxxx-xxxxxxxx - ``` - without file bridging: - ``` - link --channel_id CHANNELID --room !the-matrix:room.id --slack_bot_token xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx - ``` - These arguments can be shortened to single-letter forms: - ``` - link -I CHANNELID -R !the-matrix:room.id -t xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx - ``` -Other configuration options are available via the `matrix_appservice_slack_configuration_extension_yaml` variable. + ``` + link --channel_id CHANNELID --room !the-matrix:room.id --slack_bot_token xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx --slack_user_token xoxp-xxxxxxxx-xxxxxxxxx-xxxxxxxx-xxxxxxxx + ``` + + without file bridging: + + ``` + link --channel_id CHANNELID --room !the-matrix:room.id --slack_bot_token xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx + ``` + + These arguments can be shortened to single-letter forms: + + ``` + link -I CHANNELID -R !the-matrix:room.id -t xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx + ``` + + Other configuration options are available via the `matrix_appservice_slack_configuration_extension_yaml` variable. 11. Unlinking Channels can be unlinked again like this: + ``` - unlink --room !the-matrix:room.id + unlink --room !the-matrix:room.id ``` Unlinking doesn't only disconnect the bridge, but also makes the slackbot leave the bridged matrix room. So in case you want to re-link later, don't forget to re-invite the slackbot into this room again. @@ -117,12 +123,12 @@ Other configuration options are available via the `matrix_appservice_slack_confi `journalctl -fu matrix-appservice-slack` * linking: "Room is now pending-name" -This typically means that you haven't used the correct slack channel id. Unlink the room and recheck 'Determine the "channel ID"' from above. + This typically means that you haven't used the correct slack channel id. Unlink the room and recheck 'Determine the "channel ID"' from above. * Messages work from M to S, but not the other way around -Check you logs, if they say something like + Check you logs, if they say something like -`WARN SlackEventHandler Ignoring message from unrecognised slack channel id : %s (%s) ` + `WARN SlackEventHandler Ignoring message from unrecognised slack channel id : %s (%s) ` -then unlink your room, reinvite the bot and re-link it again. This may particularly hit you, if you tried to unsuccessfully link -your room multiple times without unlinking it after each failed attempt. + then unlink your room, reinvite the bot and re-link it again. This may particularly hit you, if you tried to unsuccessfully link + your room multiple times without unlinking it after each failed attempt.