diff --git a/docs/configuring-playbook-bridge-appservice-slack.md b/docs/configuring-playbook-bridge-appservice-slack.md index b33f565cf..d21e1496a 100644 --- a/docs/configuring-playbook-bridge-appservice-slack.md +++ b/docs/configuring-playbook-bridge-appservice-slack.md @@ -61,7 +61,21 @@ matrix_appservice_slack_control_room_id: "Your Matrix admin room ID" # matrix_appservice_slack_team_sync_enabled: true ``` -Other configuration options are available via the `matrix_appservice_slack_configuration_extension_yaml` variable. +### Extending the configuration + +There are some additional things you may wish to configure about the bridge. + +Take a look at: + +- `roles/custom/matrix-bridge-appservice-slack/defaults/main.yml` for some variables that you can customize via your `vars.yml` file +- `roles/custom/matrix-bridge-appservice-slack/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_slack_configuration_extension_yaml` variable + +For example, to change the bot's username from `slackbot`, add the following configuration to your `vars.yml` file. Replace `examplebot` with your own. + +```yaml +matrix_appservice_slack_configuration_extension_yaml: | + bot_username: "examplebot" +``` ## Installing @@ -121,7 +135,7 @@ Unlinking doesn't only disconnect the bridge, but also makes the slackbot leave ## Troubleshooting -As always, check the logs: `journalctl -fu matrix-appservice-slack` +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-appservice-slack`. ### Linking: "Room is now pending-name" @@ -129,8 +143,8 @@ This typically means that you haven't used the correct Slack channel ID. Unlink ### Messages work from Matrix to Slack, but not the other way around -Check you logs, if they say something like +Check the logs, and if you find the message like below, unlink your room, reinvite the bot and re-link it again. `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. +This may particularly hit you, if you tried to unsuccessfully link your room multiple times without unlinking it after each failed attempt. diff --git a/roles/custom/matrix-bridge-appservice-slack/defaults/main.yml b/roles/custom/matrix-bridge-appservice-slack/defaults/main.yml index 5b8594e51..b5c6f6bf9 100644 --- a/roles/custom/matrix-bridge-appservice-slack/defaults/main.yml +++ b/roles/custom/matrix-bridge-appservice-slack/defaults/main.yml @@ -153,7 +153,7 @@ matrix_appservice_slack_configuration_extension_yaml: | # console: "info" # files: # - "./debug.log": "info" - #- "./error.log": "error" + # - "./error.log": "error" matrix_appservice_slack_configuration_extension: "{{ matrix_appservice_slack_configuration_extension_yaml | from_yaml if matrix_appservice_slack_configuration_extension_yaml | from_yaml else {} }}"