Saltar al contenido principal
Midaz es un Ledger de código abierto diseñado para ser fácil de ejecutar, extender y probar localmente. Puedes instalarlo con solo unos pocos comandos usando Docker Compose, que configura el entorno completo (APIs backend y Midaz Console) de una sola vez. Ya sea que estés construyendo algo nuevo o explorando cómo funciona Midaz internamente, esta guía te acompaña a través del proceso completo de configuración.
Midaz ahora se distribuye como un único repositorio. No necesitas instalar el Ledger y Console por separado.

​
Requisitos del sistema

RequisitoMínimo
Sistema operativo- Windows: Windows 10 vía WSL versión 2004 o posterior (Build 19041+)
- macOS: Versión actual o las dos anteriores
- Linux: Ubuntu o Debian recomendados
RAM8 GB
Espacio en disco20 GB
InternetConexión estable
NavegadorChrome, Firefox o equivalente

​
Herramientas que necesitarás

​
¿En Windows? Instala WSL

Si estás usando Windows, debes instalar WSL (Windows Subsystem for Linux) para ejecutar Midaz.
1
Abre PowerShell como administrador.
2
Ejecuta:
wsl --install
3
Reinicia tu máquina si es necesario.
4
Una vez instalado, abre la aplicación Ubuntu desde el Menú Inicio para continuar la configuración.

​
Instalar Midaz

​
Paso 1 – Abre tu terminal

  • macOS/Linux: Usa tu aplicación Terminal.
  • Windows: Abre Ubuntu vía WSL.
Si usas Windows, ejecuta todos los comandos dentro de Ubuntu (WSL). ¿No estás familiarizado con terminales? Consulta esta guía para principiantes.

​
Paso 2 – Instala make

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

​
Paso 3 – Descarga el repositorio de Midaz

1

Elige tu directorio de trabajo

cd ~/Desktop
2

Clona el repositorio

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

Entra en la carpeta

cd midaz

​
Paso 4 – Configura las variables de entorno

make set-env

​
Paso 5 – Inicia los servicios

Asegúrate de que Docker esté ejecutándose, luego: 
make up
Todos los servicios, incluido el Console, se iniciarán.

​
Paso 6 – Accede a tu entorno

Asegúrate de que Docker esté activo y todos los archivos .env estén configurados correctamente antes de abrir el Console.

​
Prueba la API

¿Quieres explorar las APIs de Midaz?
1
Ve a midaz/postman.
2
Importa MIDAZ.postman_collection.json en Postman.
3
Explora los endpoints disponibles.
¿Listo para construir? Comienza con nuestra Guía de inicio rápido.

​
Autenticación

Por defecto, la versión comunitaria de Midaz es abierta y no requiere autenticación. Esto facilita las pruebas locales. Si necesitas autenticación, usa el plugin Access Manager, disponible para clientes empresariales.
Sin autenticación, recomendamos ejecutar Midaz solo en un entorno seguro y privado.

​
Comunidad y contribución

¿Quieres contribuir? Comienza con nuestra Guía de contribución.
¿Necesitas ayuda experta? Habla con nuestro equipo para soporte práctico.

​
Licencia

Midaz es de código abierto, bajo la licencia Apache 2.0.