example/README.md

29 lines
821 B
Markdown
Raw Normal View History

2021-02-08 13:24:14 +00:00
# ${REPO_NAME_TITLE}
2020-09-26 09:12:24 +00:00
${REPO_DESCRIPTION}
<!-- metadata -->
* **Category**:
* **Status**:
* **Image**: [`${REPO_NAME}`](https://hub.docker.com/r/${REPO_NAME}/${REPO_NAME})
* **Healthcheck**:
* **Backups**:
* **Email**:
* **Tests**:
* **SSO**:
<!-- endmetadata -->
2020-09-26 09:12:24 +00:00
## Basic usage
1. Set up Docker Swarm and [`abra`]
2021-01-05 22:00:14 +00:00
2. Deploy [`coop-cloud/traefik`]
3. `abra app new ${REPO_NAME} --secrets` (optionally with `--pass` if you'd like
to save secrets in `pass`)
2021-01-05 22:00:14 +00:00
4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to
2020-09-26 09:12:24 +00:00
your Docker swarm box
2021-01-05 22:00:14 +00:00
5. `abra app YOURAPPDOMAIN deploy`
6. Open the configured domain in your browser to finish set-up
2020-09-26 09:12:24 +00:00
[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
2021-01-05 22:00:14 +00:00
[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik