Go to file
StyleCI Bot db74da3e37
Apply fixes from StyleCI
2022-11-23 11:29:48 +00:00
.github/workflows chore: use npm 2022-11-18 08:30:44 +00:00
js Bundled output for commit 703cbbdd48 2022-11-21 15:33:18 +00:00
resources wip 2021-10-31 02:53:16 +02:00
src Apply fixes from StyleCI 2022-11-23 11:29:48 +00:00
.editorconfig wip 2021-10-12 23:15:47 +02:00
.gitattributes wip 2021-10-12 23:15:47 +02:00
.gitignore wip 2021-10-12 23:15:47 +02:00
LICENSE.md Create LICENSE.md (#7) 2022-02-17 22:24:42 +00:00
README.md chore: fix incorect command 2022-11-18 09:28:52 +00:00
composer.json Webpack 5 2022-05-03 09:13:10 +01:00
extend.php Apply fixes from StyleCI 2022-11-18 09:34:30 +00:00

README.md

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';

Icon made by Freepik from Flaticon.