silverstripe / silverstripe-discoverer-bifrost
A plugin module for silverstripe/silverstripe-discoverer that provides integration for Silverstripe Bifröst
Installs: 10
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 6
Forks: 0
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- php: ^8.1
- guzzlehttp/guzzle: ^7.5
- silverstripe/framework: ^5
- silverstripe/silverstripe-discoverer-elastic-enterprise: ^1.1
Requires (Dev)
- phpunit/phpunit: ^9.6.19
- slevomat/coding-standard: ^8.8
This package is auto-updated.
Last update: 2024-08-21 03:05:43 UTC
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.