Follow new exciting README standard

See coop-cloud/organising#31
This commit is contained in:
3wc 2021-03-02 18:38:30 +02:00
parent 879fb8c550
commit 375f32a1e9
1 changed files with 18 additions and 8 deletions

View File

@ -1,17 +1,27 @@
# Civicrm-Backdrop
# CiviCRM-Backdrop
CiviCRM with Backdrop CMS
<!-- metadata -->
* **Category**: Apps
* **Status**: ❹💣
* **Image**: ?
* **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/civicrm-backdrop.git && cd civicrm-backdrop`
3. `cp .envrc.sample .envrc`
4. Edit `.envrc` - be sure to change `DOMAIN` to something that resolves to
2. Deploy [`coop-cloud/traefik`]
3. `abra app new civicrm-backdrop --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`
6. Open the configured domain in your browser to finish set-up
[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
[`compose-stacks/traefik`]: https://git.autonomic.zone/compose-stacks/traefik
[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik