mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-08 12:32:43 +00:00
Marc-André Bombeck
f574e63368
An operator page for the feature, written in the register the reproductive-health page established: say the narrow true thing rather than the reassuring one. What the person given access can reach, and the table of what they cannot — credentials, sessions, tokens, connected services, notification channels, exports, share links, the sharing itself, and the AI surfaces. The AI row gets its own paragraph because it is the one that looks arbitrary: server-managed processing runs under the consent the record's owner gave for their own use. Revocation is described honestly. It lands on the next request rather than the next login, it puts a browser that was inside the record back into its own account, and it cannot take back what was already seen. The product can close the door; it cannot reach through it, and the page says so rather than implying otherwise. The activity view's window is described as the operator's setting, not as 365 — an instance that shortens the audit retention shortens this view, and an empty list means nothing was recorded within the window rather than that nothing ever happened. The three trust facts stay where they were: the operator could always read the database, encryption at rest is instance-keyed rather than per-user, and AI processing stays under the owner's own consent. The data-protection note is deliberately absent — its stance is a maintainer decision, and the page reads complete without it.
50 lines
2.7 KiB
Markdown
50 lines
2.7 KiB
Markdown
# `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/`](./api/) — the OpenAPI 3.1 spec for the native-client subset
|
|
(iOS DTO codegen target). See [`api/README.md`](./api/README.md) for
|
|
the preview commands. Also home to the MCP-server contract:
|
|
[`api/mcp-capabilities.md`](./api/mcp-capabilities.md) (tools,
|
|
resources, prompts, write model) and
|
|
[`api/mcp-skills.md`](./api/mcp-skills.md) (building a connector / skill).
|
|
- [`ops/`](./ops/) — backup / restore + encryption-key-rotation
|
|
playbooks. These are the runbooks an operator reaches for during an
|
|
incident.
|
|
- [`self-hosting/`](./self-hosting/) — horizontal-scaling notes
|
|
(`HEALTHLOG_PROCESS_TYPE=web|worker|all`) and the deploy-pipeline
|
|
recipe. Routine install steps stay on `docs.healthlog.dev`. Includes
|
|
[`self-hosting/mcp.md`](./self-hosting/mcp.md) — enabling the
|
|
off-by-default MCP connector and pointing Claude.ai / ChatGPT /
|
|
Claude Desktop at it, and [`self-hosting/sso.md`](./self-hosting/sso.md)
|
|
— OIDC SSO login: IdP setup, the identity-pinning security model,
|
|
`OIDC_ONLY` consequences, and the break-glass runbook. Also
|
|
[`self-hosting/geolite2.md`](./self-hosting/geolite2.md) — bringing your
|
|
own offline GeoLite2 databases via `GEOLITE2_DIR` instead of sending
|
|
login IPs to a third-party lookup. And
|
|
[`self-hosting/account-sharing.md`](./self-hosting/account-sharing.md) —
|
|
letting one account on the instance open another's health record: what
|
|
the person given access can and cannot reach, what revocation does and
|
|
does not undo, and which trust properties of the instance are unchanged
|
|
by it.
|
|
- [`migration/`](./migration/) — release-by-release migration notes.
|
|
Read the entry for the version you're upgrading from.
|
|
- [`audit/`](./audit/) — per-release audit summaries archived for
|
|
forensic traceability.
|
|
- [`apple-store-connect-checklist.md`](./apple-store-connect-checklist.md)
|
|
— the iOS submission gate.
|
|
- [`doctor-report.md`](./doctor-report.md) — PDF generator design
|
|
notes.
|
|
- [`codex-protocol-spec.md`](./codex-protocol-spec.md) — Codex / ChatGPT
|
|
OAuth protocol reverse-engineering notes.
|
|
- [`ui-guidelines.md`](./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](../README.md#quick-start).
|