MediaWiki Docker Image

Based on MediaWiki release 1.27. Requires Docker version 1.11.2.

Installed extensions (34 in total):

• Cargo, v1.0.1
• CirrusSearch
• Cite
• CodeEditor
• Collection
• CustomParser
• DynamicPageList
• Echo
• Editcount
• Elastica
• Embed
• External Data
• Flow
• Gadgets
• InputBox
• Interwiki
• LookupUser
• MultimediaViewer
• MyVariables
• News
• ParserFunctions
• ParserHooks
• PdfHandler
• RandomSelection
• Renameuser
• ReplaceText
• Scribunto
• SemanticForms, v3.6
• SubPageList
• SyntaxHighlight_GeSHi, depends on Python
• UploadWizard
• VisualEditor
• Widgets
• WikiEditor

Other features:

• StringFunctions are enabled

Usage

The image is built and uploaded to Docker Hub, so there is no need to clone the repository.

Start a new wiki

Create a new directory and put a docker-compose.yml file with the following content:

version: '2'
services:
  elasticsearch:
    image: initiumlab/mediawiki-elasticsearch:1.7.5-1
    restart: always
    networks:
      mediawiki-internal:
        ipv4_address: 172.27.1.10
  mysql:
    image: mysql:5.7.12
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: password
      MYSQL_DATABASE: mediawiki
    networks:
      mediawiki-internal:
        ipv4_address: 172.27.1.11
  parsoid:
    image: initiumlab/mediawiki-parsoid:1.27-1
    restart: always
    networks:
      mediawiki-internal:
        ipv4_address: 172.27.1.3
    command: /app/bin/server.js -n2
  redis:
    image: redis:2.8.23
    restart: always
    networks:
      - ocg-internal
  ocg:
    image: initiumlab/mediawiki-ocg:1.27-2
    restart: always
    networks:
      ocg-internal:
      mediawiki-internal:
        ipv4_address: 172.27.1.4
  mediawiki:
    image: initiumlab/mediawiki:1.27-7
    restart: always
    ports:
      - 80:80
    environment:
      WG_SITENAME: MediaWiki
      WG_DBNAME: mediawiki 
      WG_SERVER: http://0.0.0.0
      WG_SECRET_KEY: 85de0708611f2c909ac888af8acb2ce8d59fef57ae8aa0605a5e53d4c7c09bc6 
      WG_UPGRADE_KEY: 833566970a042c1859d10b
    volumes:
      - ./data/images:/var/www/html/w/images
    networks:
      mediawiki-internal:
        ipv4_address: 172.27.1.2

networks:
  mediawiki-internal:
    driver: bridge
    ipam:
      driver: default
      config:
      - subnet: 172.27.1.0/24
        gateway: 172.27.1.1
  ocg-internal:
    driver: bridge

After that, run docker-compose up to start the services. When the startup is done, run docker-compose exec mediawiki bash to start a bash and execute the following commands:

$ cd /var/www/html/w
$ mv LocalSettings.php LocalSettings.php.shadow # disable settings so we can ask the installer to setup database
$ php maintenance/install.php --dbname mediawiki --dbserver mysql --dbuser root --dbpass password --server $WG_SERVER --pass password $WG_SITENAME Administrator
$ mv LocalSettings.php.shadow LocalSettings.php # enable extensions
$ php maintenance/update.php --quick
$ php /var/www/html/w/extensions/CirrusSearch/maintenance/updateSearchIndexConfig.php

Open http://0.0.0.0/ in your browser, and use the Administrator user with password password to login. The address 0.0.0.0 is the default container address in Docker for Mac, which you may need to change.

Restore a previous wiki

If you have a previous MediaWiki setup, follow the steps:

• put the database dump file at data/dump folder, make sure there is a CREATE DATABASE command in your dump file
• put the images folder from previous setup to data/images
• make sure the docker-compose.yml file has the correct database settings
• run upgrade.php
• run docker-compose up
• rebuild ElasticSearch index

Upgrade

If you want to use a newer version of images, pull the corresponding image and change image tag in docker-compose.yml. After that, restart the container:

$ docker-compose up -d --no-deps mediawiki

If database migration is needed, run the upgrade.php script:

$ docker-compose exec mediawiki php /var/www/html/w/maintenance/update.php

Database backup and restore

To dump the database, run:

$ docker-compose exec mysql sh -c 'exec mysqldump initium_wiki -B -uroot -p"password"' > dump.sql

To restore database from a MySQL dump file:

• run docker-compose rm mysql to delete existing database
• put the dump file at data/dump folder
• run docker-compose up, the database will be created

Rebuild ElasticSearch index

If your previous installation does not use ElasticSearch, you need to bootstrap the search index:

$ php /var/www/html/w/extensions/CirrusSearch/maintenance/forceSearchIndex.php --skipLinks --indexOnSkip
$ php /var/www/html/w/extensions/CirrusSearch/maintenance/forceSearchIndex.php --skipParse

Development

There are two methods to install new extensions:

• Git submodule: put the extension files in mediawiki/extensions folder and configure the extension in settings.d/42-extensions.php file.
• PHP Composer: add an entry to docker/mediawiki/composer.local.json.

If you want to build the image by yourself:

• clone this repo
• git submodule update --init.
  • For VisualEditor, you have to run cd mediawiki/extensions/VisualEditor && git submodule update --init.
  • For Widgets, you have to run cd mediawiki/extensions/Widgets && git submodule update --init.
• docker-compose build

Troubleshooting

OCG

To test if the bundler can reach the MediaWiki service and generate bundle file:

$ /app/mw-ocg-bundler/bin/mw-ocg-bundler --parsoid-api http://parsoid:8000 --php-api http://mediawiki/w --api-version parsoid3 -o bundle.zip -v -h mediawiki "Main Page"

To test if the latex renderer is able to render the generated bundle file:

/app/mw-ocg-latexer/bin/mw-ocg-latexer -l -D -o out.tex --lang ZH bundle.zip
TEXINPUTS=tex/: xelatex out.tex

If the MediaWiki server address is not accessible for OCG server, add a line to /app/mw-ocg-bundler/lib/metabook.js line 245:

metabook.wikis[0]['baseurl'] = "http://mediawiki/w";

License

MIT License