docker-wikifarm

docker-wikifarm uses docker compose to build and manage MediaWiki wiki farms. It optionally supports multiple MediaWiki versions side by side. The wiki farms run in two (or more) docker containers: one for the database and one for each MediaWiki version (including the web server and MediaWiki). The MediaWiki containers build upon the official MediaWiki Docker images, if an appropriate image exists for the desired version, at https://hub.docker.com/_/mediawiki.

Files

The repo has the following directories:

scripts

This directory contains the scripts used to build and manage the wiki farm. They include:

1. build_wikifarm.sh: build the wiki farm containers for one MediaWiki version (1.31, 1.32, 1.33, 1.34, or master)
2. build_all.sh: build the wiki farm containers for all supported MediaWiki versions
3. create_wiki.sh: create a wiki on the wiki farm
4. mk-favicon.sh: creates a favicon.ico file from the logo.png file for a wiki
5. move_wiki.sh: move a wiki from one wiki farm container to another
6. backup_wiki_database.sh: create a SQL dump of a wiki in volumes/backups
7. disable_wiki: disable a wiki on a wiki farm (this does not remove the database)
8. run_update.sh: run the update maintenance script on one wiki
9. patch_master.sh: applies a gerrit patch to wikifarm-master and runs update
10. status.sh: list all images and containers
11. clean_all.sh: remove all images and containers generated from the build and prune unused containers
12. clean.sh: remove only the database and wikifarm images and containers and prune unused containers
13. wiki_shell.sh: open a bash command prompt on a wiki farm
14. database_shell.sh: open a MySQL shell on the database host

config

This directory contains files that can be edited before the wiki farm is built to specify the configuration. Currently there is a single config file:

1. variables.env: environment variables that will be used in the containers

volumes

This directory contains volumes that are shared between the host and the wiki farm container. They include:

1. instances: instance files for the wikis, including per wiki configuration, branding (i.e. logo and favicon), and images
2. backups: wiki SQL dumps created by the backup_wiki_database.sh script
3. mediawiki: wiki configuration per MediaWiki version

The mediawiki directory listed above will contain one directory for each MediaWiki version that has been built. Those subdirectories will in turn each contain the following subdirectories:

1. config: MediaWiki configuration files, including Config.php, which contains basic configuration for the wiki farm and can be edited to tweak the wiki farm configuration. In addition, WikiFarmExtensions.php and WikiFarmSkins.php can be edited to enable extensions and skins for all wikis on the wiki farm.
2. extensions: the extensions directory containing the downloaded code of the installed extensions
3. skins: the skins directory containing the downloaded code of the installed skins

wikifarm

This directory contains the files that are necessary to build the wiki farm container.

Building the wiki farm

To build the wiki farm, do the following:

1. Edit the files in the config directory at the top level of the repository. Especially change the passwords in config/variables.env.
2. Run the build_wikifarm.sh script that is in the scripts directory. It takes two parameters: the MediaWiki version (i.e. 1.31, 1.32, 1.33, 1.34, or master) and the host port to use to communicate with the wiki farm web server.

Creating a wiki on the wiki farm

To add a new wiki to the wiki farm, do the following:

1. Run the create_wiki.sh script from the scripts directory. It takes two parameters: the MediaWiki version of the wiki farm (i.e. 1.31, 1.32, 1.33, 1.34, or master) and the name of the wiki. (Note that if you have just built the wiki farm, you will need to wait a few minutes to let the database come up before creating a wiki.)
2. Copy the logo file (logo.png) into the instance branding directory at volumes/instances/<wiki name>/branding.
3. Copy your favicon file (favicon.ico) into the instance branding directory at volumes/instances/<wiki name>/branding or use the mk-favicon.sh script to generate a favicon.ico file from your logo.png file. The latter takes two parameters: the name of the wiki and the MediaWiki version of the wiki farm.
4. Create a LocalSettings.php file in the volumes/instances/<wiki name> directory to configure the wiki instance. The instance LocalSettings.php file will be called from the end of the wiki farm LocalSettings.php file. The content of the latter file can be examined at 'wikifarm/files/LocalSettings_wikifarm.php`.