Installation
Formance Ledger can be used either as a standalone microservice, or as part of The Formance Platform. The standalone versions is a good choice if you don't need yet the full Formance offering, and want to keep things simple. The installation instructions below will guide you through the process of installing Formance Ledger in a standalone mode.
Formance Ledger is available as pre-compiled binaries for Linux, macOS and Windows. You can install it using the installers below, or download a release binary from the releases page.
For historical reasons, the Formance Ledger packages and binaries are named ledger. This name will change in the future, though the ledger command will remain available for backwards compatibility.
Checking for potential existing installation
It is always good measure to make sure you don't have an existing installation of Formance Ledger before installing a new one. You can check for an existing installation by running the following command:
ledger version
Homebrew
If you have Homebrew installed on your computer, you can Formance Ledger by running:
brew install formancehq/tap/numary
And to upgrade an existing installation,
brew upgrade numary
Docker
We provide the Formance Ledger as ready-to-use Docker container images. You can install the latest version of the CLI using the latest tag or a specific version passing the appropriate tag.
You must have a database (PostgreSQL) available to launch the Ledger.
docker run -p 3068:3068 \
--env POSTGRES_URI="postgresql://localhost/dbname" \
ghcr.io/formancehq/ledger:latest
Once the container is up and running, check that the server is indeed running by calling the /_info endpoint:
curl -X GET http://127.0.0.1:3068/_info
Docker Compose
curl -L https://raw.githubusercontent.com/formancehq/ledger/main/docker-compose.yml -o docker-compose.yml
docker-compose up -d
Open Formance UI : http://127.0.0.1:3078
Install on APT Based
Add Formance's package repository to /etc/apt/sources.list:
deb [trusted=yes] https://apt.fury.io/numary/ /
Then run this command to install Formance Ledger:
apt update && apt install numary
Install on RPM based
Add Formance's package repository by creating a file called /etc/yum.repos.d/formance.repo:
[numary]
name=Formance Private Repo
baseurl=https://yum.fury.io/numary/
enabled=1
gpgcheck=0
Then run this command for install Formance Ledger:
yum update && yum install numary
Formance Cloud
If you want to try Formance Ledger without installing it, you can spin up a Formance Cloud sandbox environment. This will give you a fully functional development Formance Ledger instance, with sane defaults.