Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wirehead/semantic-mediawiki-docker
A docker container for running SemanticMediaWiki in a kubernetes-styled context
https://github.com/wirehead/semantic-mediawiki-docker
docker mediawiki php semantic-mediawiki semanticmediawiki smw wiki
Last synced: 3 days ago
JSON representation
A docker container for running SemanticMediaWiki in a kubernetes-styled context
- Host: GitHub
- URL: https://github.com/wirehead/semantic-mediawiki-docker
- Owner: wirehead
- License: apache-2.0
- Created: 2019-09-01T21:44:20.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-07T17:16:18.000Z (over 1 year ago)
- Last Synced: 2023-08-09T07:31:36.133Z (over 1 year ago)
- Topics: docker, mediawiki, php, semantic-mediawiki, semanticmediawiki, smw, wiki
- Language: PHP
- Homepage:
- Size: 405 KB
- Stars: 7
- Watchers: 7
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Semantic MediaWiki as a docker container
A nice Docker container designed for running [Semantic MediaWiki](https://www.semantic-mediawiki.org/) with a set of useful modules already installed in a kubernetes-styled situation.
You probably don't want to run the containers as-is, it's mostly intended for use with my matching [helm chart](https://github.com/wirehead/wirehead-charts/tree/master/charts/semanticmediawiki)
**WORK IN PROGRESS WARNING**: I'm totally not finished messing with this.
## Basic operation
This is primarily designed to run atop Kube, but here's some entrypoints if you want to play with things:
* To build the container: `build.sh`
* To run a browser container: `run.sh`
* To run a cron container: `cron.sh`
* To run a worker node container: `jobs.sh`
### Quickstart
## Environment variables
| Environment Variable | Config Var | Default Value | Description |
| -------------------------- | ---------------- | ------------------------ | ------------------- |
| MEDIAWIKI_DEBUG | | unset | Set this to enable debug traces |
| MEDIAWIKI_DISABLE_ICONS | $wgFooterIcons | unset | Set this to disable footer icons |
| MEDIAWIKI_SITE_SERVER | $wgServer | `http://127.0.0.1:8080` | Set this to the server host, protocol, and port if it's not a standard port. This is what MediaWiki uses to generate URLs |
| MEDIAWIKI_SCRIPT_PATH | $wgScriptPath | null | The base URL path |
| MEDIAWIKI_UPLOAD_PATH | $wgUploadPath | null | The path for uploads |
| MEDIAWIKI_SITE_NAME | $wgSitename | `tst` | Name of the site |
| MEDIAWIKI_SITE_LANG | $wgLanguageCode | `en` | Language of the site|
| MEDIAWIKI_ADMIN_USER | | `admin` | Name of the admin user |
| MEDIAWIKI_ADMIN_PASS | | `password` | Default password for the admin user |
| MEDIAWIKI_DB_TYPE | $wgDBtype | `sqlite` | DB style (sqlite, postgres, or mysql) |
| MEDIAWIKI_DB_HOST | $wgDBserver | | hostname for the DB (unneccessary for sqlite) |
| MEDIAWIKI_DB_USER | $wgDBuser | | database user (not to be confused with admin user; this is how you log into the database) |
| MEDIAWIKI_DB_PASSWORD | $wgDBpassword | | database password (not to be confused with admin password; this is how you log into the database) |
| MEDIAWIKI_DB_NAME | $wgDBname |` my_wiki` | database name |
| MEDIAWIKI_DB_PORT | $wgDBport | | database port |
| MEDIAWIKI_DB_SCHEMA | $wgDBmwschema | | database schema (for postgresql) |
| MEDIAWIKI_DATABASE_DIR | $wgSQLiteDataDir | `/var/www/data` | database directory (for sqlite) |
| MEDIAWIKI_SECRET_KEY | $wgSecretKey | ...... | secret key |
| MEDIAWIKI_ENABLE_UPLOADS | $wgEnableUploads | unset | set a value to enable uploads |
| MEDIAWIKI_ENABLE_EMAIL | $wgEnableEmail | unset | set a value to enable email |
| MEDIAWIKI_EMAIL_PW_SENDER | $wgEmergencyContact | `[email protected]` | Password sender email |
| MEDIAWIKI_EMAIL_EMERG_CONT | $wgPasswordSender | `[email protected]` | Emergency contact |
| SMW_SEMANTIC_URL | | `http://www.example.com/` | SemanticMediaWiki namespace for RDF properties |
## Versioning
v{container version}-{mediawiki major version}-{semanticmediawiki major version}
* The container version will obey SemVer, such that the minor/major version change means that you need to upgrade the Helm chart and/or run a migration script.
* The MediaWiki and SemanticMediaWiki versions are there because a lot of compatibility stuff depends on them
* All three are on an independent release cycle.
## Some details
### A brief and non-normative list of what you want to do to run things in a kubernetes-styled situation
1. One process strictly for each container. This is why pods schedule multiple containers per pod. No supervisord or other such process supervision; your container runtime handles this.
2. Secrets maintained separately from configuration, so you can inject them as a Secret.
3. Config files exist in a directory that you can use a ConfigMap to inject them.
4. Stateless containers, which precludes a *lot* of ways to do a 'friendly' setup.
5. Database is a separate concern. Users may want to use a hosted database (Amazon RDS or the like) or at least store multiple different instances in a single bigger database. Helm charts that include their own database are not great here.
6. If you are going to have local files, they need to be easily mapped and mounted volumes.
7. Contains a discrete setup process that won't accidentally wipe out your stuff.
### The layers involved
1. Debian Buster
2. [PHP 7.2 Buster Apache](https://hub.docker.com/_/php/)
3. [MediaWiki](https://github.com/wikimedia/mediawiki-docker)
4. This dockerfile that adds customizations:
* Installs Composer
* Installs some system-level packages
* Installs some source blob modules
* Uses composer to install some modules
* Sets up a parallel directory with symlinks for the config files so you can map them
* Drops some config files in place.
### Why is this complicated
* *Somebody really needs to write a kube-oriented setup script*. There is a graphical installer and a CLI installer and both of them want to generate you a config file, whereas I want a script that will safely provision a fresh database based on the values in the config file that already exists. And then the SemanticMediaWiki portion of things is separate from the MediaWiki portion of things. I wrapped it up in `db-setup.sh` but you can see how it's kinda weird and not perfect.
* The [SemanticMediaWiki config dir](https://www.semantic-mediawiki.org/wiki/Help:Setup_information_file). Because SemanticMediaWiki has a bunch of very specific implementation details related to not necessarily using the same SQL database as everything else and using a SPARQL store, I can see why they decided it was simpler to use a JSON file in a known place to keep track of that.
* No environment variables for configuration, no clear separation of the secret-secrets (the secret key and the database passwords, for example) from the configuration details.
* Any MediaWiki extensions you want to run (and you want to run them) frequently need system dependencies. Because MediaWiki is *old* a lot of the popular regular extensions aren't available yet as composer dependencies, so you also need to pull in files from random repos in weird places. Ergo, if you want to run any customized set of extensions, you will need to make your own dockerfile. This isn't actually that bad; lots of software requires you to run customized Docker builds if you want a custom module and lots of software that's still useful bit a bit old wasn't designed for a technology and methodology that didn't exist at the time.
## Persistent Data
### Database
Also note that the `data` directory needs to be writable to the `www-data` user. Not just the files. The whole directory.
### Images
### SemanticMediaWiki config
## Debugging tips..
### Helpful error messages
Add this to the `LocalSettings.php` or `LocalSettings.local.php` to get helpful error messages:
```
$wgShowExceptionDetails = true;
$wgShowDBErrorBacktrace = true;
$wgShowSQLErrors = true;
```
### Getting at a shell
Use this to get into a shell:
```
docker exec -it some-mediawiki /bin/bash -il
```
## Inspired by:
* https://github.com/wikimedia/mediawiki-docker
* https://github.com/toniher/docker-SemanticMediaWiki
* https://github.com/benhutchins/docker-mediawiki