Zulip Docs (#10)

This commit is contained in:
Yuhong Sun
2023-08-15 01:59:07 -07:00
committed by GitHub
parent 64c9b2f2c2
commit 23add6e7d3
6 changed files with 36 additions and 1 deletions
+34
View File
@@ -0,0 +1,34 @@
---
title: Zulip Connector
description: 'Capture discussions from Zulip Streams and Topics'
---
## How it works
The Zulip connector pulls in all streams and topics according to the permissions assigned to the bot user.
## Setting up
### Authorization
1. Danswer interfaces with Zulip as a Zulip Bot which is authenticated using the `zuliprc` config format.
For more context directly from Zulip, refer to the following docs:
- https://zulip.com/api/running-bots
- https://zulip.com/api/configuring-python-bindings
2. Start by creating a Zulip Bot
![ZulipBot](/images/connectors/zulip/ZulipBot.png)
3. Copy the Bot authentication info (`zuliprc` contents), see red arrow below:
![ZulipRC](/images/connectors/zulip/ZulipRC.png)
Keep this copied text to provide to Danswer in the next step
### Indexing
1. Navigate to the Admin Dashboard and select the **Zulip** Connector
2. In **Step 1**, paste in the copied `zuliprc` value
3. Grab your Zulip Realm/URL info, see below:
![ZulipRealmURL](/images/connectors/zulip/ZulipRealmURL.png)
4. In **Step 2**, provide the values for the Realm and URL
![DanswerZulipConfig](/images/connectors/zulip/DanswerZulipConfig.png)
Binary file not shown.

After

Width:  |  Height:  |  Size: 148 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 201 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

+2 -1
View File
@@ -65,7 +65,8 @@
"connectors/notion",
"connectors/bookstack",
"connectors/guru",
"connectors/productboard"
"connectors/productboard",
"connectors/zulip"
]
}
],