Installing the Coveo Plugin for Atlassian Confluence

The second-generation Coveo source for Confluence comes with a Confluence plugin. The source needs the plugin to fully support refreshes and index permissions associated with each Confluence item so that users only see in the Coveo search results what they can see in Confluence. It’s therefore recommended to install the plugin for Confluence on-premises installations.

Without the plugin, you must perform a source rescan or rebuild to take into account deleted, restored, moved items, and items with modified comments or permissions (see Configure Source Schedules). 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 Content Security).

The Coveo plugin can’t be installed in Confluence Cloud. Therefore, it’s not supported to index Confluence Cloud item permissions.

Install or Update the Coveo Confluence Plugin

  1. Download the Coveo plugin for Confluence, if not already done:

    1. On the Sources page, access the Add/Edit a Confluence Self-Hosted Source panel:

      • If you already have created a Confluence on-premises source, click the source, and then in the Action bar, click Edit.

      • If not, click Add Source > Confluence > Confluence Self-Hosted.

    2. In the Add/Edit a Confluence Self-Hosted Source panel, in the Configuration tab, click Download Plugin.

  2. Log in to your Confluence server using a Confluence administrator account.

  3. On the top menu, access the Administration drop-down menu by clicking the cogwheel icon, and then select Add-ons.

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

  5. On the Manage add-ons page, click the Upload add-on link.

  6. In the Upload add-on dialog box:

    Confluence-UploadCoveoPlugin

    1. Click Choose File.

    2. In the Open dialog box, go the folder you saved the plugin in step 1 and select the file CoveoConfluenceEnhancedRestApi-[versionNumber].jar.

    3. Click Upload.

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

    Confluence-UploadCoveoPlugin2

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

Uninstall the Coveo Confluence Plugin

  1. Log in to your Confluence server using a Confluence administrator account.

  2. On the top menu, access the Administration drop-down menu by clicking the cogwheel 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.

    Confluence-UploadCoveoPlugin3

  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.

What’s Next?

Create a Confluence Self-Hosted source and enter the credentials of the Confluence administrator account in the Authentication section (see Add or Edit a Confluence Self-Hosted Source).

Recommended Articles