Skip to content

Latest commit

 

History

History
104 lines (74 loc) · 4.75 KB

README.md

File metadata and controls

104 lines (74 loc) · 4.75 KB
Raw

matrix-puppet-slack #matrix-puppet-bridge:matrix.org

This is an unofficial matrix slack bridge that works by means of user puppetting.

Get your user_access_token from here:

https://api.slack.com/docs/oauth-test-tokens

The bridge uses that access token to connect as a client using the slack RTM API.

This technique does not require admin on the slack team; instead, the bridge is simply a custom slack client.

The bridge supports multiple teams at once, see the config.sample.json

installation

clone this repo

cd into the directory

run npm install

configure

Copy config.sample.json to config.json and update it to match your setup. Add as many teams as you like by adding them to the array.

If you are running another bridge that uses the default slack prefix, change the prefix now. You cannot change this value after the bridge has created rooms and ghost users.

register the app service

Generate an slack-registration.yaml file with node index.js -r -u "http://your-bridge-server:8090"

Note: The 'registration' setting in the config.json needs to set to the path of this file. By default, it already is.

Copy this slack-registration.yaml file to your home server. Make sure that from the perspective of the homeserver, the url is correctly pointing to your bridge server. e.g. url: 'http://your-bridge-server.example.org:8090' and is reachable.

Edit your homeserver.yaml file and update the app_service_config_files with the path to the slack-registration.yaml file.

Launch the bridge with node index.js.

Restart your HS.

docker

Build the docker image with docker build -t matrix-puppet-slack ..

Copy config.sample.json to config.json and update it to match your setup. You can work in any directory you want as you have the docker image now. Set the registrationPath in the config.json to /data/slack-registration.yaml.

Generate the slack-registration.yaml file in the data volume with docker run --rm -it -v `pwd`/data:/data -v `pwd`/config.json:/usr/src/app/config.json matrix-puppet-slack node index.js -r -u "http://your-bridge-server:8090".

As discribed in register the app service copy the registration file to your homeserver and add it to your homeserver.yaml file.

Launch the bridge with docker run -v `pwd`/data:/data -v `pwd`/config.json:/usr/src/app/config.json matrix-puppet-slack or via docker-compose.

Discussion, Help and Support

Join us in the Matrix Puppet Bridge room

Features and Roadmap

  • Multi-team
  • Channel messages
  • Direct messages
  • Recieving
  • Initiating (#50)
  • Matrix -> Slack
    • Text content
    • Formatted Text content
    • Image content (m.image msgtype events)
    • Generic file uploads (m.file msgtype events)
    • Audio (m.audio msgtype events) (#66)
    • Video content (m.video msgtype events) (#67)
    • Typing notifications
    • Editing messages
    • Redacting/deleting messages (#52)
    • User Profiles
    • /me emotes (#17)
    • @-mentions
    • @room, as @channel
  • Slack -> Matrix
    • Text content
    • Formatted Text content
    • Image/Audio/Video content as protected link to slack
    • Image/Audio/Video content as upload & embed to matrix
    • Image/Audio/Video content message text
    • Typing notifications
    • Emoji reactions (#60)
    • Thread replies, as ordinary messages
    • Thread replies, as Matrix replies (#58)
    • Editing messages
    • Redacting/deleting messages
    • User Profiles
    • /me emotes (#17)
    • Presence
    • @-mentions
    • @channel/@here, as @room (Slack users' Matrix ghost users must have permission to @room notify in the Slack channel's Matrix ghost room; converting is not enough)
  • Third Party Lookup
  • Rooms
  • Users
  • Puppet a user's real Slack account.
  • Rooms react to Slack updates