Skip to main content
Midaz is an open-source ledger designed to be easy to run, extend, and test locally. You can install it with just a few commands using Docker Compose, which sets up the full environment (backend APIs and Midaz Console) in one go. Whether you’re building something new or exploring how Midaz works under the hood, this guide walks you through the full setup process.
Midaz is now distributed as a single repository. No need to install the Ledger and Console separately.

​
System requirements

RequirementMinimum
Operating System- Windows: Windows 10 via WSL version 2004 or later (Build 19041+)
- macOS: Current or previous two versions
- Linux: Ubuntu or Debian recommended
RAM8 GB
Disk Space20 GB
InternetStable connection
BrowserChrome, Firefox, or equivalent

​
Tools you’ll need

​
On Windows? Install WSL

If you’re using Windows, you must install WSL (Windows Subsystem for Linux) to run Midaz.
1

Open PowerShell as an administrator.
2

Run:
wsl --install
3

Restart your machine if needed.
4

Once installed, open the Ubuntu app from the Start Menu to continue the setup.

​
Install Midaz

​
Step 1 – Open your terminal

  • macOS/Linux: Use your Terminal app.
  • Windows: Open Ubuntu via WSL.
If using Windows, run all commands inside Ubuntu (WSL). Not familiar with terminals? Check out this beginner guide.

​
Step 2 – Install make

  • Linux: 
    sudo apt install make
  • macOS: 
    brew install make

​
Step 3 – Download the Midaz repo

1

Choose your working directory

cd ~/Desktop
2

Clone the repo

git clone https://github.com/LerianStudio/midaz.git
3

Enter the folder

cd midaz

​
Step 4 – Set up environment variables

make set-env

​
Step 5 – Start the services

Make sure Docker is running, then: 
make up
All services, including the Console, will launch.

​
Step 6 – Access your environment

Make sure Docker is up and all .env files are properly set before opening the Console.

​
Try the API

Want to explore the Midaz APIs?
1

Go to midaz/postman.
2

Import MIDAZ.postman_collection.json into Postman.
3

Explore available endpoints.
Ready to build? Start with our Quick Start Guide.

​
Authentication

By default, the community version of Midaz is open and does not require authentication. This makes local testing easier. If you need authentication, use the Access Manager plugin, available for enterprise customers.
Without authentication, we recommend running Midaz in a secured, private environment only.

​
Community and contribution

Want to contribute? Start with our Contributing Guide.
Need expert help? Talk to our team for hands-on support.

​
License

Midaz is open-source, licensed under the Apache 2.0 License.