XperienceCommunity.ElasticSearch 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package XperienceCommunity.ElasticSearch --version 1.0.0
                    


                    

                
NuGet\Install-Package XperienceCommunity.ElasticSearch -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="XperienceCommunity.ElasticSearch" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="XperienceCommunity.ElasticSearch" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="XperienceCommunity.ElasticSearch" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add XperienceCommunity.ElasticSearch --version 1.0.0
                    


                    

                
#r "nuget: XperienceCommunity.ElasticSearch, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package XperienceCommunity.ElasticSearch@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=XperienceCommunity.ElasticSearch&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=XperienceCommunity.ElasticSearch&version=1.0.0
                    


                            Install as a Cake Tool

Description

This integration enables you to create ElasticSearch search indexes to index content of pages (content types with the 'Page' feature enabled) from the Xperience content tree using a code-first approach. To provide a search interface for the indexed content, developers can use the ElasticSearch .NET, ElasticSearch JavaScript library.

Dependencies

Package Installation

Add the package to your application using the .NET CLI

dotnet add package XperienceCommunity.ElasticSearch

Quick Start

  1. Add configuration from your Elastic search to the ASP.NET Core appsettings.json file:

    "CMSElasticSearch": {
 "SearchServiceEndPoint": "<your index application url>",
 "SearchServiceUsername": "<your index application username>",
 "SearchServicePassword": "<your index application password>"
 }

  2. Define a custom BaseElasticSearchIndexingStrategy<TSearchModel> implementation to customize how content pages/content items are processed for the index. See Custom-index-strategy.md

  3. Add this library to the application services, registering your custom BaseElasticSearchIndexingStrategy with type parameter GlobalSearchModel and Elastic search services

    // Program.cs
services.AddXperienceCommunityElasticSearch(builder =>
 {
     builder.RegisterStrategy<GlobalElasticSearchStrategy, GlobalSearchModel>("DefaultStrategy");
 }, configuration);

  4. Create an index in Xperience's Administration within the Search application added by this library. Administration search edit form

  5. Rebuild the index in Xperience's Administration within the Search application added by this library. Administration search edit form

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

Full Instructions

View the Usage Guide for more detailed instructions.

Contributing

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.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
1.0.0 214 11/4/2025

https://github.com/BiQ-Bluesoft/xperience-community-elastic-search/releases