Compare commits

..

5 Commits

Author SHA1 Message Date
6d1b370cde merge upstream
All checks were successful
continuous-integration/drone/pr Build is passing
2026-06-03 20:16:22 +00:00
c5fb2ebaf3 Improve readme 2026-06-03 21:15:54 +01:00
a34d7af280 revert 12d1e4e371
All checks were successful
continuous-integration/drone/push Build is passing
revert Merge pull request 'Improved README' (#68) from improve-readme into main

So sorry, that was a mistake!

Reviewed-on: #68
2026-06-03 20:14:21 +00:00
12d1e4e371 Merge pull request 'Improved README' (#68) from improve-readme into main
All checks were successful
continuous-integration/drone/push Build is passing
Reviewed-on: #68
2026-06-03 20:13:38 +00:00
8407a00942 Improved README
All checks were successful
continuous-integration/drone/pr Build is passing
2026-06-03 21:12:32 +01:00
2 changed files with 44 additions and 47 deletions

View File

@ -4,7 +4,7 @@ name: test
steps:
- name: test
image: alpine:3.23
image: alpine:3.21
environment:
SHELLCHECK_OPTS: -s bash
commands:

View File

@ -13,57 +13,18 @@ Coöp Cloud + [Wordpress](https://wordpress.org) = 🥳
* **Backups**: Yes
* **Email**: 3
* **Tests**: 2
* **SSO**: No
* **SSO**: 2
<!-- endmetadata -->
## Quick start
* `abra app new wordpress`
* `abra app config <app-name>`
* `abra app secret generate -a <app-name>`
* `abra app deploy <app-name>`
* `abra app cmd <app-name> app core_install`
### Authentik Integration
`abra app config <app-name>`
Configure the following envs:
```
COMPOSE_FILE="$COMPOSE_FILE:compose.authentik.yml"
AUTHENTIK_DOMAIN=authentik.example.com
AUTHENTIK_SECRET_NAME=authentik_example_com_wordpress_secret_v1 # the same as in authentik
AUTHENTIK_ID_NAME=authentik_example_com_wordpress_id_v1 # the same as in authentik
```
`abra app cmd <app-name> app set_authentik`
## Running WP-CLI
You can either run using `abra app cmd`:
`abra app cmd <app-name> app wp -- core check-update --major`
Or by entering the app shell:
1. `abra app run <app-name> app bash`
2. `su -s /bin/bash www-data -c "wp core check-update --major"`
## Network (Multi-site)
1. Set up as above
2. `abra app config <app-name>`, and uncomment `#MULTISITE=enable`
3. `abra app deploy <app-name>`
4. Log into the Wordpress admin dashboard, go to Tools » Network Setup
5. Don't worry about the suggested file changes
6. `abra app config <app-name>` again and set `MULTISITE` to either `subdomain` or `subfolder` depending on your setup.
7. `abra app deploy <app-name>`
## Installing a custom theme
`abra app cp <app-name> ~/path/to/local/theme wordpress:/var/www/html/wp-content/themes/`
## Email
There is a local or remote SMTP relay configuration available.
@ -79,9 +40,46 @@ Below are the instructions for the local relay.
`$DOMAIN` or in its `$EXTRA_SENDER_DOMAINS`
3. `abra app deploy <app-name>`
## WP-CLI
You can either run using `abra app cmd`:
```bash
abra app cmd <app-name> app wp -- core check-update --major
```
Or by entering the app shell:
1. `abra app run <app-name> app bash`
2. `su -s /bin/bash www-data -c "wp core check-update --major"`
## Network (Multi-site)
1. Set up as above
2. `abra app config <app-name>`, and uncomment `#MULTISITE=enable`
3. `abra app deploy <app-name>`
4. Log into the WordPress admin dashboard, go to **Tools → Network Setup**
5. Don't worry about the suggested file changes
6. `abra app config <app-name>` again and set `MULTISITE` to either `subdomain` or `subfolder` depending on your setup.
7. `abra app deploy <app-name>`
## Installing a custom theme
`abra app cp <app-name> ~/path/to/local/theme wordpress:/var/www/html/wp-content/themes/`
## Authentik Integration
Configure the following envs via `abra app config <app-name>`:
```bash
COMPOSE_FILE="$COMPOSE_FILE:compose.authentik.yml"
AUTHENTIK_DOMAIN=authentik.example.com
AUTHENTIK_SECRET_NAME=authentik_example_com_wordpress_secret_v1 # the same as in authentik
AUTHENTIK_ID_NAME=authentik_example_com_wordpress_id_v1 # the same as in authentik
```
`abra app cmd <app-name> app set_authentik`
## Tests
Run the full test suite:
Run the full test suite for this repository:
```sh
bash tests/run.sh
@ -96,11 +94,9 @@ brew install shellcheck gomplate
```
Some tests skip gracefully if their dependencies are missing.
[abra]: https://git.autonomic.zone/autonomic-cooperative/abra
## Migrate from a non-Co-op Cloud WordPress install
## Migrate from a non-Co-op Cloud Wordpress install
Make a .tar.gz backup of the site's wp-content dir and an .sql.gz backup of the database.
Make a `.tar.gz` backup of the site's `wp-content` dir and a `.sql.gz` backup of the database.
1. `abra app wp.example.com restore app wp-content.tar.gz`
2. `abra app wp.example.com restore db wordpress.sql.gz`
@ -108,5 +104,6 @@ Make a .tar.gz backup of the site's wp-content dir and an .sql.gz backup of the
Lastly, if there's a domain name change, run a search and replace:
`abra app wp.example.com wp "search-replace https://old.example.com https://wp.example.com"`
[abra]: https://git.autonomic.zone/autonomic-cooperative/abra
[cc-traefik]: https://git.autonomic.zone/coop-cloud/traefik
[cc-postfix-relay]: https://git.autonomic.zone/coop-cloud/traefik
[cc-postfix-relay]: https://git.autonomic.zone/coop-cloud/postfix-relay