Pular para o conteúdo principal
O Midaz é um ledger open-source 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.
O Midaz agora é distribuído como um único repositório. Não é necessário instalar o Ledger e o Console separadamente.

​
Requisitos do sistema

RequisitoMínimo
Sistema Operacional- Windows: Windows 10 via WSL versão 2004 ou posterior (Build 19041+)
- macOS: Versão atual ou duas anteriores
- Linux: Ubuntu ou Debian recomendado
RAM8 GB
Espaço em disco20 GB
InternetConexão estável
NavegadorChrome, Firefox ou equivalente

​
Ferramentas necessárias

​
No Windows? Instale o WSL

Se você está usando Windows, é necessário instalar o WSL (Windows Subsystem for Linux) para executar o Midaz.
1
Abra o PowerShell como administrador.
2
Execute:
wsl --install
3
Reinicie sua máquina se necessário.
4
Após a instalação, abra o app Ubuntu pelo Menu Iniciar para continuar a configuração.

​
Instalar o Midaz

​
Passo 1 – Abra seu terminal

  • macOS/Linux: Use o app Terminal.
  • Windows: Abra o Ubuntu via WSL.
Se estiver usando Windows, execute todos os comandos dentro do Ubuntu (WSL). Não tem familiaridade com terminais? Confira este guia para iniciantes.

​
Passo 2 – Instale o make

  • Linux: 
    sudo apt install make
  • macOS: 
    brew install make

​
Passo 3 – Baixe o repositório do Midaz

1

Escolha seu diretório de trabalho

cd ~/Desktop
2

Clone o repositório

git clone https://github.com/LerianStudio/midaz.git
3

Entre na pasta

cd midaz

​
Passo 4 – Configure as variáveis de ambiente

make set-env

​
Passo 5 – Inicie os serviços

Certifique-se de que o Docker está em execução e então: 
make up
Todos os serviços, incluindo o Console, serão iniciados.

​
Passo 6 – Acesse seu ambiente

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

​
Experimente a API

Quer explorar as APIs do Midaz?
1
Acesse midaz/postman.
2
Importe MIDAZ.postman_collection.json no Postman.
3
Explore os endpoints disponíveis.
Pronto para construir? Comece com nosso Guia de Início Rápido.

​
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, disponível para clientes enterprise.
Sem autenticação, recomendamos executar o Midaz apenas em um ambiente seguro e privado.

​
Comunidade e contribuição

Quer contribuir? Comece com nosso Guia de Contribuição.
Precisa de ajuda especializada? Fale com nossa equipe para suporte personalizado.

​
Licença

O Midaz é open-source, licenciado sob a Elastic License 2.0.