Installing Midaz

Install Midaz locally with Docker Compose in a few commands — the full source-available environment, ready for local development.

Midaz is a source-available ledger. You run, extend, and test it locally. Install it with Docker Compose, which sets up the full environment.

This guide walks you through the full setup, whether you build something new or explore how Midaz works.

Midaz now ships as a single repository. You no longer install its services separately.

System requirements

---

Requirement	Minimum
Operating System	- Windows: Windows 10 via WSL version 2004 or later (Build 19041+) - macOS: Current or previous two versions - Linux: Ubuntu or Debian recommended
RAM	8 GB
Disk Space	20 GB
Internet	Stable connection
Browser	Chrome, Firefox, or equivalent

Tools you’ll need

---

• Docker Desktop
• Git
• Postman (optional)
• Package Manager:
  • macOS: Homebrew
  • Linux: Use your system’s package manager (e.g., apt, dnf)

On Windows? Install WSL

---

On Windows, you must install WSL (Windows Subsystem for Linux) to run Midaz.

1. Open PowerShell as an administrator.

2. Run:

   Text

   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.

On Windows, run all commands inside Ubuntu (WSL). New to terminals? See this beginner guide.

Step 2 – Install make

• Linux:

  Text

  sudo apt install make
  

• macOS:

  Text

  brew install make
  

Step 3 – Download the Midaz repo

1. Choose your working directory

   Text

   cd ~/Desktop
   
2. Clone the repo

   Text

   git clone https://github.com/LerianStudio/midaz.git
   
3. Enter the folder

   Bash

   cd midaz
   

Step 4 – Set up environment variables

Docker must already be running: besides copying the .env files, make set-env generates the LCRYPTO_* CRM keys through a Docker one-shot container and fails if Docker is unavailable.

Bash

make set-env

Step 5 – Start the services

Make sure Docker is up, then:

Bash

make up

All bundled services start.

Step 6 – Access your environment

• Ledger API: http://localhost:3002

Make sure Docker is up and all .env files are set before you access the API.

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, Midaz does not require authentication. This makes local testing easier.

If you need authentication, use the Access Manager plugin, available for enterprise customers.

Run Midaz without authentication only in a secured, private environment.

Community and contribution

---

• Join us on Discord.
• Report issues on GitHub.
• Follow @LerianStudio on Twitter.

Want to contribute? Start with our Contributing Guide.

Need expert help? Talk to our team for hands-on support.

License

---

Midaz is source-available under the Elastic License 2.0.