Skip to main content

Quick Start

This guide gets you from zero to a running Lumio stack using Docker Compose.

Prerequisites​

  • Docker Desktop or Docker Engine with Compose v2 (docker compose)
  • Node.js 20+ — the bootstrap script runs on the host
  • Make (optional: npm run setup:dev:docker does the same thing)

Start the stack​

make quick-dev

This runs npm run setup:dev:docker, which:

  • Writes .env, backend/.env and frontend/.env.local with development defaults and generated secrets, keeping any values you already set
  • Builds and starts PostgreSQL, Redis, the backend and the frontend with hot reload
  • Waits for GET /api/v1/health/ready
  • Seeds the demo user

Database migrations run automatically when the backend starts.

Log in​

PostgreSQL listens on 127.0.0.1:5434 and Redis on 127.0.0.1:6379.

Next steps​

  • Upload a statement from the Statements page
  • Connect storage, mail or an AI endpoint under Integrations — see Integrations
  • Read Configuration before exposing Lumio beyond localhost

Next: Local Development