mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-08 20:42:43 +00:00
The lifecycle surface under /api/account. An owner offers read access to somebody already on the instance, the delegate accepts, either side ends it, and a browser session points itself at a record it has been granted. Ending a grant clears the acting-account carrier on every session of the delegate pointing at that record, in the same transaction that stamps the row. Split apart, a revocation would leave a browser inside a record it can no longer read: every request refused, the banner still naming the owner, nothing on screen able to explain it. Revocation has no step-up and no confirmation step. Reducing access must never be harder than granting it was. Grant management is non-delegable by construction rather than by a check: every route here resolves through bare requireAuth(), which refuses while the caller is acting on another account, so no code path through them runs as somebody else. The switch endpoint is the one actor surface, and it is the way back out. A delegate already inside a record renounces after switching out, one request, rather than the fail-closed default growing an exception that later gets widened. The state machine is not re-implemented anywhere: routes call the grant module's predicate and its transitions, and the session carrier has one writer.
docs/ — internal reference + operator playbooks
The user-facing documentation lives at https://docs.healthlog.dev — that's the canonical surface for self-hosting guides, integration walkthroughs, AI-provider setup, and the doctor-report workflow.
The files in this directory are the internal operator playbooks, audit notes, and machine-readable specs that ship alongside the source:
api/— the OpenAPI 3.1 spec for the native-client subset (iOS DTO codegen target). Seeapi/README.mdfor the preview commands. Also home to the MCP-server contract:api/mcp-capabilities.md(tools, resources, prompts, write model) andapi/mcp-skills.md(building a connector / skill).ops/— backup / restore + encryption-key-rotation playbooks. These are the runbooks an operator reaches for during an incident.self-hosting/— horizontal-scaling notes (HEALTHLOG_PROCESS_TYPE=web|worker|all) and the deploy-pipeline recipe. Routine install steps stay ondocs.healthlog.dev. Includesself-hosting/mcp.md— enabling the off-by-default MCP connector and pointing Claude.ai / ChatGPT / Claude Desktop at it, andself-hosting/sso.md— OIDC SSO login: IdP setup, the identity-pinning security model,OIDC_ONLYconsequences, and the break-glass runbook. Alsoself-hosting/geolite2.md— bringing your own offline GeoLite2 databases viaGEOLITE2_DIRinstead of sending login IPs to a third-party lookup.migration/— release-by-release migration notes. Read the entry for the version you're upgrading from.audit/— per-release audit summaries archived for forensic traceability.apple-store-connect-checklist.md— the iOS submission gate.doctor-report.md— PDF generator design notes.codex-protocol-spec.md— Codex / ChatGPT OAuth protocol reverse-engineering notes.ui-guidelines.md— UI / a11y house style.
If you're a self-hoster looking to spin up an instance, start at https://docs.healthlog.dev or jump to the Quick Start in the project README.