extension implements searching for MediaWiki using Elasticsearch
This page is for installation. After the install is working, see Help:CirrusSearch
PHP and cURL
- MediaWiki 1.29.x - 1.30.x require Elasticsearch 5.3.x - 5.4.x.
- MediaWiki 1.31.x - 1.32.x require Elasticsearch 5.5.x - 5.6.x.
- MediaWiki 1.33.x - 1.37.x require Elasticsearch 6.5.x - 6.8.x (6.5.4 recommended)
Take note that a Java installation like OpenJDK
is needed in addition. It's best to use the official Elasticsearch Docker image or a self-hosted version. A managed product like Amazon OpenSearch (formerly Amazon Elasticsearch) can work but may require additional configuration depending on its specifics. For example, Amazon OpenSearch only listens for Elasticsearch API requests over HTTPS on port 443 (i.e. it does not expose the default Elasticsearch port 9200), so a TLS-enabled proxy (e.g. Nginx) can enable CirrusSearch to communicate with an Amazon OpenSearch cluster.
Elastica is a PHP library to talk to Elasticsearch. Install Elastica per the instructions below
Due to the actual handling of jobs by the CirrusSearch extension, it is advisable to set up jobs in Redis
to prevent messages like Notice: unserialize(): Error at offset 64870 of 65535 bytes in JobQueueDB.php
and subsequent errors like Unsupported operand types
. See task T157759
Even though the instructions below tell you to only run Composer when installing from git, it may be necessary to issue it anyway in order to install all PHP dependencies.
Please follow the upgrade instructions in the CirrusSearch UPGRADE
Elasticsearch will fail to index for CirrusSearch if one is using a database name for MySQL which contains a capital character, e.g. "MyWikiDatabaseName". To mitigate this CirrusSearch provides the $wgCirrusSearchIndexBaseName configuration parameter which one needs to set, e.g. $wgCirrusSearchIndexBaseName = 'mywikidatabasename';.
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:
Elastic Search service can be run with the Vagrant role (cirrussearch) and MediaWiki Vagrant.
For Docker, you can use a command like docker run -d --name elasticsearch -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" elasticsearch:6.8.2. Then follow the installation and configuration directions. If your web host is in a container you'll want to make sure the above container is on the same network, and in LocalSettings.php you will want to reference elasticsearch as the host name. This will not have the WMF plugins but can be sufficient for basic testing.
This extension is being used on one or more Wikimedia projects
. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php
configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version
Last edited on 6 October 2021, at 08:12
Content is available under CC BY-SA 3.0
unless otherwise noted.