suilven/silverstripe-manticore-search

Search SilverStripe using Manticore


README

Build Status Scrutinizer Code Quality codecov.io

Latest Stable Version Latest Unstable Version Total Downloads License Monthly Downloads Daily Downloads composer.lock

GitHub Code Size GitHub Repo Size GitHub Last Commit GitHub Activity GitHub Issues

codecov.io

Search content in SilverStripe using manticoresearch as the free text search engine.

Install

PHP

Via Composer

$ composer require suilven/silverstripe-manticore-search

Manticore Search

Packages are available for multiple platforms, see https://manticoresearch.com/downloads/ - version 3.5 is required for compatibility with the ManticoreSearch PHP client.

Alternatively one can start an instance using docker:

docker run --name manticore -p 9306:9306 -p 9308:9308 -d manticoresearch/manticore

Note that does not include volume mapping in order to backup the indexed data.

Configuration

Indexing

See https://github.com/gordonbanderson/freetextsearch#configuration

Manticoresearch Specific

By default, manticore is expected to be found on 127.0.0.1 on port 9308. To override this, add a config file simiar to the following:

---
Name: manticore-my-host
After: manticore
---

Suilven\ManticoreSearch\Service\Client:
  host: 'manticoresearch-manticore'
  port: 19308

Usage

See https://github.com/gordonbanderson/freetextsearch#usage

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ vendor/bin/phpunit tests '' flush=1

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email gordon.b.anderson@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.