Skip to content

Commit

Permalink
Update Confluence docs (#167)
Browse files Browse the repository at this point in the history
  • Loading branch information
hagen-danswer authored Jan 10, 2025
1 parent d9a2586 commit 39f36e4
Showing 1 changed file with 19 additions and 21 deletions.
40 changes: 19 additions & 21 deletions connectors/confluence.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ title: Confluence Connector
description: "Access knowledge from your company Wiki"
---

## How it works

The Confluence connector pulls in all pages and comments from the specified spaces/pages every 10 minutes.
The Confluence connector pulls in all pages and comments from the specified spaces/pages once at the beginning and then pulls updates every 10 minutes.

## Setting up

Expand All @@ -16,23 +14,23 @@ The Confluence connector pulls in all pages and comments from the specified spac
### Indexing

1. Navigate to the Admin Dashboard and select the **Confluence** Connector
2. In **Step 1**, provide the **Access Token** and the **Username** (typically an email) it belongs to:

![ConfluenceConnector](/images/connectors/confluence/ConfluenceAuth.png)

3. In **Step 2**, provide the following information:
2. For your credentials, provide the **Access Token** and the **Username** (typically an email) it belongs to:
3. For Confluence setup, you must provide:
- **Wiki Base URL**: The base URL of your Confluence instance (e.g., https://your-domain.atlassian.net/wiki)
- **Space**: The Confluence space name to index (e.g., `KB`)
- **Page ID** (optional): Specific page ID to index - leave empty to index the entire space (e.g., `131368` for a specific page)
- **Index Recursively**: Check this box to index the specified page and all of its children
- **Whether you're using Confluence Cloud or Datacenter**: Check the `Is Cloud` box if you are using a Confluence Cloud instance, uncheck for Confluence Server/Data Center

4. Click the `Connect` button! All the specified spaces/pages and related comments will now be pulled into Onyx every **10** minutes.

Note: If no Page ID is provided, the entire space will be indexed. Here's an example to illustrate:

- Wiki Base URL: "https://example-company.atlassian.net/wiki"
- Space: "KB" (for Knowledge Base)
- Page ID: "164331"

This configuration would index the specific page at https://example-company.atlassian.net/wiki/spaces/KB/pages/164331/SomePage. If you leave the Page ID empty, it will index the entire KB space.
4. Then choose how you'd like this connector to index your Confluence instance:
- Everything:
- If you select this option, the connector will index everything the provided credentials have access to.
- Space:
- Input the key of the space you'd like to index (e.g., `KB`)
- Page:
- Page ID: Specific page ID to index - leave empty to index the entire space (e.g., `131368` for a specific page)
- Index Recursively: Check this box to index the specified page AND all of its children.
- CQL Query:
- If you'd like finer control over what is indexed, you can use a CQL query. The query must contain 'type=page' and any lastmodified filters will be overwritten. See the [CQL documentation](https://developer.atlassian.com/server/confluence/advanced-searching-using-cql/) for more information.

5. Click the `Connect` button! All the specified spaces/pages and related comments will now be pulled into Onyx every **10** minutes.

#### Permission Syncing

If you are an enterprise customer connecting to Confluence Server/Data Center and you would like to enable permission syncing, the provided credentials must be from an admin user.

0 comments on commit 39f36e4

Please sign in to comment.