Kentico.Xperience.Lucene 12.4.0

Xperience by Kentico Lucene

	Package
Lucene
Lucene Administration only
Lucene Live site only

Description

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.

This repository contains projects for 3 NuGet packages, that is Kentico.Xperience.Lucene.Admin, Kentico.Xperience.Lucene.Core and Kentico.Xperience.Lucene.

Use Kentico.Xperience.Lucene. This is the recommended version for usage of Xperience by Kentico support for Lucene .NET NuGet package and unlike the other two contains full support for both admin ui and live site.

Use Kentico.Xperience.Lucene.Core in your Xperience by Kentico project for Lucene Search in your live website. Use Kentico.Xperience.Lucene.Admin in your Xperience by Kentico Administration project for Lucene Search Administration UI managment.

Important Compatibility Notice
This Lucene integration requires persistent file system access to store and manage indexes. It is not compatible with Kentico Xperience SaaS, which restricts file system access. If you plan to run this in the cloud, ensure your environment supports persistent disk writes — such as a self-hosted VM, container with mounted volume, or a traditional server.

Screenshots

Library Version Matrix

Dependencies

• ASP.NET Core 6.0
• Xperience by Kentico

Package Installation

Add the package to your application using the .NET CLI

dotnet add package Kentico.Xperience.Lucene

Quick Start

This section is relevant for each Lucene NuGet. Steps number 3 and 4 are only relevant if you use NuGet package Kentico.Xperience.Lucene or Kentico.Xperience.Lucene.Admin.

1. Define a custom DefaultLuceneIndexingStrategy implementation to customize how content pages/content items are processed for the index.

2. Add this library to the application services, registering your custom DefaultLuceneIndexingStrategy and Lucene

   // Program.cs
   
   // Registers all services and uses default indexing behavior (no data is indexed)
   services.AddKenticoLucene();
   
   // or
   
   // Registers all services and enables custom indexing behavior
   services.AddKenticoLucene(builder =>
      builder
         .RegisterStrategy<GlobalSearchIndexingStrategy>("DefaultStrategy")
         .RegisterStrategy<ArticlesSearchIndexingStrategy>("ArticlesStrategy"));
   

3. Create an index in Xperience's Administration within the Search application added by this library.

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

5. Use the ILuceneSearchService (via DI) to retrieve the index populated by your custom ILuceneIndexingStrategy.

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

7. Display the results on your site with a Razor View 👍.

Full Instructions

View the Usage Guide for more detailed instructions.

You can view and start the DancingGoat example project. For advanced Strategy usage add your website url base to the WebCrawlerBaseUrl appsettings.json

{
  // Other settings ...
  // Our example runs on localhost with port: 58093
  "WebCrawlerBaseUrl": "http://localhost:58093/"
}

This is required for our Scraping example.

Projects

Contributing

To see the guidelines for Contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md for more information and follow the Kentico's CODE_OF_CONDUCT.

Instructions and technical details for contributing to this project can be found in Contributing Setup.

License

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

Support

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

See SUPPORT.md for more information.

Security

For any security issues see Kentico's SECURITY.md.