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 38% complete.

Other languages:
English • ‎español • ‎русский • ‎فارسی • ‎ភាសាខ្មែរ • ‎中文 • ‎日本語
MediaWiki 拡張機能マニュアル
OOjs UI icon advanced.svg
CirrusSearch
リリースの状態: 安定
実装 Search, API, Hook
説明 Implements searching for MediaWiki using Elasticsearch
作者 Nik Everett, Chad Horohoe, Erik Bernhardson
最新バージョン 継続的な更新
互換性ポリシー master
MediaWiki 1.23+
PHP 5.4+
データベースの変更 いいえ
ライセンス GNU General Public License 2.0 or later
ダウンロード
README
パラメーター
  • $wgCirrusSearchServers
  • $wgCirrusSearchMaxRetries
  • $wgCirrusSearchSoftCommitTimeout
  • $wgCirrusSearchHardCommitTimeout
  • $wgCirrusSearchHardCommitMaxPendingDocs
  • $wgCirrusSearchCacheResultTime
  • $wgCirrusSearchCacheCleanupThread
  • $wgCirrusSearchFilterCacheSize
  • $wgCirrusSearchFilterCacheAutowarmCount
  • $wgCirrusSearchQueryResultCacheSize
  • $wgCirrusSearchQueryResultCacheAutowarmCount
  • $wgCirrusSearchDocumentCacheSize
  • many others
使用するフック
AfterImportPage
APIAfterExecute
ApiBeforeMain
ArticleDelete
ArticleDeleteComplete
ArticleRevisionVisibilitySet
BeforeInitialize
GetBetaFeaturePreferences
GetPreferences
LinksUpdateComplete
MediaWikiServices
ResourceLoaderGetConfigVars
ShowSearchHitTitle
SoftwareInfo
SpecialSearchResults
SpecialSearchResultsAppend
TitleMove
TitleMoveComplete
UnitTestsList
UserGetDefaultOptions
CirrusSearchBuildDocumentFinishBatch
CirrusSearchBuildDocumentLinks
translatewiki.net で翻訳を利用できる場合は、CirrusSearch 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
Vagrant role cirrussearch
問題点 未解決のタスク · バグを報告

The CirrusSearch extension implements searching for MediaWiki using Elasticsearch.

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

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
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 という名前のディレクトリ内に配置します。
  • 以下のコードを LocalSettings.php の末尾に追加します:
    wfLoadExtension( 'Elastica' );
    
  • In the downloaded files, open a command line and change to the subdirectory of the "Elastica" extension
  • Run composer install --no-dev
  • 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 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:

API

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

関連項目