Extension:CirrusSearch

The CirrusSearch extension implements searching for MediaWiki using Elasticsearch.

See Help:CirrusSearch for documentation.

Project goals

 * No weird dependencies that make this difficult to install
 * The only dependencies should be pure-PHP MediaWiki extensions and Elasticsearch itself
 * Provide a near-real-time search index for wiki pages that's extendable by other MediaWiki extensions
 * Provide all of the query options MWSearch has given users, and more

Dependencies

 * PHP and cURL
 * In addition to the standard MediaWiki requirements for PHP, CirrusSearch requires PHP to be compiled with cURL support.
 * Elasticsearch
 * You will need to install Elasticsearch.


 * Elastica
 * Elastica is a PHP library to talk to Elasticsearch. Install Elastica per the instructions below.

Upgrading
Please follow the upgrade instructions in the CirrusSearch file.

Configuration
The configuration options of CirrusSearch are documented at the file, and also in the  file.

See also documentation on CirrusSearch configuration profiles.

Hooks
CirrusSearch extension defines a number of hooks that other extensions can make use of to extend the core schema and modify documents. The following hooks are available:


 * CirrusSearchAnalysisConfig - allows to hook into the configuration for analysis
 * CirrusSearchMappingConfig - allows configuration of the mapping of fields
 * CirrusSearchBuildDocumentParse - allows extensions to modify ElasticSearch document produced from a page
 * CirrusSearchBuildDocumentLinks - allows extensions to process incoming and outgoing links for the document
 * CirrusSearchBuildDocumentFinishBatch - called when a batch of pages has been indexed
 * CirrusSearchAddQueryFeatures - allows extensions to add query parser features
 * CirrusSearchScoreBuilder - allows extensions to define rescore builder functions

API
CirrusSearch features can be used in API queries. A few examples and queries:


 * Use the  special prefix to find pages related to Marie Curie and radium: api.php?action=query&list=search&srsearch=morelike:Marie_Curie%7Cradium&srlimit=10&srprop=size&formatversion=2


 * parameter: 2014?action=cirrusdump
 * parameter to Special:Search queries: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpQuery
 * parameter to Special:Search queries: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpResult
 * An additional parameter,, can be passed with   to have the lucene explanation of the the score included with the result dump: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpResult&cirrusExplain
 * , ,   modules to obtain dump from the CirrusSearch setup: api.php?action=cirrus-config-dump&formatversion=2