silverstripe/recipe-solr-search

Silverstripe Cloud Platform search requirements recipe

3.1.0 2024-03-10 20:03 UTC

Requires

• php: ^8.1
• cwp/cwp-search: ^2
• silverstripe/framework: ^5
• silverstripe/fulltextsearch: ^4
• silverstripe/recipe-plugin: ^2
• symbiote/silverstripe-queuedjobs: ^5

Requires (Dev)

• cwp/cwp: ^3
• cwp/cwp-core: ^3
• cwp/starter-theme: ^4
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3

Suggests

• silverstripe/textextraction: Text Extraction API for SilverStripe CMS (mostly used with 'fulltextsearch' module)

BSD-3-Clause

README

This Silverstripe CMS Recipe is designed to enable Solr-based fulltext search. It's specifically designed to work with Silverstripe Cloud Platforms, but may be functional in other environments as well. It's the successor of cwp/cwp-recipe-search.

This includes the following core Silverstripe modules:

• cwp/cwp-search: CWP fulltextsearch integration module
• silverstripe/fulltextsearch: Adds external full text search engine support to SilverStripe, specically with Solr in a CWP context
• symbiote/silverstripe-queuedjobs: A module that provides interfaces for scheduling jobs for certain times

You can also opt in to install the following suggested (not required) modules:

• silverstripe/textextraction: Text Extraction API for Silverstripe CMS (mostly used with 'fulltextsearch' module)

This can be either added to an existing project or used as a project base for creating a Silverstripe CMS install.

Unlike other Silverstripe recipes, this recipe does not constrain Silverstripe core dependencies to a particular minor version line.

Installation

composer create-project silverstripe/recipe-solr-search ./myproject

Alternative

This recipe is still supported. However, you may wish to explore the silverstripe/silverstripe-search-service module which uses a search-as-a-service approach compatible with providers such as Elastic or Algolia.

More information

See the recipe plugin page for instructions on how Silverstripe recipes work.