BrownRook Ledger documentation¶
BrownRook Ledger turns receipt evidence into canonical household expenses, categorized line items, review data, and budget reports.
The application and its primary command-line program share the Ledger name.
Run ledger --help for available operational commands. Existing automation can
continue using the compatible brownrook alias.
Use Ledger¶
Start with the user guide to review receipts, extraction quality, canonical expenses, category decisions, duplicates, and transaction matches.
Understand the system¶
The solution architecture explains the runtime components, receipt-processing flow, persistence boundaries, and GitOps delivery path.
Operate Ledger¶
- Use the local macOS guide for native services, background OCR processing, local logs, and the development loop.
- Use the operations runbook for local development, tests, deployment, and rollout verification.
- Use the troubleshooting guide for Kubernetes, Argo CD, PostgreSQL, storage, and receipt-processing recovery.
- Use the network access guide for local, public, private-LAN, DNS, TLS, and service exposure boundaries.
- Use the RabbitMQ runbook when queued receipt processing is enabled.
- Use the Kubernetes authentication guide for Entra ID, OAuth2 Proxy, ingress, and secret setup.
- Use the Grafana Entra SSO runbook for operational login, app-role assignment, client-secret rotation, and recovery access.
The project source and contribution history are available in the GitHub repository.