Confluence
Copy page
Learn how to manage Confluence sources in Inkeep
Overview
A Confluence source allows Inkeep to ingest articles from your Confluence instance.
Setup Requirements
OAuth Authorization
When you create a Confluence source, you will be redirected to an OAuth flow. Please ensure that you have admin access to the Confluence instance.
Authorization Process:
- Open the Inkeep Dashboard
- Navigate to the project you want to add the source to
- Click on Add new source
- Select Confluence
- Click on Connect
- An Atlassian web popup (OAuth redirect) will open
- Sign in to your Atlassian account if prompted
- Review the permissions requested by Inkeep
- Authorize access to your Confluence instance
- Complete the OAuth flow and return to Inkeep
Authorization
You can configure read-access for Inkeep based on:
- spaces
- tags
User vs Service Accounts
By default, the Atlassian OAuth connection happens at the user level (so the read permissions are tied to what the user has access to and what is selected during the OAuth redirect). A pattern that some customers use is to create a user account that represents the connecting service, e.g. a user named "Inkeep Connector". This allows use of Atlassian's permissioning and RBAC system, and doesn't tie the connection to the status of a single employee.
For additional details, contact sources@inkeep.com or reach out to us on Slack.