volto-searchlib

Volto add-on

Features

Elasticsearch and NLPService middleware

You can configure the proxied Elasticsearch with the env var:

RAZZLE_PROXY_ES_DSN_${appName}, so for example RAZZLE_PROXY_ES_DSN_datahub.

If you use only one ES server, you can simply set RAZZLE_PROXY_ES_DSN.

You can configure the proxied NLPServer with the env var:

RAZZLE_PROXY_QA_DSN_${appName}, for example: RAZZLE_PROXY_QA_DSN_globalsearch. You you use only one NLP service, you can simply set RAZZLE_PROXY_QA_DSN. Notice, in principle the NLPService can use different Elasticsearch indexes.

Getting started

Try volto-searchlib with Docker

  git clone https://github.com/eea/volto-searchlib.git
  cd volto-searchlib
  make
  make start

Go to http://localhost:3000

Add volto-searchlib to your Volto project

1. Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone

   docker compose up backend

2. Start Volto frontend

• If you already have a volto project, just update package.json:

  "addons": [
      "@eeacms/volto-searchlib"
  ],
  
  "dependencies": {
      "@eeacms/volto-searchlib": "*"
  }

• If not, create one:

  npm install -g yo @plone/generator-volto
  yo @plone/volto my-volto-project --canary --addon @eeacms/volto-searchlib
  cd my-volto-project
  

1. Install new add-ons and restart Volto:

   yarn
   yarn start
   

2. Go to http://localhost:3000

3. Happy editing!

Release

See RELEASE.md.

How to contribute

See DEVELOP.md.

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

See LICENSE.md for details.

Funding

European Environment Agency (EU)