Quickstart

# node-flow, from the published images — no clone, no build.
#
# Every secret below is a public development value, fine on a laptop and
# nowhere else. For a real install see /docs/guide/self-hosting.
name: node-flow

services:
  postgres:
    image: postgres:18-alpine
    container_name: node-flow-postgres
    restart: unless-stopped
    environment:
      POSTGRES_USER: nodeflow
      POSTGRES_PASSWORD: nodeflow
      POSTGRES_DB: nodeflow
      POSTGRES_INITDB_ARGS: '--locale-provider=icu --icu-locale=en-US --encoding=UTF8'
    ports:
      # 5433, not 5432, so a Postgres you already run keeps its port.
      - '${NODE_FLOW_POSTGRES_PORT:-5433}:5432'
    volumes:
      # Postgres 18 wants one mount at /var/lib/postgresql, not .../data.
      - postgres-data:/var/lib/postgresql
    command:
      - postgres
      - -c
      - autovacuum_vacuum_scale_factor=0.02
      - -c
      - autovacuum_naptime=10s
      - -c
      - io_method=worker
      - -c
      - max_connections=200
    healthcheck:
      test: ['CMD-SHELL', 'pg_isready -U nodeflow -d nodeflow']
      interval: 5s
      timeout: 5s
      retries: 10
      start_period: 10s

  # The engine: API, decider and poller in one container.
  server:
    image: ghcr.io/dsardar099/node-flow/server:1.0.0
    container_name: node-flow-server
    restart: unless-stopped
    depends_on:
      postgres:
        condition: service_healthy
    environment:
      DATABASE_URL: postgres://nodeflow:nodeflow@postgres:5432/nodeflow
      NODE_FLOW_ROLES: api,decider,poller
      NODE_FLOW_JWT_SECRET: development-secret-change-me-at-least-32-chars
      NODE_FLOW_SECRET_KEYS: 'dev:bm9kZS1mbG93LWRldmVsb3BtZW50LWtleS1ub3Qtc2U='
      # The first administrator, created on first boot. Leave the password
      # unset anywhere real and one is generated and printed once instead.
      NODE_FLOW_SEED_EMAIL: you@example.com
      NODE_FLOW_SEED_PASSWORD: development-password
      PORT: 3000
    ports:
      - '3000:3000'
    healthcheck:
      test: ['CMD-SHELL', 'node -e "fetch(\"http://localhost:3000/v1/health\").then(r=>process.exit(r.ok?0:1)).catch(()=>process.exit(1))"']
      interval: 10s
      timeout: 5s
      retries: 10
      start_period: 20s

  # The dashboard. It calls the API server-side, so the browser only ever
  # talks to one origin.
  ui:
    image: ghcr.io/dsardar099/node-flow/ui:1.0.0
    container_name: node-flow-ui
    restart: unless-stopped
    depends_on:
      server:
        condition: service_healthy
    environment:
      NODE_FLOW_API_URL: http://server:3000
      NODE_FLOW_UI_NAMESPACE: default
      PORT: 3100
    ports:
      - '3100:3100'

volumes:
  postgres-data:

docker compose up -d
docker compose ps        # all three should report "healthy" or "Up"