Providers 1.0.0-alpha.1

The Strapi search plugin uses a provider system, similar to the official Strapi Upload and Email plugin, to connect to a (third party) search service. The following search service are supported.

Algolia

In the future the Mattie Bundle will develop and officially support multiple providers. Possible search service are the following:

Elasticsearch

Meilisearch

Coveo

Addsearch

Algolia

Installation

Add @mattie/strapi-provider-search-algolia as dependency to your project with:

yarn add @mattie/strapi-provider-search-algolia

npm install @mattie/strapi-provider-search-algolia

Configuration

File based

The algolia provider can be selected and configured with the provider and providerOptions in the search plugin configuration.

Property	Description	Type
`provider`	Name of the provider, must be `'algolia'`.	`String` (required)
`providerOptions`	Provider specific options.	`Object` (required)
`providerOptions.apiKey`	Algolia API key. The Admin API Key or a custom key with ACL operations: `search`, `addObject`, `deleteObject`.	`String` (required)
`providerOptions.applicationId`	Algolia application ID.	`String` (required)

The usage of environment variables is recommended, checkout the Strapi documentation on using environment variables. ^v4

Configuration example

./config/plugins.js

module.exports = ({ env }) => ({
  settings: {
    search: {
      enabled: true,
      config: {
        provider: 'algolia',
        providerOptions: {
          apiKey: env('ALGOLIA_PROVIDER_ADMIN_API_KEY'),
          applicationId: env('ALGOLIA_PROVIDER_APPLICATION_ID'),
        },
        // ...
      },
    },
  },
});

Admin panel

Configuration by admin panel is coming soon! ✨

Create your own provider

'Create your own provider' guide coming soon! 🗒️