2dbb3c37b4
- L2 container diagram now shows the Prometheus -> ocr:8000 scrape edge (plus the previously-undrawn Prometheus -> backend edge for symmetry). - OBSERVABILITY.md gains a full ocr_* metrics table with labels, units, and the canonical example queries from issue #652. - New "Internal-only endpoints" subsection captures the unauthenticated /metrics caveat and provides the Caddy block snippet for the case where the service ever gets a host port. - Explicit note that MetricsPathFilter only quiets uvicorn stdout, and the OCR metrics must never carry PII or document content. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
C4-PlantUML Diagrams
Architecture diagrams in C4-PlantUML format. These are the authoritative source for layout-accurate diagrams. The companion c4-diagrams.md in the parent directory keeps Mermaid versions for inline Gitea rendering.
Render in Gitea
Gitea is configured to render .puml files as diagrams. Open any .puml file in the Gitea UI to see the rendered diagram.
Note:
plantumlcode fences inside Markdown files do not render inline in Gitea — this is a Gitea limitation unrelated to the server configuration. The.mdfiles in this repo use Mermaid for that reason.
Render in VS Code
Install the PlantUML extension (jebbs.plantuml). The project's .vscode/settings.json already points at the shared server:
plantuml.server = http://heim-nas:8500
Open any .puml file and press Alt+D to preview.
Files
| File | Diagram |
|---|---|
l1-context.puml |
Level 1 — System Context |
l2-containers.puml |
Level 2 — Containers |
l3-backend-3a-security.puml |
L3 Backend: Security & Authentication |
l3-backend-3b-document-management.puml |
L3 Backend: Document Management & Import |
l3-backend-3c-transcription.puml |
L3 Backend: Document Transcription Pipeline |
l3-backend-3d-users-groups.puml |
L3 Backend: Users, Groups & Administration |
l3-backend-3e-persons.puml |
L3 Backend: Persons & Family Graph |
l3-backend-3f-ocr.puml |
L3 Backend: OCR Orchestration |
l3-backend-3g-supporting.puml |
L3 Backend: Supporting Domains |
l3-frontend-3a-middleware-auth.puml |
L3 Frontend: Middleware, Auth & Layout |
l3-frontend-3b-document-workflows.puml |
L3 Frontend: Document Workflows |
l3-frontend-3c-people-stories.puml |
L3 Frontend: People, Stories & Discovery |
l3-frontend-3d-administration.puml |
L3 Frontend: Administration & Help |
seq-auth-flow.puml |
Sequence: Authentication Flow |
seq-document-upload.puml |
Sequence: Document Upload Flow |