Skip to main content
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.
Agora o Midaz é distribuído como um único repositório. Você não precisa mais instalar os serviços dele separadamente.

​
Requisitos do sistema

​
Ferramentas necessárias

​
Está no Windows? Instale o WSL

No Windows, você deve instalar o WSL (Windows Subsystem for Linux) para executar o Midaz.
1
Abra o PowerShell como administrador.
2
Execute:
3
Reinicie sua máquina, se necessário.
4
Depois de instalado, abra o aplicativo Ubuntu no menu Iniciar para continuar a configuração.

​
Instale o Midaz

​
Etapa 1 – Abra seu terminal

  • macOS/Linux: use o aplicativo Terminal.
  • Windows: abra o Ubuntu via WSL.
No Windows, execute todos os comandos dentro do Ubuntu (WSL). Novo em terminais? Veja este guia para iniciantes.

​
Etapa 2 – Instale o make

  • Linux:
  • macOS:

​
Etapa 3 – Baixe o repositório do Midaz

1

Escolha seu diretório de trabalho

2

Clone o repositório

3

Entre na pasta

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

​
Etapa 5 – Inicie os serviços

Confirme que o Docker está em execução e, em seguida:
Todos os serviços empacotados são iniciados.

​
Etapa 6 – Acesse seu ambiente

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

​
Teste a API

1
Vá até midaz/postman.
2
Importe o MIDAZ.postman_collection.json no Postman.
3
Explore os endpoints disponíveis.
Comece pelo nosso Guia de início rápido.

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

​
Comunidade e contribuição

Para contribuir, comece pelo nosso Guia de Contribuição.
Fale com nosso time para suporte prático.

​
Licença

O Midaz é source-available sob a Elastic License 2.0.