From adf19b96e19451e9450f9f25405843a517883402 Mon Sep 17 00:00:00 2001 From: Mac Chaffee Date: Tue, 9 Sep 2025 18:43:45 -0400 Subject: [PATCH] doc: expand README --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9dc8167..c9a8c2e 100644 --- a/README.md +++ b/README.md @@ -19,17 +19,28 @@ 1. Set up Docker Swarm and `abra` 2. Deploy `coop-cloud/traefik` -3. `abra app new writefreely --secrets` (optionally with `--pass` if you'd like - to save secrets in `pass`) +3. `abra app new writefreely` 4. `abra app config ` - be sure to change `` to something that resolves to your Docker swarm box 5. `abra app deploy ` -6. Open the configured domain in your browser to finish set-up +6. Once it's running, if you are not using SSO, set up a local admin user by running this command: + +``` +abra app run app -- ./cmd/writefreely/writefreely user create --admin : +``` ## Keycloak setup For the **OAUTH_HOST** config, it uses this format: `https://keycloak.domain.here/auth/realms//protocol/openid-connect`. +## MariaDB + +By default, this recipe uses sqlite. If you wish to use MariaDB instead: + +1. When creating the app, you need the `--secrets` flag: `abra app new writefreely --secrets` +2. Run `abra app config ` and follow the instructions to uncomment four lines. +3. `abra app deploy ` + ## Acknowledgements Thanks to [@knoflook](https://git.coopcloud.tech/knoflook) for packaging work :heart: