From dd91954a210e51a2ef9fba960ef2192f768788b7 Mon Sep 17 00:00:00 2001 From: stroblme Date: Mon, 12 Oct 2026 21:41:39 +0200 Subject: [PATCH] Docs: make init in the setup steps --- development.md | 5 ++++- docs/getting-started/facility-automation.md | 7 +++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/development.md b/development.md index 518ad22..01348e7 100644 --- a/development.md +++ b/development.md @@ -15,7 +15,10 @@ root `.env` — change it there and re-run `make init`. `app/Makefile` takes tha default only (`export DOMAIN ?= …`), so `make dev DOMAIN=…` overrides it and the override reaches the recipes. -**App only.** `cd app && make dev` starts this stack on its own Traefik with all host ports +**App only.** In a bare clone of this repo, `make init` once (`.env` from `.env.example` +with generated secrets, the `proxy` docker network, prints the admin login), then +`make dev-local` serves the stack detached at `http://app.localhost` behind Traefik on +port 80. `make dev` starts this stack on its own Traefik with all host ports published, in the foreground. `make dev-utils` starts just proxy and mailcatcher — the useful half when the backend runs on the host. diff --git a/docs/getting-started/facility-automation.md b/docs/getting-started/facility-automation.md index 697b62f..9a7a5de 100644 --- a/docs/getting-started/facility-automation.md +++ b/docs/getting-started/facility-automation.md @@ -40,17 +40,20 @@ Clone the app repository and write its one configuration file: ```sh git clone https://git.stroblme.de/Fluksio/app.git ~/fluksio cd ~/fluksio -cp .env.example .env +make init # writes .env, generates its secrets, prints the admin login $EDITOR .env # FIRST_SUPERUSER, ENVIRONMENT=production ``` +`make init` is safe to run again: it only fills secrets still set to +`changethis`, and `.env` otherwise stays as you left it. + `.env` is the whole configuration. The four settings that matter on day one: | Setting | What it does | |---|---| | `DOMAIN` | the hostname everything is served under, if you use one. Left alone it only names the issuer that agents authenticate against | | `FIRST_SUPERUSER` | the account you sign in with | -| `FIRST_SUPERUSER_PASSWORD` | leave it as `changethis` and one is generated for you | +| `FIRST_SUPERUSER_PASSWORD` | generated by `make init`; it prints it, and it stays in `.env` | | `ENVIRONMENT` | `production` closes the interactive API schema; `local` leaves it open | Everything the instance owns (the database, your flows, secrets, artifacts,