Skip to main content

Addon for ElasticSearch integration with Plone

Project description

ElasticSearch Integration for Plone content

  • indexer passing content to a separate running collective.elastic.ingest service.

  • index acting as a proxy to ElasticSearch, integrates with ZCatalog

  • custom plugins for plone.restapi to provide structural information for the ingestions service

  • REST api endpoint @kitsearch accepting Elasticsearch query returning results with Plone permission check.

Installation

mxdev

Add collective.elastic.plone to your requirements.txt. Provide an environments variable file .env in your backend directory with:

export CELERY_BROKER=redis://localhost:6379/0
export ELASTICSEARCH_INDEX={{elasticsearchindex}}
export ELASTICSEARCH_QUERY_SERVER={{elasticsearch_address}}

buildout

Install collective.elastic.plone by adding it to your buildout:

[buildout]

...

eggs =
    ...
    collective.elastic.plone

environment-vars +=
    CELERY_BROKER redis://localhost:6379/0
    ELASTICSEARCH_INDEX plone
    ELASTICSEARCH_QUERY_SERVER http://localhost:9200
    ELASTICSEARCH_QUERY_USE_SSL 0

and then running bin/buildout

Source Code

The sources are in a GIT DVCS with its main branches at github. There you can report issue too.

We’d be happy to see many forks and pull-requests to make this addon even better.

Maintainers are Jens Klein, Peter Holzer and the BlueDynamics Alliance developer team. We appreciate any contribution and if a release is needed to be done on pypi, please just contact one of us. We also offer commercial support if any training, coaching, integration or adaptions are needed.

Contributions

Initial implementation was made possible by Evangelisch-reformierte Landeskirche des Kantons Zürich.

Idea and testing: Peter Holzer

Concept & code by Jens W. Klein

Authors:

  • Katja Süss (Github: @ksuess)

License

The project is licensed under the GPLv2.

Changelog

1.1.1 (2023-03-03)

  • Nothing changed yet.

1.1 (2023-03-03)

  • Search REST API service @kitsearch for ElasticSearch querying with Plone security check. [ksuess]

1.0 (2022-11-08)

  • Initial release. [jensens]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.elastic.plone-1.1.1.tar.gz (36.5 kB view hashes)

Uploaded Source

Built Distribution

collective.elastic.plone-1.1.1-py3-none-any.whl (43.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page