| 1 | # Matterbridge FAQ |
| 2 | |
| 3 | ## Can matterbridge relay group messages between public chats on different platforms? |
| 4 | |
| 5 | Yes, that's precisely what matterbridge is for. |
| 6 | |
| 7 | ## Does matterbridge support private chatrooms too? |
| 8 | |
| 9 | Yes, but actual support depends on the platform. |
| 10 | |
| 11 | ## Can matterbridge be used to send private messages between users? |
| 12 | |
| 13 | No, that is currently unsupported at the moment. See tracking issue [#191](https://github.com/42wim/matterbridge/issues/191). |
| 14 | |
| 15 | ## Message being skipped |
| 16 | |
| 17 | (From https://github.com/42wim/matterbridge/discussions/1566) |
| 18 | |
| 19 | Matterbridge does not relay messages from the user account that it is logged in as. Make sure it has its own account. |
| 20 | |
| 21 | |
| 22 | * [Support bridging between any protocols](#support-bridging-between-any-protocols) |
| 23 | * [Support multiple gateways(bridges) for your protocols](#support-multiple-gatewaysbridges-for-your-protocols) |
| 24 | * [Message edits and deletes](#message-edits-and-deletes) |
| 25 | * [Attachment / files handling](#attachment--files-handling) |
| 26 | * [Username and avatar spoofing](#username-and-avatar-spoofing) |
| 27 | * [Private groups](#private-groups) |
| 28 | * [API](#api) |
| 29 | |
| 30 | # Support bridging between any protocols |
| 31 | Supported protocols are Discord, IRC, Mattermost, Matrix, RocketChat, Slack, Steam, Telegram, XMPP (and our own rest API) |
| 32 | You can bridge between any (number) protocols. Even the same protocol! |
| 33 | |
| 34 | For example you can bridge Discord, Matrix and Slack. |
| 35 | A message typed in Slack will be shown in Discord, and Matrix (and the other way around) |
| 36 | |
| 37 | Follow the steps in [[How-to-create-your-config]] |
| 38 | |
| 39 | # Support multiple gateways(bridges) for your protocols |
| 40 | A gateway here is a collection of protocols that you want to bridge. |
| 41 | |
| 42 | For example you want to bridge the channel "community" on discord, mattermost and slack. |
| 43 | But you also want to bridge the channel "development" on discord, mattermost and slack. |
| 44 | |
| 45 | To create the setup above you'll have to create 2 gateways. |
| 46 | |
| 47 | See Gateway Config Advanced TODO |
| 48 | # Message edits and deletes |
| 49 | * Support incoming and outgoing edits and deletes: Discord, Mattermost, Slack, Matrix and Telegram. |
| 50 | * Support only incoming edits/deletes: RocketChat |
| 51 | * Support only edits: XMPP |
| 52 | * Support no deletes or edits: IRC, Steam(NR) |
| 53 | |
| 54 | NR = Not researched |
| 55 | |
| 56 | # Attachment / files handling |
| 57 | The logic is: Public links > Native file upload > External mediaserver > Private links |
| 58 | |
| 59 | This means that bridges: |
| 60 | - will receive the "public link" from protocols that have links to files without authentication (IRC, Discord) |
| 61 | - that support native file uploads (Discord,Matrix,Mattermost,Slack,Telegram,Rocketchat) will receive a uploaded copy of the file from protocols that have links to files with authentication (Matrix, Mattermost, Slack, Telegram) |
| 62 | - that do NOT support native file uploads (IRC, Steam, XMPP) will receive the "public link" from your "external mediaserver" from protocols that have links to files with authentication (Matrix, Mattermost, Slack, Telegram). (If you have configured an "external mediaserver") |
| 63 | - that do NOT support native file uploads (IRC, Steam, XMPP) will receive the "private link" from protocols that have links to files with authentication (Matrix, Mattermost, Slack, Telegram). (If you have not configured an "external mediaserver") |
| 64 | |
| 65 | |
| 66 | For example if you bridge between slack and discord: |
| 67 | |
| 68 | When you upload a file to slack. The link you get from slack needs authentication, so matterbridge downloads this file and reuploads it to the destination bridge Discord (which support native file uploads). If you upload a file to discord, matterbridge will just sent the link to slack (because the discord links are public and don't need authentication) |
| 69 | |
| 70 | # Username and avatar spoofing |
| 71 | Username spoofing (so it looks like the remote users) only works with webhooks for Discord, Mattermost, Slack. |
| 72 | Matterbridge reads avatars from Discord, Mattermost and Slack but can only send them to Discord, Mattermost and Slack when webhooks are enabled. |
| 73 | |
| 74 | To have avatars from mattermost visible on the other bridges, you'll have to use the external mediaserver setup. This is because avatar images from mattermost aren't publicly visible when not logged into mattermost. This means we need to download the avatar images, and upload them to the public mediaserver, and use this (now public) avatar URL in the messages sent to another bridge, eg slack. |
| 75 | |
| 76 | See webhook in advanced for specific bridge information TODO |
| 77 | |
| 78 | # Private groups |
| 79 | Private groups are supported for Mattermost and Slack |
| 80 | |
| 81 | # API |
| 82 | See [[Api]] |
| 83 | |
| 84 | |
