https://github.com/kentico/xperience-by-kentico-lucene
Xperience by Kentico search integration with the latest 4.8 beta version of Lucene.NET
https://github.com/kentico/xperience-by-kentico-lucene
aspnetcore dotnet lucene-net xperience-by-kentico xperience-by-kentico-integrations
Last synced: 3 months ago
JSON representation
Xperience by Kentico search integration with the latest 4.8 beta version of Lucene.NET
- Host: GitHub
- URL: https://github.com/kentico/xperience-by-kentico-lucene
- Owner: Kentico
- License: mit
- Created: 2023-07-12T12:56:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T09:12:19.000Z (6 months ago)
- Last Synced: 2025-04-12T19:09:21.240Z (6 months ago)
- Topics: aspnetcore, dotnet, lucene-net, xperience-by-kentico, xperience-by-kentico-integrations
- Language: C#
- Homepage:
- Size: 21.8 MB
- Stars: 6
- Watchers: 18
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: docs/Contributing-Setup.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Xperience by Kentico Lucene
[](https://github.com/Kentico/.github/blob/main/SUPPORT.md#full-support) [](https://github.com/Kentico/xperience-by-kentico-lucene/actions/workflows/ci.yml)
| | Package |
| -------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------: |
| Lucene | [](https://www.nuget.org/packages/Kentico.Xperience.Lucene) |
| Lucene Administration only | [](https://www.nuget.org/packages/Kentico.Xperience.Lucene.Admin) |
| Lucene Live site only | [](https://www.nuget.org/packages/Kentico.Xperience.Lucene.Core) |
## Description
Xperience by Kentico search integration with the latest 4.8 beta version of [Lucene.NET](https://github.com/apache/lucenenet),
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
| Xperience Version | Library Version |
| ------------------- | --------------- |
| >= 30.6.0 | >= 12.4.0 |
| >= 30.5.1 | >= 12.3.0 |
| >= 30.0.1 | >= 11.0.1 |
| >= 30.0.0 | >= 11.0.0 |
| >= 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
- [ASP.NET Core 6.0](https://dotnet.microsoft.com/en-us/download)
- [Xperience by Kentico](https://docs.xperience.io/xp/changelog)
## Package Installation
Add the package to your application using the .NET CLI
```powershell
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
```csharp
// 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("DefaultStrategy")
.RegisterStrategy("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](./docs/Usage-Guide.md) for more detailed instructions.
You can view and start the DancingGoat example project.
For advanced [Strategy usage](./docs/Custom-index-strategy.md) add your website url base to the `WebCrawlerBaseUrl` `appsettings.json`
```json
{
// Other settings ...
// Our example runs on localhost with port: 58093
"WebCrawlerBaseUrl": "http://localhost:58093/"
}
```
This is required for our [Scraping example](./docs/Scraping-web-page-content.md).
## 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`](https://github.com/Kentico/.github/blob/main/CONTRIBUTING.md) for more information and follow the [Kentico's `CODE_OF_CONDUCT`](https://github.com/Kentico/.github/blob/main/CODE_OF_CONDUCT.md).
Instructions and technical details for contributing to **this** project can be found in [Contributing Setup](./docs/Contributing-Setup.md).
## License
Distributed under the MIT License. See [`LICENSE.md`](./LICENSE.md) for more information.
## Support
[](https://github.com/Kentico/.github/blob/main/SUPPORT.md#full-support)
This project has **Full support by 7-day bug-fix policy**.
See [`SUPPORT.md`](https://github.com/Kentico/.github/blob/main/SUPPORT.md#full-support) for more information.
## Security
For any security issues see [Kentico's `SECURITY.md`](https://github.com/Kentico/.github/blob/main/SECURITY.md).