Gateway config (channel rules) - bibanon/matterbridge GitHub Wiki

Channel configuration for each protocol

:warning: Needs to be lowercase

Below you can find how the channels (protocolchannel and protocol2channel) should be filled in:

• discord
  • channel_name
    • without the #
  • ID:123456789
    • where 123456789 is the channel ID
• gitter
  • username/room
    • as seen in the gitter.im url
• hipchat
  • id_channel
    • see here for the correct channel
• irc
  • #channel_name
    • # is required
    • must be lowercase
• keybase
  • channel_name
    • without the #
    • if your team doesn't have multiple channels, use general
• matrix
  • #channel:server
    • (local) address/alias
    • e.g. #yourchannel:matrix.org
    • encrypted rooms are not supported in matrix
• mattermost
  • channel_name
    • the channel name as seen in the URL, not the displayname
    • https://yourmattermostserver/yourteam/channels/channel_name <- channel_name
  • ID:123456789
    • where 123456789 is the channel ID
• msteams
  • `channel="19:[email protected]"
    • as seen in the URL ?threadId=19:[email protected]
    • more information
• mumble
  • channel id
    • The channel ID, as shown in the channel's "Edit" window
• nctalk
  • channel
    • The token in the URL when you are in a chat. It will be the last part of the URL.
    • eg xs25tz5y
• rocketchat
  • #channel_name
    • # is required (also for private channels)
• slack
  • channel_name
    • without the #
  • ID:C123456
    • where C123456 is the channel ID
    • does not work with webhook
• sshchat
  • channel_name must be channel="sshchat"
• steam
  • chatid
    • a large number
    • the number in the URL when you click "enter chat room" in the browser
• telegram
  • channel
    • a large negative number, eg -123456789
    • more information
    • ⚠️ telegram channels will always return unknown users. telegram groups will show usernames if possible
• twitch
  • see irc
• vk
  • a number that starts form 2000000000
  • use --debug and send any message in chat to get PeerID in the logs
  • if bot is only in one chat PeerID most likely 2000000001
• whatsapp
  • [email protected]
    • 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
• xmpp
  • channel_name
• zulip
  • stream/topic:mytopic
    • without the #

Discord

See Section docs for special features