diff --git a/README.md b/README.md index c5d92b6..839b9cc 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,28 @@ Mediawiki [version 1.35][mediawiki-1.35] -Requires Docker version 1.11.2 or above to run. + +* **Category**: Apps +* **Status**: ❸🍎 +* **Image**: [`mediawiki`](https://hub.docker.com/_/mediawiki), βΆπŸ’š, upstream +* **Healthcheck**: No +* **Backups**: Yes +* **Email**: βΆπŸ’š +* **Tests**: β·πŸ’› +* **SSO**: β·πŸ’› (OAuth, SAML) + -Based on [`mediawiki`][mediawiki]. +## Basic usage 1. Set up Docker Swarm and [`abra`][abra] 2. Deploy [`coop-cloud/traefik`][traefik] -3. `abra app new mediawiki` +3. `abra app new mediawiki --secrets` (optionally with `--pass` if you'd like + to save secrets in `pass`) 4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to your Docker swarm box -5. `abra app YOURAPPDOMAIN secret auto` (optionally with `--pass` if you'd like - to save secrets in `pass`). -6. `abra app YOURAPPDOMAIN deploy` -7. Create an initial admin user: - `abra run app php /var/www/html/maintenance/createAndPromote.php --sysop YourUsername YourPassword` +5. `abra app YOURAPPDOMAIN deploy` +6. Create an initial admin user: + `abra app YOURAPPDOMAIN run app php /var/www/html/maintenance/createAndPromote.php --sysop YourUsername YourPassword` ## Email @@ -71,7 +79,7 @@ system. Patches to make this configurable are welcome! abra app YOURAPPDOMAIN secret insert openid_client_secret v1 put-your-secret-here ``` -3. `abra deploy` +3. `abra app YOURAPPDOMAIN deploy` ## License @@ -80,7 +88,6 @@ 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