Extension:CirrusSearch

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
CirrusSearch

Release status:Extension status stable

ImplementationTemplate:Extension#type Search, API, Hook
DescriptionTemplate:Extension#description Implements searching for MediaWiki using Elasticsearch
Author(s)Template:Extension#username Nik Everett, Chad Horohoe
Latest versionTemplate:Extension#version 0.2 (2014-10-09)
MediaWikiTemplate:Extension#mediawiki 1.23+
PHPTemplate:Extension#php 5.3+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
README
ParametersTemplate:Extension#parameters
  • $wgCirrusSearchServers
  • $wgCirrusSearchMaxRetries
  • $wgCirrusSearchSoftCommitTimeout
  • $wgCirrusSearchHardCommitTimeout
  • $wgCirrusSearchHardCommitMaxPendingDocs
  • $wgCirrusSearchCacheResultTime
  • $wgCirrusSearchCacheCleanupThread
  • $wgCirrusSearchFilterCacheSize
  • $wgCirrusSearchFilterCacheAutowarmCount
  • $wgCirrusSearchQueryResultCacheSize
  • $wgCirrusSearchQueryResultCacheAutowarmCount
  • $wgCirrusSearchDocumentCacheSize
  • many others
Hooks usedTemplate:Extension#hook
AfterImportPage
ApiBeforeMain
ArticleDelete
ArticleDeleteComplete
ArticleRevisionVisibilitySet
BeforeInitialize
GetBetaFeaturePreferences
LinksUpdateComplete
SearchGetNearMatch
SoftwareInfo
SpecialRandomGetRandomTitle
SpecialSearchResultsPrepend
TitleMove
TitleMoveComplete
UnitTestsList

Translate the CirrusSearch extension if it is available at translatewiki.net

Check usage and version matrix.

Issues:

Open tasks · Report a bug

The CirrusSearch extension implements searching for MediaWiki using Elasticsearch. See Help:CirrusSearch for documentation.

Project goals[edit]

  • 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[edit]

  • PHP
  • Elasticsearch
  • You will need to install Elasticsearch. Information on installing/maintaining Elasticsearch itself can be found at elastic.co. ElasticSearch 2.x is not supported. You will need to use 1.7. Support for 2.0 is underway and planned for mid-2016.

Installation[edit]

Elastica[edit]

  • Download and place the file(s) in a directory called Elastica in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/Elastica/Elastica.php";
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

CirrusSearch[edit]

  • Download and place the file(s) in a directory called CirrusSearch in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/CirrusSearch/CirrusSearch.php";
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Now follow the setup instructions in CirrusSearch's README.

Configuration[edit]

$wgCirrusSearchServers

Should be configured with the servers (names or IP addresses) running elasticsearch without providing the port. For example:

$wgCirrusSearchServers = array( 'search01', 'search02' );

Other configuration is available and is documented in the CirrusSearch.php file.

See also[edit]