PHPackages                             spryker-eco/algolia - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. spryker-eco/algolia

ActiveLibrary[API Development](/categories/api)

spryker-eco/algolia
===================

Algolia module

1.0.1(3mo ago)011.7k↓20.7%[1 PRs](https://github.com/spryker-eco/algolia/pulls)1proprietaryPHPPHP >=8.3CI passing

Since Feb 15Pushed 3mo agoCompare

[ Source](https://github.com/spryker-eco/algolia)[ Packagist](https://packagist.org/packages/spryker-eco/algolia)[ RSS](/packages/spryker-eco-algolia/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (23)Versions (3)Used By (1)

Algolia Module
==============

[](#algolia-module)

[![Latest Stable Version](https://camo.githubusercontent.com/43b2fb27677334e294eb1cba0f7abd6c75d1e74f81f3a88dbccff84fca165933/68747470733a2f2f706f7365722e707567782e6f72672f737072796b65722d65636f2f616c676f6c69612f762f737461626c652e737667)](https://packagist.org/packages/spryker-eco/algolia)[![Minimum PHP Version](https://camo.githubusercontent.com/9c50dc780fa576f5c39b4feff00c05345c1471be0808881a09e750b91220dc54/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344253230382e332d3838393242462e737667)](https://php.net/)

The Algolia module provides seamless integration between Spryker Commerce OS and Algolia search service, enabling real-time synchronization of products and CMS pages to Algolia indices for fast, relevant search experiences.

Features
--------

[](#features)

- 🔄 **Real-time synchronization** of products and CMS pages to Algolia
- 🎯 **Event-driven architecture** using Spryker's Publisher module
- 🌍 **Multi-locale and multi-store** support
- 📦 **Batch export** capabilities for initial data sync
- 🔍 **Search API integration** for frontend and backend
- ⚙️ **Configurable event subscriptions** per entity type
- 🏗️ **Modular design** with optional module support
- 🔌 **Custom entity index mapping** for searching any custom entity in Algolia

Table of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [Real-time Synchronization](#real-time-synchronization)
    - [Product Publisher Plugins](#product-publisher-plugins)
    - [CMS Page Publisher Plugins](#cms-page-publisher-plugins)
- [Full Indexing](#full-indexing)
- [Custom Entity Index Mapping](#custom-entity-index-mapping)
- [Configuration](#configuration)
- [Migration from ACP Algolia App](#migration-from-acp-algolia-app)
- [Troubleshooting](#troubleshooting)
- [Development](#development)

Installation
------------

[](#installation)

```
composer require spryker-eco/algolia
```

**Configure Algolia credentials** in your config files:

```
// config/Shared/config_default.php or config_local.php (for local development)
use SprykerEco\Shared\Algolia\AlgoliaConstants;

$config[AlgoliaConstants::IS_ACTIVE] = true;
$config[AlgoliaConstants::APPLICATION_ID] = getenv('ALGOLIA_APPLICATION_ID');
$config[AlgoliaConstants::ADMIN_API_KEY] = getenv('ALGOLIA_WRITE_API_KEY');
$config[AlgoliaConstants::SEARCH_ONLY_API_KEY] = getenv('ALGOLIA_SEARCH_API_KEY');
// Add if you use one Algolia account for multiple environments, default is "production"
// $config[AlgoliaConstants::TENANT_IDENTIFIER] = 'john';
```

### Step 1: Enable Console Command

[](#step-1-enable-console-command)

File: `src/Pyz/Zed/Console/ConsoleDependencyProvider.php`

```