Adding a Confluence Legacy Source

You can add the content of a Confluence instance to your Coveo organization. The source can be private, shared or secured (see Source Permission Types).

The Coveo Confluence Plugin available for on-premises Confluence instances allows the Coveo Platform to manage permissions associated with each Confluence item so that users only see Confluence content in Coveo search results to which they have normally access in Confluence itself. Because you can’t install this plugin in Confluence On-Demand, Coveo can’t index permissions for this content.

  • As of February 14, 2017, the Confluence source is no longer supported and was renamed Confluence Legacy. The Confluence Legacy source isn’t available in new Coveo Cloud V1 organizations. You must contact Coveo Support to request the source. The only relevant use case for this source is when your Confluence instance version is between 5.5 and 5.7. 5.5 to 5.7 are versions that are no longer supported by Confluence and not supported by the second generation Confluence source (see Adding a Confluence Source).

  • The second generation Confluence source uses the Confluence REST API (see Adding a Confluence Source and Adding a Confluence Cloud Source). We strongly recommend that you use the new Confluence sources with the benefit of source refresh support and significantly better source creation and update performance, among other things.

  • The Confluence source doesn’t support incremental refresh. A source full refresh is required to update the source content (see Modify a Source Schedule).

  • If you change the name of a space in Confluence, the full refresh detects the change only for pages created or modified following the change. You must rebuild the source to get the space name change on all space pages (see Rebuild a Source).

Source Features Summary

Features Supported Additional information
Confluence version

5.5 to 5.8.5 and Cloud

Searchable content types

Spaces, pages (such as Wiki pages), blog posts, comments on pages and blog posts (included as metadata), and attachments (in pages, blog posts, and comments)

Content update Incremental refresh

Full refresh Rebuild needed to apply space name changes (if any) to all space pages.
Rebuild
Permission types Secured
  • Requires the Coveo plugin for on-premises Confluence instances.

  • Not supported for Confluence Cloud

Private
Shared

Add a Confluence Legacy Source

To edit a Confluence Legacy source, see Edit the Source Configuration to Re-index its Content or Re-authorize the Access, and then follow the steps below, starting from step 6.

  1. Ensure your environment meets the following requirements:

    • Atlassian Confluence 5.5 to 5.8.5

      OR

    • Atlassian Confluence On-Demand also known as Confluence Cloud (permissions can’t be indexed)

    • The Confluence SOAP remote API (Web service) must be enabled on your Confluence server (see the Atlassian item Enabling the Remote API).

    • On-premises Atlassian Confluence server accessible to Coveo Cloud

      When the access to communication ports between Coveo Cloud and the Confluence server is restricted, the appropriate port(s) must be opened in the network infrastructure such as in firewalls to allow Coveo Cloud to access the content.

  2. When you want to create a secured Confluence Legacy source for an on-premises Confluence, you must download and install the Coveo Confluence Plugin (see Installing the Coveo Plugin for Atlassian Confluence).

  3. If not already done, log in to your Coveo organization.

  4. In the navigation bar on the left, under Search Content, select Sources, and then click Add Source.

  5. On the Add Source page, click Confluence Legacy.

    When you create a source, you become the owner of the source.

  6. In the Add/Edit a Confluence Legacy Source dialog box:

    Admin-AddConfluenceLegacySource

    1. In the Source Name box, enter a name or your choice describing the content of the source.

    2. In the URLs box, enter one or more Confluence Wiki site and space addresses including the protocol (http:// or https://) that you want to make searchable, then press the Enter key or click Add.

      Enter the Confluence server root URL to index a complete Confluence site: http://MyConfluenceServer:8090/

      To index specific spaces, add their URL:

      http://MyConfluenceServer:8090/display/space1

      http://MyConfluenceServer:8090/display/space2

      • To add a URL, click Add.

      • To remove a URL, click Delete.

        Create one source per Confluence site. If you choose to include more than one address, ensure that all parameters are applicable to all addresses specified in the URLs box.

    3. In the Web Service URL box, enter the address of the Confluence server in the following format:

      http://[ConfluenceServer]:[port]

      http://MyConfluenceServer:8090

      The URL should be the same address as the one you specified in step b.

    4. When you want to index your secured Confluence Wiki content, click Authentication and then enter the Username and Password of a Confluence administrator account that can access all the content that you want to index.

    5. When you have installed the Coveo Confluence Plugin and you want to index security permissions, in the Enhanced Web Service URL box, enter the URL pointing to the Coveo web service provided by the Coveo Confluence Plugin on the Confluence server in the following format:

      http://[ConfluenceServer]:[port]/rpc/soap-axis/coveo-enhanced-service

      http://MyConfluenceServer:8090/rpc/soap-axis/coveo-enhanced-service

    6. In the Security drop-down menu, select if you want the source content to be Secured, Shared, or Private (see Source Permission Types).

      The Secured **option is only available when the **Enhanced Web Service URL parameter is set.

      If you select Shared, in search results, users can see all the items that the indexing account can access.

    7. Click Start Indexing (or Refresh Index when editing the source).

  7. Back on the Sources page, you can review the progress of your Confluence legacy source addition or modification (see Review the State of Sources Available to You).

What’s Next?

What's Next for Me?