> ## 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 Docker Compose — o ambiente completo, Ledger e Console incluídos, em poucos comandos.

O Midaz é um ledger source-available projetado para ser fácil de executar, estender e testar localmente. Você pode instalá-lo com apenas alguns comandos usando o **Docker Compose**, que configura todo o ambiente de uma só vez.

Seja construindo algo novo ou explorando como o Midaz funciona por dentro, este guia orienta você por todo o processo de configuração.

<Note>
  O Midaz agora é distribuído como um único repositório. Não é necessário instalar o Ledger e o Console 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 duas anteriores <br /> - **Linux**: Ubuntu ou Debian recomendado |
| **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 (ex.: `apt`, `dnf`)

## No Windows? Instale o WSL

***

Se você está usando Windows, é necessário 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>
    Após a instalação, abra o app Ubuntu pelo Menu Iniciar para continuar a configuração.
  </Step>
</Steps>

## Instalar o Midaz

***

### Passo 1 – Abra seu terminal

* **macOS/Linux:** Use o app Terminal.
* **Windows:** Abra o Ubuntu via WSL.

<Danger>
  Se estiver usando Windows, **execute todos os comandos dentro do Ubuntu (WSL)**. Não tem familiaridade com terminais? Confira [este guia para iniciantes](https://www.codecademy.com/learn/learn-the-command-line).
</Danger>

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

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

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

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

### Passo 5 – Inicie os serviços

Certifique-se de que o Docker está em execução e então:

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

Todos os serviços, incluindo o Console, serão iniciados.

### Passo 6 – Acesse seu ambiente

* APIs do Ledger: [http://localhost:3000](http://localhost:3000/)
* Midaz Console: [http://localhost:8081](http://localhost:8081/) (antes do Midaz v3.5)

<Danger>
  Certifique-se de que o Docker está ativo e todos os arquivos .env estão configurados corretamente antes de abrir o Console.
</Danger>

## Experimente a API

***

Quer explorar as APIs do Midaz?

<Steps>
  <Step>
    Acesse `midaz/postman`.
  </Step>

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

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

<Tip>
  Pronto para construir? Comece com nosso [Guia de Início Rápido](/pt/reference/quick-start-guide).
</Tip>

## Autenticação

***

Por padrão, a versão community do Midaz é aberta e não requer autenticação. Isso facilita os testes locais.

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

<Danger>
  Sem autenticação, recomendamos executar o Midaz apenas em um ambiente seguro e privado.
</Danger>

## Comunidade e contribuição

***

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

Quer contribuir? Comece com nosso [Guia de Contribuição](https://github.com/LerianStudio/midaz/blob/main/CONTRIBUTING.md).

<Tip>
  Precisa de ajuda especializada? [Fale com nossa equipe](https://lerian.studio/contact) para suporte personalizado.
</Tip>

## Licença

***

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