User:Tobias Gritschacher (WMDE)/Wikibase/Installation

This page provides a step-by-step instruction how to install a basic version of Wikibase. It just explains the minimal configuration needed for Wikibase. If you're interested in a more advanced configuration, please refer to the advanced configuration guide.

=Prerequisites=

MediaWiki
Technically, Wikibase is an extension (actually two extensions) to MediaWiki, so you need to set up MediaWiki first.

Composer
The easiest way to install all all dependencies of Wikibase is using Composer. Here you can find installation instructions for Composer.

=Installation= A basic installation of Wikibase is pretty much straight forward and basically consists of 4 steps: The following guide will lead you through these steps.
 * 1) getting Wikibase
 * 2) fetching dependencies
 * 3) modifying LocalSettings.php
 * 4) running some maintenance scripts.

Meet the prerequisites
Make sure you've set up MediaWiki and installed Composer.

Get Wikibase
Download Wikibase into the extensions folder of your MediaWiki installation. There are several ways to download Wikibase.

Download from Git

 * For getting the latest version of Wikibase, do:
 * For getting a specific version of Wikibase you have to specify the branch you want to download:

Download archive

 * Instead of using Git you can alternatively download an archive with the latest version of Wikibase or choose to download a specific version of Wikibase.
 * Make sure you extract the archive into a new folder inside the extensions folder of your MediaWiki installation.

Fetch all dependencies
or depending on how Composer was installed on your machine.
 * cd into Wikibase inside the extensions folder of your MediaWiki installation:
 * If you've set up Composer correctly, you should be able to fetch all dependencies by running

Adjust your LocalSettings.php
Add the following lines to LocalSettings.php of your MediaWiki installation. You have three options, depending on whether you want to enable Wikibase Repository, Wikibase Client or both of them.

Run the setup scripts
Finally, you have to run some maintenance scripts.

For Wikibase Repository and Wikibase Client

 * Run the database update script of your MediaWiki installation:


 * Run the script that populates the sites table:

For Wikibase Client only

 * If you want to run a Wikibase Client, you'll also need to run the script that populates the interwiki table:

Wikibase Repository
To verify your Wikibase Repository installation, in your MediaWiki go to Special:NewItem and you should be able to create your first Item. Enter a label and optional description and aliases and hit Create. You should be redirected to the item page.

Wikibase Client
If you've enabled Wikibase Client and everything is correct, you should see an "Add links" link in the languagelinks section in the sidebar of the main page.

= For developers = An easy way so set up a developer environment for Wikibase, is to use the wikibase_repo role in MediaWiki-Vagrant. It sets up a plain Wikibase repo installation including all dependent components. It provides a quick way to get ready for hacking on Wikibase code. Sources of the Wikibase extension can be found under  and sources of dependent components are under.