Product DocsMenu

Atlassian Confluence Connector Deployment Overview

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

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

  2. On your Confluence server:

    1. Enable the Confluence remote API.

      The Confluence 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. Optionally install the Coveo plugin.

      With Confluence version 3.5.0 to 4.x installations, when you want to index permissions, you must install the Coveo Confluence plugin on your Confluence server (see Installing the Coveo Plugin for Atlassian Confluence).

      Note: 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.

  3. On the Coveo server:

    1. Optionally create a user identity.

      The Confluence connector allows anonymous crawling. When your Confluence server does not allow anonymous users to access the SOAP remote API or when you want to crawl using a specific Confluence user, you must create a user identity and setup your Confluence source to use this user identity (see Adding a User Identity).

      With Confluence version 3.5.0 to 4.x installations, when you want to index permissions, a user identity is also required and it must refer to a Confluence administrator account.

    2. Optionally create a security provider.

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

    3. Configure and index the Confluence source.

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

  4. In the Interface Editor, consider adding Confluence specific items to your search interface:

    1. Add the built-in Confluence facets.

      CES comes with three built-in Confluence facets (Space, Type, Label) that you can add to your search interface so that end-users can more easily refine Confluence content in search results (see Managing Built-in Facets Appearing in a Search Interface).

    2. Add the Confluence Labels display field.

      In the search results, you can make the Confluence Labels value appear for each Confluence document using the syscflabels field (see Adding Display Fields).