View source for Local development quickstart

<languages/>
{{InstallationNav}}
<translate><!--T:1--> This page is a '''quickstart''' guide to setting up a local development for MediaWiki using PHP and Composer.</translate>

{{note|1=<translate><!--T:2--> This workflow is only suitable for local development.</translate> <translate><!--T:3--> To serve a public website, see <tvar name=1>{{ll|Manual:Installation requirements}}</tvar>.</translate>}}
{{TOC|limit=2}}
<translate>
== Install prerequisites == <!--T:28-->
</translate>
<translate><!--T:40--> MediaWiki's master branch requires {{<tvar name=1>ll|Compatibility#PHP</tvar>|PHP 8.3.0+}} and Composer 2.</translate>
{{void|1=<translate><!--T:4--> MediaWiki requires PHP <tvar name=1>{{MW stable php requirement}}</tvar>+ and Composer 2.</translate>}}

{{TabbedWindowBegin}}

=== Linux ===

<translate>
<!--T:5-->
On Ubuntu <tvar name=1>24</tvar>+ or Debian <tvar name=2>13</tvar>+, install the required packages using [[w:APT (software)|APT]].
</translate>

<syntaxhighlight lang="bash" copy style="max-width: fit-content;">
sudo apt install php php-intl php-mbstring php-xml php-apcu php-curl php-sqlite3 composer
</syntaxhighlight>

<translate><!--T:7--> On Fedora <tvar name=1>40</tvar>+, install the required packages using [[w:DNF (software)|DNF]].</translate>

<syntaxhighlight lang="bash" copy style="max-width: fit-content;">
sudo dnf install php composer
</syntaxhighlight>

<translate><!--T:8--> On Arch Linux, install the required packages using [[w:pacman_(software)|pacman]].</translate>

<syntaxhighlight lang="bash" copy style="max-width: fit-content;">
sudo pacman -S php composer
</syntaxhighlight>

=== Mac ===
<translate>
<!--T:9-->
Install the required packages using [<tvar name=url>https://brew.sh/</tvar> Homebrew] and make it the active version of PHP, by linking it.
</translate>

<syntaxhighlight lang="bash" copy style="max-width: fit-content;">
brew install php@8.5 composer
brew link --overwrite php@8.5
</syntaxhighlight>

<translate><!--T:38--> If the following command succeeds, it should show the PHP version.</translate>
<translate><!--T:39--> If it fails, likely your <tvar name=1>$PATH</tvar> is not configured to find commands from brew.</translate>

<syntaxhighlight lang="bash" copy style="max-width: fit-content;">
php -v
</syntaxhighlight>

=== Windows ===
<translate><!--T:10--> You have the option to use the [<tvar name=url>https://learn.microsoft.com/en-us/windows/wsl/about</tvar> Windows Subsystem for Linux] and follow the Linux instructions on this page.</translate>
<translate><!--T:11--> Or, to install MediaWiki directly on Windows, install the required packages using [<tvar name=url>https://chocolatey.org/install</tvar> Chocolatey].</translate>

<syntaxhighlight lang="powershell" copy style="max-width: fit-content;">
choco install -y php composer
</syntaxhighlight>

<translate><!--T:12--> To load the required PHP extensions, edit your <tvar name=1>php.ini</tvar> file, and uncomment the following lines.</translate>
<translate><!--T:13--> To find the location of <tvar name=1>php.ini</tvar>, run <tvar name=2><code>php --ini</code></tvar>, and look for Loaded Configuration File.</translate>

<syntaxhighlight lang="ini">
extension=fileinfo
extension=intl
extension=pdo_sqlite
extension=zip
extension=sodium
</syntaxhighlight>

{{TabbedWindowEnd}}

<translate>
== Clone MediaWiki == <!--T:29-->

<!--T:14-->
Use [<tvar name=url>https://git-scm.com/book/en/v2/Getting-Started-Installing-Git</tvar> Git] to clone the MediaWiki core repository and the default skin.
</translate>

<syntaxhighlight lang="bash" copy style="max-width: fit-content;">
git clone https://gerrit.wikimedia.org/r/mediawiki/core.git mediawiki
</syntaxhighlight>
<syntaxhighlight lang="bash" copy style="max-width: fit-content;">
git clone https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git mediawiki/skins/Vector
</syntaxhighlight>
<syntaxhighlight lang="bash" copy style="max-width: fit-content;">
cd mediawiki
</syntaxhighlight>

<translate><!--T:15--> Cloning MediaWiki takes a few minutes.</translate>
<translate><!--T:16--> While you're waiting, if you plan to create and share patches, {{<tvar name=1>ll|Developer account</tvar>|create a Wikimedia developer account}} if you don't already have one.</translate>

<translate>
== Install dependencies == <!--T:30-->

<!--T:17-->
From within your <code>mediawiki</code> directory, created above, use Composer to install MediaWiki's dependencies.
</translate>

<syntaxhighlight lang="bash" copy style="max-width: fit-content;">
composer update
</syntaxhighlight>

<translate>
== Install MediaWiki == <!--T:31-->

<!--T:18-->
Install MediaWiki with PHP's built-in SQLite database.
</translate>

<syntaxhighlight lang="bash" copy style="max-width: fit-content;">
composer mw-install:sqlite
</syntaxhighlight>

<translate>
== Start server == <!--T:32-->
</translate>
<translate><!--T:20--> Start PHP's [<tvar name=url>https://php.net/features.commandline.webserver</tvar> built-in webserver], and open <tvar name=1>[http://localhost:4000/ localhost:4000]</tvar> in a browser to see your MediaWiki instance.</translate>
<translate><!--T:24--> To log in as an {{<tvar name=1>ll|Manual:Administrators</tvar>|administrator}}, use username <tvar name=2><code>Admin</code></tvar> and password <tvar name=3><code>adminpassword</code></tvar>.</translate>

<syntaxhighlight lang="bash" copy style="max-width: fit-content;">
composer serve
</syntaxhighlight>

<translate>
== Next steps == <!--T:19-->
</translate>
* {{ll|Manual:Code|2=<translate><!--T:33--> Take a tour of the MediaWiki codebase</translate>}} – <translate><!--T:21--> Familiarize yourself with MediaWiki's core code by learning about entry points and top-level directories.</translate>
* {{ll|Manual:PHP unit testing|2=<translate><!--T:34--> Run unit tests</translate>}} – <translate><!--T:22--> 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.</translate>
* {{ll|Manual:Extensions|2=<translate><!--T:35--> Install extensions</translate>}} – <translate><!--T:25--> Add extensions, like {{<tvar name=1>ll|Extension:VisualEditor</tvar>|VisualEditor}} and <tvar name=2>{{ll|Extension:Echo|Echo}}</tvar>, to your development environment.</translate> <translate><!--T:26--> See <tvar name=1>{{ll|Manual:Developing extensions}}</tvar> to learn about how extensions work.</translate>
* {{ll|Manual:How to debug|2=<translate><!--T:36--> Debug your code</translate>}} – <translate><!--T:23--> Learn how to configure debugging aids, and debug MediaWiki code step-by-step with XDebug.</translate>
* {{ll|Gerrit/Tutorial|2=<translate><!--T:37--> Submit a patch</translate>}} – <translate><!--T:27--> Explore <tvar name=1>{{ll|good first bugs}}</tvar>, and {{<tvar name=2>ll|Gerrit/Tutorial#Configure Git</tvar>|configure SSH access}} to Wikimedia Gerrit to submit a patch.</translate>

[[Category:Development environments{{#translation:}}]]