You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,15 @@
2
2
3
3
All notable changes to SentinelID are documented in this file.
4
4
5
+
## v2.6.0 (2026-03-07)
6
+
7
+
### DX and Docs Consolidation
8
+
- Advanced the SentinelID release line to `v2.6.0` across release-critical docs, Make help text, desktop package/config metadata, pilot evidence targets, and cloud API metadata.
9
+
- Added canonical Make wrappers for developer setup and doc validation (`make install-dev`, `make check-version-consistency`, `make check-docs-consistency`, `make check-fresh-clone`) so local and CI guidance can point to one command set.
10
+
- Rewrote the runbook beginner path around `make install-dev`, `make demo-up`, `make demo-verify`, `make demo`, and `make demo-down`, and updated `.env.example` with dev-safe admin auth defaults so fresh clones no longer require manual env debugging.
11
+
- Added `scripts/release/check_docs_consistency.sh` to fail `make release-check` when key docs drift back to raw script invocations, obsolete env var names, or legacy phase-doc clutter.
12
+
- Created `docs/archive/` policy guidance and added coverage that root `docs/` stays free of `phase*.md` files.
Copy file name to clipboardExpand all lines: RUNBOOK.md
+48-22Lines changed: 48 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# SentinelID Runbook (v2.5.0)
1
+
# SentinelID Runbook (v2.6.0)
2
2
3
3
This is the single source of truth for local setup, run, and validation.
4
4
@@ -9,10 +9,9 @@ This is the single source of truth for local setup, run, and validation.
9
9
- Node.js 18+
10
10
- Rust toolchain (Tauri)
11
11
- Docker + `docker compose`
12
+
- Poetry 1.8.x
12
13
13
-
## Install Poetry (pipx, PEP 668-safe)
14
-
15
-
On macOS with Homebrew Python, install Poetry via `pipx`:
14
+
Install Poetry with `pipx` on macOS/Homebrew Python:
16
15
17
16
```bash
18
17
brew install pipx
@@ -23,19 +22,44 @@ poetry --version
23
22
24
23
If `poetry` is not on your PATH yet, restart your shell.
25
24
25
+
## Getting Started
26
+
27
+
The deterministic beginner path is:
28
+
29
+
```bash
30
+
git clone <repo-url>
31
+
cd SentinelID
32
+
make install-dev
33
+
cp .env.example .env
34
+
make demo-up
35
+
make demo-verify
36
+
DEMO_AUTO_CLOSE_SECONDS=30 make demo
37
+
make demo-down
38
+
```
39
+
40
+
What this does:
41
+
42
+
-`make install-dev` installs edge, desktop, and admin dependencies from lockfiles.
43
+
-`cp .env.example .env` gives you a dev-safe local config with matching admin credentials (`admin` / `admin123!`) and no manual secret generation.
44
+
-`make demo-up` starts postgres, cloud, and admin and waits for health.
45
+
-`make demo-verify` checks the non-interactive beginner path and is the canonical CI/headless command.
46
+
-`make demo` launches the desktop flow for the interactive walkthrough. Use `DEMO_AUTO_CLOSE_SECONDS` when you want a scripted close.
47
+
-`make demo-down` tears down the stack.
48
+
49
+
If you only want the non-interactive validation path, stop after `make demo-verify` and run `make demo-down`.
50
+
26
51
## Environment
27
52
28
53
```bash
29
54
cp .env.example .env
30
55
```
31
56
32
-
Required values:
57
+
`.env.example` is intentionally runnable for local development. Copy it as-is unless you are testing a non-default configuration.
58
+
59
+
Canonical environment names:
33
60
34
-
-`EDGE_AUTH_TOKEN`
35
-
-`ADMIN_API_TOKEN`
36
-
-`ADMIN_UI_USERNAME`
37
-
-`ADMIN_UI_PASSWORD_HASH` (bcrypt hash for non-Docker runs; keep bcrypt values single-quoted in `.env`) or `ADMIN_UI_PASSWORD_HASH_B64` (recommended for Docker Compose)
38
-
-`ADMIN_UI_SESSION_SECRET`
61
+
-`ADMIN_API_TOKEN` is the source-of-truth admin credential in `.env`, Docker Compose, and docs.
62
+
-`EDGE_AUTH_TOKEN` protects loopback admin/bearer endpoints on edge.
39
63
- In `EDGE_ENV=prod`, device and master-key initialization require OS keychain access by default. Use `ALLOW_KEYCHAIN_FALLBACK=1` only for controlled debugging when fallback storage is unavoidable.
0 commit comments