GitHub/matterbridge
3
0
Fork 0
mirror of https://github.com/42wim/matterbridge.git synced 2024-11-28 15:09:26 +01:00
Code Issues Projects Releases Wiki Activity

Reformat gateway config channel rules

Victor 2019-10-31 22:23:16 +00:00
parent 533b88473d
commit bda41b26dc
1 changed files with 58 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
Gateway-config-(channel-rules).md

@ -1,30 +1,61 @@
### Channel configuration for each protocol.
### Channel configuration for each protocol
:warning: Needs to be lowercase
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 #)
- ID:C123456 (where C123456 is the channel ID) does not work with webhook
* discord - channel (without the #)
- ID:123456789 (where 123456789 is the channel ID)
* mattermost - channel (the channel name as seen in the URL, not the displayname)
https://yourmattermostserver/yourteam/channels/yourchannel <- yourchannel
* gitter - username/room (as seen in the gitter.im url)
* xmpp - channel
* telegram - chatid (a large negative number, eg -123456789)
see (https://www.linkedin.com/pulse/telegram-bots-beginners-marco-frau)
* hipchat - id_channel (see https://www.hipchat.com/account/xmpp for the correct channel)
* rocketchat - #channel (# is required (also needed for private channels!)
* matrix - #channel:server (eg #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
* zulip - stream/topic:mytopic (without the #)
```
Below you can find how the channels (`protocolchannel` and `protocol2channel`) should be filled in:
- irc
- `#channel_name`
- \# is required
- must be lowercase
- slack
- `channel_name`
- without the #
- `ID:C123456`
- where C123456 is the channel ID
- does not work with webhook
- discord
- `channel_name`
- without the #
- `ID:123456789`
- where 123456789 is the channel ID
- mattermost
- `channel_name`
- the channel name as seen in the URL, not the displayname
- 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
- zulip
- `stream/topic:mytopic`
- without the #
### Discord