Download the PHP package gitzaai/cnsearch without Composer
On this page you can find all versions of the php package gitzaai/cnsearch. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gitzaai/cnsearch
More information about gitzaai/cnsearch
Files in gitzaai/cnsearch
Package cnsearch
Short Description Flarum 2.0 extension for Meilisearch-powered Chinese discussion search
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package cnsearch
CN Search for Flarum 2.0
gitzaai/cnsearch is a Flarum 2 extension that uses Meilisearch as the discussion search backend. It indexes discussion titles and visible comment content, then plugs into Flarum's built-in discussion search flow.
Screenshots
Admin Settings
Search Results
Features
- Uses Meilisearch for discussion full-text search.
- Stores one Meilisearch document per discussion.
- Merges visible comment posts into each discussion document.
- Adds CJK n-gram fields for Chinese, Japanese, Korean, and other CJK search terms.
- Lowers the forum search trigger length so 1-2 character Chinese queries can run.
- Provides admin APIs and console commands for status checks, connection tests, search tests, and reindexing.
- Syncs the index when posts or discussions are created, edited, hidden, restored, or deleted.
Installation
For Flarum 2.0 beta 8 and newer, run php flarum assets:publish after installing or updating the extension to make sure frontend assets match the current extension code.
Configuration
The extension does not ship with a preset Meilisearch host or API key. Configure them in the admin panel, or use the bundled command:
If your Meilisearch instance requires authentication, provide your own key:
You can also write the settings directly:
If your Flarum database tables use a prefix, replace settings with the prefixed table name.
Queue
CN Search pushes every index update onto Flarum's queue (SyncDiscussionJob,
ReindexJob). With Flarum's default sync driver each job still runs in the
same request, but using a real queue driver (e.g. database) is strongly
recommended on busy forums so post creation never blocks on Meilisearch.
Configure a queue driver and run php flarum queue:work to process jobs in
the background.
Verification
Rebuild the index:
If Flarum reports There are no commands defined in the "cnsearch" namespace., enable CN Search in the admin panel first, then run the command again.
Check status:
Documents is the number of indexed Meilisearch documents, which normally matches the number of visible discussions. Source posts is the number of visible comment posts included in the index, and can be larger than Documents.
Test a search term directly:
After updating the extension, these commands are useful:
API
Search:
Status checks and reindexing require an admin session:
Links
All versions of cnsearch with dependencies
flarum/core Version ^2.0
meilisearch/meilisearch-php Version ^1.0 || >=2.0.0-beta.1 <3.0