@nitsan-ai/ragsuite-test 0.1.2 → 0.1.4

package/src/utils/paths.js

@@ -1,50 +1,69 @@
 'use strict';
 
 const fs = require('fs');
+const os = require('os');
 const path = require('path');
 const { readConfig, CONFIG_DIR } = require('./config');
+const { getActiveInstall, setActiveInstall } = require('./global-config');
 
-function looksLikeRepoRoot(dir) {
+/** Default app install dir (npm-CLI style home install). */
+function defaultInstallDir() {
+  return path.join(os.homedir(), 'ragsuite-test');
+}
+
+function looksLikeGitCheckout(dir) {
   const start = path.join(dir, 'scripts', 'docker-start.sh');
   const pkg = path.join(dir, 'package.json');
   return fs.existsSync(start) && fs.existsSync(pkg);
 }
 
-function looksLikeFullBundleRoot(dir) {
-  if (!looksLikeRepoRoot(dir)) return false;
+function looksLikeImagesInstall(dir) {
   const compose = path.join(dir, 'docker-compose.yml');
-  return fs.existsSync(compose);
+  const start = path.join(dir, 'scripts', 'docker-start-images.sh');
+  if (!fs.existsSync(compose) || !fs.existsSync(start)) return false;
+  const cfgPath = path.join(dir, CONFIG_DIR, 'config.json');
+  if (fs.existsSync(cfgPath)) {
+    try {
+      const cfg = JSON.parse(fs.readFileSync(cfgPath, 'utf8'));
+      if (cfg.source === 'images') return true;
+    } catch {
+      /* fall through */
+    }
+  }
+  return !fs.existsSync(path.join(dir, 'scripts', 'docker-start.sh'));
+}
+
+function looksLikeRepoRoot(dir) {
+  return looksLikeGitCheckout(dir) || looksLikeImagesInstall(dir);
+}
+
+function looksLikeFullBundleRoot(dir) {
+  if (!looksLikeGitCheckout(dir)) return false;
+  return fs.existsSync(path.join(dir, 'docker-compose.yml'));
 }
 
 function walkUpForRepoRoot(startDir) {
   let current = path.resolve(startDir);
   for (;;) {
-    if (looksLikeRepoRoot(current)) {
-      return current;
-    }
+    if (looksLikeRepoRoot(current)) return current;
     const parent = path.dirname(current);
-    if (parent === current) {
-      return null;
-    }
+    if (parent === current) return null;
     current = parent;
   }
 }
 
 function envRepoRoot(env = process.env) {
-  const candidates = [env.RAGSUITE_REPO_ROOT, env.RAGSUITE_INSTALL_DIR];
-  for (const raw of candidates) {
+  for (const raw of [env.RAGSUITE_REPO_ROOT, env.RAGSUITE_INSTALL_DIR]) {
     if (!raw || !String(raw).trim()) continue;
     const root = path.resolve(String(raw).trim());
-    if (looksLikeRepoRoot(root)) {
-      return root;
-    }
+    if (looksLikeRepoRoot(root)) return root;
   }
   return null;
 }
 
 /**
- * Resolve monorepo root:
- * --repo-root → RAGSUITE_REPO_ROOT / RAGSUITE_INSTALL_DIR → walk-up / config.
+ * Resolve install root (npm-CLI style):
+ * --repo-root → env → cwd walk-up → ~/.ragsuite-test active install → ~/ragsuite-test
  */
 function resolveRepoRoot({
   cwd = process.cwd(),
@@ -56,16 +75,18 @@ function resolveRepoRoot({
     const root = path.resolve(repoRootFlag);
     if (!looksLikeRepoRoot(root)) {
       const err = new Error(
-        `Not a RAGSuite repo root (missing scripts/docker-start.sh): ${root}`,
+        `Not a RAGSuite install: ${root}. Run: ragsuite-test init`,
       );
       err.code = 'NOT_REPO_ROOT';
       throw err;
     }
+    setActiveInstall(root);
     return root;
   }
 
   const fromEnv = envRepoRoot(env);
   if (fromEnv) {
+    setActiveInstall(fromEnv);
     return fromEnv;
   }
 
@@ -77,21 +98,41 @@ function resolveRepoRoot({
         for (const key of ['repoRoot', 'installDir']) {
           const candidate = cfg[key];
           if (candidate && looksLikeRepoRoot(candidate)) {
-            return path.resolve(candidate);
+            const resolved = path.resolve(candidate);
+            setActiveInstall(resolved);
+            return resolved;
           }
         }
       }
+      setActiveInstall(walked);
       return walked;
     }
   }
 
   const walked = walkUpForRepoRoot(cwd);
   if (walked) {
+    setActiveInstall(walked);
     return walked;
   }
 
+  const active = getActiveInstall();
+  if (active && looksLikeRepoRoot(active)) {
+    return active;
+  }
+
+  const fallback = defaultInstallDir();
+  if (looksLikeRepoRoot(fallback)) {
+    setActiveInstall(fallback);
+    return fallback;
+  }
+
   const err = new Error(
-    'Could not find RAGSuite repo root. Pass --repo-root <path>, set RAGSUITE_REPO_ROOT, or run: ragsuite-test init --from-git',
+    [
+      'No RAGSuite install found.',
+      '  First time:  ragsuite-test init',
+      '  Or images:   ragsuite-test init --from-images',
+      '  Then:        ragsuite-test start',
+    ].join('\n'),
   );
   err.code = 'NOT_REPO_ROOT';
   throw err;
@@ -107,13 +148,26 @@ function ensureRagsuiteDir(repoRoot) {
   return dir;
 }
 
-/** Native PID/logs stay under .ragsuite/native (Phase 4 scripts). */
 function nativeLogDir(repoRoot) {
   return path.join(repoRoot, '.ragsuite', 'native');
 }
 
+function isImagesInstall(repoRoot) {
+  const cfg = readConfig(repoRoot);
+  if (cfg && cfg.source === 'images') return true;
+  return looksLikeImagesInstall(repoRoot) && !looksLikeGitCheckout(repoRoot);
+}
+
+function isDirEmptyOrMissing(dir) {
+  if (!fs.existsSync(dir)) return true;
+  return fs.readdirSync(dir).filter((n) => n !== '.DS_Store').length === 0;
+}
+
 module.exports = {
+  defaultInstallDir,
   looksLikeRepoRoot,
+  looksLikeGitCheckout,
+  looksLikeImagesInstall,
   looksLikeFullBundleRoot,
   walkUpForRepoRoot,
   envRepoRoot,
@@ -121,4 +175,6 @@ module.exports = {
   scriptPath,
   ensureRagsuiteDir,
   nativeLogDir,
+  isImagesInstall,
+  isDirEmptyOrMissing,
 };

package/src/utils/port.js

@@ -66,7 +66,7 @@ async function assertPortsFree(ports = DEFAULT_INSTALL_PORTS) {
         'Free them, then retry. This CLI will not kill foreign processes.',
         '',
         'If a previous RAGSuite install is running:',
-        '  ragsuite-test stop --repo-root ~/ragsuite-test',
+        '  ragsuite-test stop',
         '  # or from a monorepo checkout: cd <checkout> && npm run down',
         '',
         'See what owns the ports (macOS/Linux):',

package/templates/images/.env.example

@@ -0,0 +1,76 @@
+# RAGSuite Server — copy to .env:  cp .env.example .env
+# Never commit .env.
+#
+# Used by docker compose (backend + worker env_file) and native-start (host process).
+# Compose injects DATABASE_URL, REDIS_HOST/PORT, CHROMA_* for containers — those override
+# anything duplicated here when using Docker mode.
+# For native mode (npm run start:native), set the Native block below (or rely on script defaults).
+
+# --- Required secrets ---
+# JWT is regenerated by `ragsuite-test init` (do not put real secrets here — use .env).
+JWT_SECRET_KEY=change-me-use-a-long-random-secret-in-production
+# First-run default (not a cloud vendor key). Override in .env anytime.
+CUSTOM_LLM_INTERNAL_API_KEY=ragsuite-default-llm-internal-key
+
+# --- Transactional email (invites, 2FA, password reset) ---
+# Template only — real SMTP_USER / SMTP_PASSWORD / EMAIL_FROM belong in .env (gitignored).
+# `ragsuite-test init` copies this file to .env and does NOT ask for SMTP.
+SMTP_HOST=smtp.gmail.com
+SMTP_PORT=587
+SMTP_USER=your-smtp-user@example.com
+SMTP_PASSWORD=change-me-app-password-or-smtp-secret
+SMTP_USE_TLS=true
+EMAIL_FROM=your-smtp-user@example.com
+
+# --- Frontend Docker build (baked into env.json at image build) ---
+FRONTEND_API_URL=http://localhost:9090
+# Optional: public origin that serves /widget assets (defaults to FRONTEND_API_URL in Dockerfile)
+# WIDGET_ASSET_BASE=
+
+# --- App policy ---
+HF_HUB_OFFLINE=1
+SSO_ENABLED=false
+SSO_REQUIRE_REDIS=true
+
+# --- RAG / ingest (optional) ---
+ENABLE_ASYNC_DOCUMENT_INGEST=true
+EMBEDDING_PREFERRED_SOURCE=chat
+COMPARE_MODEL_CONFIG_SOURCE=chat
+
+# --- Optional: Docker host-port overrides (defaults match npm start) ---
+# API_PORT=9090
+# WEB_PORT=9091
+# POSTGRES_HOST_PORT=5436
+# REDIS_HOST_PORT=6382
+
+# --- Optional: Compose Postgres credentials (defaults: ragsuite / ragsuite / ragsuite_v3) ---
+# POSTGRES_USER=ragsuite
+# POSTGRES_PASSWORD=ragsuite
+# POSTGRES_DB=ragsuite_v3
+
+# --- Optional: App URL / CORS (compose sets local defaults for Docker) ---
+# CORS_ORIGINS=http://localhost:9091
+# FRONTEND_BASE_URL=http://localhost:9091
+# PUBLIC_API_BASE_URL=http://localhost:9090/api/v1
+# SSO_CALLBACK_BASE_URL=http://localhost:9090/api/v1/auth/sso/callback
+
+# --- Native mode (npm run start:native) — host Postgres/Redis/Chroma ---
+# Do not use Docker service DNS names (postgres/redis/chromadb) on the host.
+# DATABASE_URL=postgresql://ragsuite:ragsuite@localhost:5436/ragsuite_v3
+# REDIS_HOST=localhost
+# REDIS_PORT=6382
+# CHROMA_MODE=http
+# CHROMA_HOST=127.0.0.1
+# CHROMA_PORT=8004
+# CHROMA_PERSIST_PATH=data/chroma_db
+# CORS_ORIGINS=http://localhost:9191,http://127.0.0.1:9191,http://localhost:9091
+# FRONTEND_BASE_URL=http://localhost:9191
+# PUBLIC_API_BASE_URL=http://localhost:9090/api/v1
+# EXPO_DEV_SERVER_PORT=9191
+# RAGSUITE_MODE=native
+
+# Advanced tuning: backend/docs/backend/configuration.md
+
+# --- Images install (init --from-images) ---
+# IMAGE_REGISTRY=ghcr.io/nitsan-ai
+# IMAGE_TAG=latest

package/templates/images/docker-compose.yml

@@ -0,0 +1,165 @@
+# Pull-only stack (no monorepo source / no local build).
+# Used by: ragsuite-test init --from-images
+# Images: ghcr.io/nitsan-ai/ragsuite-backend and ragsuite-frontend
+#
+# Override tag: IMAGE_TAG=1.0.0 (default: latest)
+# Registry:     IMAGE_REGISTRY=ghcr.io/nitsan-ai (default)
+
+name: ragsuite-server
+
+networks:
+  ragsuite-server-net:
+    name: ragsuite-server-net
+
+x-backend-image: &backend_image
+  image: ${IMAGE_REGISTRY:-ghcr.io/nitsan-ai}/ragsuite-backend:${IMAGE_TAG:-latest}
+  pull_policy: ${PULL_POLICY:-always}
+
+services:
+  postgres:
+    image: postgres:15-alpine
+    environment:
+      POSTGRES_USER: ${POSTGRES_USER:-ragsuite}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-ragsuite}
+      POSTGRES_DB: ${POSTGRES_DB:-ragsuite_v3}
+    ports:
+      - "${POSTGRES_HOST_PORT:-5436}:5432"
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"]
+      interval: 5s
+      timeout: 5s
+      retries: 10
+    networks:
+      - ragsuite-server-net
+    restart: unless-stopped
+
+  redis:
+    image: redis:7-alpine
+    ports:
+      - "${REDIS_HOST_PORT:-6382}:6379"
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 5s
+      timeout: 3s
+      retries: 10
+    networks:
+      - ragsuite-server-net
+    restart: unless-stopped
+
+  chromadb:
+    <<: *backend_image
+    entrypoint: []
+    command:
+      - chroma
+      - run
+      - --host
+      - "0.0.0.0"
+      - --port
+      - "8000"
+      - --path
+      - /data/chroma
+    volumes:
+      - chroma_data:/data/chroma
+    healthcheck:
+      test: ["CMD", "curl", "-sf", "http://localhost:8000/api/v2/heartbeat"]
+      interval: 10s
+      timeout: 5s
+      retries: 10
+      start_period: 30s
+    networks:
+      - ragsuite-server-net
+    restart: unless-stopped
+
+  backend:
+    <<: *backend_image
+    env_file:
+      - .env
+    environment:
+      DEBUG: "True"
+      CORS_ORIGINS: "http://localhost:${WEB_PORT:-9091}"
+      ENABLE_SCHEDULER: "true"
+      ENABLE_DURABLE_JOBS: "true"
+      DATABASE_URL: postgresql://${POSTGRES_USER:-ragsuite}:${POSTGRES_PASSWORD:-ragsuite}@postgres:5432/${POSTGRES_DB:-ragsuite_v3}
+      REDIS_HOST: redis
+      REDIS_PORT: "6379"
+      CHROMA_MODE: http
+      CHROMA_HOST: chromadb
+      CHROMA_PORT: "8000"
+      CHROMA_PERSIST_PATH: /data/chroma
+      DOCUMENT_STAGING_DIR: /data/staging
+      RUN_INLINE_WORKER: "false"
+      WEB_CONCURRENCY: "2"
+      FRONTEND_BASE_URL: http://localhost:${WEB_PORT:-9091}
+      PUBLIC_API_BASE_URL: http://localhost:${API_PORT:-9090}/api/v1
+      SSO_CALLBACK_BASE_URL: http://localhost:${API_PORT:-9090}/api/v1/auth/sso/callback
+    ports:
+      - "${API_PORT:-9090}:8000"
+    depends_on:
+      postgres:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+      chromadb:
+        condition: service_healthy
+    healthcheck:
+      test: ["CMD", "curl", "-sf", "http://localhost:8000/api/v1/health/ready"]
+      interval: 30s
+      timeout: 10s
+      retries: 5
+      start_period: 120s
+    volumes:
+      - staging_data:/data/staging
+    networks:
+      - ragsuite-server-net
+    restart: unless-stopped
+
+  worker:
+    <<: *backend_image
+    entrypoint: []
+    command: ["python", "-m", "app.worker"]
+    env_file:
+      - .env
+    environment:
+      DEBUG: "False"
+      CORS_ORIGINS: "http://localhost:${WEB_PORT:-9091}"
+      ENABLE_SCHEDULER: "true"
+      ENABLE_DURABLE_JOBS: "true"
+      DATABASE_URL: postgresql://${POSTGRES_USER:-ragsuite}:${POSTGRES_PASSWORD:-ragsuite}@postgres:5432/${POSTGRES_DB:-ragsuite_v3}
+      REDIS_HOST: redis
+      REDIS_PORT: "6379"
+      CHROMA_MODE: http
+      CHROMA_HOST: chromadb
+      CHROMA_PORT: "8000"
+      CHROMA_PERSIST_PATH: /data/chroma
+      DOCUMENT_STAGING_DIR: /data/staging
+      RUN_INLINE_WORKER: "false"
+    depends_on:
+      backend:
+        condition: service_healthy
+    volumes:
+      - staging_data:/data/staging
+    networks:
+      - ragsuite-server-net
+    restart: unless-stopped
+
+  frontend:
+    image: ${IMAGE_REGISTRY:-ghcr.io/nitsan-ai}/ragsuite-frontend:${IMAGE_TAG:-latest}
+    pull_policy: ${PULL_POLICY:-always}
+    ports:
+      - "${WEB_PORT:-9091}:80"
+    healthcheck:
+      test: ["CMD", "wget", "-q", "--spider", "http://localhost/healthz"]
+      interval: 15s
+      timeout: 5s
+      retries: 5
+      start_period: 10s
+    networks:
+      - ragsuite-server-net
+    restart: unless-stopped
+
+volumes:
+  postgres_data:
+  chroma_data:
+  staging_data:

package/templates/images/scripts/docker-doctor-images.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+# Lightweight doctor for images-only installs.
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
+cd "$ROOT"
+
+ok=0
+fail=0
+
+check() {
+  local label="$1"
+  shift
+  if "$@"; then
+    echo "  ✓ $label"
+    ok=$((ok + 1))
+  else
+    echo "  ✗ $label"
+    fail=$((fail + 1))
+  fi
+}
+
+echo "Doctor (images install):"
+check "docker CLI" command -v docker >/dev/null
+check "docker daemon" docker info >/dev/null 2>&1
+check "docker compose" docker compose version >/dev/null 2>&1
+check ".env present" test -f .env
+check "compose file" test -f docker-compose.yml
+
+API_PORT="${API_PORT:-9090}"
+if curl -sf "http://127.0.0.1:${API_PORT}/api/v1/health/ping" >/dev/null 2>&1 \
+  || curl -sf "http://127.0.0.1:${API_PORT}/api/v1/crawl/auth/public-config" >/dev/null 2>&1; then
+  echo "  ✓ API reachable :${API_PORT}"
+  ok=$((ok + 1))
+else
+  echo "  ○ API not up yet on :${API_PORT} (start the stack if needed)"
+fi
+
+echo "Summary: ${ok} ok, ${fail} failed"
+if [[ "$fail" -gt 0 ]]; then
+  echo "How to fix:"
+  echo "  → Install Docker Desktop: https://www.docker.com/products/docker-desktop/"
+  echo "  → Publish images: GitHub Actions → Publish images (GHCR)"
+  echo "  → Start: ragsuite-test start --repo-root $ROOT --detach"
+  exit 1
+fi
+exit 0

package/templates/images/scripts/docker-start-images.sh

@@ -0,0 +1,107 @@
+#!/usr/bin/env bash
+# Start pull-only images stack (no source build).
+# Exit: 0 ok, 1 prereq, 2 env, 3 compose, 4 health
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
+cd "$ROOT"
+
+DETACH=1
+for arg in "$@"; do
+  case "$arg" in
+    -d|--detach) DETACH=1 ;;
+    -h|--help)
+      echo "Usage: $0 [--detach|-d]"
+      echo "  docker compose up -d (pull images, no --build)"
+      exit 0
+      ;;
+  esac
+done
+
+if ! command -v docker >/dev/null 2>&1; then
+  echo "error: docker is required for images install" >&2
+  exit 1
+fi
+if ! docker info >/dev/null 2>&1; then
+  echo "error: Docker daemon is not running" >&2
+  exit 1
+fi
+if ! docker compose version >/dev/null 2>&1; then
+  echo "error: docker compose plugin is required" >&2
+  exit 1
+fi
+
+if [[ ! -f .env ]]; then
+  if [[ -f .env.example ]]; then
+    cp .env.example .env
+    echo "warn: created .env from .env.example — edit secrets for production"
+  else
+    echo "error: missing .env" >&2
+    exit 2
+  fi
+fi
+
+# shellcheck disable=SC1091
+set -a
+# shellcheck source=/dev/null
+source .env
+set +a
+
+if [[ -z "${JWT_SECRET_KEY:-}" || "${JWT_SECRET_KEY}" == change-me* ]]; then
+  echo "error: JWT_SECRET_KEY must be set (non placeholder) in .env" >&2
+  exit 2
+fi
+if [[ -z "${CUSTOM_LLM_INTERNAL_API_KEY:-}" || "${CUSTOM_LLM_INTERNAL_API_KEY}" == change-me* ]]; then
+  echo "error: CUSTOM_LLM_INTERNAL_API_KEY must be set (non placeholder) in .env" >&2
+  exit 2
+fi
+
+export IMAGE_REGISTRY="${IMAGE_REGISTRY:-ghcr.io/nitsan-ai}"
+export IMAGE_TAG="${IMAGE_TAG:-latest}"
+export PULL_POLICY="${PULL_POLICY:-always}"
+
+COMPOSE_FILE="${COMPOSE_FILE:-docker-compose.yml}"
+if [[ ! -f "$COMPOSE_FILE" ]]; then
+  echo "error: missing $COMPOSE_FILE (images install)" >&2
+  exit 1
+fi
+
+echo "==> Pulling / starting images (no build) registry=${IMAGE_REGISTRY} tag=${IMAGE_TAG}"
+set +e
+docker compose -f "$COMPOSE_FILE" pull
+docker compose -f "$COMPOSE_FILE" up -d --pull always
+rc=$?
+set -e
+if [[ "$rc" -ne 0 ]]; then
+  echo "error: docker compose failed (exit $rc). Are GHCR images published and public/readable?" >&2
+  echo "  Expected: ${IMAGE_REGISTRY}/ragsuite-backend:${IMAGE_TAG}" >&2
+  echo "  Expected: ${IMAGE_REGISTRY}/ragsuite-frontend:${IMAGE_TAG}" >&2
+  exit 3
+fi
+
+API_PORT="${API_PORT:-9090}"
+echo "==> Waiting for API :${API_PORT}"
+ok=0
+for _ in $(seq 1 60); do
+  if curl -sf "http://127.0.0.1:${API_PORT}/api/v1/crawl/auth/public-config" >/dev/null 2>&1 \
+    || curl -sf "http://127.0.0.1:${API_PORT}/api/v1/health/ping" >/dev/null 2>&1; then
+    ok=1
+    break
+  fi
+  sleep 2
+done
+if [[ "$ok" -ne 1 ]]; then
+  echo "error: API health timed out" >&2
+  docker compose -f "$COMPOSE_FILE" ps -a || true
+  docker compose -f "$COMPOSE_FILE" logs backend --tail 80 || true
+  exit 4
+fi
+
+echo ""
+echo "Stack URLs:"
+echo "  API      http://localhost:${API_PORT}"
+echo "  Web UI   http://localhost:${WEB_PORT:-9091}"
+echo ""
+echo "Images stack is up (no source tree required)."
+exit 0

package/templates/images/scripts/docker-stop-images.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+# Stop pull-only images stack (volumes preserved).
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
+cd "$ROOT"
+
+if ! command -v docker >/dev/null 2>&1; then
+  echo "error: docker required" >&2
+  exit 1
+fi
+if ! docker info >/dev/null 2>&1; then
+  echo "error: Docker daemon is not running" >&2
+  exit 1
+fi
+
+COMPOSE_FILE="${COMPOSE_FILE:-docker-compose.yml}"
+echo "==> Stopping images stack (volumes preserved)…"
+docker compose -f "$COMPOSE_FILE" down
+echo "Containers stopped. Volumes kept."
+exit 0