Meilisearch

Meilisearch is a fast, open-source search engine written in Rust. It’s easy to set up, delivers instant, relevant results, and offers a free self-hosted option.

Getting Started

Install dependencies

First install the meilisearch package.

npm install meilisearch

Configure environment variables

Update your environment variables schema and add them to your .env file.

import { Env } from '@adonisjs/core/env'
 
export default await Env.create(new URL('../', import.meta.url), {
  MEILISEACH_HOST: Env.schema.string({ format: 'host' }),
  MEILISEARCH_API_KEY: Env.schema.string.optional(),
})

Configure the Search Engine

Add the MeilisearchEngine to your Magnify configuration.

config/magnify.ts

import env from '#start/env'
import { defineConfig, engines } from '@foadonis/magnify'
import type { InferEngines } from '@foadonis/magnify/types'
 
const magnifyConfig = defineConfig({
  default: 'meilisearch',
  engines: {
    meilisearch: engines.meilisearch({
      host: env.get('MEILISEARCH_HOST'),
      apiKey: env.get('MEILISEARCH_API_KEY', undefined),
    }),
  },
})
 
export default magnifyConfig
 
/**
 * Inferring types for the list of engines you have configured
 * in your application.
 */
declare module '@foadonis/magnify/types' {
  export interface EnginesList extends InferEngines<typeof magnifyConfig> {}
}

Index Settings

Some features like filtering and ordering require custom index configurations.

config/magnify.ts

import env from '#start/env'
import { defineConfig, engines } from '@foadonis/magnify'
import type { InferEngines } from '@foadonis/magnify/types'
 
const magnifyConfig = defineConfig({
  default: 'meilisearch',
  engines: {
    meilisearch: engines.meilisearch({
      host: env.get('MEILISEARCH_HOST'),
      apiKey: env.get('MEILISEARCH_API_KEY', undefined),
      indexSettings: {
        users: {
          filterableAttributes: ['isAdmin'],
          sortableAttributes: ['createdAt'],
        },
      },
    }),
  },
})
 
export default magnifyConfig

You can then synchronize your indices with the following command:

node ace magnify:sync

Getting Started

Install dependencies

Configure environment variables

Configure the Search Engine

Index Settings

Start Searching

On this page