Guides

Installing Midaz All-in-One

Suggest Edits

The Midaz All-in-One Suite, also known as Midaz Stack, unifies the power of Midaz Ledger and Console into a single seamless platform. This guide walks you through the steps to set up and run your Midaz All-in-One Suite, with clear instructions for users of all technical backgrounds.


Prerequisites

Before starting, ensure the following tools and resources are ready on your machine:

1. System Requirements

  • Operating System:
    • Windows: Windows 10 version 2004 and higher (Build 19041 and higher).
    • macOS: the current and previous releases of macOS.
    • Linux: Ubuntu, Debian, Red Hat Enterprise Linux or Fedora
  • RAM: At least 8 GB is recommended for running Docker.
  • Disk Space: 20 GB of free storage for containers and data.
  • Internet: A stable internet connection for downloading tools and dependencies.
  • Browser: Use a modern browser like Google Chrome or Firefox to access services like Grafana.

2. Tools You Need


3. Enable the make command

After installing Chocolatey, you must run the following command to install the make function:

sudo apt install make

brew install make

choco install make

Setting Up the Midaz All-in-One Suite

Here’s how to set it up:

❗️

Important

Midaz relies on a Linux environment for proper installation. So, if you're using Windows, make sure to set up Midaz within Windows Subsystem for Linux (WSL).

For more information about WSL, refer to Microsoft's official documetation .


1. Clone the Repository

  1. Open a terminal or command prompt.
  2. Clone the Midaz stack repository:
git clone --recurse-submodules [email protected]:LerianStudio/midaz-stack.git
cd midaz-stack

2. Start the All-in-One Suite

Run the following command to launch the unified stack:

make up

3. Access the Local Environment

After setting up your local environment, you should be able to quickly access and test Midaz services. Below are the default ports where each service runs:

This ensures you can seamlessly validate your setup and start interacting with the APIs right away. If any port conflicts occur, adjust them in your configuration files accordingly.

👍

API Reference

To learn more about our APIs, refer to our API Reference documentation.


Authentication

Starting from Midaz v1.49, authentication is no longer required in the Community version. You can make requests to the Midaz APIs directly.

Soon, you will be able to use our Auth & Identity plugin to add the authentication features to your environment. For more information, contact a Sales Representative.

📘

Older versions

If you are using an older version of Midaz, access our authentication documentation.


Additional Commands

You can also use the following commands:

  • Start the services: make start
  • Stop the services: make stop or make down
  • Restart the services: make restart
  • Rebuild and restart: make rebuild-up
  • Build all services: make build
  • Clean up all resources: make clean
  • Show help: make help (for all available commands)
  • Show Midaz commands: make midaz-help
  • Show Console commands: make midaz-console-help

Development Commands

For development purposes, you can run specific commands for each component:

Run a Midaz command

Use the following command to run commands that are specific to Midaz Core:

cd midaz && make <command>

Run a Midaz Console command

Use the following command to run commands that are specific to Midaz Core:

cd midaz-console && npm run <command>

Next Steps

Once your setup is complete, you can:

  1. Explore APIs: Use the Postman collection in the postman folder of your repository or download it here.
  2. Build Your First Structure: Check out the Quick Start Guide to create your first Midaz Structure.

Need Help?

If you have questions or encounter issues, we’re here to help:

  • Contribution Guidelines: Learn how to contribute to the Midaz project here.
  • Join the Community: Connect with us on Discord.
  • Open Issues: Find beginner-friendly issues to contribute to or propose your own.

Together, let’s build the future of ledger management!

Updated 28 days ago