From c00d5b4a167420954ce2f52615320dade5231682 Mon Sep 17 00:00:00 2001 From: stevensting Date: Tue, 4 Aug 2026 15:51:30 +0200 Subject: [PATCH 1/2] add documentation --- README.md | 42 +++++++++++++++++++++++++++++------------- 1 file changed, 29 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e8eaf27..f19d679 100644 --- a/README.md +++ b/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`] -2. Deploy [`coop-cloud/traefik`] -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 -4. `abra app config YOUR_APP_DOMAIN_NAME` and check/edit the config keys -5. `abra app deploy YOUR_APP_DOMAIN_NAME` -6. Open the configured domain in your browser and sign up! +1. `abra app new bonfire --secrets` +2. `abra app config ` +3. `abra app deploy ` +4. Open the elixi console: `abra app run app bin/bonfire remote` +5. Create admin account in Elixir console: `Bonfire.Me.make_account_only("my@email.net", "my pw")` -## Upgrades -`abra app deploy --force your-server.domain.name` +## Use a custom Bonfire flavour -NOTE: we recommend switching to the new `sonic` search backend (instead of the deprecated `meilisearch`): -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"` +By default, this recipe deploys the Bonfire `social` flavour. If you want a different one uncomment and define `APP_FLAVOUR` in you env file. + +## 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 ` 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 ` +## Protect the instance with basic auth -[`abra`]: https://docs.coopcloud.tech/abra/ -[`coop-cloud/traefik`]: https://git.coopcloud.tech/coop-cloud/traefik +For e.g. a testing phase you can protect your Bonfire instance with basic auth: + +1. uncomment the section `## BASIC_AUTH` +2. create a username/password combination with `echo $(htpasswd -nB )` +3. add the combination as secret with `abra app secret insert usersfile v1 ''` + +## ## 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). \ No newline at end of file -- 2.52.0 From 919455212a4b3248eb5c4288893d63c00ccfb919 Mon Sep 17 00:00:00 2001 From: stevensting <156+stevensting@noreply.git.coopcloud.tech> Date: Wed, 5 Aug 2026 08:50:24 +0000 Subject: [PATCH 2/2] refine admin account creation --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f19d679..4006313 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,8 @@ A [coop-cloud](https://coopcloud.tech) recipe for deploying [Bonfire](https://bo 1. `abra app new bonfire --secrets` 2. `abra app config ` 3. `abra app deploy ` -4. Open the elixi console: `abra app run app bin/bonfire remote` -5. Create admin account in Elixir console: `Bonfire.Me.make_account_only("my@email.net", "my pw")` +4. Open the Elixir console: `abra app run app bin/bonfire remote` +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")` ## Use a custom Bonfire flavour -- 2.52.0