diff --git a/connectors/outline.mdx b/connectors/outline.mdx new file mode 100644 index 00000000..55c2c493 --- /dev/null +++ b/connectors/outline.mdx @@ -0,0 +1,36 @@ +--- +title: Outline Connector +description: "Access knowledge from your Outline workspace" +--- + +## How it works + +The Outline connector indexes documents and collections from your Outline workspace. + +## Setting up + +### Authorization + +1. Login to your Outline workspace +2. Navigate to **Preferences → API & Apps** + +![OutlineConnectorAuth](/images/connectors/outline/outline_1.png) + +3. Click **New API Key...** to generate a new API key +4. Provide a name for your API key and set any desired scope limitations or expiration date + - If creating a scoped API key, ensure you include `collections.list` and `documents.list` permissions + +![OutlineConnectorAuth](/images/connectors/outline/outline_2.png) + +5. Copy the generated API key - you'll need this along with your workspace's base URL to authorize your Onyx connector + +### Indexing + +1. Navigate to the Admin Dashboard. +2. In the sidebar select **Add Connector** and click on the **Outline** tile. +3. Select **Create New** and then provide your **Base URL** and **API Key**, along with an optional name for your credentials. + - **Base URL**: Your Outline workspace URL (e.g., `https://yourcompany.getoutline.com`) + - **API Key**: The API key you generated in the previous steps +4. Click **Create** and your credentials will be saved and automatically selected. +5. After selecting **Continue** you can choose a name for your connector and then click **Create Connector**. +6. Once you have created your connector Onyx will automatically begin indexing your documents and collections. \ No newline at end of file diff --git a/images/connectors/outline/outline_1.png b/images/connectors/outline/outline_1.png new file mode 100644 index 00000000..038b8542 Binary files /dev/null and b/images/connectors/outline/outline_1.png differ diff --git a/images/connectors/outline/outline_2.png b/images/connectors/outline/outline_2.png new file mode 100644 index 00000000..7b7f4b8f Binary files /dev/null and b/images/connectors/outline/outline_2.png differ