> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

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

<Note>
  Midaz now ships as a single repository. You no longer install its services separately.
</Note>

## System requirements

***

| Requirement          | Minimum                                                                                                                                                                          |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Operating System** | - **Windows**: Windows 10 **via WSL** version 2004 or later (Build 19041+) <br /> - **macOS**: Current or previous two versions <br /> - **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](https://docs.docker.com/get-docker/)
* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [Postman](https://www.postman.com/downloads/) (optional)
* Package Manager:
  * macOS: [Homebrew](https://brew.sh/)
  * 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.

<Steps>
  <Step>
    Open PowerShell as an administrator.
  </Step>

  <Step>
    Run:

    <CodeGroup>
      ```bash Text theme={null}
      wsl --install
      ```
    </CodeGroup>
  </Step>

  <Step>
    Restart your machine if needed.
  </Step>

  <Step>
    Once installed, open the Ubuntu app from the Start Menu to continue the setup.
  </Step>
</Steps>

## Install Midaz

***

### Step 1 – Open your terminal

* **macOS/Linux:** Use your Terminal app.
* **Windows:** Open Ubuntu via WSL.

<Danger>
  On Windows, **run all commands inside Ubuntu (WSL)**. New to terminals? See [this beginner guide](https://www.codecademy.com/learn/learn-the-command-line).
</Danger>

### Step 2 – Install `make`

* **Linux:**

  <CodeGroup>
    ```bash Text theme={null}
    sudo apt install make
    ```
  </CodeGroup>
* **macOS:**

  <CodeGroup>
    ```bash Text theme={null}
    brew install make
    ```
  </CodeGroup>

### Step 3 – Download the Midaz repo

<Steps>
  <Step title="Choose your working directory">
    <CodeGroup>
      ```bash Text theme={null}
      cd ~/Desktop
      ```
    </CodeGroup>
  </Step>

  <Step title="Clone the repo">
    <CodeGroup>
      ```bash Text theme={null}
      git clone https://github.com/LerianStudio/midaz.git
      ```
    </CodeGroup>
  </Step>

  <Step title="Enter the folder">
    <CodeGroup>
      ```bash Bash theme={null}
      cd midaz
      ```
    </CodeGroup>
  </Step>
</Steps>

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

<CodeGroup>
  ```bash Bash theme={null}
  make set-env
  ```
</CodeGroup>

### Step 5 – Start the services

Make sure Docker is up, then:

<CodeGroup>
  ```bash Bash theme={null}
  make up
  ```
</CodeGroup>

All bundled services start.

### Step 6 – Access your environment

* Ledger API: [http://localhost:3002](http://localhost:3002/)

<Danger>
  Make sure Docker is up and all `.env` files are set before you access the API.
</Danger>

## Try the API

***

Want to explore the Midaz APIs?

<Steps>
  <Step>
    Go to `midaz/postman`.
  </Step>

  <Step>
    Import `MIDAZ.postman_collection.json` into Postman.
  </Step>

  <Step>
    Explore available endpoints.
  </Step>
</Steps>

<Tip>
  Ready to build? Start with our [Quick Start Guide](/en/reference/quick-start-guide).
</Tip>

## Authentication

***

By default, Midaz does not require authentication. This makes local testing easier.

If you need authentication, use the [Access Manager](/en/platform/access-manager/access-manager) plugin, available for enterprise customers.

<Danger>
  Run Midaz without authentication only in a secured, private environment.
</Danger>

## Community and contribution

***

* Join us on [Discord](https://discord.com/invite/DnhqKwkGv3).
* Report issues on [GitHub](https://github.com/LerianStudio/midaz).
* Follow [@LerianStudio](https://twitter.com/LerianStudio) on Twitter.

Want to contribute? Start with our [Contributing Guide](https://github.com/LerianStudio/midaz/blob/main/CONTRIBUTING.md).

<Tip>
  Need expert help? [Talk to our team](https://lerian.studio/contact) for hands-on support.
</Tip>

## License

***

Midaz is source-available under the [Elastic License 2.0](https://github.com/LerianStudio/midaz/blob/main/LICENSE).