Guides

Installing Midaz

Suggest Edits

Midaz uses Docker Compose to simplify the setup process and maintain a consistent development environment. This guide walks you through the steps to set up and run your Midaz stack, 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 release of macOS and the previous two releases.
    • 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 for accessing 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 Midaz

Follow these steps to set up and run the Midaz stack:

❗️

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 repository from GitHub and navigate to the project directory.
    1. Use the following command to clone the repository:
git clone https://github.com/LerianStudio/midaz.git
cd midaz

👍

Tip

If you're unsure how to use the terminal, refer to the Command Line Basics guide.


2. Configure the Environment Variables

Set up the required environment variables for Midaz by running this command:

make set-env

This step prepares your environment by setting up key configuration values that Midaz needs to operate correctly.


3. Start Midaz Services

🚧

Attention

Make sure that Docker is running before running the command.

Start all the services for Midaz using the following command: 

make up

This command builds and launches all the services defined in the docker-compose.yml file. The services will run in the background, allowing you to continue using the terminal.


4. 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.


5. Install Midaz Console

Midaz Console is part of the Midaz environment and is available to all users. To install it, follow the steps in the Installing Midaz Console page.


Additional Commands

  • Run tests: make test
  • Format code: make format
  • Run linter: make lint
  • Set up git hooks: make setup-git-hooks
  • Show help: make help (for all possible project management commands)

Next Steps

Once your Midaz project is set up, you can start using our APIs. To make this easier, we’ve made our API collection available on Postman. Here’s how to get started:

  1. Navigate to the folder where you cloned the Midaz repository. The .json file for the Postman collection is located in the midaz\postman folder.

    • Alternatively, you can download the collection directly from GitHub.

  2. Import the collection file into Postman. For guidance, refer to the Postman documentation.

  3. You’re all set to start exploring our endpoints.

👍

Ready to Build Your Midaz Structure?

Follow our Quick Start Guide to create your first Midaz Structure.


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.



Need Help?

If you encounter any issues or want to get involved with the Midaz project, here are some resources:

  1. Contribution Guidelines: Read our Contribution Guidelines to learn how to contribute effectively.
  2. Join the Discussion: Connect with the community through our Discord channel. Discuss issues, share ideas, and learn from others.
  3. Pick an Issue: Start contributing by selecting an open issue labeled for beginners or propose your own.

Don't hesitate to take the first step, whether new to open-source or an experienced contributor. For more detailed information, consult our Guides or reach out through our community support channels.

👍

Need help creating your Midaz Setup?

Our consulting service can help you design your Midaz structure to fit your organization’s unique needs. Whether you’re starting from scratch or optimizing an existing setup, we’re here to guide you. For more information, contact us .

Updated 17 days ago