Skip to content

A plugin module for silverstripeltd/discoverer that provides integration for Elastic App Search

License

Notifications You must be signed in to change notification settings

silverstripeltd/silverstripe-discoverer-elastic-enterprise

Repository files navigation

🧭 Silverstripe Discoverer > Elastic Enterprise Search

Purpose

The purpose of this module is to provide you with the ability to perform search queries to Elastic Enterprise Search (App Search) engines through Silverstripe controllers.

Note: App Search is one of the products included in Elastic Enterprise Search, the two names are currently used interchangably in this module. This module does not currently provide support for Workplace Search (which is the other product that is included in Enterprise Search).

Installation

composer require silverstripe/silverstripe-discoverer-elastic-enterprise

Specify environment variables

The following environment variables are required for this module to function:

ENTERPRISE_SEARCH_ENDPOINT="https://abc123.app-search.ap-southeast-2.aws.found.io"
ENTERPRISE_SEARCH_ENGINE_PREFIX="engine-name-excluding-variant"
ENTERPRISE_SEARCH_API_SEARCH_KEY="search-abc123"

Usage

Please see the documentation provided in (Discoverer)[https://github.com/silverstripeltd/silverstripe-discoverer].

As mentioned above, this module serves as an "adaptor provider" for Discoverer. Besides the installation steps and environment variables above, you shouldn't really be interacting with this module in your code.

About

A plugin module for silverstripeltd/discoverer that provides integration for Elastic App Search

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages