Skip to content

Latest commit

 

History

History
483 lines (352 loc) · 18.2 KB

README.md

File metadata and controls

483 lines (352 loc) · 18.2 KB
Raw

CircleCI

What is MediaWiki?

MediaWiki is an extremely powerful, scalable software and a feature-rich wiki implementation that uses PHP to process and display data stored in a database, such as MySQL.

Pages use MediaWiki's wikitext format, so that users without knowledge of XHTML or CSS can edit them easily.

https://www.mediawiki.org/

TL;DR;

Docker Compose

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-mediawiki/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Why use Bitnami Images?

  • Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
  • With Bitnami images the latest bug fixes and features are available as soon as possible.
  • Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
  • Bitnami images are built on CircleCI and automatically pushed to the Docker Hub.
  • All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution.
  • Bitnami container images are released daily with the latest distribution packages available.

Anchore Image Overview

The image overview badge contains a security report with all open CVEs. Click on 'Show only CVEs with fixes' to get the list of actionable security issues.

How to deploy MediaWiki in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami MediaWiki Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Supported tags and respective Dockerfile links

NOTE: Debian 8 images have been deprecated in favor of Debian 9 images. Bitnami will not longer publish new Docker images based on Debian 8.

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

Subscribe to project updates by watching the bitnami/mediawiki GitHub repo.

Prerequisites

To run this application you need Docker Engine 1.10.0. It is recommended that you use Docker Compose version 1.6.0 or later.

How to use this image

Run Mediawiki with a Database Container

Running Mediawiki with a database server is the recommended way. You can either use docker-compose or run the containers manually.

Run the application using Docker Compose

This is the recommended way to run Mediawiki. You can use the following docker compose template:

version: '2'
services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MARIADB_USER=bn_mediawiki
      - MARIADB_DATABASE=bitnami_mediawiki
    volumes:
      - 'mariadb_data:/bitnami'
  mediawiki:
    image: 'bitnami/mediawiki:1'
    labels:
      kompose.service.type: nodeport
    environment:
      - MARIADB_HOST=mariadb
      - MARIADB_PORT_NUMBER=3306
      - MEDIAWIKI_DATABASE_USER=bn_mediawiki
      - MEDIAWIKI_DATABASE_NAME=bitnami_mediawiki
      - ALLOW_EMPTY_PASSWORD=yes
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - 'mediawiki_data:/bitnami'
    depends_on:
      - mariadb
volumes:
  mariadb_data:
    driver: local
  mediawiki_data:
    driver: local

Run the application manually

If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:

  1. Create a new network for the application and the database:
$ docker network create mediawiki-tier
  1. Create a volume for MariaDB persistence and create a MariaDB container
$ docker volume create --name mariadb_data
$ docker run -d --name mariadb \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e MARIADB_USER=bn_mediawiki \
  -e MARIADB_DATABASE=bitnami_mediawiki \
  --net mediawiki-tier \
  --volume mariadb_data:/bitnami \
  bitnami/mariadb:latest

Note: You need to give the container a name in order for Mediawiki to resolve the host

  1. Create volumes for MediaWiki persistence and launch the container
$ docker volume create --name mediawiki_data
$ docker run -d --name mediawiki -p 80:80 -p 443:443 \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e MEDIAWIKI_DATABASE_USER=bn_mediawiki \
  -e MEDIAWIKI_DATABASE_NAME=bitnami_mediawiki \
  --net mediawiki-tier \
  --volume mediawiki_data:/bitnami \
  bitnami/mediawiki:latest

Then you can access your application at http://your-ip/

Persisting your application

If you remove the container all your data and configurations will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a volume at the /bitnami path. Additionally you should mount a volume for persistence of the MariaDB data.

The above examples define docker volumes namely mariadb_data and mediawiki_data. The MediaWiki application state will persist as long as these volumes are not removed.

To avoid inadvertent removal of these volumes you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.

Mount host directories as data volumes with Docker Compose

This requires a minor change to the docker-compose.yml template previously shown:

version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MARIADB_USER=bn_mediawiki
      - MARIADB_DATABASE=bitnami_mediawiki
    volumes:
      - '/path/to/mariadb-persistence:/bitnami'
  mediawiki:
    image: 'bitnami/mediawiki:latest'
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    environment:
      - MEDIAWIKI_DATABASE_USER=bn_mediawiki
      - MEDIAWIKI_DATABASE_NAME=bitnami_mediawiki
      - ALLOW_EMPTY_PASSWORD=yes
    volumes:
      - '/path/to/mediawiki-persistence:/bitnami'

Mount host directories as data volumes using the Docker command line

In this case you need to specify the directories to mount on the run command. The process is the same than the one previously shown:

  1. Create a network (if it does not exist):
$ docker network create mediawiki-tier
  1. Create a MariaDB container with host volume:
$ docker run -d --name mariadb \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e MARIADB_USER=bn_mediawiki \
  -e MARIADB_DATABASE=bitnami_mediawiki \
  --net mediawiki-tier \
  --volume /path/to/mariadb-persistence:/bitnami \
  bitnami/mariadb:latest

Note: You need to give the container a name in order to Mediawiki to resolve the host

  1. Run the Mediawiki container:
$ docker run -d --name mediawiki -p 80:80 -p 443:443 \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e MEDIAWIKI_DATABASE_USER=bn_mediawiki \
  -e MEDIAWIKI_DATABASE_NAME=bitnami_mediawiki \
  --net mediawiki-tier \
  --volume /path/to/mediawiki-persistence:/bitnami \
  bitnami/mediawiki:latest

Upgrade this application

Bitnami provides up-to-date versions of MariaDB and Mediawiki, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Mediawiki container. For the MariaDB upgrade see https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image

  1. Get the updated images:
$ docker pull bitnami/mediawiki:latest
  1. Stop your container
  • For docker-compose: $ docker-compose stop mediawiki
  • For manual execution: $ docker stop mediawiki
  1. Take a snapshot of the application state
$ rsync -a /path/to/mediawiki-persistence /path/to/mediawiki-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)

Additionally, snapshot the MariaDB data

You can use these snapshots to restore the application state should the upgrade fail.

  1. Remove the currently running container
  • For docker-compose: $ docker-compose rm -v mediawiki
  • For manual execution: $ docker rm -v mediawiki
  1. Run the new image
  • For docker-compose: $ docker-compose up mediawiki
  • For manual execution (mount the directories if needed): docker run --name mediawiki bitnami/mediawiki:latest

Configuration

Environment variables

When you start the mediawiki image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run command line. If you want to add a new environment variable:

  • For docker-compose add the variable name and value under the application section:
mediawiki:
  image: bitnami/mediawiki:latest
  ports:
    - 80:80
    - 443:443
  environment:
    - MEDIAWIKI_PASSWORD=my_password
  • For manual execution add a -e option with each variable and value:
$ docker run -d --name mediawiki -p 80:80 -p 443:443 \
  -e MEDIAWIKI_PASSWORD=my_password \
  --net mediawiki-tier \
  --volume /path/to/mediawiki-persistence:/bitnami \
  bitnami/mediawiki:latest

Available variables:

User and Site configuration
  • MEDIAWIKI_USERNAME: Mediawiki application username. Default: user
  • MEDIAWIKI_PASSWORD: Mediawiki application password. Default: bitnami1
  • MEDIAWIKI_EMAIL: Mediawiki application email. Default: [email protected]
  • MEDIAWIKI_WIKI_NAME: Mediawiki wiki name. Default: Bitnami MediaWiki
Use an existing database
  • MARIADB_HOST: Hostname for MariaDB server. Default: mariadb
  • MARIADB_PORT_NUMBER: Port used by MariaDB server. Default: 3306
  • MEDIAWIKI_DATABASE_NAME: Database name that MediaWiki will use to connect with the database. Default: bitnami_mediawiki
  • MEDIAWIKI_DATABASE_USER: Database user that MediaWiki will use to connect with the database. Default: bn_mediawiki
  • MEDIAWIKI_DATABASE_PASSWORD: Database password that MediaWiki will use to connect with the database. No defaults.
  • ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no
Create a database for MediaWiki using mysql-client
  • MARIADB_HOST: Hostname for MariaDB server. Default: mariadb
  • MARIADB_PORT_NUMBER: Port used by MariaDB server. Default: 3306
  • MARIADB_ROOT_USER: Database admin user. Default: root
  • MARIADB_ROOT_PASSWORD: Database password for the MARIADB_ROOT_USER user. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_NAME: New database to be created by the mysql client module. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_USER: New database user to be created by the mysql client module. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_PASSWORD: Database password for the MYSQL_CLIENT_CREATE_DATABASE_USER user. No defaults.
  • ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no
SMTP Configuration

To configure Mediawiki to send email using SMTP you can set the following environment variables:

  • SMTP_HOST: SMTP host.
  • SMTP_HOST_ID: SMTP host ID.
  • SMTP_PORT: SMTP port.
  • SMTP_USER: SMTP account user.
  • SMTP_PASSWORD: SMTP account password.

This would be an example of SMTP configuration using a GMail account:

  • docker-compose:
  mediawiki:
    image: bitnami/mediawiki:latest
    ports:
      - 80:80
      - 443:443
    environment:
      - MEDIAWIKI_DATABASE_USER=bn_mediawiki
      - MEDIAWIKI_DATABASE_NAME=bitnami_mediawiki
      - ALLOW_EMPTY_PASSWORD=yes
      - SMTP_HOST=ssl://smtp.gmail.com
      - SMTP_HOST_ID=mydomain.com
      - SMTP_PORT=465
      - [email protected]
      - SMTP_PASSWORD=your_password
  • For manual execution:
$ docker run -d --name mediawiki -p 80:80 -p 443:443 \
  -e MEDIAWIKI_DATABASE_USER=bn_mediawiki \
  -e MEDIAWIKI_DATABASE_NAME=bitnami_mediawiki \
  -e SMTP_HOST=ssl://smtp.gmail.com \
  -e SMTP_HOST_ID=mydomain.com \
  -e SMTP_PORT=465 \
  -e [email protected] \
  -e SMTP_PASSWORD=your_password \
  --net mediawiki-tier \
  --volume /path/to/mediawiki-persistence:/bitnami \
  bitnami/mediawiki:latest

How to install imagemagick in the Bitnami MediaWiki Docker image

If you require better quality thumbnails for your uploaded images, you may want to install imagemagick instead of using GD. To do so you can build your own docker image adding the imagemagick system package.

  1. Create the following Dockerfile
FROM bitnami/mediawiki:latest
RUN install_packages imagemagick
  1. Build the docker image
$ docker build -t bitnami/mediawiki:imagemagick .

  1. Edit the docker-compose.yml to use the docker image built in the previous step.

  2. Finally exec into your MediaWiki container and edit the file /opt/bitnami/mediawiki/LocalSettings.php as described here in order to start using imagemagick.

How to migrate from a Bitnami Mediawiki Stack

You can follow these steps in order to migrate it to this container:

  1. Export the data from your SOURCE installation: (assuming an installation in /opt/bitnami directory)
$ mysqldump -u root -p bitnami_mediawiki > ~/backup-mediawiki-database.sql
$ gzip -c ~/backup-mediawiki-database.sql > ~/backup-mediawiki-database.sql.gz
$ cd /opt/bitnami/apps/mediawiki/htdocs/
$ tar cfz ~/backup-mediawiki-extensions.tar.gz extensions
$ tar cfz ~/backup-mediawiki-images.tar.gz images
$ tar cfz ~/backup-mediawiki-skins.tar.gz skins
  1. Copy the backup files to your TARGET installation:
$ scp ~/backup-mediawiki-* YOUR_USERNAME@TARGET_HOST:~

  1. Create the Mediawiki Container as described in the section How to use this Image (Using Docker Compose)

  2. Wait for the initial setup to finish. You can follow it with

$ docker-compose logs -f mediawiki

and press Ctrl-C when you see this:

nami    INFO  mediawiki successfully initialized
Starting mediawiki ...
  1. Stop Apache:
$ docker-compose exec mediawiki nami stop apache
  1. Obtain the password used by Mediawiki to access the database in order avoid reconfiguring it:
$ docker-compose exec mediawiki bash -c 'cat /opt/bitnami/mediawiki/LocalSettings.php | grep wgDBpassword'
  1. Restore the database backup: (replace ROOT_PASSWORD below with your MariaDB root password)
$ cd ~
$ docker-compose exec mariadb mysql -u root -pROOT_PASSWORD
$ MariaDB [(none)]> drop database bitnami_mediawiki;
$ MariaDB [(none)]> create database bitnami_mediawiki;
$ MariaDB [(none)]> grant all privileges on bitnami_mediawiki.* to 'bn_mediawiki'@'%' identified by 'PASSWORD_OBTAINED_IN_STEP_6';
$ MariaDB [(none)]> exit
$ gunzip -c ./backup-mediawiki-database.sql.gz | docker exec -i $(docker-compose ps -q mariadb) mysql -u root bitnami_mediawiki -pROOT_PASSWORD
  1. Restore extensions/images/skins directories from backup:
$ cat ./backup-mediawiki-extensions.tar.gz | docker exec -i $(docker-compose ps -q mediawiki) bash -c 'cd /bitnami/mediawiki/ ; tar -xzvf -'
$ cat ./backup-mediawiki-images.tar.gz | docker exec -i $(docker-compose ps -q mediawiki) bash -c 'cd /bitnami/mediawiki/ ; tar -xzvf -'
$ cat ./backup-mediawiki-skins.tar.gz | docker exec -i $(docker-compose ps -q mediawiki) bash -c 'cd /bitnami/mediawiki/ ; tar -xzvf -'
  1. Fix Mediawiki directory permissions:
$ docker-compose exec mediawiki chown -R daemon:daemon /bitnami/mediawiki
  1. Restart Apache:
$ docker-compose exec mediawiki nami start apache

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:

  • Host OS and version
  • Docker version ($ docker version)
  • Output of $ docker info
  • Version of this container ($ echo $BITNAMI_IMAGE_VERSION inside the container)
  • The command you used to run the container, and any relevant output you saw (masking any sensitive information)

License

Copyright 2016-2018 Bitnami

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.