PHPackages elastic/app-search-magento - 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 & Filtering](/categories/search) 4. / 5. elastic/app-search-magento AbandonedArchivedMagento2-module[Search & Filtering](/categories/search) elastic/app-search-magento ========================== Elastic App Search official integration for Magento 2 1.0.0-beta4(6y ago)255.0k8[7 issues](https://github.com/elastic/app-search-magento/issues)[1 PRs](https://github.com/elastic/app-search-magento/pulls)OSL-3.0PHPPHP ^7.1 Since Jun 24Pushed 1y ago25 watchersCompare [ Source](https://github.com/elastic/app-search-magento)[ Packagist](https://packagist.org/packages/elastic/app-search-magento)[ Docs](https://github.com/elastic/app-search-magento)[ RSS](/packages/elastic-app-search-magento/feed)WikiDiscussions master Synced yesterday READMEChangelog (4)Dependencies (7)Versions (6)Used By (0) [![Elastic App Search Logo](https://github.com/elastic/app-search-magento/raw/master/docs/assets/logo-app-search.png?raw=true)](https://github.com/elastic/app-search-magento/raw/master/docs/assets/logo-app-search.png?raw=true) [![](https://camo.githubusercontent.com/8fed3d325819346b46f74a08121c73607c6f4532e4cc9517b79ffdb112601148/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f656c61737469632f6170702d7365617263682d6d6167656e746f)](https://camo.githubusercontent.com/8fed3d325819346b46f74a08121c73607c6f4532e4cc9517b79ffdb112601148/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f656c61737469632f6170702d7365617263682d6d6167656e746f) [![GitHub release](https://camo.githubusercontent.com/8e2da792bbf85f6d56dadbe1ace306d25b506fbad9a92801cb218cd779ee1810/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f656c61737469632f6170702d7365617263682d6d6167656e746f2f616c6c2e7376673f7374796c653d666c61742d737175617265)](https://github.com/elastic/app-search-magento/releases) [![CircleCI build](https://camo.githubusercontent.com/226cc4753d8be737c7ba8ccf56ac6fa5d1ff1df0db0ca46c033aaffb30e99fe3/68747470733a2f2f696d672e736869656c64732e696f2f636972636c6563692f6275696c642f6769746875622f656c61737469632f6170702d7365617263682d6d6167656e746f2f6d6173746572)](https://circleci.com/gh/elastic/app-search-magento) > A first-party Magento integration for building excellent, relevant search experiences with [Elastic App Search](https://www.elastic.co/cloud/app-search-service). > **⚠️ This is a beta version of the client. [View known issues](#known-issues).** Contents -------- [](#contents) - [Getting started](#getting-started-) - [Usage](#usage) - [Development](#development) - [FAQ](#faq-) - [Contribute](#contribute-) - [License](#license-) --- Getting started 🐣 ----------------- [](#getting-started-) Using this client assumes that you have already: - Created an App Search account on or you have a self managed version of App Search available - PHP >= 7.1 - Magento >= 2.2.6 installed and running You can install the module in your project by using this composer command from your Magento project root: ``` composer require elastic/app-search-magento:1.0.0-beta3@beta ``` Once the module is installed, you should clean your cache and update your Magento instance if already installed: ``` bin/magento cache:clean bin/magento setup:upgrade ``` Usage ----- [](#usage) ### Configuring App Search credentials [](#configuring-app-search-credentials) To configure your credentials, you will need to collect the following information: - Your App Search API endpoint - Your App Search Private API key - Your App Search Public Search key If using a swiftype.com account, you will be able to access this information at . Self-managed users should connect to their App Search instance to retrieve their credentials. #### From Magento Admin [](#from-magento-admin) You can provide your App Search credentials within Magento Admin by browsing to the **Stores > Configuration > General > Elastic App Search** section: [![App Search Credentials Config](docs/assets/config-credentials.png)](docs/assets/config-credentials.png) **Note:**The module will create one App Search Engine per store view. New Engines will use a prefix that can be configured within the client: e.g. `magento2-catalogfulltext-search-1`. Update this setting (e.g. `my-website-staging`) if you plan to use the same account for several environment. #### From Magento CLI [](#from-magento-cli) You can update credentials using the Magento CLI: ``` bin/magento config:set elastic_appsearch/client/api_endpoint "https://host-xxxx.api.swiftype.com" bin/magento config:set elastic_appsearch/client/private_api_key "private-XXXXX" bin/magento config:set elastic_appsearch/client/search_api_key "search-XXXXX" ``` You can additionally set the Engine prefix: ``` bin/magento config:set elastic_appsearch/client/engine_prefix "my-website-staging" ``` ### Configuring App Search as Magento default search engine [](#configuring-app-search-as-magento-default-search-engine) Once your credentials are set in Magento, you need to update Magento configuration to use App Search instead of the out of the box MySQL search engine. Browse to the **Stores > Configuration > Catalog > Catalog Search** section to do so: [![Engine configuration](docs/assets/config-engine.png)](docs/assets/config-engine.png) As an alternative, you can use the Magento CLI to change the default search engine: ``` bin/magento config:set catalog/search/engine "elastic_appsearch" ``` ### Reindexing content [](#reindexing-content) To finish the install, you need to clean your cache and reindex your content into App Search: ``` bin/magento cache:clean bin/magento indexer:reindex catalogsearch_fulltext ``` ### Known issues [](#known-issues) The module is in its first round of beta. This first round is intended to act as a technical preview, which aims to integrate App Search as a Magento search adapter interface. There are a few caveats with the current implementation: - The maximum number of fields allowed by App Search (currently 64) does not allow you to index catalogs with too many products attributes (#37) - We will need to rework how product prices are stored into App Search to allow sites with a large number of customer groups to be indexed (#38) - Search relevance is still being tuned. Development ----------- [](#development) We ❤️ developers and want everyone to be able to contribute to the module. We have built a fully dockerized development environment using Magento sample data to help you in testing the module and contributing to the code. Full documentation to setup your environment is available [here](docs/DEVELOPMENT-ENVIRONMENT.md). FAQ 🔮 ----- [](#faq-) ### Where do I report issues with the client? [](#where-do-i-report-issues-with-the-client) If something is not working as expected, please open an [issue](https://github.com/elastic/app-search-magento/issues/new). ### Where can I find the full App Search API documentation ? [](#where-can-i-find-the-full-app-search-api-documentation-) Your best bet is to read the [documentation](https://swiftype.com/documentation/app-search). ### Where else can I go to get help? [](#where-else-can-i-go-to-get-help) You can checkout the [Elastic community discuss forums](https://discuss.elastic.co/c/app-search). Contribute 🚀 ------------ [](#contribute-) We welcome contributors to the project. Before you begin, a couple notes... - Before opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/elastic/app-search-magento/issues). - Please write simple code and concise documentation, when appropriate. License 📗 --------- [](#license-) [Open Software License ("OSL") v.3.0](LICENSE) © [Elastic](https://github.com/elastic) Thank you to all the [contributors](https://github.com/elastic/app-search-magento/graphs/contributors)! ### Health Score 30 — LowBetter than 64% of packages Maintenance22 Infrequent updates — may be unmaintained Popularity29 Limited adoption so far Community14 Small or concentrated contributor base Maturity44 Maturing project, gaining track record 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 ~42 days Total 4 Last Release 2385d ago PHP version history (2 changes)1.0.0-beta1PHP ^7.0 1.0.0-beta2PHP ^7.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/75c7c511421feb14316a01d29a7566bd4fdd97147b5a4f3faa5a065f9d0a0193?d=identicon)[ezimuel](/maintainers/ezimuel) ![](https://www.gravatar.com/avatar/ba68169b385c1d03c63650369b86685236583f1c8c223f840d54b6582922b911?d=identicon)[afoucret](/maintainers/afoucret) ![](https://www.gravatar.com/avatar/f887e605035c0c2b5ae9b8affd560079327e995aa92f08e2102c468359121e97?d=identicon)[JasonStoltz](/maintainers/JasonStoltz) --- Tags ecommerceelasticelastic-app-searchmagentomagento-extensionmagento2phpsearchswiftypeclientsearchmagentoelasticmagento2 ### Code Quality Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/elastic-app-search-magento/health.svg) ``` [![Health](https://phpackages.com/badges/elastic-app-search-magento/health.svg)](https://phpackages.com/packages/elastic-app-search-magento) ``` ### Alternatives [elasticsearch/elasticsearch PHP Client for Elasticsearch 5.3k178.3M943](/packages/elasticsearch-elasticsearch)[smile/elasticsuite Magento 2 merchandising and search engine built on ElasticSearch 8044.5M33](/packages/smile-elasticsuite)[smile/module-elasticsuite-cms-search Smile Elasticsuite - Cms Pages Search Module for Smile Elasticsuite. 25916.7k1](/packages/smile-module-elasticsuite-cms-search)[smile/elasticsuite-for-retailer Smile ElasticSuite for Retailers - Magento2 toolkit for Retailers : Store Locator, Availability and Prices per store, etc... 18235.4k](/packages/smile-elasticsuite-for-retailer)[elastic/enterprise-search Enterprise Search official PHP client 25617.7k9](/packages/elastic-enterprise-search)[smile/module-elasticsuite-rating Smile ElasticSuite - Rating search module. 1492.1k2](/packages/smile-module-elasticsuite-rating) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)