Skip to content

Latest commit

 

History

History
230 lines (156 loc) · 6.65 KB

DEVELOPERS.md

File metadata and controls

230 lines (156 loc) · 6.65 KB
Raw

MediaWiki Developers

Welcome to the MediaWiki community! Please see How to become a MediaWiki hacker for general information on contributing to MediaWiki.

Docker Developer Environment

MediaWiki provides an extendable local development environment based on Docker Compose.

The default environment provides PHP, Apache, XDebug and a SQLite database. (Do not run this stack in production! Bad things might happen!)

More documentation as well as example overrides and configuration recipes are available at mediawiki.org/wiki/MediaWiki-Docker.

Support is available on the Freenode IRC network at #mediawiki and on Wikimedia Phabricator at #MediaWiki-Docker.

Requirements

You'll need a locally running Docker and Docker Compose:

Linux users

Quickstart

Using a text editor, create a .env file in the root of the MediaWiki core repository, and copy these contents into that file:

MW_DOCKER_PORT=8080
MW_SCRIPT_PATH=/
MW_SERVER=http://localhost:8080
MEDIAWIKI_USER=Admin
MEDIAWIKI_PASSWORD=dockerpass
XDEBUG_CONFIG=''

Linux users

If you are on a Linux system, first create a

docker-compose.override.yml containing the following:

version: '3.7'
services:
  mediawiki:
    # On Linux, these lines ensure file ownership is set to your host user/group
    user: "${MW_DOCKER_UID}:${MW_DOCKER_GID}"

Run the following command to add your user ID and group ID to your .env file:

echo "MW_DOCKER_UID=$(id -u)
MW_DOCKER_GID=$(id -g)" >> .env

Start environment and install MediaWiki

Start the environment:

# -d is detached mode - runs containers in the background:
docker-compose up -d

Install Composer dependencies:

docker-compose exec mediawiki composer update

Install MediaWiki in the environment:

docker-compose exec mediawiki /bin/bash /docker/install.sh
Re-install

Remove or rename LocalSettings.php, delete the cache/sqlite directory, then re-run the installation command above. Copy over any changes from your previous LocalSettings.php and then run maintenance/update.php.

Usage

Running commands

You can use docker-compose exec mediawiki bash to open a bash shell in the MediaWiki container, or you can run commands in the container from your host, for example: docker-compose exec mediawiki php maintenance/update.php

Running tests

PHPUnit

Run all tests:

docker-compose exec mediawiki php tests/phpunit/phpunit.php

Run a single test:

docker-compose exec mediawiki php tests/phpunit/phpunit.php /path/to/test

See PHPUnit Testing on MediaWiki.org for more help.

Selenium

You can use Fresh to run Selenium in a dedicated container. Example usage:

export MW_SERVER=http://localhost:8080
export MW_SCRIPT_PATH=/
export MEDIAWIKI_USER=Admin
export MEDIAWIKI_PASSWORD=dockerpass
fresh-node -env -net
npm ci
npm run selenium

API Testing

You can use Fresh to run API tests in a dedicated container. Example usage:

export MW_SERVER=http://localhost:8080/
export MW_SCRIPT_PATH=/
export MEDIAWIKI_USER=Admin
export MEDIAWIKI_PASSWORD=dockerpass
fresh-node -env -net
# Create .api-testing.config.json as documented on
# https://www.mediawiki.org/wiki/MediaWiki_API_integration_tests
npm ci
npm run api-testing

Modifying the development environment

You can override the default services with a docker-compose.override.yml file, and configure those overrides with changes to LocalSettings.php.

Example overrides and configurations can be found at MediaWiki-Docker

After updating docker-compose.override.yml, run docker-compose down followed by docker-compose up -d for changes to take effect.

Installing extra packages

If you need root on the container to install packages for troubleshooting, you can open a shell as root with docker-compose exec --user root mediawiki bash.

Use Vector skin

Clone the skin to skins/Vector:

git clone "https://gerrit.wikimedia.org/r/mediawiki/skins/Vector" skins/Vector

Configure MediaWiki to use the skin:

echo "wfLoadSkin( 'Vector' );" >> LocalSettings.php

XDebug

You can override the XDebug configuration included with the default image by passing XDEBUG_CONFIG={your config} in the .env file at the root of the MediaWiki repository:

XDEBUG_CONFIG=remote_enable=1 remote_host=172.17.0.1 remote_log=/tmp/xdebug.log remote_port=9009
Troubleshooting
Port conflicts

If you installed php-fpm on your host, that is listening on port 9000 and will conflict with XDebug. The workaround is to tell your IDE to listen on a different port (e.g. 9009) and to set the configuration in your .env file: XDEBUG_CONFIG=remote_port=9009

Linux desktop, host not found

The image uses host.docker.internal as the remote_host value which should work for Docker for Mac/Windows. On Linux hosts, you need to specify the hostname or IP address of your host. The IP address works more reliably. You can obtain it by running e.g. ip -4 addr show docker0 and copying the IP address into the config, like XDEBUG_CONFIG=remote_host=172.17.0.1

Generating logs

Switching on the remote log for XDebug comes at a performance cost so only use it while troubleshooting. You can enable it like so: XDEBUG_CONFIG=remote_log=/tmp/xdebug.log