Kentico.Xperience.Lucene 2.0.1

Xperience by Kentico Lucene

About The Project

Xperience by Kentico search integration with the latest 4.8 beta version of Lucene.NET, enabling auto-indexing of content in Xperience based on application-local, code-defined search indexes and search results retrieval.

Getting Started

Prerequisites

• Xperience by Kentico >= 26.2.0

Installation

Add the package to your application using the .NET CLI

dotnet add package Kentico.Xperience.Lucene

Setup

1. Define a custom (or multiple) LuceneSearchModel implementation to represent the content you want index.

2. Define a custom DefaultLuceneIndexingStrategy implementation to customize how page content/fields are processed for the index.

3. Add this library to the application services, registering your custom LuceneSearchModel.

   builder.Services.AddKentico();
   // ... other registrations
   builder.Services.AddLucene(new[]
   {
       new LuceneIndex(
           typeof(MySearchModel),
           new StandardAnalyzer(Lucene.Net.Util.LuceneVersion.LUCENE_48),
           MySearchModel.IndexName,
           indexPath: null,
           new MyCustomIndexingStrategy()),
   });
   

4. Rebuild the index in Xperience's Administration within the Lucene application added by this library.

5. Use the ILuceneIndexService (via DI) to retrieve the index populated by your custom LuceneSearchModel.

6. Execute a search with a customized Lucene Query (like the MatchAllDocsQuery) using the ILuceneIndexService.

7. Return or display the results on your site 👍.

Usage

• Review the "Search" functionality in the src\Kentico.Xperience.Lucene.Sample Dancing Goat project to see how to implement search.
• Read the Lucene.NET introduction or full documentation to explore the core library's APIs and functionality.
• Explore the Lucene.NET source on GitHub

Implementing document decay feature (scoring by "freshness", "recency")

1. boosting relevant fields by setting field boost (preferable method, but requires more work)
2. boosting one field with constant value, that is always present in search query (shown in sample, less desirable method. Downside of this method is that all documents get matched, usable only for scenarios where total number of result is not required)
3. using sort expression, implementation details can be found in Lucene.NET unit tests, Lucene.NET implementations

Methods 1 and 2 require implementing DefaultLuceneIndexingStrategy and overriding OnDocumentAddField method. In OnDocumentAddField match required fields and calculate boost, then apply to desired files as shown in example DancingGoatLuceneIndexingStrategy.OnDocumentAddField

differences too small in boosts will be ignored by Lucene

Sample features

Trigger rebuild of index via webhook

Rebuild of index could be triggered by calling POST on webhook /search/rebuild with body

{
  "indexName": "...",
  "secret": "..."
}

This could be used to trigger regular reindexing of content via CRON, Windows Task Scheduler or any other external scheduler.

Contributing

For Contributing please see CONTRIBUTING.md for more information and follow the CODE_OF_CONDUCT.

Requirements

• .NET SDK >= 7.0.109

  • https://dotnet.microsoft.com/en-us/download/dotnet/7.0

• Node.js >= 18.12

  • https://nodejs.org/en/download
  • https://github.com/coreybutler/nvm-windows

Sample Project

To run the Sample app Admin customization in development mode, add the following to your User Secrets for the application.

"CMSAdminClientModuleSettings": {
  "kentico-xperience-integrations-lucene": {
    "Mode": "Proxy",
    "Port": 3009
  }
}

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

This contribution has Full support by 7-day bug-fix policy.

See SUPPORT.md for more information.

For any security issues see SECURITY.md.