4.1. Search

The search feature provides the ability to search for files across one or more sites.

This page describes the steps required to set up the search feature.

For information on how to use the search feature, see Search

4.1.1. Prerequisites

The search feature is only supported on workers running on a PixStor.

There are two backends which can provide search functionality to Ngenea Hub: PixStor Search and PixStor Analytics.

This document assumes that the desired backend has already been deployed, as described in the PixStor deployment guide. Be aware that neither backend will have been deployed by default.

4.1.2. Configuration

4.1.2.1. Search Backend

By default, Ngenea Hub will use the Analytics backend. If you want to use the PixStor Search backend instead, change the search_backend to pixstor_search, as described in Global Configurations

$ curl -s -X PATCH 'http://example.com/api/configurations/' -H 'Accept: application/json' -H "Authorization: Bearer $JWT_ACCESS_TOKEN" -H 'Content-Type: application/json' -d '{"search_backend": "pixstor_search"}'

All sites must use the same backend - all analytics or all PixStor Search.

4.1.2.2. Elasticsearch URL

If you are using the Analytics backend and the worker is running on PixStor 6, you will need to change the elasticsearch_url for the site to http://localhost:19200, as described in Site-specific Configurations

$ curl -s -X PATCH 'http://example.com/api/sites/1/' -H 'Accept: application/json' -H "Authorization: Api-Key $APIKEY" -H 'Content-Type: application/json' -d '{"elasticsearch_url": "localhost:19200"}'

If not set, the elasticsearch_url will default to localhost:9200, which is correct for workers running on PixStor 5.

Different sites may configure a different elasticsearch_url, for example if one is PixStor 5 and another is PixStor 6.

4.1.3. Search UI

Once configured, search can be used via the REST API as described in Search

To use search via the Ngenea Hub UI, you must first enable the searchui feature flag, as described in Feature Flags

For example, using ngclient

ngclient features enable searchui