| 1 | # RocketChat settings |
| 2 | |
| 3 | > [!TIP] |
| 4 | > This page contains the details about rocketchat settings. More general information about rocketchat support in matterbridge can be found in [README.md](README.md). |
| 5 | |
| 6 | ## Login |
| 7 | |
| 8 | login needs to be the login with email address! user@domain.com |
| 9 | Use a dedicated user for this and not your own! |
| 10 | |
| 11 | - Setting: **REQUIRED** |
| 12 | - Format: *string* |
| 13 | - Example: |
| 14 | ```toml |
| 15 | Login="yourlogin@domain.com" |
| 16 | ``` |
| 17 | |
| 18 | ## Password |
| 19 | |
| 20 | - Setting: **REQUIRED** |
| 21 | - Format: *string* |
| 22 | - Example: |
| 23 | ```toml |
| 24 | Password="yourpass" |
| 25 | ``` |
| 26 | |
| 27 | ## Server |
| 28 | |
| 29 | The rocketchat hostname. (prefix it with http or https) |
| 30 | |
| 31 | - Setting: **REQUIRED** |
| 32 | - Format: *string* |
| 33 | - Example: |
| 34 | ```toml |
| 35 | Server="https://yourrocketchatserver.domain.com:443" |
| 36 | ``` |
| 37 | |
| 38 | ### WebhookBindAddress |
| 39 | |
| 40 | Address to listen on for outgoing webhook requests from rocketchat. |
| 41 | See administration - integrations - new integration - outgoing webhook |
| 42 | |
| 43 | - Setting: **OPTIONAL** |
| 44 | - Format: *string* |
| 45 | - Example: |
| 46 | ```toml |
| 47 | WebhookBindAddress="0.0.0.0:9999" |
| 48 | ``` |
| 49 | |
| 50 | ### Nick |
| 51 | |
| 52 | Your nick/username as specified in your incoming webhook "Post as" setting |
| 53 | |
| 54 | - Setting: **OPTIONAL** |
| 55 | - Format: *string* |
| 56 | - Example: |
| 57 | ```toml |
| 58 | Nick="matterbot" |
| 59 | ``` |
| 60 | |
| 61 | ### WebhookURL |
| 62 | |
| 63 | Url is your incoming webhook url as specified in rocketchat ([docs](https://rocket.chat/docs/administrator-guides/integrations/#how-to-create-a-new-incoming-webhook)). |
| 64 | See administration - integrations - new integration - incoming webhook |
| 65 | |
| 66 | - Setting: **OPTIONAL** |
| 67 | - Format: *string* |
| 68 | - Example: |
| 69 | ```toml |
| 70 | WebhookURL="https://yourdomain/hooks/yourhookkey" |
| 71 | ``` |
| 72 | |
