coop-cloud/mediawiki
coop-cloud
/
mediawiki
6
0
Fork 3
Code Issues 6 Pull Requests Releases Wiki Activity

Update abra syntax in examples (finally) [mass update]

This commit is contained in:
3wc 2023-01-19 16:02:28 -08:00
parent bde470d4f9
commit bf2fcbd7b4
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -21,20 +21,20 @@ Mediawiki [version 1.35][mediawiki-1.35]
2. Deploy [`coop-cloud/traefik`][traefik] 2. Deploy [`coop-cloud/traefik`][traefik]
3. `abra app new mediawiki --secrets` (optionally with `--pass` if you'd like 3. `abra app new mediawiki --secrets` (optionally with `--pass` if you'd like
to save secrets in `pass`) to save secrets in `pass`)
4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to 4. `abra app config YOURAPPDOMAIN` - be sure to change `$DOMAIN` to something that resolves to
your Docker swarm box your Docker swarm box
5. `abra app YOURAPPDOMAIN deploy` 5. `abra app deploy YOURAPPDOMAIN`
6. Create an initial admin user: 6. Create an initial admin user:
`abra app YOURAPPDOMAIN run app php /var/www/html/maintenance/createAndPromote.php --sysop YourUsername YourPassword` `abra app run YOURAPPDOMAIN app php /var/www/html/maintenance/createAndPromote.php --sysop YourUsername YourPassword`
## Email ## Email
1. `abra app YOURAPPDOMAIN config` - edit `.envrc` and uncomment the `SMTP` lines. Set `SMTP_HOST` to 1. `abra app config YOURAPPDOMAIN` - edit `.envrc` and uncomment the `SMTP` lines. Set `SMTP_HOST` to
`postfix_relay` for `coop-cloud/postfix_relay`, or `mailu_front` for `postfix_relay` for `coop-cloud/postfix_relay`, or `mailu_front` for
`coop-cloud/mailu` (assuming default stack names) `coop-cloud/mailu` (assuming default stack names)
2. For `postfix_relay`, add the domain to your email config – `EXTRA_SENDER_DOMAINS` in 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. `postfix_relay`. This doesn't seem to be required for Mailu.
3. `abra app YOURAPPDOMAIN deploy` 3. `abra app deploy YOURAPPDOMAIN`
## Single Sign On ## Single Sign On
@ -48,13 +48,13 @@ This app includes optional SAML Single Sign On using
NOTE: currently, if you enable SAML then it'll disable Mediawiki's own user account NOTE: currently, if you enable SAML then it'll disable Mediawiki's own user account
system. Patches to make this configurable are welcome! system. Patches to make this configurable are welcome!
1. `abra app YOURAPPDOMAIN config` - uncomment lines in the `SAML` section (including `COMPOSE_FILE`) 1. `abra app config YOURAPPDOMAIN` - uncomment lines in the `SAML` section (including `COMPOSE_FILE`)
2. Generate secrets: (add `--pass` if you want to store secrets in `pass`) 2. Generate secrets: (add `--pass` if you want to store secrets in `pass`)
``` ```
abra app YOURAPPDOMAIN secret generate saml_admin_password v1 abra app YOURAPPDOMAIN secret generate saml_admin_password v1
abra app YOURAPPDOMAIN secret generate saml_secret_salt v1 "pwgen -n 64 1" abra app YOURAPPDOMAIN secret generate saml_secret_salt v1 "pwgen -n 64 1"
``` ```
3. `abra app YOURAPPDOMAIN deploy` 3. `abra app deploy YOURAPPDOMAIN`
4. Copy your SimpleSAMLphp metadata and certificates to the container (assuming 4. Copy your SimpleSAMLphp metadata and certificates to the container (assuming
you have local `metadata` and `cert` folders: you have local `metadata` and `cert` folders:
``` ```
@ -72,14 +72,14 @@ system. Patches to make this configurable are welcome!
### OpenID Connect ### OpenID Connect
1. `abra app YOURAPPDOMAIN config` - uncomment lines in the `OPENID` section (including `COMPOSE_FILE`) 1. `abra app config YOURAPPDOMAIN` - uncomment lines in the `OPENID` section (including `COMPOSE_FILE`)
2. Store your Keycloak-generated client secret in Docker: 2. Store your Keycloak-generated client secret in Docker:
``` ```
abra app YOURAPPDOMAIN secret insert openid_client_secret v1 put-your-secret-here abra app YOURAPPDOMAIN secret insert openid_client_secret v1 put-your-secret-here
``` ```
3. `abra app YOURAPPDOMAIN deploy` 3. `abra app deploy YOURAPPDOMAIN`
## License ## License