Follow new exciting README standard

See coop-cloud/organising#31
This commit is contained in:
3wc 2021-03-02 18:38:43 +02:00
parent 65007b30bb
commit 64f622901c
1 changed files with 20 additions and 7 deletions

View File

@ -2,16 +2,29 @@
Statuspal lets you communicate your web apps/services status • https://github.com/statuspal/statuspal/
<!-- metadata -->
* **Category**: Graveyard
* **Status**: ❹💣
* **Image**: [`statuspal/statuspal`](https://hub.docker.com/r/statuspal/statuspal), ❶💚, upstream
* **Healthcheck**: No
* **Backups**: No
* **Email**: No
* **Tests**: No
* **SSO**: No
<!-- endmetadata -->
## 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