| 1 | # Zulip |
| 2 | |
| 3 | - Status: ??? |
| 4 | - Maintainers: ??? |
| 5 | - Features: |
| 6 | - attachments: no |
| 7 | |
| 8 | ## Configuration |
| 9 | |
| 10 | > [!TIP] |
| 11 | > For detailed information about zulip settings, see [settings.md](settings.md) |
| 12 | |
| 13 | > [!WARNING] |
| 14 | > Don't forget to make sure that the streams you want to bridge exit and |
| 15 | > are subscribed to by the new bot. Otherwise, things will break. You can |
| 16 | > subscribe the bot using the stream's settings, under "Stream membership". |
| 17 | |
| 18 | **Basic configuration example:** |
| 19 | |
| 20 | ```toml |
| 21 | [zulip.myzulip] |
| 22 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " |
| 23 | Token="Yourtokenhere" |
| 24 | #Login is the Username of the bot you've got when creating the bot |
| 25 | Login="yourbot-bot@yourserver.com" |
| 26 | #The URL of your zulip server |
| 27 | Server="https://yourserver.com" |
| 28 | ``` |
| 29 | |
| 30 | ## FAQ |
| 31 | |
| 32 | ### How to generate the zulip token for my matterbridge bot? |
| 33 | |
| 34 | 1. Navigate to Settings () -> Your bots -> Add a new bot. |
| 35 | 2. Select Generic for bot type, fill out the form and click on Create bot. |
| 36 | 3. Token is the API key, you've got when creating the bot |
| 37 | |
| 38 |  |
| 39 | |
