Skip to main content

Add the Confluence integration

Once Confluence is connected, the search of Astrolabe finds its pages: type a word of a page, and the page is in the list. You do this once, as an Astrolabe administrator.

🔑 1. Create a token in Confluence​

The token reads what its owner can see: the account must be able to open the pages you want to find. No Confluence administrator right is needed.

  1. Log in to Confluence with the account Astrolabe will read with.
  2. Open your profile, then Personal Access Tokens, then click Create token.
  3. Give it a name (Astrolabe), then create it.
  4. Copy the token as is.

🔌 2. Add the integration​

  1. In the left sidebar, at the bottom, click Administration.

  2. Under PLATFORM, click Company connections.

  3. On the Confluence card, click Configure.

  4. Top right, click Add Token.

  5. Fill in the form:

    FieldWhat to enterExample
    NameA name of your choice (the form proposes Confluence)Confluence
    Confluence hostThe domain name of your Confluence, with its port if it is not 443; no https://wiki.example.com
    API tokenThe token of step 1, pasted as is

  6. Click Test connection. The form says Connection works: the source accepted the credentials.

  7. Click Add. Astrolabe restarts on its own, in a few seconds.

The token is in the list, with State set to Connected.

🗂️ 3. Choose the spaces to search (optional)​

Without this step, Astrolabe searches every space the token's account can read. To keep only some, do this in the form of step 2, before Add:

  1. Click Optional settings.
  2. In Spaces to search, type the keys of the spaces, separated by commas: ENG, OPS. The key of a space is in its address: .../spaces/ENG/....
  3. Click Add.

Test connection does not check the space keys. A key that matches no space is said later, in Administration › Problems: see Common problems with Confluence.

Two other optional fields are in Optional settings: E-mail (Confluence Cloud only: the e-mail of the Atlassian account that owns the API token) and Context path (a Confluence installed under a path, such as /confluence). Leave both empty otherwise.

Confluence Cloud

A Confluence Cloud (.atlassian.net) takes the E-mail of the Atlassian account together with an API token of this account (id.atlassian.com, Security, Create and manage API tokens). This path was not tried on a Confluence Cloud instance.

✅ That's it!

Next: Find a Confluence page in the search.