Product DocsMenu

Atlassian Confluence V2 Connector Deployment Overview

The following procedure outlines the steps needed to deploy the Confluence V2 connector. The steps indicate the order in which you must perform configuration tasks on both the Confluence and Coveo servers.

To deploy the Confluence V2 connector

  1. Validate that your environment meets the requirements (see Atlassian Confluence V2 Connector Requirements).

  2. On your Confluence server:

    1. Enable the Confluence remote API.

      The Confluence V2 connector requires the Confluence SOAP remote API (Web service) to be enabled on your Confluence server (see the Atlassian document Enabling the Remote API).

    2. For an on-premises deployment, optionally install the Coveo plugin.

      With Confluence on-premises installations, when you want to index permissions and perform incremental refreshes, you must install the Coveo Confluence plugin on your Confluence server (see Installing the Coveo Plugin for Atlassian Confluence V2).


      • Indexing permissions associated with each Confluence object is recommended as it allows the Coveo search interface to only show Confluence documents to which the end-user performing the search has access in Confluence.

      • Because you cannot install the Coveo Confluence plugin in Confluence Cloud, Coveo cannot index permissions for this content.

  3. On the Coveo server:

    1. Create a user identity.

      Note: When configuring the source, you must use the credentials of a native Confluence user. Users managed by other identity providers such as Google are not supported.

      • When you want to leverage the Coveo plugin to index permissions and perform incremental refreshes, with Confluence on-premises installations, you must create a user identity that refers to a Confluence administrator account (member of the confluence-administrators group) (see Adding a User Identity).

      • When your Confluence server does not allow anonymous users to access the REST remote API, or when you want to crawl using a specific Confluence user, you must also create a user identity and set up your Confluence V2 source to use this user identity.

        (When you do not want the user identity to be a Confluence administrator - not recommended) The following table lists the minimal required permissions that you must grant to the user identity.

        Important: When the user identity is not a Confluence administrator, permissions as well as pages with "View" restrictions are not indexed, and incremental refreshes are not supported (see Page Restrictions).

        Permission Type Permission
        Global Can use



        Note: The user identity must have the View permission for all spaces that you want to index.

    2. Optionally create an Email security provider

      When an email is defined for each of your users in Confluence and this email is used to authenticate them in your Coveo search interface, you can create an Email security provider to allow you to map your Confluence users to their email (see Configuring an Email Security Provider).

    3. When you want to index permissions, create a security provider.

      For all on-premises supported Confluence versions, when you want to index permissions, you must configure a security provider (see Configuring an Atlassian Confluence V2 Security Provider).

    4. Create a Confluence V2 field set.

      It is recommended to import the out-of-the-box Confluence V2 field set ([CES_Path]\Bin\Coveo.CES.CustomCrawlers.COnfluence2.FieldSet.xml to be able to easily add Confluence-specific facets to your Coveo search interfaces (see Exporting and Importing a Field Set) .

    5. Configure and index the Confluence V2 source.

      The Coveo connector needs to know details about your Confluence installation to be able to index its content (see Configuring and Indexing an Atlassian Confluence V2 Source).

People who viewed this topic also viewed