{"id":13752376,"url":"https://github.com/elastic/app-search-magento","last_synced_at":"2025-06-30T20:06:36.499Z","repository":{"id":34978609,"uuid":"176694127","full_name":"elastic/app-search-magento","owner":"elastic","description":"A first party module to integrate Elastic App Search in Magento 2.","archived":false,"fork":false,"pushed_at":"2024-08-08T15:05:44.000Z","size":944,"stargazers_count":26,"open_issues_count":12,"forks_count":11,"subscribers_count":30,"default_branch":"master","last_synced_at":"2025-06-25T00:13:49.019Z","etag":null,"topics":["ecommerce","elastic","elastic-app-search","magento","magento-extension","magento2","php","search","swiftype"],"latest_commit_sha":null,"homepage":"https://www.elastic.co/products/app-search","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"osl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elastic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-20T09:00:14.000Z","updated_at":"2024-09-23T13:43:39.000Z","dependencies_parsed_at":"2025-01-14T11:10:52.410Z","dependency_job_id":"5cf5531f-0a3a-4558-b7eb-0c94704b9b7e","html_url":"https://github.com/elastic/app-search-magento","commit_stats":{"total_commits":310,"total_committers":6,"mean_commits":"51.666666666666664","dds":0.07096774193548383,"last_synced_commit":"3b92e8f857e9c25b7be030396d93b09f3e9c4da9"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/elastic/app-search-magento","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elastic%2Fapp-search-magento","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elastic%2Fapp-search-magento/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elastic%2Fapp-search-magento/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elastic%2Fapp-search-magento/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elastic","download_url":"https://codeload.github.com/elastic/app-search-magento/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elastic%2Fapp-search-magento/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262842922,"owners_count":23373167,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ecommerce","elastic","elastic-app-search","magento","magento-extension","magento2","php","search","swiftype"],"created_at":"2024-08-03T09:01:04.844Z","updated_at":"2025-06-30T20:06:36.288Z","avatar_url":"https://github.com/elastic.png","language":"PHP","funding_links":[],"categories":["Open Source Extensions"],"sub_categories":["Search"],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"https://github.com/elastic/app-search-magento/raw/master/docs/assets/logo-app-search.png?raw=true\" alt=\"Elastic App Search Logo\"\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/packagist/l/elastic/app-search-magento\" /\u003e\n  \u003ca href=\"https://github.com/elastic/app-search-magento/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/release/elastic/app-search-magento/all.svg?style=flat-square\" alt=\"GitHub release\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://circleci.com/gh/elastic/app-search-magento\"\u003e\u003cimg src=\"https://img.shields.io/circleci/build/github/elastic/app-search-magento/master\" alt=\"CircleCI build\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003e A first-party Magento integration for building excellent, relevant search experiences with [Elastic App Search](https://www.elastic.co/cloud/app-search-service).\n\n\u003e **:warning: This is a beta version of the client. [View known issues](#known-issues).**\n\n\n## Contents\n\n- [Getting started](#getting-started-)\n- [Usage](#usage)\n- [Development](#development)\n- [FAQ](#faq-)\n- [Contribute](#contribute-)\n- [License](#license-)\n\n***\n\n## Getting started 🐣\n\nUsing this client assumes that you have already:\n\n- Created an App Search account on https://swiftype.com/ or you have a self managed version of App Search available\n- PHP \u003e= 7.1\n- Magento \u003e= 2.2.6 installed and running\n\nYou can install the module in your project by using this composer command from your Magento project root:\n\n```bash\ncomposer require elastic/app-search-magento:1.0.0-beta3@beta\n```\n\nOnce the module is installed, you should clean your cache and update your Magento instance if already installed:\n\n```bash\nbin/magento cache:clean\nbin/magento setup:upgrade\n```\n\n## Usage\n\n### Configuring App Search credentials\n\nTo configure your credentials, you will need to collect the following information:\n\n- Your App Search API endpoint\n- Your App Search Private API key\n- Your App Search Public Search key\n\nIf using a swiftype.com account, you will be able to access this information at [https://app.swiftype.com/as/credentials](https://app.swiftype.com/as/credentials).\n\nSelf-managed users should connect to their App Search instance to retrieve their credentials.\n\n#### From Magento Admin\n\nYou can provide your App Search credentials within Magento Admin by browsing to the **Stores \u003e Configuration \u003e General \u003e Elastic App Search** section:\n\n![App Search Credentials Config](docs/assets/config-credentials.png)\n\n**Note:**\nThe module will create one App Search Engine per store view.\nNew Engines will use a prefix that can be configured within the client: e.g. `magento2-catalogfulltext-search-1`.\n\nUpdate this setting (e.g. `my-website-staging`) if you plan to use the same account for several environment.\n\n#### From Magento CLI\n\nYou can update credentials using the Magento CLI:\n\n```bash\nbin/magento config:set elastic_appsearch/client/api_endpoint \"https://host-xxxx.api.swiftype.com\"\nbin/magento config:set elastic_appsearch/client/private_api_key \"private-XXXXX\"\nbin/magento config:set elastic_appsearch/client/search_api_key \"search-XXXXX\"\n```\n\nYou can additionally set the Engine prefix:\n\n```bash\nbin/magento config:set elastic_appsearch/client/engine_prefix \"my-website-staging\"\n```\n\n### Configuring App Search as Magento default search engine\n\nOnce 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.\n\nBrowse to the **Stores \u003e Configuration \u003e Catalog \u003e Catalog Search** section to do so:\n\n![Engine configuration](docs/assets/config-engine.png)\n\nAs an alternative, you can use the Magento CLI to change the default search engine:\n\n```bash\nbin/magento config:set catalog/search/engine \"elastic_appsearch\"\n```\n\n### Reindexing content\n\nTo finish the install, you need to clean your cache and reindex your content into App Search:\n\n```bash\nbin/magento cache:clean\nbin/magento indexer:reindex catalogsearch_fulltext\n```\n\n### Known issues\n\nThe 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.\n\nThere are a few caveats with the current implementation:\n\n- The maximum number of fields allowed by App Search (currently 64) does not allow you to index catalogs with too many products attributes (#37)\n\n- 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)\n\n- Search relevance is still being tuned.\n\n\n## Development\n\nWe ❤️ developers and want everyone to be able to contribute to the module.\n\nWe have built a fully dockerized development environment using Magento sample data to help you in testing the module and contributing to the code.\n\nFull documentation to setup your environment is available [here](docs/DEVELOPMENT-ENVIRONMENT.md).\n\n## FAQ 🔮\n\n### Where do I report issues with the client?\n\nIf something is not working as expected, please open an [issue](https://github.com/elastic/app-search-magento/issues/new).\n\n### Where can I find the full App Search API documentation ?\n\nYour best bet is to read the [documentation](https://swiftype.com/documentation/app-search).\n\n### Where else can I go to get help?\n\nYou can checkout the [Elastic community discuss forums](https://discuss.elastic.co/c/app-search).\n\n## Contribute 🚀\n\nWe welcome contributors to the project. Before you begin, a couple notes...\n\n+ Before opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/elastic/app-search-magento/issues).\n+ Please write simple code and concise documentation, when appropriate.\n\n## License 📗\n\n[Open Software License (\"OSL\") v.3.0](LICENSE) © [Elastic](https://github.com/elastic)\n\nThank you to all the [contributors](https://github.com/elastic/app-search-magento/graphs/contributors)!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felastic%2Fapp-search-magento","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felastic%2Fapp-search-magento","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felastic%2Fapp-search-magento/lists"}