From f2225be2333004bffe111a7d4a460206205b0a10 Mon Sep 17 00:00:00 2001 From: 3wc <3wc.git@doesthisthing.work> Date: Tue, 2 Mar 2021 18:38:45 +0200 Subject: [PATCH] Follow new exciting README standard See coop-cloud/organising#31 --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e09fa64..fc58c71 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,28 @@ -# wordpress +# Wordpress [![Build Status](https://drone.autonomic.zone/api/badges/coop-cloud/wordpress/status.svg)](https://drone.autonomic.zone/coop-cloud/wordpress) Coรถp Cloud + [Wordpress](https://wordpress.org) = ๐Ÿฅณ + +* **Category**: Apps +* **Status**: โถ๐Ÿ’š +* **Image**: [`wordpress`](https://hub.docker.com/_/wordpress), โถ๐Ÿ’š, upstream +* **Healthcheck**: Yes +* **Backups**: Yes +* **Email**: โถ๐Ÿ’š +* **Tests**: โท๐Ÿ’› +* **SSO**: No + + +## Basic usage + 1. Set up Docker Swarm and [`abra`][abra] 2. Deploy [`coop-cloud/traefik`][cc-traefik] -3. `abra app new wordpress` +3. `abra app new wordpress --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. `abra app YOURAPPDOMAIN secret auto` (optionally with `--pass` if you'd like - to save secrets in `pass`). 6. `abra app YOURAPPDOMAIN deploy` 7. Open the configured domain in your browser to finish set-up 8. `abra app YOURAPPDOMAIN run app chown www-data:www-data /var/www/html/wp-content` to fix @@ -41,7 +53,7 @@ _(Only tested using subdomains)_ `abra app YOURAPPDOMAIN cp ~/path/to/local/theme wordpress:/var/www/html/wp-content/themes/` -## Backups +## Backups (using backup-bot) 1. `abra app YOURAPPDOMAIN config`, and uncomment the `export COMPOSE_FILE="compose.yml:compose.backup.yml"` line 2. `abra app YOURAPPDOMAIN deploy` @@ -56,4 +68,4 @@ _(Only tested using subdomains)_ [abra]: https://git.autonomic.zone/autonomic-cooperative/abra [cc-traefik]: https://git.autonomic.zone/coop-cloud/traefik -[cc-postfix-relax]: https://git.autonomic.zone/coop-cloud/traefik +[cc-postfix-relay]: https://git.autonomic.zone/coop-cloud/traefik