| 1 |
|
| 2 | # Hubot Slack Relay
|
| 3 |
|
| 4 | A script to relay messages from a local channel to a remote channel on a separate slack server without an account. This script is designed
|
| 5 | specifically for use with Hubot and the Slack adapter.
|
| 6 |
|
| 7 | ## Features
|
| 8 |
|
| 9 | * Multiple local channels can relay to multiple remote channels
|
| 10 | * No need for additional bots
|
| 11 | * Accounts not required on each slack server
|
| 12 |
|
| 13 | ## Installation
|
| 14 |
|
| 15 | `npm install hubot-slack-relay`
|
| 16 |
|
| 17 | Then add `"hubot-slack-relay"` to `external-scripts.json`
|
| 18 |
|
| 19 | ## Commands
|
| 20 |
|
| 21 | ### Adding Relays
|
| 22 |
|
| 23 | Adds a relay from the local channel to the remote channel. The remote token will be the same token as the remote HUBOT\_SLACK_TOKEN.
|
| 24 |
|
| 25 | *NOTE:* Tokens are private and this should be setup via Direct Messaging.
|
| 26 |
|
| 27 | `hubot relay add <local-channel> <remote-channel> <remote-token>`
|
| 28 |
|
| 29 | ### Remove Relays
|
| 30 |
|
| 31 | Removes relays from the local channel specified. All remote channels can be removed or single remote channels can be removed one by one.
|
| 32 |
|
| 33 | `hubot relay remove <local-channel> [<remote-channel>]`
|
| 34 |
|
| 35 | ### List Relays
|
| 36 |
|
| 37 | Show all existing local server to remote server relay mappings and a partial token listing in case of duplicates.
|
| 38 |
|
| 39 | `hubot relay list`
|
| 40 |
|
| 41 |
|