This repository has been archived on 2021-07-22. You can view files and clone it, but cannot push or open issues or pull requests.
mediawiki/README.md

70 lines
2.4 KiB
Markdown
Raw Normal View History

2020-09-04 23:59:00 +00:00
# Mediawiki
2020-09-07 23:38:20 +00:00
Mediawiki [version 1.32.1][mediawiki-1.32]
2020-09-04 23:59:00 +00:00
2020-09-07 23:38:20 +00:00
Requires Docker version 1.11.2 or above to run.
2020-09-04 23:59:00 +00:00
2020-09-07 23:38:20 +00:00
Based on [`mediawiki-ve-bundle`][mediawiki-ve].
2020-09-04 23:59:00 +00:00
2020-09-07 23:38:20 +00:00
1. Set up Docker Swarm and [`abra`][abra]
2. Deploy [`compose-stacks/traefik`][compose-traefik]
2020-09-04 23:59:00 +00:00
2. `cp .envrc.sample .envrc`
2020-09-07 23:38:20 +00:00
3. Edit `.envrc` - be sure to change `$DOMAIN` to something that resolves to
your Docker swarm box
2020-09-04 23:59:00 +00:00
4. `direnv allow` (or `. .envrc`)
2020-09-19 10:09:49 +00:00
5. Generate secrets:
```
abra secret_generate db_password v1
abra secret_generate db_root_password v1
2020-09-22 18:12:24 +00:00
abra secret_generate mediawiki_secret_key v1 "pwgen -n 64 1"
2020-09-19 10:09:49 +00:00
```
6. `abra deploy`
7. `abra run mediawiki /bin/bash` to open a shell
8. `php /var/www/html/maintenance/createAndPromote.php YourUsername YourPassword`
2020-09-16 20:19:23 +00:00
## SimpleSAMLphp
2020-09-16 20:19:23 +00:00
This app includes optional SAML Single Sign On using
[SimpleSAMLphp][simplesamlphp] and Mediawiki's
[Extension:SimpleSAMLphp][mw-simplesamlphp], based on the
[`venatorfox/simplesamlphp`][venatorfox-simplesamlphp] image.
NOTE: currently, if you enable SAML then it'll disable Mediawiki's own user account
system. Patches to make this configurable are welcome!
1. Edit `.envrc` and uncomment lines in the `SAML` section (including `COMPOSE_FILE`)
2. `direnv allow`
3. Generate secrets:
```
abra secret_generate saml_admin_password v1
2020-09-22 18:12:24 +00:00
abra secret_generate saml_secret_salt v1 "pwgen -n 64 1"
```
4. `abra deploy`
5. Copy your SimpleSAMLphp metadata and certificates to the container (assuming
you have local `metadata` and `cert` folders:
```
2020-09-22 18:12:24 +00:00
abra cp metadata simplesaml:/var/simplesamlphp/
abra cp cert simplesaml:/var/simplesamlphp/
```
6. You can log into SimpleSAMLphp using the password you generated at
https://$DOMAIN/simplesaml/ and test authentication
7. Edit SimpleSAMLphp's `config.php` and change `store.sql.dsn`:
```
2020-09-22 18:12:24 +00:00
abra run simplesaml vi /var/simplesamlphp/config/config.php
# find 'store.sql.dsn' and edit to:
# 'sqlite:/var/simplesamlphp/data/simplesamlphp.sq3'
```
2020-09-04 23:59:00 +00:00
## License
MIT License
2020-09-07 23:38:20 +00:00
[mediawiki-1.32]: https://www.mediawiki.org/wiki/Release_notes/1.32.1
[abra]: https://git.autonomic.zone/autonomic-cooperative/abra
[compose-traefik]: https://git.autonomic.zone/compose-stacks/traefik
[mediawiki-ve]: https://hub.docker.com/r/revianlabs/mediawiki-ve-bundle
[simplesamlphp]: https://simplesamlphp.org/
[mw-simplesamlphp]: https://www.mediawiki.org/wiki/Extension:SimpleSAMLphp
[venatorfox-simplesamlphp]: https://hub.docker.com/r/venatorfox/simplesamlphp