blomstra/search

Replaces Flarum search with one powered by an elastic search server.

0.1.17 2023-01-30 22:17 UTC

Requires

• php: >= 8.0
• elasticsearch/elasticsearch: 7.*
• flarum/core: ^1.2.0
• spatie/elasticsearch-query-builder: ^1.3.0

MIT

• Team Blomstra

• search
• extension
• elasticsearch
• elastic
• fulltext
• flarum
• blomstra

README

Search replaces the native Flarum search functionality which relies on MySQL badly performing fulltext search with one that is completely relying on the proven elasticsearch engine.

Features

• Sync discussions to elastic search using your queue, unobtrusively for the user.
• Reduces search loading times to well below 400ms (local tests with 50.000 discussion 260ms)
• Uses Flarum's group permissions and tags system.
• Compatible with Friends of Flarum Byōbu.

Installation

Use composer:

composer require blomstra/search:*

Enable the extension inside the admin area and configure the settings.

Set up

Enable the extension in your admin area. Now to seed your existing discussions use the following command:

php flarum blomstra:search:index

All mutations to discussions are automatically added and removed from the elasticsearch index.

FAQ

I have another question. Reach out to us via https://helpdesk.blomstra.net. We will get back to you as soon as we can. If you have a running subscription please mention when you started your plan and/or which plan you are on. Always add sufficient information when reporting errors. We prefer errors being reported here, but understand that sometimes you can't.

Can I dispatch the sync jobs to another queue? Yes:

\Blomstra\Search\Observe\Job::$onQueue = 'sync';

• Blomstra provides managed Flarum hosting.
• https://blomstra.net
• https://blomstra.community/t/ext-search

Icon made by Freepik from Flaticon.