Follow new exciting README standard

See coop-cloud/organising#31
This commit is contained in:
3wc 2021-03-02 18:38:34 +02:00
parent 8a9237d565
commit d8352ac7bd
1 changed files with 20 additions and 7 deletions

View File

@ -2,16 +2,29 @@
web server index • https://github.com/lrsjng/h5ai
<!-- metadata -->
* **Category**: Apps
* **Status**: ❸🍎
* **Image**: [`michaeljefferys/docker-h5ai`](https://hub.docker.com/r/michaeljefferys/docker-h5ai), ❸🍎, 3rd-party
* **Healthcheck**: Yes
* **Backups**: No
* **Email**: N/A
* **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/h5ai.git && cd h5ai`
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]
2. Deploy [`coop-cloud/traefik`][cc-traefik]
3. `abra app new h5ai`
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. Copy your files to the container, using something like
```
abra app YOURAPPDOMAIN cp foo.mp4 app:/var/www
```
[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
[`compose-stacks/traefik`]: https://git.autonomic.zone/compose-stacks/traefik