Explore related content in the Algolia Academy
Algolia for Adobe Commerce and Magento Open Source
Before you begin
Before you can use the Algolia extension in your Magento store, you need to create a (free) Algolia accountYou can use Algolia for Magento with Grow or Premium plans,
but some features are only available in the Premium plan.
Magento 2.4 compatibility
The Magento 2.4 release introduced significant changes, including removing the MySQL search engine option. If you’re running Magento 2.4, you must install version 3 of the Algolia extension. To be compatible with Magento 2.4, Algolia’s extension (starting from version 3) doesn’t include backend rendering features that rely on the MySQL search adapter classes. Older versions of the Algolia extension aren’t compatible with Magento 2.4, and are no longer supported by Algolia. See System requirements in the Magento documentation for more information.Installation
You can install the Algolia extension for Magento Open Source and Adobe Commerce using composer, or from the Magento Marketplace.Install the Algolia extension with composer
Use composer to install the Algolia extension for Magento. Run the following commands:-f
flag to the last command:
Install the Algolia extension from the Magento Marketplace
Go to the Magento Marketplace to get the extension and follow the instructions to install. If you run into an error about missing dependencies while installing or upgrading through the Marketplace, resolve all dependencies by runningcomposer update
.
Installation error
The errorFatal error: Class 'AlgoliaSearch\Version' not found in .../AlgoliaHelper.php on line xx
error usually means that the extension has been installed incorrectly.
Reinstall according to the instructions.
Configuration
To configure the Magento extension, you need the following Algolia credentials:- Application ID
- Search-only API key
- Admin API key
-
In the Admin panel of your Magento project, go to Stores > Algolia Search > Credentials and Basic Setup to open the configuration page for Algolia.
-
Enter your Algolia credentials and choose a name for the Index Name Prefix.
- Click Save Config at the top right to save your configuration.
Support for multiple application IDs
Starting with version 3.15.0, the extension supports setting up multiple application IDs. This lets you specify multiple applications that you own at the website level. For example, if you have a Magento store configured with two different websites (website A and website B), you can configure it with two different applications A and B:- Set the default configuration with application A (with its own search-only API key and admin API key).
- Select website B, clear the Use default option, and set the configuration with application B with the corresponding search-only API key and admin API key.
- Clear the cache.
If you use multiple application IDs,
make sure that each of these applications have access to the Algolia features you’re using.