Install the Coveo Plugin for Atlassian Confluence

This is for:

Developer System Administrator

The Coveo Confluence Server source comes with a plugin in Confluence. 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 server 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 Schedule a source update). 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).

Install the Coveo Connector Plugin

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

  2. On the top menu, access the Administration dropdown menu by clicking the cogwheel icon at the upper-right corner, and then select Manage apps.

  3. On the left menu bar, locate the Atlassian Marketplace section, and then click Find new apps.

  4. In the search bar, search for Coveo Connector Plugin:

    1. Locate the Coveo Connector Plugin, which should be the only search result, and click Install.

      Confluence-SearchForPlugin

      • In the Confirm app installation box that appears, review Coveo’s privacy policy and terms of use.

      • Click Accept & install to confirm the installation.

      • Once the installation is completed, a dialog box appears to confirm that the Coveo Enhanced REST API Plugin is ready to use.

  5. In the left menu bar, click Manage apps, and validate that the Coveo Enhanced REST API Plugin is listed under User-installed apps.

Uninstall the Coveo Connector Plugin

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

  2. On the top menu, access the Administration dropdown menu by clicking the cogwheel icon, and then select Manage apps.

  3. In the dropdown menu, select User-installed to view your list of installed apps.

  4. Locate and click the Coveo Enhanced REST API Plugin:

    Confluence-UninstallPlugin

    1. In the information box that appears, click Uninstall.

    2. In the Uninstall app? box, click Uninstall app to finalize the uninstallation.

    3. Once the uninstallation is completed, a confirmation message will appear.

  5. Refresh the page to validate that the Coveo Enhanced REST API Plugin is no longer in the User-installed apps list.

What’s Next?

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