Lucene Search Application

Last modified by Admin on 2021/03/19 02:03

cogAllows searching on the wiki using Apache Lucene
Developed by

XWiki Development Team

2 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager


The Lucene module is not maintained anymore, you should use the Solr Search Application.

The XWiki Lucene Plugin indexes all the content of your XWiki instance(s). The Lucene search has several benefits over database search:

  • It indexes attachments (such as PDFs or MS Word documents) making them searchable. It does not replace the search page itself but rather makes more content available for searching.
  • It provides a scoring for the search results.
  • It offers pagination when there are lots of results.
  • It scales well when there are lots of documents in the wiki.
  • It supports multi wikis.
  • It supports a strong query syntax.

You can access the Lucene search page directly by navigating to Main.LuceneSearch:


Search Results without Admin Rights

If you don't have administrative rights you'll see the following type of result when you make a search. It lists all the pages matching your search criteria:


Search Results with Admin Rights

If you have administrative rights you'll be able to see pages that are only visible to administrators:


Search Spaces and RSS feeds

You can restrict the search to a specific subwiki and space using their corresponding drop-down lists:


You can also subscribe to an RSS Feed on the results of your search (from then on you will be informed when the search returns a new result):


Search Administration

In this section you can see the status for the Lucene Search, both the number of indexed elements and the number of elements in the indexing queue:


You can also control the Lucene index by:

  • Indexing the whole farm
  • Indexing the wiki
  • Customizing the index:
    • Choose the wikis to be indexed (only available on the main wiki administration page, otherwise the current wiki is indexed)
    • Define an HQL based filter query (only available if you have programming rights)
    • Clear the index before starting to re-index
    • Only index elements not already indexed


Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki


Dependencies for this extension (org.xwiki.platform:xwiki-platform-search-lucene-ui 6.4.8):

Get Connected