Download the PHP package ernestdefoe/typesense without Composer
On this page you can find all versions of the php package ernestdefoe/typesense. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ernestdefoe/typesense
More information about ernestdefoe/typesense
Files in ernestdefoe/typesense
Package typesense
Short Description Fast, typo-tolerant Typesense search for Flarum 2 — a free, drop-in search driver.
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 typesense
Typesense Search for Flarum
A free, drop-in Typesense search driver for Flarum 2 — fast, typo-tolerant full-text search across discussions, users and posts that anyone can set up in a few minutes.
Flarum 2 shipped a pluggable search architecture; this extension implements a Typesense driver for it. Text searches are answered by Typesense; everything else (filtering, browsing, permissions) stays exactly as Flarum does it. You choose per resource which searches Typesense answers.
Why it's safe by design
Typesense is only ever asked for candidate discussion IDs and their ranking. Which
results a given user may actually see is decided entirely by Flarum's own
whereVisibleTo (including tag restrictions) — never by Typesense. The search server
holds no authorization logic, and the browser never talks to it. Your API key is stored
server-side and is never exposed to visitors.
Requirements
- Flarum
^2.0 - A running Typesense server (self-hosted is a single binary or Docker container, or use Typesense Cloud)
Install
Run Typesense (self-hosted example)
Set up
- Admin → Typesense Search. Enter the host, port, protocol and API key, then Save.
- Click Test connection to confirm Flarum can reach the server.
- Click Rebuild index (or run
php flarum typesense:index) to populate the index from your existing discussions. - Turn on Use Typesense for discussion search and save.
That's it — searches for discussions are now served by Typesense.
Search tabs that Typesense answers show a small Powered by Typesense badge in the search modal, so you can see at a glance which searches are using the driver. Only that on/off fact is sent to the browser — connection details and the API key stay on the server.
Console
How indexing works
- Each discussion is one Typesense document: its title plus the concatenated text of its visible comment posts.
- Creating, editing or deleting a discussion or post re-indexes the affected discussion automatically through Flarum's queued indexing pipeline.
- Configure a real queue driver (
redis,database, …) in production so indexing and rebuilds run in the background rather than inline on a web request.
Several forums can share one Typesense server safely — collections are namespaced by a prefix (set one, or it's derived from your forum URL).
What's indexed
Everything Flarum can full-text search, each in its own namespaced collection:
- Discussions — title + the concatenated text of visible comment posts.
- Users — username and display name.
- Posts — individual comment post text (post-scoped search).
Each is toggled independently in the admin, so you can send discussion search to Typesense while leaving users or posts on the database, or run all three through it. (Groups and access tokens have no full-text search in Flarum, so they always stay on the database driver.)
License
MIT © Ernest Defoe
All versions of typesense with dependencies
flarum/core Version ^2.0
typesense/typesense-php Version ^4.9
symfony/http-client Version ^6.0 || ^7.0
nyholm/psr7 Version ^1.8