Development environment for MediaWiki.
Shell PHP
Switch branches/tags
Nothing to show
Clone or download
addshore and tarrow Copy and chmod mysql configs for windows... (#59)
* Copy and chmod mysql configs for windows...
* set +x for mysql entrypoints
* Add comments to the mysql entrypoints
Latest commit fe8bcfb Aug 3, 2018

README.md

Instructions

Install

1) Install Docker & Docker Compose

https://docs.docker.com/compose/install/

Unix notes
  • You mostly want the docker-ce package not the docker package (please read the install instructions)
  • If you want to avoid logging in as root or sudo commands, you will have to add your user to the docker group: https://askubuntu.com/questions/477551/how-can-i-use-docker-without-sudo#477554
    • This does not mean your containers will not run as root. These are different settings not really used currently by this dev setup.

2) Clone this repository

git clone https://github.com/addshore/mediawiki-docker-dev.git

3) Clone MediaWiki Core & the Vector Skin (default skin)

You can start without the skin but you will find that your MediaWiki install doesn't look very nice.

From Wikimedia Gerrit:

git clone https://gerrit.wikimedia.org/r/mediawiki/core /srv/dev/git/gerrit/mediawiki
git clone https://gerrit.wikimedia.org/r/mediawiki/skins/Vector /srv/dev/git/gerrit/mediawiki/skins/Vector

(You can clone your code to somewhere other than /srv/dev/git/gerrit/mediawiki. For example, ~/src/mediawiki but you'll need to follow step 6 carefully.)

4) Run composer install for MediaWiki

Either on your host machine or with Docker, inside the /srv/dev/git/gerrit/mediawiki directory:

docker run -it --rm --user $(id -u):$(id -g) -v ~/.composer:/composer -v $(pwd):/app docker.io/composer install

5) Create a basic LocalSettings.php

The .docker/LocalSettings.php file will exist within the containers running Mediawiki.

Make a LocalSettings.php in the root of the Mediawiki repo containing the following:

<?php
require_once __DIR__ . '/.docker/LocalSettings.php';

When you come to change any MediaWiki settings this is the file you will want to be altering.

For example after install you will probably find you want to load the default skin:

wfLoadSkin( 'Vector' );

6) Configure the environment

Note: If you cloned mediawiki into a directory other than /srv/dev/git/gerrit/mediawiki you will need to do this step, otherwise the defaults can likely be used.

Copy the content of default.env from the mediawiki-docker-dev dir into a new file called local.env.

Alter any settings that you want to change, for example the install location of MediaWiki, a directory to a local composer cache, or webserver or php version.

7) Launch the environment

Create and start the Docker containers:

./up

Update your hosts file:

Add the following to your /etc/hosts file:

127.0.0.1 default.web.mw.localhost # mediawiki-docker-dev
127.0.0.1 proxy.mw.localhost # mediawiki-docker-dev
127.0.0.1 phpmyadmin.mw.localhost # mediawiki-docker-dev
127.0.0.1 graphite.mw.localhost # mediawiki-docker-dev

You can also use the ./hosts-sync script to try and update it automatically if possible. You may need to use sudo ./hosts-sync instead if the file is not writable by the shell user.

Commands

You can setup a small bash alias to make running the various commands much easier. An example is provided below:

alias mw-docker-dev='_(){ (cd /$GITPATH/github/addshore/mediawiki-docker-dev; ./$@) ;}; _'

Without such a bash alias you will have the run the scripts from within the mediawiki-docker-dev directory itself.

Up

Create and start containers.

This includes setting up a default wiki @ http://default.web.mw.localhost:8080 with an "admin" user that has password "adminpass".

You can choose the spec of the system that the up command will set up by using a custom .env file called local.env and customizing the variables.

mw-docker-dev up

Stop

Shuts down the containers. Databases and other volumes persist.

mw-docker-dev stop

Start

Start (or restart) the containers, if things have already been created using ./up.

mw-docker-dev start

Down

Stop and delete the containers. Also removes databases and volumes.

mw-docker-dev down

Bash

Run commands on the webserver.

If the containers are running you can use ./bash to open up an interactive shell on the webserver.

This can be used to run PHPUnit tests, maintenance scripts, etc.

mw-docker-dev bash

Add site

You can add a new site by subdomain name using the ./addsite command

mw-docker-dev addsite enwiki

Hosts file sync

Check whether the hosts file contains all needed entries, and if not, shows which entries need to be added, and also tries to add them automatically if possible.

mw-docker-dev hosts-sync

PHPUnit

mw-docker-dev phpunit-file default extensions/FileImporter/tests/phpunit

QUnit

To run the QUnit tests from the browser, use Special:JavaScriptTest.

See also https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing.

To run QUnit from the command-line, make sure you have Node.js v4 or later installed on the host, and set the following environment variables:

export MW_SERVER='http://default.web.mw.localhost:8080'
export MW_SCRIPT_PATH='/mediawiki'
$ cd ~/dev/mediawiki
$ npm install
$ npm run qunit

Access

Debugging

While using PHP you can use remote xdebug debugging.

To do so you need to set IDELOCALHOST in you local.env file to the IP of your local machine (where you run your IDE) as it appears to docker.

xdebug connections will then be sent to this IP address on port 9000.

TODO

  • FIX HHVM strict mode
    • Strict Warning: It is not safe to rely on the system's timezone settings. Please use the date.timezone setting, the TZ environment variable or the date_default_timezone_set() function.
  • Statsv endpoint
  • Setup awesome hosts file additions & removals