docs(install): fix AI-INSTALL.md drift against current compose and scripts - #577
Merged
Conversation
Audit of docs/AI-INSTALL.md against docker-compose*.yml, scripts/setup-env.sh, .env.example, the wizard, and the API surface. Fixes the points that had drifted: - Step 5 Verify: caddy carries no healthcheck, so 'all services running/healthy' can stall an agent waiting for caddy to turn healthy. Name the three services that do report healthy and say caddy only ever shows running. - Step 8: setup-env.sh prepares whatever DB_BACKUP_HOST_PATH points at (accepted as an env var, like MEDIA_HOST_PATH), not only the default ./backups dir. - LPR section: repair the unclosed bold in '(**Users & Security)' and match the console's 'Users & security' naming. - Maintainers blind-spot note updated to match the Step 5 fix. - Replace the three en-dash numeric ranges with hyphens. Everything else in the runbook checked out against the code: MOTION_HWACCEL=cpu default, the auto cuda probe, GO2RTC_AUTH posture, the storage-preflight verdicts and exit behavior, the wizard step list, the system-alert set, alert templates, per-channel snapshot modes, the backup job, ports/profiles, and the smoke coverage. Signed-off-by: badbread <badbread@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Full accuracy audit of
docs/AI-INSTALL.mdagainst the current compose files,scripts/setup-env.sh,.env.example, the migrations (through 0080), the wizard (WIZARD_ALL_STEPS), and the API surface. Most of the runbook checked out; this fixes the four points that had drifted.Fixed
running/healthy", butcaddyhas no healthcheck indocker-compose.ymland only ever shows plainrunning. The Verify now names which services reporthealthy(postgres, recorder, api) and says outright not to wait for caddy. The "For maintainers" blind-spot note is updated to match.setup-env.sh. The script prepares whateverDB_BACKUP_HOST_PATHpoints at (accepted as an env var,DB_BACKUP_HOST_PATH=/mnt/nas/crumb-backups scripts/setup-env.sh, same asMEDIA_HOST_PATH), not just the default./backupsdir. The doc said "prepares the default dir".(**Users & Security)had an unclosed bold; also matched the console's actual "Users & security" naming.Verified as already accurate (no churn)
Checked claim-by-claim and left alone:
MOTION_HWACCEL=cpudefault (compose +.env.example+ Step 1/4/6b/troubleshooting), theautocuda probe (decode_probe.rs, 15s deadline, cached, per-worker CPU demotion),GO2RTC_AUTHposture and warnings, the storage-preflight three verdicts and deferredexit 1plus the early hard-fail on missingcaddy/Caddyfile/go2rtc/go2rtc.yaml,--forcesecret rotation warning, the wizard step list and step 5/6 changes (Add a camera by address, per-row Rescan, suffixed-name conflict retry, grouping moved out of the wizard, "Server default" decode option), the full 15-key system-alert set, alert-text templates and their tokens (0079), per-channelsnapshot_modenone/plate/vehicle/both with the exact provider image caps and the legacyinclude_snapshotmapping (0080), the backup job (03:15, boot catch-up,daily/, "database backup written"), ports/binds/profiles including mosquitto on127.0.0.1:1883, discovery's 60s cap and 500-8000timeout_msclamp, thePUT /config/servermerge semantics, the smoke script/workflow triggers, and every endpoint and file anchor in the maintainers list.No em-dashes or en-dashes remain; no RFC1918 addresses (examples use RFC 5737
198.51.100.x); all referenced repo and docs-site paths resolve.