Instalación
Requisitos
Sección titulada «Requisitos»| Requisito | Versión | Descarga |
|---|---|---|
| Docker Desktop | reciente, con Docker Compose | docs.docker.com |
| Node.js | >= 18 | nodejs.org |
| Git | cualquiera reciente | git-scm.com |
Con el CLI (recomendado)
Sección titulada «Con el CLI (recomendado)»-
Instala el CLI globalmente:
Ventana de terminal npm i -g @openfactu/cli -
Descarga Keirost. El instalador te deja elegir la versión (desde las releases de GitHub) y prepara los contenedores Docker:
Ventana de terminal openfactu install -
Configura el acceso externo. Es un wizard interactivo que decide cómo se expone la instancia (solo local, LAN o internet):
Ventana de terminal cd openfactuopenfactu deploy -
Ejecuta la configuración inicial — verifica la base de datos, crea el usuario admin y el primer tenant (empresa):
Ventana de terminal openfactu setup
Manual con Docker
Sección titulada «Manual con Docker»Si prefieres controlar cada paso:
git clone https://github.com/AngelAcedo12/Keirost.gitcd Keirostcp .env.example .env # revisa las variables antes de arrancardocker compose up -d --buildEl archivo .env contiene la configuración de la instancia (credenciales de PostgreSQL, puertos, secretos). El .env.example trae valores por defecto válidos para un entorno local.
Verificar la instalación
Sección titulada «Verificar la instalación»- Web:
http://localhost:8080 - API:
http://localhost:3000
# Estado de los contenedoresopenfactu deploy:statusEntra en la web con el usuario admin creado en openfactu setup. Si el login funciona y ves el dashboard, la instalación está completa.
Solución de problemas
Sección titulada «Solución de problemas»| Síntoma | Causa probable | Solución |
|---|---|---|
docker: command not found o errores de conexión al daemon |
Docker no instalado o no arrancado | Arranca Docker Desktop y reintenta |
| El puerto 8080 o 3000 está ocupado | Otro servicio usa esos puertos | Libera el puerto o ajusta los puertos en .env |
Contenedores en estado Restarting |
Configuración incompleta | Revisa openfactu logs para ver el error concreto |
| La web carga pero el login falla | setup sin ejecutar |
Ejecuta openfactu setup |
Comandos útiles de diagnóstico:
openfactu logs # logs de los serviciosopenfactu rebuild # reconstruye y reinicia los contenedoresopenfactu restart # reinicia sin rebuildSi el problema persiste, abre un issue en GitHub con la salida de openfactu logs.