Follow new exciting README standard

See coop-cloud/organising#31
This commit is contained in:
3wc 2021-03-02 18:38:39 +02:00
parent b88a6061e3
commit 4b242eabc3
1 changed files with 14 additions and 5 deletions

View File

@ -2,16 +2,25 @@
Static site generator • https://github.com/getpelican/pelican/
<!-- metadata -->
* **Category**: Apps
* **Status**: ❷💛
* **Image**: [`3wordchant/pelican`](https://hub.docker.com/r/3wordchant/pelican), ❹💣, own
* **Healthcheck**: No
* **Backups**: No
* **Email**: N/A
* **Tests**: ❷💛
* **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/pelican.git && cd pelican`
3. `cp .envrc.sample .envrc`
4. Edit `.envrc` - be sure to change `DOMAIN` to something that resolves to
3. `abra app new pelican --secrets`
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`
[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
[`compose-stacks/traefik`]: https://git.autonomic.zone/compose-stacks/traefik