mw dev

Build a local MediaWiki environment with Docker Compose, then add the services you need.

Getting startedCreate and install your first local wiki.MediaWikiWork with checkouts, extensions and maintenance commands.ServicesAdd databases, caches, debugging tools and more.Environment configurationInspect and change your environment settings.

Getting started

Install Docker with Compose and make sure docker info works. Create MediaWiki, add MySQL, then install the wiki:

mw dev mediawiki create
mw dev mysql create
mw dev mediawiki install --dbtype=mysql

The setup wizard lets you choose a checkout and local port. For a separate environment, use --context NAME.

Read the setup guide →

Working with services

Read the service workflow guide for the shared patterns.

Choose a service in the sidebar for its overview and commands. Many services share create, start, stop, logs and image configuration commands; each service's reference lists what it supports.

• MySQL and PostgreSQL for databases.
• Redis and Memcached for caching.
• Jaeger and MailHog for debugging.
• Traefik for gateway access and service URLs.

Managing your environment

Use stop and start to pause and resume containers, or compose to work directly with Docker Compose.

For repeatable setups, recipes apply a YAML definition of an environment.

All environment commands and options

Develop MediaWiki and supporting services using Docker Compose. Use --context NAME for a separate environment, or set CONTEXT in your shell. mw docker remains an alias for existing scripts.

Start with mw help guides dev setup. Read mw help guides dev contexts and mw help guides dev ports for environment configuration, or mw help guides dev services for workflows across services. Use --web on a guide command to read it on MediaWiki.org.

Environment

• mw dev compose — Interact directly with the docker compose environment
• mw dev destroy — Destroy all containers and data
• mw dev env — Interact with the environment variables
• mw dev restart — Restart local containers and stop temporary tunnel access
• mw dev start — Start containers that were running before
• mw dev stop — Stop all currently running containers
• mw dev update — Update running containers

Services

• mw dev adminer — adminer service
• mw dev citoid — citoid service
• mw dev custom — custom docker compose service sets
• mw dev elasticsearch — elasticsearch service
• mw dev eventlogging — eventlogging service
• mw dev grafana — grafana service
• mw dev graphite — graphite service
• mw dev jaeger — jaeger service
• mw dev keycloak — Keycloak service
• mw dev logs — logs service
• mw dev mailhog — mailhog service
• mw dev mediawiki — MediaWiki service
• mw dev memcached — memcached service
• mw dev mysql — mysql service
• mw dev mysql-replica — mysql-replica service
• mw dev novnc — novnc service
• mw dev opensearch — opensearch service
• mw dev phpmyadmin — phpmyadmin service
• mw dev postgres — postgres service
• mw dev prometheus — prometheus service
• mw dev redis — redis service
• mw dev shellbox — shellbox services
• mw dev traefik — traefik service
• mw dev wdqs — wdqs service
• mw dev wdqs-ui — wdqs-ui service

Other

• mw dev hosts — Interact with your system hosts file
• mw dev recipe — Apply a YAML recipe to set up a complete dev environment
• mw dev tunnel — Connect to the development environment through an optional tunnel
• mw dev where — Outputs the path of the working directory for the environment

Options

-c, --context <string>

Development context to use (overrides CONTEXT) Default: default.

Global options

--help

Help for this command

--no-interaction

Do not ask any interactive questions

-v, --verbose <count>

Increase output verbosity. Example: --verbose=2 or -vv

Examples

mw dev mediawiki create
mw dev mysql create
mw dev mediawiki install --dbtype=mysql

See also

• mw