Atlassian Confluence Connector

Index spaces, pages, and comments in Confluence.

The Atlassian Confluence connector indexes spaces, pages, and comments across your Confluence instance.

The connector supports Atlassian Confluence Cloud.

Installing the Confluence app

Atolio connects to Confluence Cloud through an Atlassian Forge app that is unique to your deployment. A site administrator installs it once with the Forge CLI; afterwards Atolio manages the connection and its API credentials automatically.

Prerequisites

  • Administrator access to your Confluence Cloud site.
  • Node.js and the Forge CLI: npm install -g @forge/cli.
  • Your deployment’s connector URL, provided by your Deployment Engineer (for example https://relay.search.example.com/connectors/confluencecloud/default).
  • If you set up this connector on an Atolio version earlier than 4.24 as a “Connect Module”, uninstall the previous Atolio Confluence app first (in Confluence: Apps → Manage your apps).

Steps

  1. Confirm with your Deployment Engineer that the connector is deployed and reachable at the URL above. Empty/partial configuration is okay at this point.

  2. Create a new empty folder for the app, and download your deployment’s pre-filled manifest into it as manifest.yml.

    mkdir atolio-confluence-app && cd atolio-confluence-app
curl -o manifest.yml https://relay.search.example.com/connectors/confluencecloud/default/forge-manifest.yml

    If you run more than one Confluence instance, use the matching instance name in the URL (default above).

  3. Log in:

    forge login

    It will prompt you to provide an email, and then a token. If no token was created before, visit the link displayed by the CLI, press “Create API token with scopes” button, select “Forge” app, and continue.

  4. Register the Forge app:

    forge register "Atolio Confluence Connector"

    It will prompt you to select a “Developer Space” to host the app. If no developer space was created before, provide a name such as “Your-Company Developer Space” to create a new one, and continue.

  5. Deploy and install it on your site:

    forge deploy -e production
forge install -e production --site your-site.atlassian.net --product confluence

Once installed, the app registers itself with your Atolio deployment and indexing begins automatically. The connection is stored securely in Atolio — there is nothing further to configure.

(Optional) Scope Confluence indexing

If you want fine-grained control over which Confluence spaces should be indexed, provide a list of inclusions or exclusions to your Deployment Engineer: they can use the includes or excludes feature in Atolio configuration to control the relevant spaces that should be indexed.