diff --git a/connectors/zulip.mdx b/connectors/zulip.mdx new file mode 100644 index 0000000..0d1bda8 --- /dev/null +++ b/connectors/zulip.mdx @@ -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) diff --git a/images/connectors/zulip/DanswerZulipConfig.png b/images/connectors/zulip/DanswerZulipConfig.png new file mode 100644 index 0000000..9b2efb1 Binary files /dev/null and b/images/connectors/zulip/DanswerZulipConfig.png differ diff --git a/images/connectors/zulip/ZulipBot.png b/images/connectors/zulip/ZulipBot.png new file mode 100644 index 0000000..17dfe66 Binary files /dev/null and b/images/connectors/zulip/ZulipBot.png differ diff --git a/images/connectors/zulip/ZulipRC.png b/images/connectors/zulip/ZulipRC.png new file mode 100644 index 0000000..796a5e8 Binary files /dev/null and b/images/connectors/zulip/ZulipRC.png differ diff --git a/images/connectors/zulip/ZulipRealmURL.png b/images/connectors/zulip/ZulipRealmURL.png new file mode 100644 index 0000000..15ab74d Binary files /dev/null and b/images/connectors/zulip/ZulipRealmURL.png differ diff --git a/mint.json b/mint.json index a8eb3fd..6f26610 100644 --- a/mint.json +++ b/mint.json @@ -65,7 +65,8 @@ "connectors/notion", "connectors/bookstack", "connectors/guru", - "connectors/productboard" + "connectors/productboard", + "connectors/zulip" ] } ],