Pymediawikidocker

From BITPlan Wiki
Jump to navigation Jump to search

OsProject

OsProject
edit
id  pymediawikidocker
state  active
owner  WolfgangFahl
title  pymediawikidocker
url  https://github.com/WolfgangFahl/pymediawikidocker
version  0.12.0
description  Python controlled mediawiki docker image installation
date  2024-04-16
since  2021-06-08
until  

tickets

Motivation

Official Mediawiki docker images are available for the different Mediawiki versions.

These images need additional infrastructure to create useable Mediawiki environments.

docker run --name local-mediawiki -p 8080:80 -d mediawiki

will only install part of a LAMP environment to install Mediawiki and make it available via http://localhost:8080/. E.g. the database needs to be installed separately.

The goal of this project is to semi-automatically create such environments and test the functionality. Python was choosen as a development environment for the libraries that are needed and available to perform the tasks:

python on whales was chosen over:

Since it works on the command line interface and not via the SDK and supports docker compose.

How it works

The core concept is a "MediawikiCluster" that is a set of docker applications that run MediaWiki instances with varying versions of MediaWiki and the underlying database. The graphic belows shows the docker containers which are created for different versions of Mediawiki

Installation

Prerequisites

Docker on Windows, Mac or Linux suppporting "docker compose up" using the Docker composer V2 CLI

Ubuntu 22.04 LTS installation

see https://docs.docker.com/engine/install/ubuntu/ on how to setup the docker repositorysudo

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin
docker --version
Docker version 23.0.2, build 569dd73
docker run hello-world
Hello from Docker!
This message shows that your installation appears to be working correctly.

...

Compatibility test

# test on a Mac OS machine 2022-07-02
docker 2>&1 | grep compose
  compose*    Docker Compose (Docker Inc., v2.4.1)
# test on an Ubuntu machine 2023-04-07
docker 2>&1 | grep compose
 compose*    Docker Compose (Docker Inc., v2.17.2)

Installation of Docker Compose V2 CLI

lsb_release -a
No LSB modules are available.
Distributor ID:	Ubuntu
Description:	Ubuntu 22.04.e LTS
Release:	22.04
Codename:	jammy

docker-ce from docker repo

# Update existing list of packages
sudo apt update

# Install prerequisite packages which let apt use packages over HTTPS
sudo apt install apt-transport-https ca-certificates curl software-properties-common

# Add Docker’s official GPG key
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

# Add Docker repository to APT sources
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"

# Update the package database with Docker packages from the newly added repo
sudo apt update

# Make sure you are about to install from the Docker repo instead of the default Ubuntu repo
apt-cache policy docker-ce

# Install Docker CE
sudo apt install docker-ce

docker compose (not docker-compose)

docker compose version
Docker Compose version v2.26.1
sudo apt  install docker-compose
docker-compose version
docker-compose version 1.29.2, build unknown
docker-py version: 5.0.3
CPython version: 3.10.12
OpenSSL version: OpenSSL 3.0.2 15 Mar 2022
which docker-compose
/usr/bin/docker-compose

pymediawikidocker installation via pip

pip install pymediawikidocker
# alternatively if your pip is not a python3 pip
pip3 install pymediawikidocker

upgrade

pip install pymediawikidocker -U
# alternatively if your pip is not a python3 pip
pip3 install pymediawikidocker -U

check version

mwcluster -V
mwcluster (v0.11.1,2024-04-15)

Usage

mwcluster -h
usage: mwcluster [-h] [-cn CONTAINER_NAME] [-d] [-el [EXTENSIONNAMELIST ...]]
                 [-ej EXTENSIONJSONFILE] [-f] [-fu] [--host HOST]
                 [-dp DOCKER_PATH] [--logo LOGO] [-mv MARIADBVERSION]
                 [--mysqlPassword MYSQLPASSWORD] [-rp] [-p PASSWORD]
                 [-pl PASSWORD_LENGTH] [--prefix PREFIX] [--prot PROT]
                 [--script_path SCRIPT_PATH] [--url URL] [-sp SQL_PORT]
                 [-smw SMW_VERSION] [-u USER] [-q] [-bp BASE_PORT]
                 [-vl [VERSIONS ...]] [--about] [--create] [--down] [--check]
                 [--list] [-V]

Copyright 2020-2023 contributors. All rights reserved. Licensed under the
Apache License 2.0 http://www.apache.org/licenses/LICENSE-2.0 Distributed on
an "AS IS" basis without warranties or conditions of any kind, either express
or implied.

options:
  -h, --help            show this help message and exit
  -cn CONTAINER_NAME, --container_name CONTAINER_NAME
                        set container name (only valid and recommended for
                        single version call) (default: mw-139)
  -d, --debug           enable debug mode [default: False]
  -el [EXTENSIONNAMELIST ...], --extensionList [EXTENSIONNAMELIST ...]
                        list of extensions to be installed [default: ['Admin
                        Links', 'Header Tabs', 'SyntaxHighlight',
                        'Variables']]
  -ej EXTENSIONJSONFILE, --extensionJson EXTENSIONJSONFILE
                        additional extension descriptions default: [default:
                        None]
  -f, --forceRebuild    force rebuilding [default: False]
  -fu, --force_user     force overwrite of wikiuser (default: False)
  --host HOST           the host to serve / listen from [default:
                        fix.bitplan.com]
  -dp DOCKER_PATH, --docker_path DOCKER_PATH
                        the base directory to store docker and jinja template
                        files [default: /Users/wf/.pymediawikidocker]
  --logo LOGO           set Logo [default:
                        $wgResourceBasePath/resources/assets/wiki.png]
  -mv MARIADBVERSION, --mariaDBVersion MARIADBVERSION
                        mariaDB Version to be installed [default: 10.11]
  --mysqlPassword MYSQLPASSWORD
                        set sqlRootPassword [default: None] - random password
                        if None
  -rp, --random_password
                        create random password and create wikiuser while at it
                        (default: False)
  -p PASSWORD, --password PASSWORD
                        set password for initial user [default: sysop-1234!]
  -pl PASSWORD_LENGTH, --password_length PASSWORD_LENGTH
                        set the password length for random passwords[default:
                        15]
  --prefix PREFIX       the container name prefix to use [default: mw]
  --prot PROT           change to https in case [default: http]
  --script_path SCRIPT_PATH
                        change to any script_path you might need to set
                        [default: ]
  --url URL             will set prot host,script_path, and optionally port
                        based on the url given [default: None]
  -sp SQL_PORT, --sql_base_port SQL_PORT
                        set base mySql port 3306 to be exposed - incrementing
                        by one for each version [default: 9306]
  -smw SMW_VERSION, --smw_version SMW_VERSION
                        set SemanticMediaWiki Version to be installed default
                        is None - no installation of SMW (default: None)
  -u USER, --user USER  set username of initial user with sysop rights
                        [default: Sysop]
  -q, --quiet           not verbose [default: False]
  -bp BASE_PORT, --base_port BASE_PORT
                        set how base html port 80 to be exposed - incrementing
                        by one for each version [default: 9080]
  -vl [VERSIONS ...], --version_list [VERSIONS ...]
                        mediawiki versions to create docker applications for
                        [default: ['1.35.13', '1.38.6', '1.39.7', '1.40.3',
                        '1.41.1']]
  --about               show about info [default: False]
  --create              create wikis [default: False]
  --down                shutdown wikis [default: False]
  --check               check the wikis [default: False]
  --list                list the wikis [default: False]
  -V, --version         show program's version number and exit

Examples

Pymediawikidocker_example_2022-10-26

create with default settings

Starts a cluster with versions 1.35.13,1.38.6 and 1.39.7, 1.40,3 and 1.14.1 using MariaDB 10.11. Essentially this is automatic generation of the configuration with a docker compose up for all versions asked for.

mwcluster --create -f
creating docker compose applications for mediawiki versions ['1.35.13', '1.38.6', '1.39.7', '1.40.3', '1.41.1']
...
Initializing MediaWiki SQL tables
Executing docker command /root/installExtensions.sh
Executing docker command /root/initdb.sh
Executing docker command /root/update.sh
Executing docker command /root/addSysopUser.sh
Executing docker command /root/addCronTabEntry.sh
...

Mediawiki applications will be available at

http://localhost:9080 http://localhost:9080/index.php/Special:Version

http://localhost:9081 http://localhost:9081/index.php/Special:Version

http://localhost:9082 http://localhost:9082/index.php/Special:Version

http://localhost:9083 http://localhost:9083/index.php/Special:Version

http://localhost:9084 http://localhost:9084/index.php/Special:Version

check

mwcluster --check -f  
checking docker access for mediawiki versions ['1.35.13', '1.38.6', '1.39.7', '1.40.3', '1.41.1']
1:checking 1.35.13 ...
mediawiki webserver container mw-135-mw:✅
mediawiki database container mw-135-db:✅
port binding 9080= expected  port 9080?:✅
Checking http://fur.bitplan.com:9080/index.php/Special:Version ...
Special Version accessible ...:✅
Mediawiki Version 1.35.13= expected  1.35.13?:✅
Maria DB Version 10.11 fitting expected 10.11?:✅
2:checking 1.38.6 ...
mediawiki webserver container mw-138-mw:✅
mediawiki database container mw-138-db:✅
port binding 9081= expected  port 9081?:✅
Checking http://fur.bitplan.com:9081/index.php/Special:Version ...
Special Version accessible ...:✅
Mediawiki Version 1.38.6= expected  1.38.6?:✅
Maria DB Version 10.11 fitting expected 10.11?:✅
3:checking 1.39.7 ...
mediawiki webserver container mw-139-mw:✅
mediawiki database container mw-139-db:✅
port binding 9082= expected  port 9082?:✅
Checking http://fur.bitplan.com:9082/index.php/Special:Version ...
Special Version accessible ...:✅
Mediawiki Version 1.39.7= expected  1.39.7?:✅
Maria DB Version 10.11 fitting expected 10.11?:✅
4:checking 1.40.3 ...
mediawiki webserver container mw-140-mw:✅
mediawiki database container mw-140-db:✅
port binding 9083= expected  port 9083?:✅
Checking http://fur.bitplan.com:9083/index.php/Special:Version ...
Special Version accessible ...:✅
Mediawiki Version 1.40.3= expected  1.40.3?:✅
Maria DB Version 10.11 fitting expected 10.11?:✅
5:checking 1.41.1 ...
mediawiki webserver container mw-141-mw:✅
mediawiki database container mw-141-db:✅
port binding 9084= expected  port 9084?:✅
Checking http://fur.bitplan.com:9084/index.php/Special:Version ...
Special Version accessible ...:✅
Mediawiki Version 1.41.1= expected  1.41.1?:✅
Maria DB Version 10.11 fitting expected 10.11?:✅

down

mwcluster --down -f
running docker compose down for mediawiki versions ['1.35.13', '1.38.6', '1.39.7', '1.40.3', '1.41.1']
running docker compose down for mw-135 1.35.13 docker application ...
[+] Running 6/6
 ✔ Container mw-135-mw       Removed                                       1.3s 
 ✔ Container mw-135-db       Removed                                       0.7s 
 ✔ Volume mw-135_mysql-data  Removed                                       0.0s 
 ✔ Volume mw-135_wiki-www    Removed                                       0.5s 
 ✔ Volume mw-135_wiki-etc    Removed                                       0.5s 
 ✔ Network mw-135_default    Removed                                       0.3s 
running docker compose down for mw-138 1.38.6 docker application ...
[+] Running 6/6
 ✔ Container mw-138-mw       Removed                                       1.4s 
 ✔ Container mw-138-db       Removed                                       0.8s 
 ✔ Volume mw-138_wiki-etc    Removed                                       0.0s 
 ✔ Volume mw-138_mysql-data  Removed                                       0.0s 
 ✔ Volume mw-138_wiki-www    Removed                                       0.5s 
 ✔ Network mw-138_default    Removed                                       0.3s 
running docker compose down for mw-139 1.39.7 docker application ...
[+] Running 6/6
 ✔ Container mw-139-mw       Removed                                       1.4s 
 ✔ Container mw-139-db       Removed                                       0.8s 
 ✔ Volume mw-139_wiki-www    Removed                                       0.5s 
 ✔ Volume mw-139_wiki-etc    Removed                                       0.5s 
 ✔ Volume mw-139_mysql-data  Removed                                       0.5s 
 ✔ Network mw-139_default    Removed                                       0.3s 
running docker compose down for mw-140 1.40.3 docker application ...
[+] Running 6/6
 ✔ Container mw-140-mw       Removed                                       1.3s 
 ✔ Container mw-140-db       Removed                                       0.9s 
 ✔ Volume mw-140_wiki-www    Removed                                       0.6s 
 ✔ Volume mw-140_wiki-etc    Removed                                       0.6s 
 ✔ Volume mw-140_mysql-data  Removed                                       0.6s 
 ✔ Network mw-140_default    Removed                                       0.3s 
running docker compose down for mw-141 1.41.1 docker application ...
[+] Running 6/6
 ✔ Container mw-141-mw       Removed                                       1.5s 
 ✔ Container mw-141-db       Removed                                       1.1s 
 ✔ Volume mw-141_mysql-data  Removed                                       0.0s 
 ✔ Volume mw-141_wiki-www    Removed                                       0.6s 
 ✔ Volume mw-141_wiki-etc    Removed                                       0.6s 
 ✔ Network mw-141_default    Removed                                       0.4s

Single 1.35.13 LTS

# python mwdocker/mwcluster.py  can be used instead of mwcluster if you test from your locally cloned environment
mwcluster \
  --create \
  --forceRebuild\
  --version_list 1.35.13\
  --base_port 8480\
  --sql_base_port 10306\
  --mariaDBVersion 10.11\
  --container_name mw135lts\
  --logo https://upload.wikimedia.org/wikipedia/commons/thumb/f/f9/Bigsmile_smiley_yellow_simple.svg/128px-Bigsmile_smiley_yellow_simple.svg.png
creating docker compose applications for mediawiki versions ['1.35.13']
starting mw135lts 1.35.13 docker application ..

Mediawiki application will be available at

http://localhost:8480 http://localhost:8480/index.php/Special:Version PyMediaWikiDocker-ExampleMW135WithLogo.png

Single 1.35 with Semantic Mediawiki

There might be more current versions of SMW available see https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki_Version_History and adapt the example below if you see the need to do so.

Version 4.1.2

mwcluster \
  --create \
  --container_name smw4\
  --forceRebuild\
  --version_list 1.35.13\
  --base_port 8481\
  --sql_base_port 10307\
  --mariaDBVersion 10.11\
  --smw_version 4.1.2
creating docker compose applications for mediawiki versions ['1.35.13']
starting smw4 1.35.13 docker application ...

debug docker compose results - ports and other configuration parts

cd ~/.pymediawikidocker/smw4
docker-compose up
# in another terminal session:
docker ps
CONTAINER ID   IMAGE                   COMMAND                  CREATED              STATUS         PORTS                     NAMES
87a795d444eb   smw4_mw                 "docker-php-entrypoi…"   About a minute ago   Up 7 seconds   0.0.0.0:8481->80/tcp      smw4-mw
7ca3a0434d31   mariadb:10.11           "docker-entrypoint.s…"   About a minute ago   Up 7 seconds   0.0.0.0:10307->3306/tcp   smw4-db

open bash in docker container

docker exec -it smw4-mw /bin/bash
root@87a795d444eb:/var/www/html#

check installExtensions.sh script

cat /root/installExtensions.sh 
#!/bin/bash
# install the required extensions
# WF 2021-06-23
cd /var/www/html/extensions

# Admin Links
# https://www.mediawiki.org/wiki/Extension:Admin_Links
git clone https://github.com/wikimedia/mediawiki-extensions-AdminLinks --single-branch --branch REL1_35 AdminLinks

# Header Tabs
# https://www.mediawiki.org/wiki/Extension:Header_Tabs
git clone https://github.com/wikimedia/mediawiki-extensions-HeaderTabs --single-branch --branch REL1_35 HeaderTabs

# SyntaxHighlight
# https://www.mediawiki.org/wiki/Extension:SyntaxHighlight
# no installation script command specified

# Variables
# https://www.mediawiki.org/wiki/Extension:Variables
git clone https://github.com/wikimedia/mediawiki-extensions-Variables --single-branch --branch REL1_35 Variables

check Semantic MediaWiki settings in LocalSettings.php

grep -i semantic LocalSettings.php 
# enable Support for Semantic MediaWiki
# see https://www.semantic-mediawiki.org/wiki/Help:EnableSemantics
# Version of SemanticMediaWiki at install time: 4.1.1
wfLoadExtension( 'SemanticMediaWiki' );
enableSemantics();
# https://www.semantic-mediawiki.org/wiki/Help:$smwgQMaxInlineLimit

SMW Version 3.2.3

Installation

mwcluster \
  --create \
  --container_name smw3\
  --forceRebuild\
  --version_list 1.35.13\
  --base_port 8482\
  --sql_base_port 10308\
  --mariaDBVersion 10.11\
  --logo https://www.semantic-mediawiki.org/w/images/4/4e/SMW_logo_180.png\
  --smw_version 3.2.3

Check

mwcluster --check --container_name smw3 --version_list 1.35.13

Down

mwcluster --down --container_name smw3 --version_list 1.35.13 -f
running docker compose down for mediawiki versions ['1.35.13']
running docker compose down for smw3 1.35.10 docker application ...
[+] Running 3/3
 ⠿ Volume smw3_wiki-etc    Removed                                0.0s
 ⠿ Volume smw3_mysql-data  Removed                                0.1s
 ⠿ Volume smw3_wiki-www    Removed                                1.2s

Extensions

see Pymediawikidocker/Extensions

Debugging

Docker files

You'll find the files created by pymediawikidocker in ".pymediawikidocker" in your homedirectory.

pwd
/Users/***/.pymediawikidocker/mw1_35_2
ls -l
total 176
-rw-r--r--  1 wf  staff   1057 22 Jun 07:03 Dockerfile
-rw-r--r--  1 wf  staff   4580 22 Jun 07:03 LocalSettings.php
-rw-r--r--  1 wf  staff   1161 22 Jun 07:03 docker-compose.yml
-rw-r--r--  1 wf  staff    317 22 Jun 07:03 initdb.sh
-rw-r--r--  1 wf  staff    125 22 Jun 07:03 phpinfo.php
-rw-r--r--  1 wf  staff  64515 22 Jun 07:03 wiki.sql

Check installed docker images

docker images | grep mw
mw1_38_4_mw    latest    c647ad44a344   About a minute ago   996MB
mw1_37_6_mw    latest    af9de508138c   About a minute ago   980MB
mw1_35_8_mw    latest    f41c84ab16c3   2 minutes ago        988MB
mw1_31_16_mw   latest    9a8a26949b58   2 minutes ago        897MB
mw1_27_7_mw    latest    1fa159362ec9   2 minutes ago        898MB

Bash into docker containers

# Mediawiki container
docker exec -it mw1_38_4-mw /bin/bash
docker exec -it mw1_37_6-mw /bin/bash
docker exec -it mw1_35_8-mw /bin/bash
docker exec -it mw1_31_16-mw /bin/bash
docker exec -it mw1_27_7-mw /bin/bash

# MariaDB container
docker exec -it mw1_38_4-db /bin/bash
docker exec -it mw1_37_6-db /bin/bash
docker exec -it mw1_35_8-db /bin/bash
docker exec -it mw1_31_16-db /bin/bash
docker exec -it mw1_27_7-db /bin/bash

Monkey patching

# Enable raw html in for the wiki
docker exec  mw1_35_8-mw sh -c "echo '\$wgRawHtml = true;\n' >> /var/www/html/LocalSettings.php"

No space left on device issue

e.g. when starting mariadb container see https://stackoverflow.com/questions/37645879/how-can-i-fix-docker-mac-no-space-left-on-device-error

Wiki Backup

The passwords are available from the docker files e.g.

grep PASS docker-compose.yml 
      MYSQL_PASSWORD: "TnbKf2zGRmZPjUvz7B"
      MYSQL_ROOT_PASSWORD: "QWehnR9yLMY7YAb9pw"

In a docker bash a dump can be created

mysqldump wiki -u wikiuser --password=TnbKf2zGRmZPjUvz7B > /tmp/wiki.sql

and then copied to your local machine

docker cp mw1_36_0_db_1:/tmp/wiki.sql /tmp

Docker cleanup procedure

#!/bin/bash
# WF 2023-04-08
# 
# ⚠️ ⚠️ ⚠️ 
#
#  kids  don't do this at home ...
#
# ⚠️ These commands will stop and remove all running docker containers (not only the ones created pymediawikidocker/the mwcluster command) 
# kill/stop all running containers
docker kill $(docker ps -q)
#docker stop $(docker ps -aq)
# remove all docker containers
docker rm $(docker ps -aq)
# remove all images
# ⚠️ This command will remove all your images not only the ones created by pymediawikidocker (docker will hopefully refuse to do this without the -f option) 
docker rmi $(docker images -q)
# ⚠️ these commands will remove all your volumes - you might loose valuable data if you don't check what your volumes contain before starting this command 
# see https://stackoverflow.com/a/46091568/1497139
docker volume rm $(docker volume ls -qf dangling=true | xargs)
#⚠️ WARNING! This will remove:
#  - all stopped containers
#  - all networks not used by at least one container
#  - all dangling images
#  - all dangling build cache
docker system prune --force

Links