93 lines
3.2 KiB
Markdown
93 lines
3.2 KiB
Markdown
# Mediawiki
|
||
|
||
[](https://drone.autonomic.zone/coop-cloud/mediawiki)
|
||
|
||
Mediawiki [version 1.35][mediawiki-1.35]
|
||
|
||
Requires Docker version 1.11.2 or above to run.
|
||
|
||
Based on [`mediawiki`][mediawiki].
|
||
|
||
1. Set up Docker Swarm and [`abra`][abra]
|
||
2. Deploy [`coop-cloud/traefik`][traefik]
|
||
3. `cp .envrc.sample .envrc`
|
||
4. Edit `.envrc` - be sure to change `$DOMAIN` to something that resolves to
|
||
your Docker swarm box
|
||
5. `direnv allow` (or `source .envrc`)
|
||
6. Generate secrets:
|
||
```
|
||
abra secret_generate db_password v1
|
||
abra secret_generate db_root_password v1
|
||
abra secret_generate mediawiki_secret_key v1 "pwgen -n 64 1"
|
||
```
|
||
7. `abra deploy`
|
||
8. Create an initial admin user:
|
||
`abra run app php /var/www/html/maintenance/createAndPromote.php --sysop YourUsername YourPassword`
|
||
|
||
## Email
|
||
|
||
1. Edit `.envrc` and uncomment the `SMTP` lines. Set `SMTP_HOST` to
|
||
`postfix_relay` for `coop-cloud/postfix_relay`, or `mailu_front` for
|
||
`coop-cloud/mailu` (assuming default stack names)
|
||
2. For `postfix_relay`, add the domain to your email config – `EXTRA_SENDER_DOMAINS` in
|
||
`postfix_relay`. This doesn't seem to be required for Mailu.
|
||
3. `direnv allow` (or `source .envrc`)
|
||
4. `abra deploy`
|
||
|
||
## Single Sign On
|
||
|
||
### SimpleSAMLphp
|
||
|
||
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
|
||
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:
|
||
```
|
||
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`:
|
||
```
|
||
abra run simplesaml vi /var/simplesamlphp/config/config.php
|
||
# find 'store.sql.dsn' and edit to:
|
||
# 'sqlite:/var/simplesamlphp/data/simplesamlphp.sq3'
|
||
```
|
||
|
||
### OpenID Connect
|
||
|
||
1. Edit `.envrc` and uncomment lines in the `OPENID` section (including `COMPOSE_FILE`)
|
||
2. `direnv allow`
|
||
3. Store your Keycloak-generated client secret in Docker:
|
||
```
|
||
abra secret insert openid_client_secret v1 put-your-secret-here
|
||
```
|
||
4. `abra deploy`
|
||
|
||
## License
|
||
|
||
MIT License
|
||
|
||
[mediawiki-1.35]: https://www.mediawiki.org/wiki/Release_notes/1.35
|
||
[abra]: https://git.autonomic.zone/autonomic-cooperative/abra
|
||
[traefik]: https://git.autonomic.zone/coop-cloud/traefik
|
||
[mediawiki]: https://hub.docker.com/_/mediawiki
|
||
[simplesamlphp]: https://simplesamlphp.org/
|
||
[mw-simplesamlphp]: https://www.mediawiki.org/wiki/Extension:SimpleSAMLphp
|
||
[venatorfox-simplesamlphp]: https://hub.docker.com/r/venatorfox/simplesamlphp
|