No description
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2020-04-22 16:10:00 +01:00
config Update README, move config into a config file 2016-08-12 14:37:33 +01:00
app.js Remove commented-out bits 2016-09-07 12:15:12 +01:00
LICENSE Add copy of the Apache-2.0 license (#3) 2020-04-22 16:10:00 +01:00
package.json add initial version 2016-07-29 11:40:26 +01:00
README.md Update README.md 2016-08-29 17:06:07 -07:00

matrix-appservice-rocketchat

A Rocket Chat application service

This is currently a very barebones bridge, it just does basic text in pre-enumerated channels.

To install:

$ npm install

To set up on the Rocket Chat side:

  • Add inbound & outbound webhook integrations to the room you want to bridge.
  • For the inbound webhook, note down the webhook URL that Rocket Chat provisions for you - e.g. http://matrix.org:3000/hooks/xxx/yyy
  • For the outbound webhook, you'll need to expose your bridge to the internet and hand the URL to Rocket Chat - e.g. https://rocketchatbridge.matrix.org

To set up on the Matrix side: Create a config.yaml file (there's a skeleton one in config/config.sample.yaml). Add the homeserver details, the port of the listener, the Matrix Room ID and the Rocket Chat webhook URL to this file.

You might want to restrict the AS to a room. This is done by adding the following to the config:

  rooms:
    - exclusive: false
      regex: "!xxx:matrix.org"

Then generate a registration file by running:

$ node app.js -r -c config.yaml -u "http://localhost:9000"

Reference the registration yaml file from your homeserver's homeserver.yaml config and restart the server to pick it up.

Start your application service:

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

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