Ir al contenido

Instalación

Requisito Versión Descarga
Docker Desktop reciente, con Docker Compose docs.docker.com
Node.js >= 18 nodejs.org
Git cualquiera reciente git-scm.com
  1. Instala el CLI globalmente:

    Ventana de terminal
    npm i -g @openfactu/cli
  2. 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
  3. 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 openfactu
    openfactu deploy
  4. Ejecuta la configuración inicial — verifica la base de datos, crea el usuario admin y el primer tenant (empresa):

    Ventana de terminal
    openfactu setup

Si prefieres controlar cada paso:

Ventana de terminal
git clone https://github.com/AngelAcedo12/Keirost.git
cd Keirost
cp .env.example .env # revisa las variables antes de arrancar
docker compose up -d --build

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

  • Web: http://localhost:8080
  • API: http://localhost:3000
Ventana de terminal
# Estado de los contenedores
openfactu deploy:status

Entra en la web con el usuario admin creado en openfactu setup. Si el login funciona y ves el dashboard, la instalación está completa.

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:

Ventana de terminal
openfactu logs # logs de los servicios
openfactu rebuild # reconstruye y reinicia los contenedores
openfactu restart # reinicia sin rebuild

Si el problema persiste, abre un issue en GitHub con la salida de openfactu logs.