Reformat gateway config channel rules

Victor 2019-10-31 22:23:16 +00:00
parent 533b88473d
commit bda41b26dc

@ -1,30 +1,61 @@
### Channel configuration for each protocol. ### Channel configuration for each protocol
:warning: Needs to be lowercase :warning: Needs to be lowercase
Below you can find how the channels (protocolchannel, and protocol2channel) should be filled in
``` Below you can find how the channels (`protocolchannel` and `protocol2channel`) should be filled in:
* irc - #channel (# is required) (this needs to be lowercase!)
* slack - channel (without the #) - irc
- ID:C123456 (where C123456 is the channel ID) does not work with webhook - `#channel_name`
* discord - channel (without the #) - \# is required
- ID:123456789 (where 123456789 is the channel ID) - must be lowercase
* mattermost - channel (the channel name as seen in the URL, not the displayname) - slack
https://yourmattermostserver/yourteam/channels/yourchannel <- yourchannel - `channel_name`
* gitter - username/room (as seen in the gitter.im url) - without the #
* xmpp - channel - `ID:C123456`
* telegram - chatid (a large negative number, eg -123456789) - where C123456 is the channel ID
see (https://www.linkedin.com/pulse/telegram-bots-beginners-marco-frau) - does not work with webhook
* hipchat - id_channel (see https://www.hipchat.com/account/xmpp for the correct channel) - discord
* rocketchat - #channel (# is required (also needed for private channels!) - `channel_name`
* matrix - #channel:server (eg #yourchannel:matrix.org) - without the #
encrypted rooms are not supported in matrix - `ID:123456789`
* steam - chatid (a large number). - where 123456789 is the channel ID
The number in the URL when you click "enter chat room" in the browser - mattermost
* whatsapp - 48111222333-123455678999@g.us A unique group JID; - `channel_name`
if you specify an empty string bridge will list all the possibilities - the channel name as seen in the URL, not the displayname
- "Group Name" if you specify a group name the bridge will hint its JID to - https://yourmattermostserver/yourteam/channels/channel_name <- channel_name
- gitter
- `username/room`
- as seen in the gitter.im url
- xmpp
- `channel_name`
- telegram
- `chatid`
- a large negative number, eg -123456789
- [more information](https://www.linkedin.com/pulse/telegram-bots-beginners-marco-frau)
- hipchat
- `id_channel`
- see [here](https://www.hipchat.com/account/xmpp) for the correct channel
- rocketchat
- `#channel_name`
- \# is required (also for private channels)
- matrix
- `#channel:server`
- e.g. `#yourchannel:matrix.org`
- encrypted rooms are not supported in matrix
- steam
- `chatid`
- a large number
- the number in the URL when you click "enter chat room" in the browser
- whatsapp
- `48111222333-123455678999@g.us`
- a unique group JID
- if you specify an empty string bridge will list all the possibilities
- `"Group Name"`
- if you specify a group name the bridge will hint its JID to
specify as group names might change in time and contain weird emoticons specify as group names might change in time and contain weird emoticons
* zulip - stream/topic:mytopic (without the #) - zulip
``` - `stream/topic:mytopic`
- without the #
### Discord ### Discord