Kresus is an open-source libre self-hosted personal finance manager. It allows you to safely track your banking history, check your overall balance and know exactly on what you are spending money with the use of tags!
It has started as a fork of cozy-pfm but is way different now.
If you like the work we're doing, consider making a donation!
How to install Kresus
Run a pre-built image
docker run -p 9876:9876 -v /opt/kresus/data:/home/user/data -ti -d bnjbvr/kresus
Build the image
There is a Dockerfile from which you can build and run Kresus, using the following commands (don't forget to change the port mapping and the volume mapping, if necessary!):
git clone https://framagit.org/bnjbvr/kresus && cd kresus
docker build -t kresus .
docker run -p 9876:9876 -v /opt/kresus/data:/home/user/data -ti -d kresus
Note that Kresus needs the latest stable version of Weboob, which is 1.1 at this point. Although Kresus would also work with the 1.0 version, it won't let you run this version, because bank modules might be outdated and not updated anymore, and as a result synchronization with your bank website would not work.
This can be done with the following command, under Debian based systems:
Install on CozyCloud
If you already have a Cozy instance set up, then your best (and only) choice is to install Kresus from the Marketplace.
Standalone install on Debian
Kresus can be installed standalone (without a cozy). In this case, a few features won't be enabled: email reports and notifications, simple notifications.
DISCLAIMER: as Kresus is designed to run under CozyCloud, which handles authentication, there are no builtin authentication systems in the standalone Kresus and it is therefore more risky to use it in the wild. Choose this only if you know what you're doing and you're able to handle authentication.
There's a single command to run to install Kresus under Debian:
This will install the dependencies, build the project and install at the global
node.js program location. Note that if this location is
might need to use root access to apply this command properly.
On any other (UNIX based) operating system
DISCLAIMER: the disclaimer above for Debian applies here as well.
First of all, make sure to have installed all the dependencies, as explained above.
Install the node dependencies and build the scripts (this won't install kresus globally):
Alternatively, if you want to install Kresus globally, you'll need to use
And then you can simply start Kresus from any terminal in any directory with:
Note that whatever the launch process you're using (global or local install), you can set several options at runtime:
the default port is 9876. This can be overriden with the env variable
the default host on which Kresus listens is
localhost. This can be overriden with the env variable
in standalone mode, the default install location is
~/.kresus/. This can be overriden with the env variable
You'll need the following firewall authorizations:
- http/https access to your bank website, for fetching new operations on your behalf.
A big thank you to all contributors!
Code of conduct
There is a code of conduct that everybody is expected to follow. Read it for further information about how to behave, how to report abuses, etc.
What is Cozy?
Cozy is a platform that brings all your web services in the same private space. With it, your web apps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one profiles you.