coop-cloud/writefreely
1
0
Fork 0
generated from coop-cloud/example
Code Issues 1 Pull Requests Projects Releases Wiki Activity

doc: expand README

Browse Source
This commit is contained in:
Mac Chaffee
2025-09-09 18:43:45 -04:00
parent 92846b4226
commit adf19b96e1
1 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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 <domain>` - be sure to change `<domain>` to something that resolves to
your Docker swarm box
5. `abra app deploy <domain>`
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 <domain> app -- ./cmd/writefreely/writefreely user create --admin <some-username>:<some-password>
```
## Keycloak setup
For the **OAUTH_HOST** config, it uses this format: `https://keycloak.domain.here/auth/realms/<your realm>/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 <domain>` and follow the instructions to uncomment four lines.
3. `abra app deploy <domain>`
## Acknowledgements
Thanks to [@knoflook](https://git.coopcloud.tech/knoflook) for packaging work :heart: