Kentico.Xperience.Algolia
4.0.0
Prefix Reserved
See the version list below for details.
dotnet add package Kentico.Xperience.Algolia --version 4.0.0
NuGet\Install-Package Kentico.Xperience.Algolia -Version 4.0.0
<PackageReference Include="Kentico.Xperience.Algolia" Version="4.0.0" />
paket add Kentico.Xperience.Algolia --version 4.0.0
#r "nuget: Kentico.Xperience.Algolia, 4.0.0"
// Install Kentico.Xperience.Algolia as a Cake Addin #addin nuget:?package=Kentico.Xperience.Algolia&version=4.0.0 // Install Kentico.Xperience.Algolia as a Cake Tool #tool nuget:?package=Kentico.Xperience.Algolia&version=4.0.0
Xperience by Kentico Algolia
Description
This integration enables you to create Algolia 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 .NET API, JavaScript API, or the InstantSearch.js library.
Library Version Matrix
Xperience Version | Library Version |
---|---|
28.x | >= 3.x |
>= 26.2.0, < 27.0.0 | 2.x |
Dependencies
Package Installation
Add the package to your application using the .NET CLI
dotnet add package Kentico.Xperience.Algolia
Quick Start
Add configuration from your Algolia account to the ASP.NET Core
appsettings.json
file:"CMSAlgoliaSearch": { "ApplicationId": "<your application ID>", "ApiKey": "<your Indexing API key>", "SearchKey": "<your Search API key>" }
Define a custom
DefaultAlgoliaIndexingStrategy
implementation to customize how content pages/content items are processed for the index. SeeCustom-index-strategy.md
Add this library to the application services, registering your custom
DefaultAlgoliaIndexingStrategy
and Algolia services// Program.cs services.AddKenticoAlgolia(configuration); services.RegisterStrategy<GlobalAlgoliaIndexingStrategy>("DefaultStrategy");
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.
Display the results on your site with a Razor View 👍.
Full Instructions
View the Usage Guide for more detailed instructions.
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
- Algolia.Search (>= 6.16.0)
- Kentico.Xperience.Admin (>= 28.1.2)
- Kentico.Xperience.WebApp (>= 28.1.2)
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 |
---|---|---|
4.1.0 | 327 | 4/30/2024 |
4.0.0 | 103 | 4/10/2024 |
4.0.0-prerelease-1 | 71 | 4/10/2024 |
3.0.0 | 243 | 2/13/2024 |
3.0.0-prerelease-1 | 71 | 2/9/2024 |
2.0.2 | 232 | 5/29/2023 |
2.0.1 | 138 | 5/26/2023 |
2.0.0 | 145 | 5/17/2023 |
1.0.0 | 197 | 11/7/2022 |