Files
HealthLog/docs/README.md
T
Marc-André Bombeck 189024cc00 fix(geo): make GEOLITE2_DIR reachable and tell self-hosters what they can do
The runtime has always read GEOLITE2_DIR, but the variable was absent
from the compose `environment:` whitelist, from both env examples, and
from the docs. A variable that is not on that whitelist never reaches
the container even when the operator's `.env` sets it, so the override
existed in code and was unreachable from the documented path.

Put it on the whitelist, document it in both examples and the manifest,
and add `docs/self-hosting/geolite2.md`: fetch the databases with a free
MaxMind account, mount the directory read-only, point the variable at
it. The compose file carries the bind-mount line commented out beside
the app service.

The admin notification told the reader to set MAXMIND_LICENSE_KEY in
this repository's Actions secrets — something nobody running the
published image can do, about a fallback that sends their sign-in
addresses to a third party. It now names the mount, names the online
provider it is actually querying, and links the runbook. Six locales.
It also no longer claims the carrier column stays empty; the online
tier has filled the carrier from the ISP field since v1.25.8.

A blank GEOLITE2_DIR now resolves to the default instead of the process
working directory: compose substitutes an unset variable to the empty
string, which is not nullish.

Refs #659
2026-07-27 14:47:55 +02:00

2.4 KiB

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). See api/README.md for the preview commands. Also home to the MCP-server contract: api/mcp-capabilities.md (tools, resources, prompts, write model) and api/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 on docs.healthlog.dev. Includes 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 — OIDC SSO login: IdP setup, the identity-pinning security model, OIDC_ONLY consequences, and the break-glass runbook. Also self-hosting/geolite2.md — bringing your own offline GeoLite2 databases via GEOLITE2_DIR instead 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.