wikibase/cirrussearch

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Extension for Wikibase to implement CirrusSearch functionality.

dev-master 2021-10-09 12:36 UTC

This package is not auto-updated.

Last update: 2021-10-11 23:30:06 UTC


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. 

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.