PHPackages                             lupasearch/magento2-lupasearch-plugin - 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. [Search &amp; Filtering](/categories/search)
4. /
5. lupasearch/magento2-lupasearch-plugin

ActiveMagento2-module[Search &amp; Filtering](/categories/search)

lupasearch/magento2-lupasearch-plugin
=====================================

LupaSearch module

1.5.1(2mo ago)03.0k↓29.4%22OSL-3.0PHPPHP &gt;=7.4

Since Aug 26Pushed 2mo ago1 watchersCompare

[ Source](https://github.com/lupasearch/magento2-plugin)[ Packagist](https://packagist.org/packages/lupasearch/magento2-lupasearch-plugin)[ RSS](/packages/lupasearch-magento2-lupasearch-plugin/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (46)Versions (28)Used By (2)

LupaSearch Magento 2 Plugin
===========================

[](#lupasearch-magento-2-plugin)

Introduction
------------

[](#introduction)

The LupaSearch Magento 2 Plugin integrates LupaSearch's search functionality into your Magento 2 store, providing enhanced search capabilities that improve the user experience.

Requirements
------------

[](#requirements)

- **PHP**: &gt;=7.4
- **Magento 2**: compatible with Magento 2.2.x - 2.4.x
- **Optional**: For MySQL-based queues, install the [lupasearch/magento2-lupasearch-plugin-queue-db](https://github.com/lupasearch/magento2-plugin-queue-db) extension.

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

[](#installation)

### 1. Install with Composer

[](#1-install-with-composer)

Install the core LupaSearch plugin:

```
composer require lupasearch/magento2-lupasearch-plugin
```

If RabbitMQ is not available, include the MySQL queue compatibility extension:

```
composer require lupasearch/magento2-lupasearch-plugin-queue-db

```

### 2. Enable modules

[](#2-enable-modules)

```
php bin/magento module:enable LupaSearch_LupaSearchPluginCore LupaSearch_LupaSearchPlugin

```

If the MySQL queue compatibility extension is installed, enable it as well:

```
php bin/magento module:enable LupaSearch_LupaSearchPluginQueueDb

```

### 3. Run installation scripts

[](#3-run-installation-scripts)

```
php bin/magento setup:upgrade
php bin/magento setup:di:compile

```

Change Indexer Mode to "On Schedule" (only works on this mode)

```
bin/magento indexer:set-mode schedule lupasearch_product lupasearch_category
```

Enable cache

```
bin/magento cache:enable lupasearch
```

> 💡 **Before indexing, make sure your index mappings are already configured.**If your product, category, or suggestion mappings do not exist yet, use the examples available here:
>
> To update a mapping, use the mapping endpoints available in the LupaSearch API:

Configure the extension
-----------------------

[](#configure-the-extension)

### 1. Initial configurations

[](#1-initial-configurations)

Navigate to **Stores -&gt; Configuration -&gt; Catalog -&gt; LupaSearch** in your Magento admin panel.

Configure the following settings:

- **General configuration &gt; API Key**: Generate an API Key in the LupaSearch Dashboard and paste it into this field.
- **Indices &gt; Product**: Copy the UUID of your product search index from the LupaSearch Dashboard and paste it here.
- **Indices &gt; Product Suggestion**: Copy the UUID of your product suggestion index and paste it here.
- **Indices &gt; Category**: Copy the UUID of your category search index and paste it here.
- **Indexing &gt; Enabled**: Set this option to **Yes**.

Click **Save Config** to apply your changes.

### 2. Generate search configurations

[](#2-generate-search-configurations)

After saving the initial settings, go to the **LupaSearch Queries Management** section in your Magento admin panel. Click the **Generate All Queries** button. A confirmation message, **"Queries successfully generated,"** will appear once the process is complete. To verify, go to the **Search Queries** page in the LupaSearch Dashboard and confirm that all queries are created successfully.

Synchronize data
----------------

[](#synchronize-data)

### 1. Indexing

[](#1-indexing)

Reindex the data:

```
bin/magento index:reindex lupasearch_product
bin/magento index:reindex lupasearch_category

```

Manually run the indexer to refresh the data:

```
bin/magento indexer:reindex lupasearch_product
bin/magento indexer:reindex lupasearch_category
```

### 2. Run consumers

[](#2-run-consumers)

Start the LupaSearch queue consumers to process queued tasks:

```
bin/magento queue:consumers:start lupasearch.all

```

### 3: Verify data

[](#3-verify-data)

1. Log in to the [LupaSearch Console](https://console.lupasearch.com/login).
2. Navigate to your product index.
3. Verify that your products and categories are correctly indexed and available.

Adding Custom Product Attributes
--------------------------------

[](#adding-custom-product-attributes)

To add custom attributes to the product feed, follow these steps:

1. Review existing Hydrators used in the plugin:
2. Create your own Hydrator class implementing the logic for your custom attribute.
3. Register the new Hydrator in di.xml by adding it to the hydrator pool, for example:
4. Go to your index mapping and add the new attribute field.
5. Add the new attribute to your search query configuration.

Support
-------

[](#support)

For questions or assistance, contact us at .

###  Health Score

46

—

FairBetter than 93% of packages

Maintenance86

Actively maintained with recent releases

Popularity23

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 96.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~37 days

Recently: every ~29 days

Total

16

Last Release

68d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e731dcdb8b5eb320746e071e16e6dc71c6403eb1e2ab874485900ad476adfa7b?d=identicon)[aurzal](/maintainers/aurzal)

---

Top Contributors

[![aurzal](https://avatars.githubusercontent.com/u/101714175?v=4)](https://github.com/aurzal "aurzal (25 commits)")[![tarutis](https://avatars.githubusercontent.com/u/94372208?v=4)](https://github.com/tarutis "tarutis (1 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/lupasearch-magento2-lupasearch-plugin/health.svg)

```
[![Health](https://phpackages.com/badges/lupasearch-magento2-lupasearch-plugin/health.svg)](https://phpackages.com/packages/lupasearch-magento2-lupasearch-plugin)
```

###  Alternatives

[dotdigital/dotdigital-magento2-extension

Dotdigital for Magento 2

50374.2k18](/packages/dotdigital-dotdigital-magento2-extension)[mollie/magento2

Mollie Payment Module for Magento 2

1121.6M10](/packages/mollie-magento2)[swissup/module-search-mysql-legacy

Legacy mysql search for magento 2.4

10483.0k](/packages/swissup-module-search-mysql-legacy)[run-as-root/magento2-prometheus-exporter

Magento2 Prometheus Exporter

69344.4k](/packages/run-as-root-magento2-prometheus-exporter)[buckaroo/magento2

Buckaroo Magento 2 extension

32404.0k6](/packages/buckaroo-magento2)[fredden/magento2-module-javascript-error-reporting

A Magento 2 module which captures JavaScript errors for later review by website administrators

3138.1k](/packages/fredden-magento2-module-javascript-error-reporting)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
