From 2cfa2510361c9366c968e4e734240cf346290a13 Mon Sep 17 00:00:00 2001 From: stroblme Date: Mon, 12 Oct 2026 21:50:21 +0200 Subject: [PATCH] Docs: getting started mirrors the README quick start Co-Authored-By: Claude Opus 5.5 --- docs/getting-started/facility-automation.md | 29 ++++++++++++--------- 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/docs/getting-started/facility-automation.md b/docs/getting-started/facility-automation.md index 9a7a5de..86db8bb 100644 --- a/docs/getting-started/facility-automation.md +++ b/docs/getting-started/facility-automation.md @@ -33,21 +33,25 @@ all part of the same process, editing the same graph. - Optionally: an MQTT broker and an InfluxDB you already run. If not, the stack can start both for you -## Configure it +## Set it up -Clone the app repository and write its one configuration file: +Clone the app repository and try it on the machine you are sitting at: ```sh git clone https://git.stroblme.de/Fluksio/app.git ~/fluksio cd ~/fluksio -make init # writes .env, generates its secrets, prints the admin login -$EDITOR .env # FIRST_SUPERUSER, ENVIRONMENT=production +make init # once: .env with generated secrets, `proxy` network, prints the admin login +make dev-local # full stack at http://app.localhost (API at http://api.localhost) +make down # stop it ``` -`make init` is safe to run again: it only fills secrets still set to -`changethis`, and `.env` otherwise stays as you left it. +`make dev-local` needs port 80 free and only answers on `localhost`; the +sections below make it reachable from other machines. `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: +For an instance you leave running, edit `.env` first (`FIRST_SUPERUSER`, +`ENVIRONMENT=production`). It is the whole configuration. The four settings that matter on day one: | Setting | What it does | |---|---| @@ -116,14 +120,15 @@ attach it to the `proxy` network and forward `app.${DOMAIN}` → !!! tip "Developing on the same machine" - `make dev-lan` is the same idea for the integrated dev stack: the app on - `http://:8080`, `APP_PORT` to move it. `make dev` rebuilds without - the published port, so re-run `make dev-lan` after one. + `make dev-lan` is `make dev-local` plus the published port: the app on + `http://:8080`, `APP_PORT` to move it. `make dev-local` recreates + the stack without that port, so re-run `make dev-lan` after one. ## Sign in -Open whichever address you chose. You should be looking at Home: an empty brain -graph, a health summary, and a flow list with nothing in it. +Open whichever address you chose (`http://app.localhost` for `make dev-local`) +and sign in with the login `make init` printed. You should be looking at Home: +an empty brain graph, a health summary, and a flow list with nothing in it. ## Your first flow