OpenCashFlow 0.1.0-preview.1
Pre-releaseRelease date: 2026-07-09
Status
OpenCashFlow 0.1.0-preview.1 is a Developer Preview / Early Self-Hosted Preview.
It is not production-ready. Use this package for local evaluation, architecture review, contributor onboarding, and early self-hosted feedback. Do not use it for regulated, audited, or business-critical financial operations.
What Is Included
- ASP.NET Core API and WebApp for local self-hosted evaluation.
- Docker Compose evaluation path.
- First-run setup wizard for a fresh database.
- First company/tenant bootstrap.
- First administrator bootstrap.
- Strong generated temporary administrator password shown once after setup.
- First-login password change requirement for the temporary password.
- Setup lock after the instance is configured.
- API Docker runtime fix for the missing
libgssapi_krb5.so.2dependency.
First-Run Setup
Start from the repository root:
cp .env.example .env
docker compose up --buildOpen:
http://localhost:5200
On a fresh database, OpenCashFlow redirects to /Setup. The setup wizard creates the first company and administrator, then shows a generated temporary administrator password exactly once. Store it immediately.
After setup, log in with the administrator email and generated password. The user is required to change the password after first login.
What Setup Does Not Do
The setup wizard configures application data only.
It does not:
- create PostgreSQL users;
- create PostgreSQL databases;
- change database permissions;
- provision infrastructure;
- configure TLS or reverse proxy settings.
Database connectivity must already be configured through Docker Compose, environment variables, or host deployment configuration.
Docker Compose Evaluation Path
The default Compose file is for local evaluation:
- WebApp:
http://localhost:5200 - API health:
http://localhost:5100/health - PostgreSQL:
localhost:5432
Before any public or shared deployment, replace all development secrets and review the production hardening guidance under Docs/ops/.
Known Limitations
- Not production-ready.
- No stable API, database, or upgrade compatibility guarantee yet.
- Cash Custody is not fully persisted yet.
- Multi-cash-account custody, transfer persistence, and reconciliation workflows remain future work.
- Forecast and Safe-to-Pay style decisions should be considered WIP/experimental until Cash Custody persistence and reconciliation are complete.
- Backup/restore and upgrade drills are documented, but operators must validate them against their own environment.
- The default Docker Compose configuration uses local evaluation defaults and must not be exposed as-is.
Local Package Contents
The preview package contains:
docker-compose.yml.env.exampleREADME.mdLICENSECHANGELOG.mdDocs/setup/*Docs/ops/*- this release note
Validation
This preview was prepared with:
dotnet build OpenCashFlow.sln --configuration Release --no-restoredotnet test OpenCashFlow.sln --configuration Release --no-builddocker compose configscripts/smoke/clean-install-smoke.sh
The clean-install smoke covers setup, login with generated temporary password, required password change, payment creation, and cash ledger verification on an isolated Docker Compose stack.
Reporting Issues
Use GitHub issues for bugs and feature requests:
https://github.com/Reckonry/OpenCashFlow/issues
Do not include secrets, passwords, generated setup passwords, tokens, private database connection strings, or exploitable security details in public issues. Follow SECURITY.md for vulnerability reports.