How to view the contents of the search index in Confluence Server and Data Center

Still need help?

The Atlassian Community is here for you.

Ask the community

Platform Notice: Server and Data Center Only - This article only applies to Atlassian products on the server and data center platforms.

Purpose

Confluence uses a search engine called Lucene. The search index is used by Confluence search, the dashboard, some macros, and many other places where we show information about content in your site.  

If you need to see more details of the indexed pages in your Confluence site, you can use Luke to browse the index files. Luke is a development and diagnostic tool that can be used to access existing Lucene indexes and allows you to display and modify their content.

Solution

To use Luke to browse the Confluence search index:

  1. Download luke-4.5.0-jar-with-dependencies.jar from https://github.com/DmitryKey/luke/releases/tag/4.5.0.   
    You'll need to download this specific version. Later versions won't work with Confluence's index. 
  2. Double click the file, or use the following command to launch Luke:

    java -jar luke-4.5.0-jar-with-dependencies.jar
  3. In Luke, select Open Lucene index
  4. In the path field, enter the path to the index directory <home-directory>/index. If you run Confluence in a cluster this will be in the local home directory. 
  5. Select the Open in Read-Only mode checkbox
  6. Select OK.


You can then browse or search for specific items in the index. You can find information about the syntax to use in the Lucene documentation

If you're having problems with your index, we don't recommend attempting to edit the index manually, unless directed by our support team. Instead, you may need to rebuild your index.  See Content Index Administration



Last modified on Aug 30, 2021

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.