GitHub/matterbridge
3
0
Fork 0
mirror of https://github.com/42wim/matterbridge.git synced 2024-11-22 20:19:35 +01:00
Code Issues Projects Releases Wiki Activity

Improve grammar and writing. Add a reminder about checking whether the Discord bot is banned from the server.

Hugo Locurcio 2020-10-01 15:19:46 +02:00
parent 1dd9d42b1f
commit 5f96ca1948
1 changed files with 32 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
FAQ.md

@ -1,15 +1,16 @@
## Something doesn't work ## Something doesn't work
First create a basic configuration following https://github.com/42wim/matterbridge/wiki/How-to-create-your-config First, create a basic configuration following https://github.com/42wim/matterbridge/wiki/How-to-create-your-config
Also read the [features](https://github.com/42wim/matterbridge/wiki/Features) Also, read the [Features](https://github.com/42wim/matterbridge/wiki/Features) page.
FAQ for: FAQ for:
* [Slack](#slack) * [Slack](#slack)
* [Discord](#discord) * [Discord](#discord)
* [Telegram](#telegram) * [Telegram](#telegram)
* [Mattermost](#mattermost) * [Mattermost](#mattermost)
* [Steam](#steam) * [Steam](#steam)
* [rocketchat](#rocketchat) * [Rocket.Chat](#rocket-chat)
# Slack # Slack
## Messages come from Slack API tester ## Messages come from Slack API tester
@ -17,39 +18,41 @@ Did you set `RemoteNickFormat`?
Try adding `RemoteNickFormat="<{NICK}>"` Try adding `RemoteNickFormat="<{NICK}>"`
## Messages from other bots aren't getting relayed ## Messages from other bots aren't getting relayed
If you're using `WebhookURL` in your slack configuration this is normal. If you're using `WebhookURL` in your Slack configuration, this is normal.
If you only have `Token` configuration this could be a bug, please open an issue. If you only have `Token` configuration, this could be a bug. Please open an issue.
# Gitter # Gitter
## Messages deleted on gitter aren't deleted on other bridges ## Messages deleted on Gitter aren't deleted on other bridges
Gitter doesn't send delete events to their API, so we can't pick those up. Gitter doesn't send delete events to their API, so we can't pick those up.
When you delete a message on another bridge slack, they will be deleted on gitter though. (matterbridge can delete messages on gitter, but we do not get an event when a message on gitter is deleted) When you delete a message on another bridge Slack, they will be deleted on Gitter though. (matterbridge can delete messages on Gitter, but we do not get an event when a message on Gitter is deleted).
So slack <=> gitter bridge, deleting messages when on gitter doesn't get deleted on slack. So Slack <=> Gitter bridge, deleting messages when on Gitter doesn't get deleted on Slack.
On the same bridge, deleting messages on slack gets also deleted on gitter. On the same bridge, deleting messages on slack gets also deleted on Gitter.
# Discord # Discord
## Discord is not getting or receiving messages ## Discord is not getting or receiving messages
Did you specify the correct channel name ? Did you specify the correct channel name?
Try using the ID. Try using the ID instead of the channel name.
You can find the number in the URL of the channel: You can find the number in the URL of the channel:
`https://discordapp.com/channels/number1/number2` `https://discordapp.com/channels/number1/number2`
Instead of `channel="name"` set `channel="ID:number2"` Instead of `channel="name"`, set `channel="ID:number2"`.
## Seeing id's instead of usernames on the other bridges ? Also, make sure your bot hasn't been banned from the server for some reason.
## Seeing IDs instead of usernames on the other bridges?
If you want roles/groups mentions to be shown with names instead of ID, you'll need to give your bot the "Manage Roles" permission. If you want roles/groups mentions to be shown with names instead of ID, you'll need to give your bot the "Manage Roles" permission.
## Can I join the bot to a server I don't own ? ## Can I join the bot to a server I don't own?
You need permissions on the server to be able to join the bot, if you're allowed to here's how you do it: You need permissions on the server to be able to join the bot, if you're allowed to here's how you do it:
Click on the bot here: https://discordapp.com/developers/applications/me Click on the bot here: https://discordapp.com/developers/applications/me
Click the "Generate OAUTH" button, copy the URL and paste it into your address bar, open the page and you'll see the drop down menu for adding the bot to any server you have permissions on. Click the "Generate OAUTH" button, copy the URL and paste it into your address bar, open the page and you'll see the drop down menu for adding the bot to any server you have permissions on.
## Files/images not getting uploaded ? ## Files/images not getting uploaded?
If you are using the discord webhook and the discord token, the webhook will be used for posting messages. If you are using the discord webhook and the discord token, the webhook will be used for posting messages.
The webhook can't do native upload of files/images to discord. The webhook can't do native upload of files/images to discord.
@ -57,7 +60,7 @@ Possible solution:
* Disable the webhook and use only the token. (you'll loose the avatar/nick changing) * Disable the webhook and use only the token. (you'll loose the avatar/nick changing)
* Setup a [mediaserver](Mediaserver-setup-(advanced)) this way matterbridge will upload the files/images to the mediaserver and the webhook will post the URL of the files/images on the mediaserver. * Setup a [mediaserver](Mediaserver-setup-(advanced)) this way matterbridge will upload the files/images to the mediaserver and the webhook will post the URL of the files/images on the mediaserver.
## Messages not being edited, but a new message with (edit) appears ? ## Messages not being edited, but a new message with (edit) appears?
Message editing is not supported by discord using webhooks. If you want message editing, disable webhooks and use token only Message editing is not supported by discord using webhooks. If you want message editing, disable webhooks and use token only
# Telegram # Telegram
@ -73,8 +76,9 @@ Disable privacy mode with @Botfather.
* Go to [BotFather](https://t.me/botfather) send /setprivacy. * Go to [BotFather](https://t.me/botfather) send /setprivacy.
* Select the username of the bot. * Select the username of the bot.
* Select Disable. * Select Disable.
Kick bot from chat if it's already in it. * Kick bot from chat if it's already in it.
Invite bot to chat. * Invite bot to chat.
The order is important. The order is important.
## Matterbridge is not relaying images/stickers/files from Telegram ## Matterbridge is not relaying images/stickers/files from Telegram
@ -91,22 +95,22 @@ Telegram doesn't has "deleted messages" metadata, so we don't know which message
# Mattermost # Mattermost
## mattermost not sending to other bridges. ## mattermost not sending to other bridges.
You did create a dedicated account for matterbridge ? Did you create a dedicated account for matterbridge?
See https://github.com/42wim/matterbridge/wiki/Section-Mattermost-(basic) See https://github.com/42wim/matterbridge/wiki/Section-Mattermost-(basic)
## "version not supported error" ## "version not supported error"
By default matterbridge tries https to connect to your mattermost setup. By default, matterbridge tries HTTPS to connect to your Mattermost setup.
If you're using a test setup for mattermost, this will probably listen on http and on port 8065. If you're using a test setup for Mattermost, this will probably listen on HTTP and on port 8065.
Add ```NoTLS=true``` and use ```Server="yourmattermostserver.domain:8065"``` to your mattermost config. Add ```NoTLS=true``` and use ```Server="yourmattermostserver.domain:8065"``` to your Mattermost configuration.
Also see https://github.com/42wim/matterbridge/wiki/Section-Mattermost-(basic) See also https://github.com/42wim/matterbridge/wiki/Section-Mattermost-(basic)
### mattermost doesn't show the IRC nicks ### Mattermost doesn't show the IRC nicks
If you're running the webhooks version, this can be fixed by either: If you're running the webhooks version, this can be fixed by either:
* enabling "override usernames". See [mattermost documentation](http://docs.mattermost.com/developer/webhooks-incoming.html#enabling-incoming-webhooks) * enabling "override usernames". See [mattermost documentation](http://docs.mattermost.com/developer/webhooks-incoming.html#enabling-incoming-webhooks)
* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml. * setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml.
If you're running the login/password version you'll need to: If you're running the login/password version, you'll need to:
* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml. * setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml.
Also look at the ```RemoteNickFormat``` setting. Also look at the ```RemoteNickFormat``` setting.
@ -118,8 +122,8 @@ or increase the session timeout, see https://forum.mattermost.org/t/solved-remov
## Steam ## Steam
## Bridge doesn't seem to work ## Bridge doesn't seem to work
See https://github.com/42wim/matterbridge/issues/351 and https://support.steampowered.com/kb_article.php?ref=3330-IAGK-7663 See https://github.com/42wim/matterbridge/issues/351 and https://support.steampowered.com/kb_article.php?ref=3330-IAGK-7663
Apparently the account you use need to do a purchase on steam for it to work. Apparently, the account you use needs to make a purchase on Steam for it to work.
## Rocketchat ## Rocket.Chat
## Alias not changing when messages are sent without receiving other messages between ## Alias not changing when messages are sent without receiving other messages between
Bug in rocketchat. See: https://github.com/RocketChat/Rocket.Chat/issues/7549 This is a bug in Rocket.Chat. See: https://github.com/RocketChat/Rocket.Chat/issues/7549