From 64f622901c0727c629d06a3aa5fd1c88803c91b2 Mon Sep 17 00:00:00 2001 From: 3wc <3wc.git@doesthisthing.work> Date: Tue, 2 Mar 2021 18:38:43 +0200 Subject: [PATCH] Follow new exciting README standard See coop-cloud/organising#31 --- README.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index eea6414..43a224c 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,29 @@ Statuspal lets you communicate your web apps/services status β€’ https://github.com/statuspal/statuspal/ + +* **Category**: Graveyard +* **Status**: βΉπŸ’£ +* **Image**: [`statuspal/statuspal`](https://hub.docker.com/r/statuspal/statuspal), βΆπŸ’š, upstream +* **Healthcheck**: No +* **Backups**: No +* **Email**: No +* **Tests**: No +* **SSO**: No + + ## Basic usage -1. Set up Docker Swarm and [`abra`] -2. Deploy [`compose-stacks/traefik`] -3. `git clone https://git.autonomic.zone/coop-cloud/statuspal.git && cd statuspal` -3. `cp .envrc.sample .envrc` -4. Edit `.envrc` - be sure to change `DOMAIN` to something that resolves to +1. Set up Docker Swarm and [`abra`][abra] + +1. Set up Docker Swarm and [`abra`][abra] +2. Deploy [`coop-cloud/traefik`][cc-traefik] +3. `abra app new statuspal --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. `direnv allow` (or `. .envrc`) -6. `abra deploy` +5. `abra app YOURAPPDOMAIN deploy` +6. Open the configured domain to finish set-up [`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra [`compose-stacks/traefik`]: https://git.autonomic.zone/compose-stacks/traefik