https://github.com/eea/volto-searchlib

EEA Searchlib Volto integration package
https://github.com/eea/volto-searchlib

Last synced: 2 months ago
JSON representation

EEA Searchlib Volto integration package

• Host: GitHub
• URL: https://github.com/eea/volto-searchlib
• Owner: eea
• License: mit
• Created: 2021-09-10T12:38:30.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2026-01-26T08:11:49.000Z (5 months ago)
• Last Synced: 2026-01-26T22:34:16.886Z (5 months ago)
• Language: JavaScript
• Size: 12 MB
• Stars: 3
• Watchers: 29
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# volto-searchlib

[![Releases](https://img.shields.io/github/v/release/eea/volto-searchlib)](https://github.com/eea/volto-searchlib/releases)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-searchlib%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-searchlib/job/master/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-searchlib&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-searchlib)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-searchlib&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-searchlib)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-searchlib&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-searchlib)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-searchlib&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-searchlib)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-searchlib%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-searchlib/job/develop/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-searchlib&branch=develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-searchlib&branch=develop)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-searchlib&branch=develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-searchlib&branch=develop)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-searchlib&branch=develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-searchlib&branch=develop)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-searchlib&branch=develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-searchlib&branch=develop)

[Volto](https://github.com/plone/volto) add-on

## Features

![Searchlib](https://raw.githubusercontent.com/eea/volto-searchlib/master/docs/volto-searchlib.gif)

### Elasticsearch 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`.

## 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

`make start` now defaults to Volto 18. To run the same setup against Volto 17, use:

      VOLTO_VERSION=17 make

      VOLTO_VERSION=17 make start

### Add volto-searchlib to your Volto project

1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone

   ```Bash

   docker compose up backend

   ```

1. Start Volto frontend

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

   ```JSON

   "dependencies": {

       "@eeacms/volto-searchlib": "*"

   }

   ```

   and `volto.config.js`:

   ```JavaScript

   const addons = ['@eeacms/volto-searchlib'];

   ```

* If not, create one with Cookieplone, as recommended by the official Plone documentation for Volto 18+:

   ```

   uvx cookieplone project

   cd project-title

   ```

1. Install or update dependencies, then start the project:

   ```

   make install

   ```

   For a Cookieplone project, start the backend and frontend in separate terminals:

   ```

   make backend-start

   make frontend-start

   ```

   For a legacy Volto 17 project, install the package with `yarn` and restart the frontend as usual.

1. Go to http://localhost:3000

1. Happy editing!

## Release

See [RELEASE.md](https://github.com/eea/volto-searchlib/blob/master/RELEASE.md).

## How to contribute

See [DEVELOP.md](https://github.com/eea/volto-searchlib/blob/master/DEVELOP.md).

## Copyright and license

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

All Rights Reserved.

See [LICENSE.md](https://github.com/eea/volto-searchlib/blob/master/LICENSE.md) for details.

## Funding

[European Environment Agency (EU)](http://eea.europa.eu)