ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-12-22 20:45:48 +00:00
Code Issues Projects Releases Wiki Activity

Update docs/configuring-playbook-bridge-appservice-slack.md: fix indentation

Browse Source 
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara 2024-10-16 00:35:07 +09:00
parent 3fd7377290
commit 9a75758bbe
No known key found for this signature in database
GPG Key ID: E4F9743DAB4B7B75
1 changed files with 39 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
docs/configuring-playbook-bridge-appservice-slack.md
View File

@ -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. room ID will be displayed near the top.
2. Enable the bridge with the following configuration in your `vars.yml` file: 2. Enable the bridge with the following configuration in your `vars.yml` file:
```yaml ```yaml
matrix_appservice_slack_enabled: true matrix_appservice_slack_enabled: true
matrix_appservice_slack_control_room_id: "Your matrix admin room id" matrix_appservice_slack_control_room_id: "Your matrix admin room id"
``` ```
3. Enable puppeting (optional, but recommended) 3. Enable puppeting (optional, but recommended)
```yaml ```yaml
matrix_appservice_slack_puppeting_enabled: true 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_id: "Your Classic Slack App Client ID"
matrix_appservice_slack_puppeting_slackapp_client_secret: "Your Classic Slack App Client Secret" matrix_appservice_slack_puppeting_slackapp_client_secret: "Your Classic Slack App Client Secret"
``` ```
4. Enable Team Sync (optional) 4. Enable Team Sync (optional)
```yaml ```yaml
matrix_appservice_slack_team_sync_enabled: true matrix_appservice_slack_team_sync_enabled: true
``` ```
See https://matrix-appservice-slack.readthedocs.io/en/latest/team_sync/ 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. 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: 5. Invite the bridge bot user into the admin room:
``` ```
/invite @slackbot:MY.DOMAIN /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). 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: * Issue a link command in the administration control room with these collected values as arguments:
with file bridging: 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 11. Unlinking
Channels can be unlinked again like this: 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. 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` `journalctl -fu matrix-appservice-slack`
* linking: "Room is now pending-name" * 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 * 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) <the channel id> <some other id>` `WARN SlackEventHandler Ignoring message from unrecognised slack channel id : %s (%s) <the channel id> <some other id>`
then unlink your room, reinvite the bot and re-link it again. This may particularly hit you, if you tried to unsuccessfully link 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. your room multiple times without unlinking it after each failed attempt.