Merge pull request 'update documentation' (#19) from more-doc into main

Reviewed-on: #19

README.md

@@ -15,24 +15,38 @@ A [coop-cloud](https://coopcloud.tech) recipe for deploying [Bonfire](https://bo
 
 ## Basic usage
 
-1. Set up Docker Swarm and [`abra`]
+1. `abra app new bonfire --secrets`
-2. Deploy [`coop-cloud/traefik`]
+2. `abra app config <app-name>`
-3. `abra app new bonfire --secrets` (optionally with `--pass` if you'd like to save secrets in `pass`) and select your server from the list and enter the domain name you want Bonfire to be served from
+3. `abra app deploy <app-name>`
-4. `abra app config YOUR_APP_DOMAIN_NAME` and check/edit the config keys
+4. Open the Elixir console: `abra app run <app-name> app bin/bonfire remote`
-5. `abra app deploy YOUR_APP_DOMAIN_NAME`
+5. Create admin account in Elixir console (the first account created this way will get admin rights): `Bonfire.Me.make_account_only("my@email.net", "my pw")`
-6. Open the configured domain in your browser and sign up! 
 
-## Upgrades 
+## Use a custom Bonfire flavour
-`abra app deploy --force your-server.domain.name`
 
-NOTE: we recommend switching to the new `sonic` search backend (instead of the deprecated `meilisearch`):
+By default, this recipe deploys the Bonfire `social` flavour. If you want a different one uncomment and define `APP_FLAVOUR` in you env file.
-1. comment the `COMPOSE_FILE` line that contains `compose.meilisearch.yml` in the `.env` file for your bonfire instancem and replace with a line like `COMPOSE_FILE="compose.yml:compose.sonic.yml"`
+
+## Use a custom Bonfire version
+
+Attention: This is not recommended for production deployment!
+
+You can deploy another version of Bonfire by using `APP_VERSION` and `APP_PLATFORM`. Be aware that not all versions might be compatible with this recipe, especially the quite old ones.
+If you want to use bleeding edge releases try setting `APP_VERSION=latest-alpha`. When using this, every time you deploy with `abra app deploy --force <app-name>` the latest alpha replease will be used.
+
+## Using a search backend
+
+1. uncomment the `COMPOSE_FILE` line that contains `compose.sonic.yml` in the `.env` file for your bonfire instance.
 2. add `SONIC_PASSWORD=a-super-secret-password` to the same file (make sure to change the password after pasting!)
-3. redeploy with `abra app deploy --force your-server.domain.name`
+3. redeploy with `abra app deploy --force <app-name>`
 
+## Protect the instance with basic auth
 
-[`abra`]: https://docs.coopcloud.tech/abra/
+For e.g. a testing phase you can protect your Bonfire instance with basic auth:
-[`coop-cloud/traefik`]: https://git.coopcloud.tech/coop-cloud/traefik
+
+1. uncomment the section `## BASIC_AUTH`
+2. create a username/password combination with `echo $(htpasswd -nB <username>)`
+3. add the combination as secret with `abra app secret insert <app-name> usersfile v1 '<the-user-password-combination>'`
+
+## 
 
 ## FAQ
 
@@ -44,3 +58,5 @@ Go into your app's Elixir console and enter something like `Bonfire.Me.make_acco
 
 ### How can I get to the app's Elixir console?
 `abra app run your-server.domain.name app bin/bonfire remote`
+
+For more, see [docs.coopcloud.tech](https://docs.coopcloud.tech).

compose.yml

@@ -49,8 +49,6 @@ services:
       - ENABLE_SSO_PROVIDER
       - OAUTH_ISSUER
 
-      - BONFIRE_CONSOLE_TOKEN
-
       - SECRET_KEY_BASE_FILE=/run/secrets/secret_key_base
       - SIGNING_SALT_FILE=/run/secrets/signing_salt
       - ENCRYPTION_SALT_FILE=/run/secrets/encryption_salt