generated from coop-cloud/example
doc: expand README
This commit is contained in:
17
README.md
17
README.md
@ -19,17 +19,28 @@
|
|||||||
|
|
||||||
1. Set up Docker Swarm and `abra`
|
1. Set up Docker Swarm and `abra`
|
||||||
2. Deploy `coop-cloud/traefik`
|
2. Deploy `coop-cloud/traefik`
|
||||||
3. `abra app new writefreely --secrets` (optionally with `--pass` if you'd like
|
3. `abra app new writefreely`
|
||||||
to save secrets in `pass`)
|
|
||||||
4. `abra app config <domain>` - be sure to change `<domain>` to something that resolves to
|
4. `abra app config <domain>` - be sure to change `<domain>` to something that resolves to
|
||||||
your Docker swarm box
|
your Docker swarm box
|
||||||
5. `abra app deploy <domain>`
|
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
|
## Keycloak setup
|
||||||
|
|
||||||
For the **OAUTH_HOST** config, it uses this format: `https://keycloak.domain.here/auth/realms/<your realm>/protocol/openid-connect`.
|
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
|
## Acknowledgements
|
||||||
|
|
||||||
Thanks to [@knoflook](https://git.coopcloud.tech/knoflook) for packaging work :heart:
|
Thanks to [@knoflook](https://git.coopcloud.tech/knoflook) for packaging work :heart:
|
||||||
|
Reference in New Issue
Block a user