Product DocsMenu

Installing the Coveo Plugin for Atlassian Confluence V2

The second-generation Coveo connector for Confluence comes with a Confluence plugin. The connector needs the plugin to fully support incremental refreshes and index permissions associated with each Confluence item so that users only see Confluence content to which they have access in Coveo search results. It is therefore recommended to install the plugin for Confluence 5.7.x to 6.0.1 on-premises installations.

Without the plugin, you must perform a source full refresh or rebuild to take into account deleted, restored, and moved items, and items with modified comments or permissions (see Configuring and Indexing an Atlassian Confluence V2 Source). You must also set permissions globally on the source, so that all indexed Confluence content is searchable by anyone that has the permissions to view the source content (see Configuring and Indexing an Atlassian Confluence V2 Source).

Notes:

  • The Coveo plugin cannot be installed in Confluence Cloud and consequently, permissions associated with each Confluence item cannot be indexed.

  • The Coveo plugin is distributed with CES and is not available from the Atlassian Marketplace.

To install or update the Coveo Confluence Plugin

  1. Log into your Confluence server using a Confluence administrator account.

  2. On the top menu, access the Administration drop-down list menu by clicking the gear icon, and then select Add-ons.

  3. If the Administrator Access dialog box appears, enter your administrator account credentials, and then click Confirm.

  4. In the Manage add-ons page, click the Upload add-on link.

  5. In the Upload add-on dialog box:

    1. Click Choose File.

    2. In the Open dialog box, select the [CES_Path]\Bin\CoveoConfluenceEnhancedRestApi-[versionNumber].jar file from your Coveo Master server, and then click Open.

    3. Click Upload.

  6. In the Installed and ready to go! dialog box, click Close.

  7. In the User-installed add-ons list, validate that the Coveo Enhanced REST API Plugin is listed.

To uninstall the Coveo Confluence plugin

  1. Log into your Confluence server using a Confluence administrator account.

  2. On the top menu, access the Administration drop-down list menu by clicking the gear icon, and then select Add-ons.

  3. If the Administrator Access dialog box appears, enter your administrator account credentials, and then click Confirm.

  4. In the User-installed add-ons list, locate and expand Coveo Enhanced REST API Plugin.

  5. In the Coveo Enhanced REST API Plugin, click Uninstall.

  6. In the Uninstall add-on? dialog box, click Uninstall add-on.

  7. Validate the Coveo Enhanced REST API Plugin is no longer listed in the User-installed add-ons list.

People who viewed this topic also viewed