sbp-jm
/
sbp-flarum-search
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases 2 Wiki Activity
143 Commits 11 Branches 62 Tags 1.1 MiB
PHP 87.1%
TypeScript 12.8%
Go to file
Bart van Bragt e2e2d1428f feat: restructure index as parent-child documents with blue-green rebuilds 
- Switch to ES parent/child join_field: discussion docs hold all metadata,
  post docs hold content only. Routing ensures parent and child land on the
  same shard. Removes the old flat-document approach where post data was
  duplicated onto every comment document.

- Add HasChildQuery with inner_hits so the best-matching post ID is
  surfaced as mostRelevantPost without a second DB query.

- Blue-green index rebuilds: --recreate writes into a timestamped pending
  index, --swap atomically promotes it via alias. Interrupted builds are
  resumable with --recreate --continue. --swap requires confirmation before
  proceeding.

- Index hidden posts; non-moderators are filtered at query time via
  is_hidden on the has_child clause. Core\Hidden and Core\Restored trigger
  re-indexing so moderators with post.hide can search hidden posts.
 		2026-04-09 23:30:57 +02:00
.github/workflows chore: use npm 2022-11-18 08:30:44 +00:00
js Bundled output for commit f6503f5e6a 2023-01-30 22:17:40 +00:00
resources complete testing 2022-11-10 12:54:26 +01:00
src feat: restructure index as parent-child documents with blue-green rebuilds 2026-04-09 23:30:57 +02: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 2023-10-18 13:57:41 +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.