Wikibase/Suite

From mediawiki.org
Jump to navigation Jump to search
Other languages:
English • ‎日本語
Wikibase logo

Introduction[edit]

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 docker-compose command. 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.

Network configuration[edit]

Consult the network description and diagram: https://wikiba.se/maint

Before you dive in[edit]

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[edit]

MariaDB[edit]

Notes[edit]

Instructions[edit]

The MediaWiki install linked in the next step relies on a running RDBMS with a database and user already created.

We recommend using MariaDB, and though a full installation guide is outside of the scope of this document, start with this excellent collection of documentation and this tutorial.

MediaWiki[edit]

Notes[edit]

  • 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 fastcgi_pass HOST:9000.
  • You will need the following PHP extensions (install doc): calendar ctype dom fileinfo iconv intl json mysql mbstring xml

Instructions[edit]

Install instructions for MediaWiki

Working MediaWiki nginx config

Wikibase extension[edit]

Notes[edit]

The Wikibase data model is described in these documents:

Instructions[edit]

Installation guide for Wikibase

Installation guide for Composer

Optional sidebar[edit]

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.

Other extensions[edit]

OAuth[edit]

Wikibase needs the OAuth extension for the Wikidata query service, as you'll see below.

Installation[edit]

The OAuth install instructions are comprehensive. Note that you'll benefit from a working understanding of User rights to finish this install.

Wikidata Query Service[edit]

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.

Instructions[edit]

While intrepid users may wish to compile their own instance of WDQS, we recommend using the precompiled version.

Elasticsearch[edit]

Notes[edit]

Elasticsearch is a Lucene-based search engine. To get it working with MediaWiki/Wikibase, you'll need the following software:

Instructions[edit]

> $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
  • Modify elasticsearch.yml as needed:
    • Name your cluster with the cluster.name directive.
    • Make a single-node cluster: discovery.zen.minimum_master_nodes: 1
    • Set network.host as needed
  • Modify jvm.options as needed (above all, set -Xms and -Xmx based on the amount of memory available to your host)

QuickStatements[edit]

Notes[edit]

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.

Instructions[edit]

For more information, consult the Docker image README.

Reference[edit]