Before you start
- A Pro plan or higher, and permission to edit sources in the knowledge base.
- A Confluence Cloud site, such as
acme.atlassian.net. - An Atlassian account that can read the spaces you want. A shared service account keeps the source working when a teammate leaves.
- An API token for that account. Create one at id.atlassian.com and copy it. Atlassian shows it only once.
Set up
Connect
Open the knowledge base, click Add source, pick Confluence and click Continue. Enter a Display name and click Next. Then enter the Base URL (
https://acme.atlassian.net), the account email as Atlassian email, and the API token.Choose a space (optional)
To index one space only, enter its Space key, such as
ENG. Leave it empty to index every space the account can read.Options
| Option | Default | What it does |
|---|---|---|
| Spaces Include | all spaces | Only these spaces. |
| Spaces Exclude | none | Skip these spaces. |
| Pages Include | all pages | Only these pages. |
| Pages Include With Children | none | Only these pages and everything under them. |
| Pages Exclude | none | Skip these pages. |
| Pages Exclude With Children | none | Skip these pages and everything under them. |
| Last updated after | all time | Only pages updated on or after this date (YYYY-MM-DD). |
What gets indexed
- One document per page, with its title, its place in the page tree, and a link back to Confluence.
- Headings, lists, tables, code blocks, panels and image alt text and captions.
- Macros that generate content when the page is viewed (for example a page tree or a Jira issue list) come through empty.
- Attachments are not indexed.
Sync
Confluence re-syncs every 10 minutes. Pages that have not changed are not re-embedded. Click Sync Now on the source page to sync at once. See Keeping content fresh.Troubleshooting
- The sync fails naming a space. The account can’t read that space. Give it access, or exclude the space. Kelu stops the whole sync rather than delete that space’s pages.
- 401 or 403 errors. The token was revoked or the account lost access. Create a new token and enter it on the Configuration tab.
- A page looks almost empty. Its content comes from macros. See What gets indexed.
- Too much indexed. Include only the spaces you need, or add one source per space and, on an Enterprise plan, organize them with source groups.
- The wiki must stay internal. Add the source to an internal knowledge base. See Visibility.