mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-08 12:32:43 +00:00
Marc-André Bombeck
df6d20b696
On a host whose CPU cannot run the page renderer (x64 without AVX2, arm64 musl without LSE/RCpc), every AI read of a PDF for a provider that only takes images failed with "Scanning PDFs needs a Claude vision provider", which says nothing about the cause. Most medical PDFs are produced digitally and carry every word in their text layer, which pdf.js reads without rendering. `prepareVisionInput` now answers a text read (`mode: "text"`) when the renderer is unavailable on this host, the provider cannot take the PDF whole and the PDF has a usable text layer. Summary, suggest and the background summary send that text through their existing text mode; "Read with AI" and the index backfill write it as the local text index it is, with no provider call; the automatic index leaves it to its local path. `planVisionReads` does the same for the extraction and the lab scan: text reads by page group, with anchored provenance, and the pages without a text layer reported as `extractionIncomplete` on a document and as `unreadPages` on a lab scan. A supplement label PDF is read from its text layer too. A scan on such a host now answers `documents.inbound.pdfRendererUnavailable` and `labs.ocr.pdfRendererUnavailable` (422): this server's processor cannot run the page renderer, so a scanned PDF can only be read by a provider that takes PDF files directly, or as photos. The `pdfNeedsAnthropic` codes are no longer emitted, since with a working renderer every provider reads a PDF; the recorded index outcome keeps its `pdf-needs-anthropic` value with corrected copy. The extraction path no longer folds a render failure of one document into the capability error: like `prepareVisionInput` since #776 it reports "The PDF pages couldn't be rendered for scanning." (`extractFailed`), and the lab scan answers `labs.ocr.extractFailed`. Hosts that render, and providers that take PDFs whole, are unchanged. Refs #1311
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/— operator runbooks: deploy, backup / restore, encryption-key rotation, password reset and account recovery, env checks, TLS pinning, data repair. These are what an operator reaches for during an incident.self-hosting/— operator notes next to the code:getting-started.md(install and updates, the page the boot log points at), the TrueNAS, Unraid and Portainer installs with their catalog templates, Tailscale, the reverse proxy, horizontal scaling (HEALTHLOG_PROCESS_TYPE=web|worker|all), notification channels, the environment module, document sources and reproductive-health data. 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. Andself-hosting/account-sharing.md— letting one account on the instance open another's health record: the three access levels, the eight sections a grant can be narrowed to, managed profiles for somebody with no login and the guardians who look after them, what revocation does and does not undo, and which trust properties of the instance are unchanged by any of it. Andself-hosting/support.md— reporting a problem: error ids, the support info every account can copy, the operator's redacted support report, and finding an error in the admin log.using/— notes on using the app that sit close to the code.using/search.mdcovers the command palette's record search: opening it, what it finds, how matching works, and its limits on very large and shared records.migration/— migration notes. Currently only v1.3 to v1.4; later releases are covered byCHANGELOG.mdand https://docs.healthlog.dev.integrations/— per-integration reference: Withings, WHOOP, Fitbit, Google Health, Strava, Nightscout, Dawarich and the Garmin route; the Apple Health, Health Connect, document and data imports; AI providers; and Home Assistant with its blueprint. Oura and Polar are covered on the docs site only.adr/— architecture decision records.security/— threat-model notes.diagrams/— architecture diagrams rendered through docs.healthlog.dev.releases/— release imagery.apple-store-connect-checklist.md— the iOS submission gate.codex-protocol-spec.md— Codex / ChatGPT OAuth protocol reverse-engineering notes.contributing/ui-standards.md— the binding UI standards: card anatomy, spacing, text colour, tokens and which primitive to use where. Read before touching any surface.contributing/benchmarks.md— the large-account benchmark (latency and statements per request) and the statement budgets on the hot routes.contributing/testing.md— which suite a test belongs in, the route test kit, the integration database, sharding, property and mutation tests, and the flaky-test quarantine.ui-guidelines.md— UI / a11y house style; where it disagrees with the UI standards, the standards win.
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.