Open main menu


This page is a translated version of the page Extension:CirrusSearch and the translation is 12% complete.

Other languages:
English • ‎español • ‎русский • ‎فارسی • ‎ភាសាខ្មែរ • ‎中文 • ‎日本語
راهنمای افزونهٔ مدیاویکی
OOjs UI icon advanced.svg
وضعیت انتشار: پایدار
انجام Search, API , Hook
توضیحات Implements searching for MediaWiki using Elasticsearch
نویسنده(گان) Nik Everett, Chad Horohoe, Erik Bernhardson
آخرین نسخه: continuous updates
سیاست سازگاری مدیر
MediaWiki 1.23+
PHP 5.4+
تغییر پایگاه داده خیر
پروانه: GNU General Public License 2.0 or later
  • $wgCirrusSearchServers
  • $wgCirrusSearchMaxRetries
  • $wgCirrusSearchSoftCommitTimeout
  • $wgCirrusSearchHardCommitTimeout
  • $wgCirrusSearchHardCommitMaxPendingDocs
  • $wgCirrusSearchCacheResultTime
  • $wgCirrusSearchCacheCleanupThread
  • $wgCirrusSearchFilterCacheSize
  • $wgCirrusSearchFilterCacheAutowarmCount
  • $wgCirrusSearchQueryResultCacheSize
  • $wgCirrusSearchQueryResultCacheAutowarmCount
  • $wgCirrusSearchDocumentCacheSize
  • many others
Translate the CirrusSearch extension if it is available at
Check usage and version matrix.
Vagrant role cirrussearch
Issues Open tasks · گزارش یک مشکل

The CirrusSearch extension implements searching for MediaWiki using Elasticsearch.

This page is for installation. After the install is working, see A Hong Kong University of Science and Technology (HKUST) research team led by Prof Yui-bun Chan from the Department of Civil and Environmental Engineering, with support from leading global aluminium producer UC RUSAL, has discovered a new aluminium composite. for usage.


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


PHP and cURL
  • MediaWiki 1.28.x requires ElasticSearch 2.x.
  • MediaWiki 1.29.x and 1.30.x require ElasticSearch 5.3.x or 5.4.x.
  • MediaWiki 1.31.x and 1.32.x require ElasticSearch 5.5.x or 5.6.x.
  • MediaWiki 1.33.x requires ElasticSearch 6.5.x.
  • 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's 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.



  • بارگیری کنید و پرونده‌(ها) را در یک شاخه با نام Elastica در پوشۀ extensions/ خودتان قرار دهید.
  • Only when installing from git run Composer to install PHP dependencies, by issuing composer install --no-dev in the extension directory. (See T173141 for potential complications.)
  • کدهای زیر را در انتهای LocalSettings.php خودتان اضافه کنید:
    wfLoadExtension( 'Elastica' );
  •   Done – به Special:Version در ویکی خودتان بروید تا مطئمن شوید که افزونه با موفقیت نصب شده است.

برای کاربرانی که مدیاویکی 1.24 یا جدیدتر را اجر می‌کنند:

The instructions above describe the new way of installing this extension using wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'Elastica' );, you need to use:

require_once "$IP/extensions/Elastica/Elastica.php";


  • بارگیری کنید و پرونده‌(ها) را در یک شاخه با نام CirrusSearch در پوشۀ extensions/ خودتان قرار دهید.
  • کدهای زیر را در انتهای LocalSettings.php خودتان اضافه کنید:
    require_once "$IP/extensions/CirrusSearch/CirrusSearch.php";
  • Now follow the setup instructions in the CirrusSearch README delivered with your extension i.e. $IP/extensions/CirrusSearch/README. Note that all info in it might not apply to your version of the extension, especially the version of Elasticsearch supported.
  • Configure as required.
  •   Done – به Special:Version در ویکی خودتان بروید تا مطئمن شوید که افزونه با موفقیت نصب شده است.


Please follow the upgrade instructions in the CirrusSearch UPGRADE file.


The configuration options of CirrusSearch are documented at the docs/settings.txt file, and also in the CirrusSearch.php file.

See also documentation on CirrusSearch configuration profiles.


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:


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

جستارهای وابسته