Wikibase/Installation
This page provides step-by-step instructions for installing a basic, minimal version of Wikibase. If you're interested in more advanced configurations, please refer to the advanced configuration guide. More detailed documentation bound to each version of the code can be found in the docs folder of the Wikibase source repository: see doc.wikimedia.org.
Prerequisites
MediaWiki
Since Wikibase is an extension (actually two extensions) to MediaWiki, you'll first need to set up MediaWiki.
Composer
The easiest way to install all dependencies for Wikibase is to use Composer. Install Composer using these instructions.
Installation
A basic installation of Wikibase consists of four steps:
The following guide will lead you through these steps.
Before you begin
Make sure you've set up MediaWiki and installed Composer.
Obtain Wikibase
Determine which version of MediaWiki you have by navigating to wiki/Special:Version
; use the Wikibase release corresponding to your MediaWiki version.
If you have the latest version of MediaWiki, download the latest version of Wikibase (or the version matching your MediaWiki installation) into the extensions
folder of your MediaWiki installation.
Install dependencies
Thanks to the composer-merge-plugin, you can simply rename the composer.local.json-sample
file in the root of your MediaWiki install directory to composer.local.json
.
Then, from the root of your MediaWiki installation, run:
rm composer.lock
Then, assuming composer is available as a binary:
composer install --no-dev
Modify LocalSettings.php
For repositories whose version numbers are 1.36+
If you intend to run a wiki where Wikibase entries are edited, then you want a Wikibase repository and should include the following in your 'LocalSettings.php'.
wfLoadExtension( 'WikibaseRepository', "$IP/extensions/Wikibase/extension-repo.json" );
require_once "$IP/extensions/Wikibase/repo/ExampleSettings.php";
For clients whose version numbers are 1.36+
If you intend to run a wiki which takes data from a different wiki instance where the entries are created, then you want a Wikibase client and should include the following in your 'LocalSettings.php'.
wfLoadExtension( 'WikibaseClient', "$IP/extensions/Wikibase/extension-client.json" );
require_once "$IP/extensions/Wikibase/client/ExampleSettings.php";
For repositories whose version numbers are 1.36 or lower
If you intend to run a wiki where Wikibase entries are edited, then you want a Wikibase repository and should include the following in your 'LocalSettings.php'.
$wgEnableWikibaseRepo = true;
require_once "$IP/extensions/Wikibase/repo/Wikibase.php";
require_once "$IP/extensions/Wikibase/repo/ExampleSettings.php";
For clients whose version numbers are 1.36 or lower
If you intend to run a wiki which takes data from a different wiki instance where the entries are created, then you want a Wikibase client and should include the following in your 'LocalSettings.php'.
$wgEnableWikibaseClient = true;
require_once "$IP/extensions/Wikibase/client/WikibaseClient.php";
require_once "$IP/extensions/Wikibase/client/ExampleSettings.php";
Run maintenance scripts
Finally, run some maintenance scripts -- among them the database update script and the scripts that populate the sites
table and the interwiki
table.
MediaWiki version: | ≥ 1.36 |
php maintenance/run.php ./maintenance/update.php
php maintenance/run.php ./extensions/Wikibase/lib/maintenance/populateSitesTable.php
php maintenance/run.php ./extensions/Wikibase/repo/maintenance/rebuildItemsPerSite.php
php maintenance/run.php ./maintenance/populateInterwiki.php
MediaWiki version: | ≤ 1.35 |
php maintenance/update.php
php extensions/Wikibase/lib/maintenance/populateSitesTable.php
php extensions/Wikibase/repo/maintenance/rebuildItemsPerSite.php
php maintenance/populateInterwiki.php
sites
table with Wikimedia's project list. See Manual:Sites table#Managing the sites table for how to list non-WMF projects.Verifying your installation
- Navigate to the
Special:NewItem
page in your MediaWiki and create your first Item. Enter a label and optional description and aliases and click Create. You should be redirected to the item page.
- Verify that an "Add links" link in the languagelinks section appears in the main page sidebar.