Open navigation

Integration Steps for Magento 2

For Magento 2.4 and above, we've introduced a backward compatibility module to our extension, so there are new steps required for installing and upgrading Klevu Search. Please carefully follow the instructions below.

 

Installing the Extension:

There are two methods to install the Klevu Search extension:

1. Via Composer (recommended):For Magento 2.4+, before running composer require, please modify your project composer.json to remove the module we've introduced for backward compatibility. Do not add this 'replace' for Magento 2.3 or lower.

  "require": {
...
},
"replace": {
"klevu/module-mysqlcompat": "*"
}

Then for all Magento versions, complete the following steps:

composer require klevu/module-search
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

2. Via Manual Download: Clone the following repositories from Github by executing below commands.

HTTPS: git clone https://github.com/klevu/productsearch.git
HTTPS: git clone https://github.com/klevu/content.git
HTTPS: git clone https://github.com/klevu/addtocart.git
HTTPS: git clone https://github.com/klevu/magento-troubleshoot.git

After cloning, please create following folder structures and copy all the files which you have downloaded from above link to the following folders respectively:

  • app/code/Klevu/Search
  • app/code/Klevu/Content
  • app/code/Klevu/Addtocart
  • app/code/Klevu/Troubleshoot

For Magento 2.3 and below, one additional step is required to install a module for backward compatibility. Do not clone this mysqlcompat module if you are using Magento 2.4+.

HTTPS: git clone https://github.com/klevu/mysqlcompat.git

After cloning, please create the following folder structures and copy all the files which you have downloaded from the above link to the following folder:

  • app/code/Klevu/MysqlCompat

Then for all Magento versions, execute the following commands.

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

Via Magento Marketplace: Since Magento 2.4, we no longer recommend installation via the Magento Marketplace. For earlier versions, you can go to Magento Marketplace and get the extension. After that login into your Magento admin panel and install the extension by following the  guide .


Configure the extension:

  1. Go to Magento2 Admin Panel
  2. Go to Stores → Configuration
  3. Go to Klevu → Search Configuration
  4. Click on Start Configuration Wizard
  5. Register a New User OR if you already have a Klevu account, login into your Klevu account
  6. Select a plan and start 14-Day risk free trial
  7. Configure a store
    • You need to configure Klevu Search separately on each storeview. Choose a storeview from the dropdown to configure the Klevu Search on it.
    • Select option for How do you want to display product prices in search?
    • Which base URL would you like to use for products in search results?:
      • Unsecure: This will ask the Klevu Search plugin to use the Base URL from System → Configuration → Web → Unsecure
      • Secure: This will ask the Klevu Search plugin to use the Base URL from System → Configuration → Web → Secure
  8. Click on the Finish and Sync button to synchronise your products to Klevu

You are done, please allow 10-15 minutes before trying out search on your store.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.