https://github.com/johnroyer/bookstack-meilisearch
Use Meilisearch at BookStack's search box
https://github.com/johnroyer/bookstack-meilisearch
bookstack cms meilisearch php
Last synced: 4 months ago
JSON representation
Use Meilisearch at BookStack's search box
- Host: GitHub
- URL: https://github.com/johnroyer/bookstack-meilisearch
- Owner: johnroyer
- License: mit
- Created: 2024-09-03T16:01:30.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-08-08T06:24:09.000Z (4 months ago)
- Last Synced: 2025-09-01T02:54:30.653Z (4 months ago)
- Topics: bookstack, cms, meilisearch, php
- Language: PHP
- Homepage:
- Size: 41.2 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# BookStack-meilisearch
This is a concept provement testing. Use Meilisearch as BookStack's search suggestion.
**NOTE**: not all funtionality has been implemented yet. Do NOT use it on production.
----
# Why Meilisearch
BookStack use space to separate sentence to words (search tokens). But not all language can be index by this algorithm.
Meilisearch use N-grams to create indexes. It make better search experience, and can use on most of languages.
----
# Migration
**WARNING**: BACKUP, before you do any changes.
You can manually copy and overwrite `app/Search/SearchController.php` on your currrent project.
set your Meilisearch configs in `.env`:
```
MEILISEARCH_HOST=127.0.0.1
MEILISEARCH_PORT=7700
MEILISEARCH_MASTER_KEY=
```
Then execute `php artisan bookstack:regenerate-search` to re-index data by Meilisearch.
if no error occurs, you can search using Meiliseach on SearchSuggestion (only, see sreenshot below).
----
# Screenshot
You can now search using event words in the middle of the phrease:
