Local development quickstart

This page is a quickstart guide to setting up a local development for MediaWiki using PHP and Composer.

This workflow is only suitable for local development. To serve a public website, see Manual:Installation requirements .

1. Install prerequisites

MediaWiki requires PHP 7.4.3+ and Composer 2.

Linux

On Ubuntu 22+ or Debian 11+, install the required packages using APT.

sudo apt install -y php php-intl php-mbstring php-xml php-apcu php-curl php-sqlite3 composer

On Ubuntu 20, install PHP from APT, but install Composer from getcomposer.org/download.

sudo apt install -y php php-intl php-mbstring php-xml php-apcu php-curl php-sqlite3

On Fedora 35+, install the required packages using DNF.

sudo dnf install -y php composer

On Arch Linux, install the required packages using pacman.

sudo pacman -S php composer --noconfirm

Mac

Install the required packages using Homebrew.

brew install php composer

Windows

You have the option to use the Windows Subsystem for Linux and follow the Linux instructions on this page. Or, to install MediaWiki directly on Windows, install the required packages using Chocolatey.

choco install -y php composer

To load the required PHP extensions, edit your php.ini file, and uncomment the following lines. To find the location of php.ini, run php -i, and look for Loaded Configuration File.

extension:fileinfo
extension:intl
extension:pdo_sqlite
extension:zip

2. Clone MediaWiki

Use Git to clone the MediaWiki core repository and the default skin.

git clone https://gerrit.wikimedia.org/r/mediawiki/core.git mediawiki && git clone https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git mediawiki/skins/Vector && cd mediawiki

Cloning MediaWiki takes a few minutes. While you're waiting, create a Wikimedia developer account if you don't already have one.

3. Install dependencies

From within MediaWiki's root directory, use Composer to install MediaWiki's dependencies.

composer update

4. Install MediaWiki

Install MediaWiki with PHP's built-in SQLite database.

composer mw-install:sqlite

5. Start server

Start PHP's built-in webserver, and open localhost:4000 in a browser to see your MediaWiki instance. To log in as an administrator, use username Admin and password adminpassword.

composer serve

Next steps

• Take a tour of the MediaWiki codebase – Familiarize yourself with MediaWiki's core code by learning about entry points and top-level directories.
• Run unit tests – MediaWiki uses the PHPUnit framework for unit and integration testing of PHP code. Read the docs to run tests and find information about writing tests.
• Install extensions – Add extensions, like VisualEditor and Echo, to your development environment. See Manual:Developing extensions to learn about how extensions work.
• Debug your code – Learn how to configure debugging aids, and debug MediaWiki code step-by-step with XDebug.
• Submit a patch – Explore good first bugs, and configure SSH access to Wikimedia Gerrit to submit a patch.