Adding a Confluence Source

You can add the content of a Confluence instance (6.1 to 6.9.1 on-premises installations) to your Coveo organization. The source can be shared or private (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 normally have access in Confluence itself. The plugin is also needed to perform refreshes of the source content.

By default, a Confluence source starts a full refresh every hour to retrieve Confluence item changes (addition, modification, or deletion).

  • 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).

  • For clients migrating from Coveo Enterprise Search 7.0 (CES 7), the following source has the same specifications as the Confluence V2 connector (see Atlassian Confluence V2 Connector).

Source Features Summary

Features Supported Additional information
Confluence version 6.1 to 6.9.1
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

Requires the Coveo plugin to retrieve deleted, restored, and moved items, and items with modified comments or permissions.

Full refresh
Rebuild
Permission types Secured

Requires the Coveo plugin.

Private
Shared

Add a Confluence Source

To edit a Confluence 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 on-premises installation version 6.1 to 6.9.1 using the Confluence REST API and Search REST API.

    • When you want to include Confluence permissions, you must create a specific Confluence administrator account that will be only used for the source. Otherwise, you will need to also change the source Password value each time the account password changes to prevent authentication errors.

  2. When you want to create a secured Confluence 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.

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

  6. In the Add/Edit a Confluence Source dialog box, enter appropriate values for the following parameters:

    Admin-AddConfluenceSource

    • Source name

      A descriptive name for your source under 255 characters (not already in use for another source in this organization).

      Confluence-CorporateWiki

    • URLs

      One or more Confluence Wiki site and space addresses including the protocol (http:// or https://) that you want to make searchable.

      Depending on your use case, use one of the following URL formats:

      • To index a complete Confluence (on-premises) site, add the Confluence server root URL:

        http://MyConfluenceServer:8090/

      • To index specific on-premises spaces, add their URL:

        • http://MyConfluenceServer:8090/display/space1

        • http://MyConfluenceServer:8090/display/space2

      • To be able to include item permissions, all your URLs must be located on a single Confluence site. Create separate sources for separate sites.

      • You can enter specific space addresses for deployments where Confluence isn’t installed at the server root, respecting the following format:

        http://server/MyConfluence/display/spacename.

    Content to include section

    Consider changing the default value of the parameters in this section when you want to fine-tune how your Confluence site is crawled:

    • Space type:

      Select which spaces you want to index

      By default, only global spaces content is included and personal space content is excluded.

      • Global

      • Personal

      • Both

    • Options:

      Select which items you want to include:

      • Attachments (binary files attached to a page, blog post, or comment)

      • Comments (on blog posts and pages)

        Comments are included as metadata of the page, not as items.

    Space Filter

    Enter a regular expression (regex) to filter spaces when you want to include only a subset of a Confluence site.

    This parameter is useful when you have a large number of spaces to include that have an element in common in their space keys.

    You want to include all spaces with keys starting with an uppercase letter followed by a number, so you enter the following regex:

    ^[A-Z][0-9].*$

    Authentication section

    When you want to include secured Confluence content or include permissions, you must fulfill the following parameters:

    • Username

      The username of a dedicated Confluence administrator account who has access to all the content that you want to include.

    • Password

      The corresponding password.

    • Security

      Select who can see items from this source in a search interface that includes this source in its scope (see Source Permission Types):

      • Secured: Only users authenticated in the search interface will see the source items for which they have read permission.

      • Shared: Everyone

      • Private: Only you, when you’re authenticated to the search interface with the identity with which you create the source.

  7. Finish adding or editing your source:

    • Click Start Indexing to add the source content.

    • Click Refresh Index when you’re done editing the source and want to make changes effective.

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

What’s Next?

What's Next for Me?