Strapi plugin strapi-algolia

A strapi plugin to sync your strapi content with Algolia.

Getting started

1. Installation

Strapi v5 - Use latest version

With Yarn

yarn add strapi-plugin-strapi-algolia@latest

With NPM

npm install --save strapi-plugin-strapi-algolia@latest

Strapi v4 - Use version 1.x.x

With Yarn

yarn add strapi-plugin-strapi-algolia@1

With NPM

npm install --save strapi-plugin-strapi-algolia@1

2. Setup environment variables

ALGOLIA_ADMIN_KEY=your_algolia_app_id
ALGOLIA_APP_ID=your_algolia_api_key

3. Configure the plugin

In Javascript

Add the following code to ./config/plugins.js

1'use strict';
2
3module.exports = ({ env }) => ({
4  // ...
5  'strapi-algolia': {
6    enabled: true,
7    config: {
8      apiKey: env('ALGOLIA_ADMIN_KEY'),
9      applicationId: env('ALGOLIA_APP_ID'),
10      contentTypes: [
11        { name: 'api::article.article' },
12        // ...
13      ],
14    },
15  },
16});

In Typescript

Add the following code to ./config/plugins.ts

1export default ({ env }) => ({
2  // ...
3  'strapi-algolia': {
4    enabled: true,
5    config: {
6      apiKey: env('ALGOLIA_ADMIN_KEY'),
7      applicationId: env('ALGOLIA_APP_ID'),
8      contentTypes: [
9        { name: 'api::article.article' },
10        // ...
11      ],
12    },
13  },
14});

All configurations options

UI

For each content type configured in the plugin, a new button will be added to the content type list. This button will allow you to index all the content of the content type.

Endpoints

Index all the content of a content-type

Call the following endpoint /strapi-algolia/index-all-articles with POST method.

The body must be like this:

1{
2  "name": "api::article.article"
3}

You must be admin and add an authorization bearer token in the header.

1Authorization: Bearer YOUR_TOKEN

Example with curl:

curl --request POST \
  --url https://YOUR_STRAPI_INSTANCE/strapi-algolia/index-all-articles \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
	"name": "api::article.article"
}'