https://github.com/kentico/xperience-by-kentico-algolia
Enables the creation of Algolia search indexes and the indexing of Xperience content tree pages using a code-first approach.
https://github.com/kentico/xperience-by-kentico-algolia
algolia algolia-search kentico xperience-by-kentico xperience-by-kentico-integrations
Last synced: 7 months ago
JSON representation
Enables the creation of Algolia search indexes and the indexing of Xperience content tree pages using a code-first approach.
- Host: GitHub
- URL: https://github.com/kentico/xperience-by-kentico-algolia
- Owner: Kentico
- License: mit
- Created: 2022-08-09T07:24:31.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T08:11:17.000Z (7 months ago)
- Last Synced: 2025-04-12T19:09:10.782Z (7 months ago)
- Topics: algolia, algolia-search, kentico, xperience-by-kentico, xperience-by-kentico-integrations
- Language: C#
- Homepage: https://www.kentico.com/
- Size: 17.6 MB
- Stars: 4
- Watchers: 22
- Forks: 1
- Open Issues: 0
-
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 Algolia
[](https://github.com/Kentico/.github/blob/main/SUPPORT.md#full-support) [](https://github.com/Kentico/xperience-by-kentico-algolia/actions/workflows/ci.yml) [](https://www.nuget.org/packages/Kentico.Xperience.Algolia)
## Description
This integration enables you to create [Algolia](https://www.algolia.com/) search indexes to index content of [web pages](https://docs.kentico.com/x/JwKQC) from an Xperience website channel using a code-first approach. To provide a search interface for the indexed content, developers can use the [.NET API](https://www.algolia.com/doc/api-client/getting-started/what-is-the-api-client/csharp/?client=csharp), [JavaScript API](https://www.algolia.com/doc/api-client/getting-started/what-is-the-api-client/javascript/?client=javascript), or the [InstantSearch.js](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/) library.
## Library Version Matrix
| Xperience Version | Library Version |
| ------------------- | --------------- |
| >= 30.0.0 | >= 6.0.0 |
| >= 29.5.0 | >= 5.0.0 |
| >= 29.0.0 | >= 4.1.0 |
| 28.x | >= 3.x |
| >= 26.2.0, < 27.0.0 | 2.x |
## Dependencies
- [ASP.NET Core 8.0](https://dotnet.microsoft.com/en-us/download)
- [Xperience by Kentico](https://docs.xperience.io/xp/changelog)
- [Algolia](https://www.algolia.com/doc/)
## Package Installation
Add the package to your application using the .NET CLI
```powershell
dotnet add package Kentico.Xperience.Algolia
```
## Quick Start
1. Add configuration from your Algolia account to the ASP.NET Core `appsettings.json` file:
```json
"CMSAlgoliaSearch": {
"ApplicationId": "",
"ApiKey": "",
"SearchKey": ""
}
```
2. Define a custom `DefaultAlgoliaIndexingStrategy` implementation to customize how content pages/content items are processed for the index. See [`Custom-index-strategy.md`](docs/Custom-index-strategy.md)
3. Add this library to the application services, registering your custom `DefaultAlgoliaIndexingStrategy` and Algolia services
```csharp
// Program.cs
services.AddKenticoAlgolia(configuration);
services.RegisterStrategy("DefaultStrategy");
```
4. Create an index in Xperience's Administration within the Search application added by this library.
1. Rebuild the index in Xperience's Administration within the Search application added by this library.
1. Display the results on your site with a Razor View 👍.
## Full Instructions
View the [Usage Guide](docs/Usage-Guide.md) for more detailed instructions.
## 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).