Skip to content

Latest commit

 

History

History
115 lines (69 loc) · 3.1 KB

File metadata and controls

115 lines (69 loc) · 3.1 KB
Coveralls Latest Version Egg Status

https://img.shields.io/pypi/pyversions/plone.typesense.svg?style=plastic:alt:Supported-PythonVersions

License

plone.typesense

Typesense Plone integration (WIP!)

Features

  • Indexing of all or partial content of the Plone site in Typesense.

Goals

plone.typesense is meant to be a full Plone integration, including permissions/roles. You will be able to query Typesense directly from a client and also get all data from there. This much faster than querying Plone which queries Typesense and you have the full query power of Typesense. But everything inside Plone will work as expected. So plone.api/restapi should have all known API calls. But they are limited to what Plone offers with the default search.

Installation

Install plone.typesense by adding it to your buildout:

[buildout]

...

eggs =
    plone.typesense

and then running bin/buildout

Typesense

This package requires a typesense search engine running.

You can run one by using podman-compose up or docker-compose up.

Please read this for a [quick docker based setup](https://typesense.org/docs/guide/install-typesense.html#option-2-local-machine-self-hosting).

A nice UI is also available here: https://github.com/bfritscher/typesense-dashboard/releases

Usage

http://localhost/Plone/@@typesense-test-connection http://localhost/Plone/@@typesense-reindex-collection

Authors

Maik Derstappen - MrTango - md@derico.de

Contributors

Put your name here, you deserve it!

  • ?

Contribute

Support

If you are having issues, please let us know.

License

The project is licensed under the GPLv2.