bimthebam/silverstripe-meilisearch

Easily integrate meilisearch into SilverStripe

Installs: 44

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 2

Open Issues: 1

Type:silverstripe-vendormodule

1.0.1 2023-08-09 14:32 UTC

This package is auto-updated.

Last update: 2024-05-13 10:33:00 UTC


README

Intro

This module adds support for connecting with meilisearch as (multi-lingual) full-text search engine.

mailisearch

An open-source, lightning-fast, and hyper-relevant search engine that fits effortlessly into your workflow.

Requirements

  • SilverStripe 4.x and 5.x
  • PHP 8.1
  • meilisearch 1.3 - self hosted
    (due to missing supoprt for authorization keys.)

Supports

Installation

composer require bimthebam/silverstripe-meilisearch ^1.0

Configuration

This module requires a single environment variable to be defined: MEILISEARCH_HOST_AND_PORT

e.g. MEILISEARCH_HOST_AND_PORT=http://your-meilisearch-host:7700

Usage

Initialization

Run the buit-in task RebuildAllIndexesTask, which will create all the needed indexes within your meilisearch instance and fills them up with contents.

Although not neccessary, it is suggested to run the task from CLI.

e.g. sake dev/tasks/meilisearch-rebuild-all-indexes

Search

This module comes with a pre-defined index for SiteTree. So searching in page contents should mostly work out of the box.

To start, simply add a new page of type SearchPage to your site tree.

Custom indexes

Documentation incomplete

ToDo

  • Add support for authentication keys
  • Complete documentation for custom indexes