| 1 | # Zulip settings |
| 2 | |
| 3 | > [!TIP] |
| 4 | > This page contains the details about zulip settings. More general information about zulip support in matterbridge can be found in [README.md](README.md). |
| 5 | |
| 6 | ## Login |
| 7 | |
| 8 | Username of the bot, normally called yourbot-bot@yourserver.zulipchat.com. |
| 9 | |
| 10 | See `username` in `Settings` → `Your bots`. |
| 11 | |
| 12 | - Setting: **REQUIRED** |
| 13 | - Format: *string* |
| 14 | - Example: |
| 15 | ```toml |
| 16 | Login="yourbot-bot@yourserver.zulipchat.com" |
| 17 | ``` |
| 18 | |
| 19 | ## Server |
| 20 | |
| 21 | URL of your zulip instance. |
| 22 | |
| 23 | - Setting: **REQUIRED** |
| 24 | - Format: *string* |
| 25 | - Example: |
| 26 | ```toml |
| 27 | Server="https://yourserver.zulipchat.com" |
| 28 | ``` |
| 29 | |
| 30 | ## Token |
| 31 | |
| 32 | Zulip API token (called bot API key in `Settings` → `Your bots`). |
| 33 | |
| 34 | - Setting: **REQUIRED** |
| 35 | - Format: *string* |
| 36 | - Example: |
| 37 | ```toml |
| 38 | Token="Yourtokenhere" |
| 39 | ``` |
| 40 | |
