Integrate Nuclia search in Plone
Project description
# nuclia.plone
![Nuclia logo](https://nuclia.cloud/assets/logos/logo_text.svg)
This Plone add-on allows to index Plone contents in [Nuclia](https://nuclia.com/).
## Create a Nuclia knowledge box
[Create a Nuclia account](https://docs.nuclia.dev/docs/quick-start/create)
## Install the add-on
Add nuclia.plone in your buildout in the eggs section and run buildout.
Restart Plone.
Go to Site Setup / Add-ons and install nuclia.plone.
Go to Nuclia settings, and enter the following:
Knowledge box ID: you have a default knowledge box created with your Nuclia account, go to [Nuclia dashboard](https://nuclia.cloud/), the knowledge box ID is indicated on the home page in the Nuclia APi endpoint.
API key: see [how to get an API key](https://docs.nuclia.dev/docs/guides/getting-started/quick-start/push#get-an-api-key).
Region: this the geographical region your knowledge box is attached to.
Widget snippet: see [how to create a widget](https://docs.nuclia.dev/docs/guides/getting-started/quick-start/search#add-a-search-widget-to-your-website).
File attribute: the attribute of the content that contains the file to index. Default is file.
Metadata mapping: Nuclia allows to store the following metadata: title, summary, tags, contributors, created, modified. You can map Plone content fields to these metadata fields. If the field belongs to the parent node, use the following format: parent/field_name.
Workflow states: you can choose which workflow states trigger indexing in Nuclia. Default is published.
## Usage
Everytime a content having a file is created or modified (and if it is in the appropriate workflow state).
The Nuclia search widget is visible on the /@@nuclia-search view.
Contributors
Eric BREHAULT, ebrehault@gmail.com
Changelog
1.0b4 (2024-07-29)
Fix tags encoding for Python 2.7 [ebrehault]
1.0b3 (2024-06-28)
Manage target folders [ebrehault]
Respect workflow state when reindexing [ebrehault]
1.0b2 (2024-06-27)
Conservative encoding for the filename [ebrehault]
1.0b1 (2024-05-24)
Allow to re-index all files [ebrehault]
Support different field name for the file content, and allow to map metadata fields [ebrehault]
Compliancy with Plone 5.1 [ebrehault]
Allow to re-index all files [ebrehault]
1.0a3 (2022-10-10)
Fix project metadata. [ebrehault]
1.0a2 (2022-10-03)
Fix project metadata. [ebrehault]
1.0a1 (2022-10-03)
Initial release. [ebrehault]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.