Kentico.Xperience.Lucene
10.0.0
Prefix Reserved
dotnet add package Kentico.Xperience.Lucene --version 10.0.0
NuGet\Install-Package Kentico.Xperience.Lucene -Version 10.0.0
<PackageReference Include="Kentico.Xperience.Lucene" Version="10.0.0" />
paket add Kentico.Xperience.Lucene --version 10.0.0
#r "nuget: Kentico.Xperience.Lucene, 10.0.0"
// Install Kentico.Xperience.Lucene as a Cake Addin #addin nuget:?package=Kentico.Xperience.Lucene&version=10.0.0 // Install Kentico.Xperience.Lucene as a Cake Tool #tool nuget:?package=Kentico.Xperience.Lucene&version=10.0.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.
Screenshots
Library Version Matrix
Xperience Version | Library Version |
---|---|
>= 29.3.3 | >= 8.1.0 |
>= 29.0.0 | >= 6.1.x |
>= 28.4.3, < 29.0.0 | >= 5.x.x |
>= 28.0.0 | >= 3.x.x |
>= 26.2.0, < 27.0.0 | >= 2.x, < 3.x.x |
Dependencies
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
.
Define a custom
DefaultLuceneIndexingStrategy
implementation to customize how content pages/content items are processed for the index.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"));
Create an index in Xperience's Administration within the Search application added by this library.
Rebuild the index in Xperience's Administration within the Search application added by this library.
Use the
ILuceneSearchService
(via DI) to retrieve the index populated by your customILuceneIndexingStrategy
.Execute a search with a customized Lucene
Query
(like theMatchAllDocsQuery
) using theILuceneSearchService
.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
Project | Description |
---|---|
src/Kentico.Xperience.Lucene | Xperience by Kentico Lucene integration library |
src/Kentico.Xperience.Lucene.Core | Xperience by Kentico Lucene integration Live site only library |
src/Kentico.Xperience.Lucene.Admin | Xperience by Kentico Lucene integration Admin only library |
examples/DancingGoat | Example project to showcase basic search functionality |
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
.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- Kentico.Xperience.Lucene.Admin (>= 10.0.0)
- Kentico.Xperience.Lucene.Core (>= 10.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
10.0.0 | 1,114 | 10/29/2024 |
9.0.1 | 830 | 10/9/2024 |
9.0.0 | 1,018 | 9/4/2024 |
8.1.0 | 470 | 8/20/2024 |
8.0.0 | 314 | 8/14/2024 |
7.0.2 | 564 | 7/12/2024 |
7.0.1 | 822 | 6/4/2024 |
7.0.0 | 613 | 5/6/2024 |
6.1.0 | 1,322 | 4/22/2024 |
6.0.0 | 141 | 4/19/2024 |
6.0.0-prerelease-1 | 87 | 4/18/2024 |
5.0.0 | 352 | 4/10/2024 |
5.0.0-prerelease-1 | 87 | 4/10/2024 |
4.2.0 | 284 | 3/25/2024 |
4.1.0 | 876 | 2/1/2024 |
4.1.0-prerelease-4 | 99 | 1/31/2024 |
4.1.0-prerelease-3 | 87 | 1/31/2024 |
4.1.0-prerelease-2 | 79 | 1/31/2024 |
4.1.0-prerelease-1 | 85 | 1/31/2024 |
4.0.0 | 188 | 1/17/2024 |
3.0.0 | 150 | 1/12/2024 |
3.0.0-v28preview-3 | 87 | 1/12/2024 |
3.0.0-v28preview-2 | 92 | 1/12/2024 |
3.0.0-v28preview | 110 | 12/21/2023 |
2.0.1 | 240 | 9/22/2023 |
2.0.0 | 197 | 9/12/2023 |
1.0.0 | 179 | 8/15/2023 |
1.0.0-prerelease-1 | 166 | 8/2/2023 |