A Wikibase install often consists of the following elements:
- An RDBMS (MariaDB/MySQL or SQLite) [required]
- MediaWiki [required]
- The Wikibase extension [required]
- Other related extensions [optional]
- The Wikidata query service (WDQS) [optional]
- The WDQS proxy
- The WDQS frontend
- QuickStatements [optional]
- Elasticsearch [optional]
The Docker install contains all these components and can be started with a single
This install meets the needs of many Wikibase users, especially those just starting out.
However, for those not wanting to run Docker (because of additional administrative overhead, scaling issues in production, or a desire to understand the components better), here's how to install each component manually.
Consult the network description and diagram: https://wikiba.se/maint
Before you dive in
There's a large amount of technical documentation to be read and enjoyed at the Wikibase technical doc site.
To successfully navigate this process, you should probably have:
- Familiarity with Linux and web server software
- One or more servers on which you have permissions to install software
Installing the Wikibase suite
- MediaWiki creates a database structure outlined in this document: MediaWiki database layout
- Wikibase's database schema is described here: Wikibase database schema
The MediaWiki install linked in the next step relies on a running RDBMS with a database and user already created.
- Note that while the vanilla install of MediaWiki (correctly) notes PostgreSQL as a working option, Wikibase does not work with PostgreSQL.
- For this install of MediaWiki, we recommend using nginx with php-fpm.
- This configuration assumes you have php-fpm running on the same host; to use a network port use
- You will need the following PHP extensions (install doc):
calendar ctype dom fileinfo iconv intl json mysql mbstring xml
The Wikibase data model is described in these documents:
If you'd like to add some Wikibase-related links to your main page sidebar, you can add these configuration stanzas to your LocalSettings.php.
Wikibase needs the OAuth extension for the Wikidata query service, as you'll see below.
Wikidata Query Service
The Wikidata Query Service (WDQS), which consists of the Blazegraph SPARQL query backend and its updater, can be and often is used in conjunction with Wikibase.
While intrepid users may wish to compile their own instance of WDQS, we recommend using the precompiled version.
- Download the desired version from [ https://archiva.wikimedia.org/repository/releases/org/wikidata/query/rdf/service Archiva].
- To configure the query service, consult both the Wikitech WDQS guide and the WDQS user manual.
Elasticsearch is a Lucene-based search engine. To get it working with MediaWiki/Wikibase, you'll need the following software:
- Three MediaWiki extensions:
- Two Elasticsearch plugins:
- Install Elasticsearch 6.5.4 (refer to its install instructions ).
- ES's install process will prompt you to install OpenJDK.
- Install the aforementioned extensions on your MediaWiki instance:
- Install the aforementioned Elasticsearch plugins using these commands:
> $PATH_TO_ELASTICSEARCH/bin/elasticsearch-plugin install org.wikimedia.search:extra:6.5.4 > $PATH_TO_ELASTICSEARCH/bin/elasticsearch-plugin install org.wikimedia.search.highlighter:experimental-highlighter-elasticsearch-plugin:6.5.4
jvm.optionsas needed (above all, set
-Xmxbased on the amount of memory available to your host)
Installation and use of this third-party import tool is not officially supported; it was originally made for Wikidata and, without some significant tweaking, only works in the Toolforge environment.
Consult the general QuickStatements help page.
- Download and install QuickStatements from GitHub.
- Make changes to config.json as needed. Lines to change include but are not limited to:
For more information, consult the Docker image README.