wikibase/cirrussearch

Extension for Wikibase to implement CirrusSearch functionality.

dev-master 2024-10-20 13:25 UTC

Requires

• composer/installers: >=1.0.1

Requires (Dev)

• mediawiki/mediawiki-codesniffer: 44.0.0
• mediawiki/mediawiki-phan-config: 0.14.0
• mediawiki/minus-x: 1.1.3
• php-coveralls/php-coveralls: ^2.0.0
• php-parallel-lint/php-console-highlighter: 1.0.0
• php-parallel-lint/php-parallel-lint: 1.4.0

GPL-2.0-or-later

• WMF Search Platform Team

• search
• elasticsearch
• wikibase
• wikidata
• cirrussearch

README

MediaWiki extension: WikibaseCirrusSearch
-----------------------------------------

This extension implements ElasticSearch-based search for Wikibase.

Dependencies
------------

This extension relies on Wikibase and CirrusSearch extensions to be installed and fully functional.
Please refer to documentation of these extensions for instructions on how to install them.

This extension relies on the wikimedia search-extra and search-highlighter plugins for elasticsearch
to be installed to the elasticsearch cluster. Please refer to documentation of the plugins for
instructions on how to install them:

https://mvnrepository.com/artifact/org.wikimedia.search/extra
https://mvnrepository.com/artifact/org.wikimedia.search.highlighter/experimental-highlighter-elasticsearch-plugin

Configurations
--------------

Please see the description of available configuration options in docs/config.wiki. All variables are stored in
globals with wgWBCS prefix, e.g. wgWBCSUseCirrus.

Development
-----------

The fastest way to get started with WikibaseCirrusSearch development is to use MediaWiki-Vagrant.
1.  Follow steps here: https://www.mediawiki.org/wiki/MediaWiki-Vagrant#Quick_start
2.  Now execute the following:
vagrant enable-role wikibasecirrussearch
vagrant provision

This can take some time but it produces a clean development environment in a virtual machine
that has everything required to run Cirrus.