Atlassian Confluence Legacy 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.

To deploy the Confluence Legacy connector

1. Validate that your environment meets the requirements (see Atlassian Confluence Legacy 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. For an on-premises deployment, optionally install the Coveo plugin.

      With Confluence version 3.5.0, 4.x, and 5.8.5 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.

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

3. On the Coveo server:

   1. Create a user identity.

      When you want to index permissions, 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 set up your Confluence source to use this user identity (see Adding a User Identity).

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

      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.

   2. 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 Creating a Security Provider for the Atlassian Confluence Legacy Connector).

   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 Configuring and Indexing an Atlassian Confluence Source With the Legacy Connector).

4. In the Interface Editor, consider adding Confluence specific items to your Coveo .NET Front-End 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 and Related Results Appearing in a .NET 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 to Search Results With the .NET Interface Editor).

   3. Integrate a Coveo .NET search interface in Confluence

      You can replace the Confluence search page by a Coveo search interface (see Integrating Coveo .NET Search UI in Confluence). This is particularly useful when your Coveo index contains several other sources, bringing this content into Confluence through the search interface.

   4. Add a Confluence security provider to an outside Confluence search interface

      When a Coveo .NET Front-End search interface used to search for Confluence content is not integrated in Confluence, you must add a security provider to the search interface to allow each user to log in to the search interface with their Confluence credentials, and then be able to see, in the search results, the secured Confluence content for which they have read permissions (see Adding Security Providers to a .NET Search Interface).