Skip to main content
Midaz es un ledger source-available. Lo ejecutas, lo extiendes y lo pruebas de forma local. Instálalo con Docker Compose, que configura todo el entorno. Esta guía te lleva por todo el proceso de configuración.
Midaz ahora se distribuye como un único repositorio. Ya no necesitas instalar sus servicios por separado.

Requisitos del sistema


Herramientas que necesitas


¿Usas Windows? Instala WSL


En Windows, debes instalar WSL (Windows Subsystem for Linux) para ejecutar Midaz.
1
Abre PowerShell como administrador.
2
Ejecuta:
3
Reinicia tu equipo si es necesario.
4
Una vez instalado, abre la aplicación Ubuntu desde el menú Inicio para continuar con la configuración.

Instala Midaz


Paso 1 – Abre tu terminal

  • macOS/Linux: usa tu aplicación de Terminal.
  • Windows: abre Ubuntu mediante WSL.
En Windows, ejecuta todos los comandos dentro de Ubuntu (WSL). ¿Es tu primera vez con terminales? Consulta esta guía para principiantes.

Paso 2 – Instala make

  • Linux:
  • macOS:

Paso 3 – Descarga el repositorio de Midaz

1

Elige tu directorio de trabajo

2

Clona el repositorio

3

Ingresa a la carpeta

Paso 4 – Configura las variables de entorno

Inicia Docker antes de este paso. make set-env copia los archivos .env y genera las claves LCRYPTO_* de CRM mediante un contenedor de Docker de un solo uso. El comando falla si Docker no está disponible.

Paso 5 – Inicia los servicios

Verifica que Docker esté activo y luego ejecuta:
Se inician todos los servicios incluidos.

Paso 6 – Accede a tu entorno

Confirma que Docker esté activo y que todos los archivos .env estén configurados antes de acceder a la API.

Prueba la API


1
Ve a midaz/postman.
2
Importa MIDAZ.postman_collection.json en Postman.
3
Explora los endpoints disponibles.
Empieza con nuestra guía de inicio rápido.

Autenticación


De forma predeterminada, Midaz no requiere autenticación. Esto facilita las pruebas locales. Si necesitas autenticación, usa el plugin Access Manager, disponible para clientes empresariales.
Ejecuta Midaz sin autenticación solo en un entorno seguro y privado.

Comunidad y contribución


Para contribuir, empieza con nuestra guía de contribución.
Habla con nuestro equipo para obtener soporte personalizado.

Licencia


Midaz es source-available bajo la Elastic License 2.0.