Phabricator のプロジェクト名 #cirrussearch

Extension:CirrusSearch

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:CirrusSearch and the translation is 100% complete.

Other languages:
English • ‎español • ‎русский • ‎فارسی • ‎ភាសាខ្មែរ • ‎中文 • ‎日本語
MediaWiki 拡張機能マニュアル
OOjs UI icon advanced.svg
CirrusSearch
リリースの状態: 安定
実装 検索, API , フック
説明 Elasticsearch を使った MediaWiki 検索の実装
作者 Nik Everett, Chad Horohoe, Erik Bernhardson
最新バージョン 継続的な更新
互換性ポリシー master
MediaWiki 1.23+
PHP 5.4+
データベースの変更 いいえ
ライセンス GNU 一般公衆利用許諾書 2.0 以降
ダウンロード
README
  • $wgCirrusSearchServers
  • $wgCirrusSearchMaxRetries
  • $wgCirrusSearchSoftCommitTimeout
  • $wgCirrusSearchHardCommitTimeout
  • $wgCirrusSearchHardCommitMaxPendingDocs
  • $wgCirrusSearchCacheResultTime
  • $wgCirrusSearchCacheCleanupThread
  • $wgCirrusSearchFilterCacheSize
  • $wgCirrusSearchFilterCacheAutowarmCount
  • $wgCirrusSearchQueryResultCacheSize
  • $wgCirrusSearchQueryResultCacheAutowarmCount
  • $wgCirrusSearchDocumentCacheSize
  • many others
translatewiki.net で翻訳を利用できる場合は、CirrusSearch 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
Vagrant role cirrussearch
問題点 未解決のタスク · バグを報告

CirrusSearch 拡張機能はElasticsearchを使った MediaWiki 検索を実装します。

説明文書は Help:CirrusSearch を参照してください。

プロジェクトの目標

  • 奇妙な依存関係がなくてもインストールが簡単にできること
    • 唯一の依存関係は pure-PHP MediaWiki 拡張機能と Elasticsearch だけ
  • 他の MediaWiki 拡張機能で拡張できるウィキページについて、ほぼリアルタイムに検索インデックスを返す
  • MWSearch が利用者に開放したクエリオプションすべてと、その他を提供

依存関係

PHP and cURL
Elasticsearch
  • 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
  • Elastica is a PHP library to talk to Elasticsearch. Install Elastica per the instructions below.

Installation

Elastica

  • ダウンロードして、ファイルを extensions/ フォルダー内の Elastica という名前のディレクトリ内に配置します。
  • git からのインストールの場合のみ、PHP の依存関係をインストールするため Composer を実行します。拡張機能のディレクトリで composer install --no-dev を実行します。 (See T173141 for potential complications.)
  • 以下のコードを LocalSettings.php の末尾に追加します:
    wfLoadExtension( 'Elastica' );
    
  • Yes 完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

MediaWiki 1.24 以前を稼働させている利用者へ:

上記の手順では、wfLoadExtension() を使用してこの拡張機能をインストールする新しい方法を記載しています。 この拡張機能をこれらの過去のバージョン (MediaWiki 1.24 以前) にインストールする必要がある場合は、wfLoadExtension( 'Elastica' ); の代わりに以下を使用する必要があります:

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

CirrusSearch

  • ダウンロードして、ファイルを extensions/ フォルダー内の CirrusSearch という名前のディレクトリ内に配置します。
  • 以下のコードを 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.
  • Yes 完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

Upgrading

Please follow the upgrade instructions in the CirrusSearch UPGRADE file.

Configuration

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 拡張機能が規定するフックは他の拡張機能でも利用でき、それぞれのコアのスキーマ拡張と説明文書の変更に使えます。 使用できるフックは次の通りです。

API

CirrusSearch の機能は API クエリで使用可能です。 サンプルとクエリの例を紹介します。

関連項目