Files
eleith 062dd0b56a
ci/woodpecker/pr/web Pipeline was successful
ci/woodpecker/pr/worker Pipeline was successful
ci/woodpecker/push/web Pipeline was successful
ci/woodpecker/push/worker Pipeline was successful
fix(dev): configure the localhost web port
2026-11-10 17:28:35 -08:00

34 lines
1.2 KiB
Markdown

# hledger web reports
A read-only financial app for an hledger journal. Browse saved reports and account
activity, or explicitly request preparation and live queries. Hledger owns accounting.
## Run locally
Use Docker with host networking enabled. Create private
`apps/web/config/hledger-reports.yaml` from the
[example](apps/web/config/hledger-reports.example.yaml), without overwriting existing
configuration. Select your journal and supply the [sign-in secrets](docs/authentication.md).
The worker mounts `apps/web/journals/`, or `JOURNAL_DIR`, read-only at `/journal`.
Use that container path in the configuration.
```sh
cd apps/web &&
mkdir -m 700 -p data &&
docker compose -f docker-compose.dev.yml up --build --wait
```
Open **http://localhost:5173/**, sign in and choose **Prepare reports** in Settings.
Reload for status. Browsing and journal edits never prepare reports automatically.
Keep configuration, journals and the shared data folder private and backed up.
## Guides
- [Development and operations](docs/development.md)
- [Configuration](packages/config/README.md)
- [Authentication](docs/authentication.md)
- [Architecture](docs/architecture.md)
- [Development principles](docs/philosophy.md)