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

# Instalando o Midaz

> Instale o Midaz localmente com o Docker Compose em poucos comandos: o ambiente completo source-available, pronto para desenvolvimento local.

O Midaz é um ledger source-available. Você o executa, estende e testa localmente. Instale-o com o **Docker Compose**, que configura o ambiente completo.

Este guia mostra o passo a passo completo da configuração.

<Note>
  Agora o Midaz é distribuído como um único repositório. Você não precisa mais instalar os serviços dele separadamente.
</Note>

## Requisitos do sistema

***

| Requisito               | Mínimo                                                                                                                                                                                |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Sistema operacional** | - **Windows**: Windows 10 **via WSL** versão 2004 ou posterior (Build 19041+) <br /> - **macOS**: versão atual ou as duas anteriores <br /> - **Linux**: recomendado Ubuntu ou Debian |
| **RAM**                 | 8 GB                                                                                                                                                                                  |
| **Espaço em disco**     | 20 GB                                                                                                                                                                                 |
| **Internet**            | Conexão estável                                                                                                                                                                       |
| **Navegador**           | Chrome, Firefox ou equivalente                                                                                                                                                        |

## Ferramentas necessárias

***

* [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/) (opcional)
* Gerenciador de pacotes:
  * macOS: [Homebrew](https://brew.sh/)
  * Linux: use o gerenciador de pacotes do seu sistema (por exemplo, `apt`, `dnf`)

## Está no Windows? Instale o WSL

***

No Windows, você deve instalar o WSL (Windows Subsystem for Linux) para executar o Midaz.

<Steps>
  <Step>
    Abra o PowerShell como administrador.
  </Step>

  <Step>
    Execute:

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

  <Step>
    Reinicie sua máquina, se necessário.
  </Step>

  <Step>
    Depois de instalado, abra o aplicativo Ubuntu no menu Iniciar para continuar a configuração.
  </Step>
</Steps>

## Instale o Midaz

***

### Etapa 1 – Abra seu terminal

* **macOS/Linux:** use o aplicativo Terminal.
* **Windows:** abra o Ubuntu via WSL.

<Danger>
  No Windows, **execute todos os comandos dentro do Ubuntu (WSL)**. Novo em terminais? Veja [este guia para iniciantes](https://www.codecademy.com/learn/learn-the-command-line).
</Danger>

### Etapa 2 – Instale o `make`

* **Linux:**

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

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

### Etapa 3 – Baixe o repositório do Midaz

<Steps>
  <Step title="Escolha seu diretório de trabalho">
    <CodeGroup>
      ```bash Text theme={null}
      cd ~/Desktop
      ```
    </CodeGroup>
  </Step>

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

  <Step title="Entre na pasta">
    <CodeGroup>
      ```bash Bash theme={null}
      cd midaz
      ```
    </CodeGroup>
  </Step>
</Steps>

### Etapa 4 – Configure as variáveis de ambiente

Inicie o Docker antes desta etapa. O `make set-env` copia os arquivos `.env` e gera as chaves `LCRYPTO_*` do CRM por meio de um container Docker one-shot. O comando falha se o Docker não estiver disponível.

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

### Etapa 5 – Inicie os serviços

Confirme que o Docker está em execução e, em seguida:

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

Todos os serviços empacotados são iniciados.

### Etapa 6 – Acesse seu ambiente

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

<Danger>
  Confirme que o Docker está em execução e que todos os arquivos `.env` estão configurados antes de acessar a API.
</Danger>

## Teste a API

***

<Steps>
  <Step>
    Vá até `midaz/postman`.
  </Step>

  <Step>
    Importe o `MIDAZ.postman_collection.json` no Postman.
  </Step>

  <Step>
    Explore os endpoints disponíveis.
  </Step>
</Steps>

<Tip>
  Comece pelo nosso [Guia de início rápido](/pt/reference/products/midaz/quick-start-guide).
</Tip>

## Autenticação

***

Por padrão, o Midaz não exige autenticação. Isso facilita os testes locais.

Se precisar de autenticação, use o plugin [Access Manager](/pt/platform/access-manager), disponível para clientes enterprise.

<Danger>
  Execute o Midaz sem autenticação apenas em um ambiente seguro e privado.
</Danger>

## Comunidade e contribuição

***

* Junte-se a nós no [Discord](https://discord.com/invite/DnhqKwkGv3).
* Relate problemas no [GitHub](https://github.com/LerianStudio/midaz).
* Siga [@LerianStudio](https://twitter.com/LerianStudio) no Twitter.

Para contribuir, comece pelo nosso [Guia de Contribuição](https://github.com/LerianStudio/midaz/blob/main/CONTRIBUTING.md).

<Tip>
  [Fale com nosso time](https://lerian.studio/contact) para suporte prático.
</Tip>

## Licença

***

O Midaz é source-available sob a [Elastic License 2.0](https://github.com/LerianStudio/midaz/blob/main/LICENSE).