Adobe Commerce only. Learn more.

Install Live Search

Live Search is a set of standalone meta packages that replaces standard Adobe Commerce search capabilities.

Package Description
module-live-search Allows merchants to configure their search settings for faceting, synonyms, query rules, etc., and provides access to a read-only GraphQL playground to test queries from the Adobe Commerce Admin.
module-live-search-adapter Routes search requests from the storefront to the Live Search service and renders the results in the storefront.
- Category browse - Routes requests from the storefront top navigation to the search service.
- Global search - Routes requests from the quick search box in the upper-right of the storefront to the Live Search service.
module-live-search-storefront-popover A “search as you type” popover replaces the standard quick search and returns dynamic product suggestions and thumbnails of top search results.

Requirements

  • Adobe Commerce 2.4.x
  • PHP 7.3 / 7.4
  • Composer

Adobe Commerce is installed first without Live Search. After the installation, use Composer to install the live-search package.

  1. Install Adobe Commerce 2.4.x without Live Search.

  2. To install the live-search package, run the following from the command line:

    1
    
    composer require magento/live-search
    

Dependencies

The following Live Search dependencies are captured by Composer:

Dependency Description
Export modules The following modules collect and sync catalog data:
saas-export
module-bundle-product-exporter
module-catalog-data-exporter
module-catalog-inventory-data-exporter
module-catalog-url-rewrite-data-exporter
module-configurable-product-data-exporter
module-data-exporter
module-parent-product-data-exporter
services-connector Required to configure your connection to Commerce Services.
module-services-id Required to configure your connection to Commerce Services.

Step 2: Disable Elasticsearch modules

The modules that allow the native Adobe Commerce search and category browse pages function must be disabled for Live Search to work. Because Live Search relies on a backend search service, it is no longer necessary to host and configure Elasticsearch. The exception is if Elasticsearch is required by other extensions or customizations that have been added to your Adobe Commerce installation.

  1. Check your app/etc/config.php file and ensure that the following ElasticSearch modules are disabled:

    • Magento_ElasticSearch
    • Magento_ElasticSearch6
    • Magento_ElasticSearch7
    • Magento_AdvancedSearch
    • Magento_ElasticSearchCatalogPermissions
    • Magento_InventoryElasticSearch

    This list might change as new modules are added. If you find additional ElasticSearch modules in your config.php file, disable them also.

  2. In the core_config_data table, delete any entry with the catalog/search/engine path.

To update Live Search, run the following from the command line:

1
composer update magento/live-search -–with-dependencies

To update to a major version such as from 1.0 to 2.0, edit the project’s root Composer .json file as follows:

  1. Open the root composer.json file and search for magento/live-search.

  2. In the require section, update the version number as follows:

    1
    2
    3
    4
    5
    
    "require": {
       ...
       "magento/live-search": "^2.0",
       ...
     }
    
  3. Save composer.json. Then, run the following from the command line:

    1
    
    composer update magento/live-search –-with-dependencies
    

To uninstall Live Search, go to Uninstall modules.