mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-08 12:32:43 +00:00
Marc-André Bombeck
b57c517929
Setup walk (byte-exact redirect URI), client-registration essentials for Authentik / Keycloak / Authelia / Pocket-ID, the security model (identity pinned to (issuer, sub) after a one-time verified-email link; SSO sessions never satisfy step-up; native-2FA accounts still get their second-factor step; MFA policy belongs at the IdP), the OIDC_ONLY consequences incl. the iOS lockout and the break-glass runbook, and a troubleshooting table for the recurring failure shapes (issuer trailing slash, unfollowed discovery redirects, clock skew, IdP-side redirect_uri mismatch).
42 lines
2.2 KiB
Markdown
42 lines
2.2 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.
|
|
- [`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).
|