From bda41b26dc1a4e3f1d5fddff94870f0447e46e0d Mon Sep 17 00:00:00 2001 From: Victor Date: Thu, 31 Oct 2019 22:23:16 +0000 Subject: [PATCH] Reformat gateway config channel rules --- Gateway-config-(channel-rules).md | 85 +++++++++++++++++++++---------- 1 file changed, 58 insertions(+), 27 deletions(-) diff --git a/Gateway-config-(channel-rules).md b/Gateway-config-(channel-rules).md index 38c21ef..05d5986 100644 --- a/Gateway-config-(channel-rules).md +++ b/Gateway-config-(channel-rules).md @@ -1,31 +1,62 @@ -### 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 -See Section docs for special features \ No newline at end of file +See Section docs for special features