| 1 | # Mattermost |
| 2 | |
| 3 | - Status: ??? |
| 4 | - Maintainers: ??? |
| 5 | - Features: ??? |
| 6 | |
| 7 | > [!WARNING] |
| 8 | > **Create a dedicated user first. It will not relay messages from yourself if you use your account** |
| 9 | |
| 10 | ## Configuration |
| 11 | |
| 12 | > [!TIP] |
| 13 | > For detailed information about mattermost settings, see [settings.md](settings.md) |
| 14 | |
| 15 | **Basic configuration example:** |
| 16 | |
| 17 | ```toml |
| 18 | [mattermost.mymattermost] |
| 19 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " |
| 20 | # Don't use http or https scheme in the Server |
| 21 | Server="yourmattermostserver.domain:443" |
| 22 | # Uncomment if you're accessing your server over plaintext HTTP |
| 23 | #NoTLS=true |
| 24 | |
| 25 | #the team name as can be seen in the mattermost webinterface URL |
| 26 | #in lowercase, without spaces |
| 27 | Team="yourteam" |
| 28 | |
| 29 | Login="yourlogin" |
| 30 | Password="yourpass" |
| 31 | |
| 32 | PrefixMessagesWithNick=true |
| 33 | PreserveThreading=true |
| 34 | ``` |
| 35 | |
| 36 | ## FAQ |
| 37 | |
| 38 | ### "version not supported error" |
| 39 | |
| 40 | By default, matterbridge tries HTTPS to connect to your Mattermost setup. |
| 41 | If you're using a test setup for Mattermost, this will probably listen on HTTP and on port 8065. |
| 42 | |
| 43 | Add ```NoTLS=true``` and use ```Server="yourmattermostserver.domain:8065"``` to your Mattermost configuration. |
| 44 | |
| 45 | ### Mattermost doesn't show the IRC nicks |
| 46 | |
| 47 | If you're running the webhooks version, this can be fixed by either: |
| 48 | * enabling "override usernames". See [mattermost documentation](http://docs.mattermost.com/developer/webhooks-incoming.html#enabling-incoming-webhooks) |
| 49 | * setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml. |
| 50 | |
| 51 | If you're running the login/password version, you'll need to: |
| 52 | * setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml. |
| 53 | |
| 54 | Also look at the ```RemoteNickFormat``` setting. |
| 55 | |
| 56 | ### Session expire |
| 57 | |
| 58 | Use personal access tokens [that don't expire](https://docs.mattermost.com/developer/personal-access-tokens.html), or [increase the session timeout](https://forum.mattermost.org/t/solved-removing-the-session-timeout/3033). |
| 59 | |
