Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/idave2/dockerwiki
Docker( MediaWiki + MariaDB )
https://github.com/idave2/dockerwiki
docker mariadb mediawiki
Last synced: 5 days ago
JSON representation
Docker( MediaWiki + MariaDB )
- Host: GitHub
- URL: https://github.com/idave2/dockerwiki
- Owner: iDave2
- License: gpl-3.0
- Created: 2023-08-06T23:09:09.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-23T00:55:32.000Z (about 1 year ago)
- Last Synced: 2024-10-10T18:42:14.197Z (26 days ago)
- Topics: docker, mariadb, mediawiki
- Language: Shell
- Homepage: https://hub.docker.com/repository/docker/idave2/mediawiki/general
- Size: 4.77 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DockerWiki
This project is an implementation of the multi-container pattern outlined
in Docker Docs'
[Getting Started](https://docs.docker.com/get-started/07_multi_container/)
guide.
It targets developers and students.
For business applications, please find similar projects from
[Bitnami](https://hub.docker.com/r/bitnami/mediawiki) or organizations
whose context includes strong security, support, and all the things a
business needs to run.
A summary of what is here:
- `bin/backrest.sh`: simple backup and restore starter kit
- `bin/cake.sh`: build script to *make* and unmake artifacts
- `bin/*API.sh`: test scripts for related projects
- `.env`: build and runtime configuration variables
- `compose.yaml`: launch instructions for `docker compose`
- `setEnv.sh`: shortcuts to simplify development and test
## Builds
`source setEnv.sh` for a build script that runs anywhere,
```bash
alias cake="/absolute/path/to/bin/cake.sh"
alias dc="docker compose"
```
When run from mariadb or mediawiki directories, `cake` only builds that image.
When run from the parent of those folders – the project root –
`cake` builds both images:
```bash
$ cake # create everything
$ cake -cccc # destroy everything
$ cake -h # display usage summary
```
The `--clean` option is so complex, it might function as a Turing machine:
```bash
$ cake -c # Removes build folders,
$ cake -cc # and containers and networks,
$ cake -ccc # and images,
$ cake -cccc # and volumes.
```
Build instructions were removed from `compose.yaml` when post-install steps
became complex. `docker compose` still launches DockerWiki provided it can
find the requested images locally or on the hub,
```bash
$ dc up -d # create everything
$ dc down -v --rmi local # destroy almost everything
```
Remember to backup important data before (accidentally) removing its volume!
## Backups
`source setEnv.sh` for a backup and restore script that runs anywhere,
```bash
alias br="/absolute/path/to/bin/backrest.sh"
```
`backrest.sh` backs up and restores three items:
- MariaDB database;
- MediaWiki images directory tree;
- MediaWiki LocalSettings.php file.
The working directory (option `-w` or `--work-dir`) is
optional for backup but required for restore:
```bash
$ br -b # -> /tmp/DockerWiki/backup-/
$ br -bw ./my-git-backups/ # -> ./my-git-backups/
$ br --restore -w ./my-git-backups # <- ./my-git-backups/
```
# Installers
In this context, *installer* refers to the method used to create MediaWiki's
initial database and runtime configuration stored in `LocalSettings.php`.
`cake` offers four choices:
```bash
$ cake -i web # web-based installer
$ cake --installer cli # command-line installer (default)
$ cake -i debug # same as cli but w/extra dev tools
$ cake -i restore=my/backup # Restore a backrest.sh backup
```
The first three methods create a database and local settings *after* the
images are built and running in their containers, so if these containers
(not images) were destroyed and recreated, they would again need to have
a database and local settings created.
In order for these important artifacts to end up in image layers rather
than volatile container memory, we use a Dockerfile that copies them into
the image from a folder previously created by `backrest.sh`:
```bash
$ cake --installer restore=./hub
```
This is how the Docker Hub images corresponding to this git repository
were created.
---
Latest images are pushed to [Docker Hub](https://hub.docker.com/u/idave2) and no CI is configured (yet).
Docker is fun; five stars to the team.
> "Yes, we are *very* good."
> – Top Gun: Maverick, community edition