Skip to main content

Installation

Interested in trying Formance Ledger out? You can install it on your local machine first.

Formance Ledger is, as you'd expect, available for Linux, macOS, and Windows.

We also provide Docker images for production environments. You can learn more about all the different ways of installing Formance Ledger in the reference documentation.

macOSโ€‹

If you have Homebrew installed on your computer, you can install the CLI by running:

brew install numary/tap/numary

To upgrade an existing installation of the Formance CLI, run:

brew upgrade numary

Linuxโ€‹

Formance Ledger is available for APT (Debian) and RPM (RedHat) based distributions.

Install with APT (Debian, Ubuntu)โ€‹

Add Formance's package repository to /etc/apt/sources.list:

/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 with RPM (RedHat, Fedora, SUSE)โ€‹

Add Formance's package repository by creating a file called /etc/yum.repos.d/formance.repo:

/etc/yum.repos.d/numary.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

Windowsโ€‹

Download the pre-compiled binary numary_x.y.z_Windows-64bit.zip from GitHub (where x.y.z is the version number). Unzip the file, and place numary.exe somewhere convenient such as C:\Program Files.

info

Consider renaming the executable numary (without the .exe suffix) to make it easier to type, and so the example commands in the rest of the tutorial will work without having to edit them.

Dockerโ€‹

We provide the Formance CLI 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.

docker run -p 3068:3068 -v $HOME/numary:/root/.numary --env NUMARY_SERVER_HTTP_BIND_ADDRESS="0.0.0.0:3068" ghcr.io/numary/ledger:latest

Open Formance API : http://127.0.0.1:3068/_info

Troubleshootingโ€‹

You can check that Formance CLI was installed correctly by trying the following command:

numary version

You should see something like

Version: 1.4.0-beta.3 
Date: 2022-04-08T10:18:48Z
Commit: ce59ebc

If you don't, then recheck the steps above, or reach out to us to ask for help.