![\"Meilisearch-Strapi\"](\"https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_strapi.svg\")
\n\n \n
\n ![\"npm](\"https://img.shields.io/npm/v/strapi-plugin-meilisearch.svg\")
\n ![\"Tests\"](\"https://github.com/meilisearch/strapi-plugin-meilisearch/workflows/Tests/badge.svg\"){kind=icon}
\n ![\"Prettier\"](\"https://img.shields.io/badge/styled_with-prettier-ff69b4.svg\"){kind=icon}
\n ![\"License\"](\"https://img.shields.io/badge/license-MIT-informational\"){kind=icon}
⚡ The Meilisearch plugin for Strapi
\n\nMeilisearch is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)\n\nAdd your Strapi content-types into a Meilisearch instance. The plugin listens to modifications made on your content-types and updates Meilisearch accordingly.\n\n## Table of Contents \n\n- [📖 Documentation](#-documentation)\n- [🔧 Installation](#-installation)\n- [🚀 Getting started](#-getting-started)\n- [💅 Customization](#-customization)\n- [💡 Run the Playground](#-run-the-playground)\n- [🤖 Compatibility with Meilisearch and Strapi](#-compatibility-with-meilisearch-and-strapi)\n- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)\n- [🌎 Community support](#-community-support)\n- [🤩 Just for the pleasure of the eyes](#-just-for-the-pleasure-of-the-eyes)\n\n## 📖 Documentation\n\nTo understand Meilisearch and how it works, see the [Meilisearch's documentation](https://www.meilisearch.com/docs/learn/getting_started/installation).\n\nTo understand Strapi and how to create an app, see [Strapi's documentation](https://strapi.io/documentation/developer-docs/latest/getting-started/introduction.html).\n\n## 🔧 Installation\n\nThis package version works with the [v5 of Strapi](https://docs.strapi.io/dev-docs/intro). If you are using [Strapi v4](https://docs-v4.strapi.io/), refer to versions under [`v0.12`](https://github.com/meilisearch/strapi-plugin-meilisearch/tree/v0.12.0), if you are using [Strapi v3](https://docs-v3.strapi.io/), consider [this README](https://github.com/meilisearch/strapi-plugin-meilisearch/tree/v3_main).\n\nInside your Strapi app, add the package:\n\nWith `npm`:\n\n```bash\nnpm install strapi-plugin-meilisearch\n```\n\nWith `yarn`:\n\n```bash\nyarn add strapi-plugin-meilisearch\n```\n\nTo apply the plugin to Strapi, a re-build is needed:\n\n```bash\nstrapi build\n```\n\nYou will need both a running Strapi app and a running Meilisearch instance. For [specific version compatibility, see this section](#-compatibility-with-meilisearch-and-strapi).\n\n### Run Meilisearch \n\n⚡️ **Launch, scale, and streamline in minutes with Meilisearch Cloud**—no maintenance, no commitment, cancel anytime. [Try it free now](https://cloud.meilisearch.com/login?utm_campaign=oss&utm_source=github&utm_medium=strapi-plugin-meilisearch).\n\n🪨 Prefer to self-host? [Download and deploy](https://www.meilisearch.com/docs/learn/self_hosted/getting_started_with_self_hosted_meilisearch?utm_campaign=oss&utm_source=github&utm_medium=strapi-plugin-meilisearch) our fast, open-source search engine on your own infrastructure.\n\n### 🏃♂️ Run Strapi \n\nIf you don't have a running Strapi project yet, you can either launch the [playground present in this project](#-run-the-playground) or [create a Strapi project](https://strapi.io/documentation/developer-docs/latest/getting-started/quick-start.html).\n\nWe recommend indexing your content-types to Meilisearch in development mode to allow the server reloads needed to apply or remove listeners.\n\nTo start playground project you first need to run from the root of the repo\n\n```bash\nyarn watch:link\n```\n\nand after that in the playground\n\n```bash\nyarn dlx yalc add --link strapi-plugin-meilisearch && yarn install\nstrapi develop\n// or\nyarn dlx yalc add --link strapi-plugin-meilisearch && yarn install\nyarn develop\n```\n\n### Run Both with Docker\n\nYou can use Docker to run Meilisearch and Strapi on the same server. A Docker configuration example can be found in the directory [`resources/docker`](resources/docker/) of this repository.\n\nTo run the Docker script add both files `Dockerfile` and `docker-compose.yaml` at the root of your Strapi project and run it with the following command: `docker-compose up`.\n\n## 🚀 Getting started\n\nNow that you have installed the plugin, a running Meilisearch instance and, a running Strapi app, let's go to the plugin page on your admin dashboard.\n\nOn the left-navbar, `Meilisearch` appears under the `PLUGINS` category. If it does not, ensure that you have installed the plugin and re-build Strapi (see [installation](#-installation)).\n\n### 🤫 Add Credentials \n\nFirst, you need to configure credentials via the Strapi config, or on the plugin page.\nThe credentials are composed of:\n\n- The `host`: The url to your running Meilisearch instance.\n- The `api_key`: The `master` or `private` key as the plugin requires administration permission on Meilisearch.[More about permissions here](https://www.meilisearch.com/docs/reference/features/authentication.html).\n\n⚠️ The `master` or `private` key should never be used to `search` on your front end. For searching, use the `public` key available on [the `key` route](https://www.meilisearch.com/docs/reference/api/keys.html#get-keys).\n\n#### Using the plugin page\n\nYou can add your Meilisearch credentials in the `settings` tab on the Meilisearch plugin page.\n\nFor example, using the credentials from the section above: [`Run Meilisearch`](#-run-meilisearch), the following screen shows where the information should be.\n\n\n![\"Add](\"./assets/credentials-tab.png\")
\n
\n![\"Content-types\"](\"./assets/content-type-tab.png\")
\n
\n![\"Content-types\"](\"./assets/indexing.gif\")
\n
\n![\"Remove](\"./assets/un-check.png\")
\n
Example with two single types:
\n\n![\"Example](\"./assets/same-index.gif\")
\n
\n![\"Restaurant](\"./assets/obrigado.gif\")
\n
\n![\"Foodadvisor](\"./assets/restaurant.gif\")
\n