From d588d928a10b34b39e1bb0dca4ee40124c887224 Mon Sep 17 00:00:00 2001 From: Krstan Vjestica Date: Thu, 23 Jul 2026 17:13:13 +0200 Subject: [PATCH] docs: fix the Quick Start health check step MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit `./scripts/healthcheck-web.sh` cannot run on the host — the file is not executable and its first command is `forail-manage`, which only exists inside the backend image. The scripts under scripts/ are the container probes Compose mounts at /etc/forail/ and runs there. Point step 4 at `docker compose ps` and document the manual form, `docker compose exec forail-web bash /etc/forail/healthcheck-web.sh`. Both verified against a stack brought up from the documented .env.example. --- CHANGELOG.md | 8 ++++++++ README.md | 10 +++++++++- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 33097ee..1c391a9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,14 @@ and the project adheres to CalVer (`YYYY.MM.PATCH`). ## [Unreleased] +### Fixed +- **Quick Start health check.** Step 4 told you to run `./scripts/healthcheck-web.sh` + on the host, where it fails: the file is not executable and calls `forail-manage`, + which exists only inside the backend image. Those scripts are the *container* + probes Compose mounts at `/etc/forail/`. The README now points at + `docker compose ps` and, for a manual run, + `docker compose exec forail-web bash /etc/forail/healthcheck-web.sh`. + ### Added - AWX → Forail migration importer (`forail-manage import_from_awx`) — see the backend changelog and `forail-deploy/docs/RELEASE_NOTES_v2026.07.0.md`. diff --git a/README.md b/README.md index 274d831..0c62826 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,15 @@ cp .env.example .env docker compose up -d # 4. Check health -./scripts/healthcheck-web.sh +docker compose ps # every service should report (healthy) +``` + +The scripts under `scripts/` are the container health probes — Compose mounts +them into the containers and runs them there (`bash /etc/forail/healthcheck-web.sh`), +so they call `forail-manage` and only work inside the image. Run one by hand with: + +```bash +docker compose exec forail-web bash /etc/forail/healthcheck-web.sh && echo healthy ``` ## Architecture