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 todo o ambiente. Este guia orienta você por toda a configuração, seja para construir algo novo ou explorar como o Midaz funciona.
O Midaz agora é distribuído como um único repositório. Você não instala mais os seus serviços separadamente.

​
Requisitos do sistema

​
Ferramentas necessárias

​
No Windows? Instale o WSL

No Windows, é necessário 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
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.
No Windows, execute todos os comandos dentro do Ubuntu (WSL). Novo em terminais? Veja este guia para iniciantes.

​
Passo 2 – Instale o make

  • Linux:
  • macOS:

​
Passo 3 – Baixe o repositório do Midaz

1

Escolha seu diretório de trabalho

2

Clone o repositório

3

Entre na pasta

​
Passo 4 – Configure as variáveis de ambiente

O Docker já precisa estar rodando: além de copiar os arquivos .env, o make set-env gera as chaves LCRYPTO_* do CRM por meio de um container Docker de uso único e falha se o Docker não estiver disponível.

​
Passo 5 – Inicie os serviços

Certifique-se de que o Docker está ativo e então:
Todos os serviços incluídos são iniciados.

​
Passo 6 – Acesse seu ambiente

Certifique-se de que o Docker está ativo e todos os arquivos .env estão configurados antes de acessar a API.

​
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, o Midaz 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.
Execute o Midaz sem autenticação 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 é source-available, sob a Elastic License 2.0.