Skip to content

Latest commit

 

History

History
220 lines (153 loc) · 7.8 KB

README.md

File metadata and controls

220 lines (153 loc) · 7.8 KB
Raw

matrix-appservice-slack

A Matrix <--> Slack bridge

This is currently a very barebones bridge, it just does basic text in pre-enumerated channels. It will become more exciting.

Installation

$ git clone ...
$ cd matrix-appservice-slack
$ npm install

Setup

  1. Create a new Matrix room to act as the administration control room. Note its internal room ID.

  2. Pick/decide on two spare local TCP port numbers to use. One will listen for messages from Matrix and needs to be visible to the homeserver. The other will listen for messages from Slack and needs to be visible to the internet. Take care to configure firewalls appropriately. These ports will be notated as $MATRIX_PORT and $SLACK_PORT in the remaining instructions.

  3. Create a config.yaml file for global configuration. There is a sample one to begin with in config/config.sample.yaml you may wish to copy and edit as appropriate.

    At minimum this needs to contain:

    slack_hook_port: $SLACK_PORT
bot_username: "localpart for the bot's own user account"
username_prefix: "localpart prefix for generated ghost users"

homeserver:
  url: "http URL pointing at the homeserver"
  server_name: "domain part of the homeserver's name. Used for
                ghost username generation"

matrix_admin_room: "the ID of the room created in step 1."

  4. Generate the appservice registration file (if the application service runs on the same server you can use localhost as the $HOST name):

    $ node app.js -r -c config.yaml -u "http://$HOST:$MATRIX_PORT"

  5. Start the actual application service. You can use forever

    $ forever start app.js -c config.yaml -p $MATRIX_PORT

    or node

    $ node app.js -c config.yaml -p $MATRIX_PORT

  6. Copy the newly-generated slack-registration.yaml file to the homeserver. Add the registration file to your homeserver config (default homeserver.yaml):

    app_service_config_files:
   - ...
   - "/path/to/slack-registration.yaml"

    Don't forget - it has to be a YAML list of strings, not just a single string.

    Restart your homeserver to have it reread the config file an establish a connection to the bridge.

  7. Invite the bridge bot user into the admin room, so it can actually see and respond to commands. The bot's user ID is formed from the bot_username field of the config file, and the homeserver's domain name. For example:

    /invite @slackbot:my.server.here

The bridge itself should now be running.

To actually use it, you will need to configure some linked channels.

Provisioning

This bridge allows linking together pairs of Matrix rooms and Slack channels, relaying messages said by people in one side into the other. To create a link first the individual Matrix room and Slack channel need to be created, and then a command needs to be issued in the administration console room to add the link to the bridge's database.

There are 2 ways to bridge a room. The recommended way uses the newer slack events api and bot users. This allows you to link as many channels as you would like with only 1 slack integration. The legacy way uses incoming/outgoing webhooks, and requires 2 slack integrations per channel to be bridged.

Recommended

  1. Add a custom app to your slack team/workspace by visiting https://api.slack.com/apps and clicking on Create New App.

  2. Name the app & select the team/workspace this app will belong to.

  3. Click on bot users and add a new bot user. We will use this account to bridge the the rooms.

  4. Click on Event Subscriptions and enable them. At this point, the bridge needs to be started as slack will do some verification of the request rul. The request url should be https://$HOST:$SLACK_PORT". Then add the following events and save:

    Bot User Events:

    - team_domain_change
- message.channels
- message.groups (if you want to bridge private channels)

  5. Skip this step if you do not want to bridge files. Click on OAuth & Permissions and add the following scopes:

    • files:write:user

    Note: any media uploaded to matrix is currently accessible by anyone who knows the url. In order to make slack files visible to matrix users, this bridge will make slack files visible to anyone with the url (including files in private channels). This is different then the current behavior in slack, which only allows authenticated access to media posted in private channels.

  6. Click on Install App and Install App to Workspace. Note the access tokens show. You will need the Bot User OAuth Access Token and if you want to bridge files, the OAuth Access Token whenever you link a room.

  7. For each channel you would like to bridge, perform the following steps:

    1. Create a Matrix room in the usual manner for your client. Take a note of its Matrix room ID - it will look something like !aBcDeF:example.com.

    2. invite the bot user to the slack channel you would like to bridge.

      /invite @bot-user-name

      You will also need to determine the "channel ID" that Slack uses to identify the channel, which can be found in the url https://XXX.slack.com/messages/<channel id>/.

    3. 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

Legacy

  1. Create a Matrix room in the usual manner for your client. Take a note of its Matrix room ID - it will look something like !aBcDeF:example.com.

  2. Create a Slack channel in the usual manner.

  3. Add an "Incoming WebHooks" integration to the Slack channel and take a note of its "Webhook URL" from the integration settings in Slack - it will look something like https://hooks.slack.com/services/ABC/DEF/123.

  4. Add an "Outgoing WebHooks" integration to the Slack channel and take a note of its token field. Add a URL to this web hook pointing back at the application service port you configured during setup.

    You will also need to determine the "channel ID" that Slack uses to identify the channel. Unfortunately, it is not easily obtained from the Slack UI. The easiest way to do this is to send a message from Slack to the bridge; the bridge will log the channel ID as part of the unrecognised message output. You can then take note of the channel_id field.

  5. Issue a link command in the administration control room with these collected values as arguments:

    link --channel_id CHANNELID --room !the-matrix:room.id --webhook_url https://hooks.slack.com/services/ABC/DEF/123

    These arguments can be shortened to single-letter forms:

    link -I CHANNELID -R !the-matrix:room.id -u https://hooks.slack.com/services/ABC/DEF/123

See also https://github.com/matrix-org/matrix-appservice-bridge/blob/master/HOWTO.md for the general theory of all this :)

Mattermost

Because Mattermost's webhook APIs are Slack-compatible, the Matrix <--> Slack bridge also works with it. The webhook configuration is very similar to Slack's and is documented on Mattermost's website.