Installation & Integration

Preparation

3min

Please ensure you have read the installation and integration guides before beginning the process. Upgrading from v2.x/v3.x requires manual steps to be taken by Klevu support to upgrade your account from XML indexing to JSON indexing.

Contact support to check if your account can be upgraded from XML indexing to JSON indexing.

Installation

In line with Magento's best practice, we recommend taking a backup of your database and enabling maintenance mode before making any changes to your Magento site.

All changes should be tested in a non-production environment first.

You are free to install it from Packagist or Magento Marketplace. New versions will be released to Packagist first, with a delay in releasing to Marketplace due to the review processes. This delay could be several weeks.

It is not possible to install v2.x/v3.x and v4.x at the same time. Any attempt to install v4.x while v2.x/v3.x is installed will fail and display a warning message. i.e. running composer require klevu/module-m2-search before running composer remove "klevu/*" will fail.

Integration

There are steps you may wish to take before integrating your API keys.

After you save your API keys the Klevu module will discover all your attributes, determine, which must be registered with Klevu and register them via the API. Klevu determines which attributes to sync via the Register with Klevu setting on each attribute. You may want to set these before integration. If you do not they will be picked up during the next cron run after integration. See Indexing - Attributes for more information on this setting.

We recommend creating a data patch to implement these changes on installation in your production environment.



Updated 27 Sep 2024
Doc contributor
Doc contributor
Did this page help you?