Waterflow documentation
Run Waterflow on your own machine, use it with your family or group, and see how it works.
Waterflow is a spending tracker you run yourself, for you, your family or a small group. Your money data stays on your own machine or server: nobody else runs it, and the project collects nothing. It’s free and open source (AGPL-3.0).
Start here
- Install: one file and one command on any machine with Docker.
- Accounts and invites: the admin, inviting people, forgotten passwords.
- Use it from other devices: HTTPS with Tailscale, your own domain or Cloudflare Tunnel.
- Backups and restore: what’s backed up, and how to keep a copy somewhere else.
- Changelog: what changed in each version.
The sections
| Section | For |
|---|---|
| Getting started | Whoever runs a server (the operator): install, people, HTTPS, updates, backups, settings, troubleshooting |
| How it works | Anyone who wants to know what happens to their data: the ledger, sharing, sign-in, security, the server’s parts |
| Reference | The API, error codes, settings, database roles, the requirements and their tests |
| Contributing | Developers: running it from source, tests, conventions, releases |
The code is at github.com/LeeMinNguyeen/waterflow. Found a mistake in these pages? Each one has an “Edit this page” link at the bottom.