| 1 | # Mattermost settings |
| 2 | |
| 3 | > [!TIP] |
| 4 | > This page contains the details about mattermost settings. More general information about mattermost support in matterbridge can be found in [README.md](README.md). |
| 5 | |
| 6 | ## Login |
| 7 | |
| 8 | login of your bot. |
| 9 | Use a dedicated user for this and not your own! |
| 10 | |
| 11 | - Setting: **REQUIRED** (when not using webhooks) |
| 12 | - Format: *string* |
| 13 | - Example: |
| 14 | ```toml |
| 15 | Login="yourlogin" |
| 16 | ``` |
| 17 | |
| 18 | ## NoTLS |
| 19 | |
| 20 | Enable this to make a http connection (instead of https) to your mattermost. |
| 21 | |
| 22 | - Setting: **OPTIONAL** |
| 23 | - Format: *boolean* |
| 24 | - Example: |
| 25 | ```toml |
| 26 | NoTLS=true |
| 27 | ``` |
| 28 | |
| 29 | ## Password |
| 30 | |
| 31 | login of your bot. |
| 32 | Use a dedicated user for this and not your own! |
| 33 | |
| 34 | - Setting: **REQUIRED** (when not using webhooks) |
| 35 | - Format: *string* |
| 36 | - Example: |
| 37 | ```toml |
| 38 | Password="yourpass" |
| 39 | ``` |
| 40 | |
| 41 | ## Server |
| 42 | |
| 43 | The mattermost hostname. (do not prefix it with http or https) |
| 44 | |
| 45 | - Setting: **REQUIRED** |
| 46 | - Format: *string* |
| 47 | - Example: |
| 48 | ```toml |
| 49 | Server="yourmattermostserver.domain" |
| 50 | ``` |
| 51 | |
| 52 | ## SkipVersionCheck |
| 53 | |
| 54 | Skip the Mattermost server version checks that are normally done when connecting. |
| 55 | The usage scenario for this feature would be when the Mattermost instance is hosted behind a |
| 56 | reverse proxy that suppresses "non-standard" response headers in flight. |
| 57 | |
| 58 | - Setting: **OPTIONAL** |
| 59 | - Format: *boolean* |
| 60 | - Example: |
| 61 | ```toml |
| 62 | SkipVersionCheck=true |
| 63 | ``` |
| 64 | |
| 65 | ## Team |
| 66 | |
| 67 | Your team on mattermost. |
| 68 | |
| 69 | - Setting: **REQUIRED** (when not using webhooks) |
| 70 | - Format: *string* |
| 71 | - Example: |
| 72 | ```toml |
| 73 | Team="yourteam" |
| 74 | ``` |
| 75 | |
| 76 | ## Token |
| 77 | |
| 78 | personal access token of the bot. |
| 79 | new feature since mattermost 4.1. See https://docs.mattermost.com/developer/personal-access-tokens.html |
| 80 | you can use token instead of login/password. |
| 81 | |
| 82 | - Setting: **OPTIONAL** (when not using webhooks) |
| 83 | - Format: *string* |
| 84 | - Example: |
| 85 | ```toml |
| 86 | Token="abcdefghijklm" |
| 87 | ``` |
| 88 | |
| 89 | ### WebhookURL |
| 90 | |
| 91 | > [!WARNING] |
| 92 | > NOT RECOMMENDED TO USE INCOMING/OUTGOING WEBHOOK. |
| 93 | > USE DEDICATED BOT USER WHEN POSSIBLE! |
| 94 | |
| 95 | Url is your incoming webhook url as specified in mattermost. |
| 96 | See account settings - integrations - incoming webhooks on mattermost. |
| 97 | If specified, messages will be sent to mattermost using this URL |
| 98 | |
| 99 | - Setting: **OPTIONAL** |
| 100 | - Format: *string* |
| 101 | - Example: |
| 102 | ```toml |
| 103 | WebhookURL="https://yourdomain/hooks/yourhookkey"` |
| 104 | ``` |
| 105 | |
| 106 | ### WebhookBindAddress |
| 107 | |
| 108 | > [!WARNING] |
| 109 | > NOT RECOMMENDED TO USE INCOMING/OUTGOING WEBHOOK. |
| 110 | > USE DEDICATED BOT USER WHEN POSSIBLE! |
| 111 | |
| 112 | Address to listen on for outgoing webhook requests from mattermost. |
| 113 | See account settings - integrations - outgoing webhooks on mattermost. |
| 114 | If specified, messages will be received from mattermost on this ip:port |
| 115 | (this will only work if `WebhookURL` is also configured) |
| 116 | |
| 117 | - Setting: **OPTIONAL** |
| 118 | - Format: *string* |
| 119 | - Example: |
| 120 | ```toml |
| 121 | WebhookBindAddress="0.0.0.0:9999" |
| 122 | ``` |
| 123 | |
| 124 | ### IconURL |
| 125 | |
| 126 | > [!WARNING] |
| 127 | > NOT RECOMMENDED TO USE INCOMING/OUTGOING WEBHOOK. |
| 128 | > USE DEDICATED BOT USER WHEN POSSIBLE! |
| 129 | |
| 130 | Icon that will be showed in mattermost. |
| 131 | This only works when `WebhookURL` is configured. |
| 132 | |
| 133 | - Setting: **OPTIONAL** |
| 134 | - Format: *string* |
| 135 | - Example: |
| 136 | ```toml |
| 137 | IconURL="http://youricon.png" |
| 138 | ``` |
| 139 | |
