silverstripe/silverstripe-discoverer-bifrost

A plugin module for silverstripe/silverstripe-discoverer that provides integration for Silverstripe Bifröst

2.0.0 2024-11-06 01:10 UTC

Requires

• php: ^8.1
• guzzlehttp/guzzle: ^7.5
• silverstripe/framework: ^5
• silverstripe/silverstripe-discoverer-elastic-enterprise: ^2

Requires (Dev)

• phpunit/phpunit: ^9.6.19
• slevomat/coding-standard: ^8.8

BSD-3-Clause

• Christopher David Penny

• search
• filter
• query
• silverstripe
• filtering
• querying
• Silverstripe CMS
• Search Service

README

Purpose

Perform search queries on your Silverstripe Search data through Silverstripe CMS controllers.

This module is used to integrate with the 🌈 Bifröst - the API for Silverstripe's Search service.

Installation

composer require silverstripe/silverstripe-discoverer-bifrost

Specify environment variables

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

BIFROST_ENDPOINT="https://abc.provided.domain"
BIFROST_ENGINE_PREFIX="engine-name-excluding-variant"
BIFROST_QUERY_API_KEY="abc.123.xyz"

Usage

Please see the documentation provided in Discoverer.

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