From 91e0178b6a73689f98724c8daa18c1fe8e0da94e Mon Sep 17 00:00:00 2001 From: 3wc <3wc.git@doesthisthing.work> Date: Tue, 2 Mar 2021 18:38:37 +0200 Subject: [PATCH] Follow new exciting README standard See coop-cloud/organising#31 --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 82d3cb0..63f8f40 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,27 @@ Matomo analytics + CoöpCloud + +* **Category**: Apps +* **Status**: ❸🍎 +* **Image**: [`matomo`](https://hub.docker.com/_/matomo), ❶💚, upstream +* **Healthcheck**: Yes +* **Backups**: No +* **Email**: No +* **Tests**: ❷💛 +* **SSO**: No + + +## Basic usage + 1. Set up Docker Swarm and [`abra`][abra] -2. Deploy [`compose-stacks/traefik`][compose-traefik] -2. `cp .envrc.sample .envrc` -3. Edit `.envrc` - be sure to change `$DOMAIN` to something that resolves to +2. Deploy [`coop-cloud/traefik`][cc-traefik] +3. `abra app new matomo --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 -4. `direnv allow` (or `. .envrc`) -5. Generate secrets: - ``` - abra secret_generate db_password v1 - abra secret_generate db_root_password v1 - ``` -6. `abra deploy` -7. Open the configured domain to finish set-up +5. `abra app YOURAPPDOMAIN deploy` +6. Open the configured domain to finish set-up [abra]: https://git.autonomic.zone/autonomic-cooperative/abra [compose-traefik]: https://git.autonomic.zone/compose-stacks/traefik