Skip to content

Github mirror of MediaWiki extension WikibaseCirrusSearch - our actual code is hosted with Gerrit (please see https://www.mediawiki.org/wiki/Developer_access for contributing)

License

Notifications You must be signed in to change notification settings

wikimedia/mediawiki-extensions-WikibaseCirrusSearch

Repository files navigation

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.

About

Github mirror of MediaWiki extension WikibaseCirrusSearch - our actual code is hosted with Gerrit (please see https://www.mediawiki.org/wiki/Developer_access for contributing)

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published