@nitsan-ai/ragsuite-test 0.1.1 → 0.1.3

package/src/index.js

@@ -31,15 +31,16 @@ function globalHelp() {
     'Global options:',
     '  --help, -h              Show help',
     '  --repo-root <path>      Monorepo / install root',
-    '  --from-git [url]        init: clone public monorepo',
-    '  --install-dir <path>    init: target for --from-git (default ~/ragsuite-test)',
+    '  --from-git [url]        init: clone source (default public repo)',
+    '  --from-images           init: Docker images only (no app source on disk)',
+    '  --install-dir <path>    init: install target (default ~/ragsuite-test)',
     '  --llm-api-key <key>     init: optional override for CUSTOM_LLM_INTERNAL_API_KEY',
     '  --smtp-host <host>      init: optional SMTP override',
     '  --smtp-user <user>      init: optional SMTP override',
     '  --smtp-password <pass>  init: optional SMTP override',
     '  --email-from <email>    init: optional SMTP override',
     '  --force                 init: overwrite non-empty install dir / .env',
-    '  --yes, -y               Non-interactive',
+    '  --yes, -y               Non-interactive (same defaults as plain init)',
     '  --mode <docker|native>  Override config (Docker optional)',
     '  --dry-run               Print actions without running (start/stop/doctor/logs)',
     '',

package/src/utils/args.js

@@ -11,6 +11,7 @@ function parseArgv(argv) {
     dryRun: false,
     mode: null,
     fromGit: null,
+    fromImages: false,
     fromRelease: null,
     installDir: null,
     force: false,
@@ -79,6 +80,11 @@ function parseArgv(argv) {
       continue;
     }
 
+    if (t === '--from-images') {
+      globals.fromImages = true;
+      continue;
+    }
+
     if (t === '--from-git' || t.startsWith('--from-git=')) {
       if (t === '--from-git') {
         const next = tokens[i + 1];

package/src/utils/config.js

@@ -21,6 +21,12 @@ function defaultConfig(repoRoot, mode = 'docker') {
   };
 }
 
+function normalizeSource(raw) {
+  const s = String(raw || '').trim();
+  if (s === 'images' || s === 'git' || s === 'zip' || s === 'checkout') return s;
+  return 'checkout';
+}
+
 function readConfig(repoRoot) {
   const file = configPath(repoRoot);
   if (!fs.existsSync(file)) {
@@ -31,11 +37,10 @@ function readConfig(repoRoot) {
     if (!raw || typeof raw !== 'object') {
       return null;
     }
-    const source = raw.source === 'zip' ? 'zip' : 'checkout';
     return {
       version: Number(raw.version) || CONFIG_VERSION,
       mode: raw.mode === 'native' ? 'native' : 'docker',
-      source,
+      source: normalizeSource(raw.source),
       repoRoot: path.resolve(String(raw.repoRoot || repoRoot)),
       installDir: path.resolve(String(raw.installDir || raw.repoRoot || repoRoot)),
     };
@@ -48,10 +53,11 @@ function writeConfig(repoRoot, partial = {}) {
   const dir = path.join(repoRoot, CONFIG_DIR);
   fs.mkdirSync(dir, { recursive: true });
   const existing = readConfig(repoRoot) || defaultConfig(repoRoot);
-  const source =
-    partial.source === 'zip' || partial.source === 'checkout'
+  const source = normalizeSource(
+    partial.source !== undefined && partial.source !== null
       ? partial.source
-      : existing.source || 'checkout';
+      : existing.source || 'checkout',
+  );
   const next = {
     ...existing,
     ...partial,

package/src/utils/distribution.js

@@ -3,22 +3,21 @@
 /**
  * Distribution modes for the testing CLI.
  *
- * - git-clone: init --from-git (public deploy)
- * - local-checkout: --repo-root / env / walk-up
- * Registry/GHCR compose remains stubbed.
+ * - git-clone: `ragsuite-test init` (source on disk)
+ * - images: `ragsuite-test init --from-images` (pull GHCR, no app source)
+ * - local-checkout: --repo-root
  */
 
 const MODE_LOCAL = 'local-checkout';
 const MODE_GIT = 'git-clone';
+const MODE_IMAGES = 'images';
 const MODE_REGISTRY = 'registry-compose';
 
-function assertSupportedInstall() {
-  // git + checkout supported
-}
+function assertSupportedInstall() {}
 
 function resolveComposeBundle() {
   const err = new Error(
-    'Registry/compose (GHCR) install is not available yet. Use: ragsuite-test init --from-git  OR  --repo-root <checkout>.',
+    'Use: ragsuite-test init --from-images  (pull-only)  OR  ragsuite-test init  (git source)',
   );
   err.code = 'DIST_NOT_READY';
   throw err;
@@ -26,16 +25,17 @@ function resolveComposeBundle() {
 
 function installHint() {
   return [
-    'Install paths:',
-    '  Public:    ragsuite-test init --from-git [--install-dir ~/ragsuite-test]',
-    '  Checkout:  ragsuite-test init --repo-root <path>',
-    'Docker is optional — use --mode native (Postgres :5436 + Redis :6382) if you have no Docker.',
+    'Choose an install style:',
+    '  Source on disk:  ragsuite-test init',
+    '  No source:       ragsuite-test init --from-images',
+    'Then:              ragsuite-test start --repo-root ~/ragsuite-test --detach',
   ].join('\n');
 }
 
 module.exports = {
   MODE_LOCAL,
   MODE_GIT,
+  MODE_IMAGES,
   MODE_REGISTRY,
   mode: MODE_GIT,
   assertSupportedInstall,

package/src/utils/images-install.js

@@ -0,0 +1,100 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const { defaultInstallDir } = require('./git-install');
+
+function templatesRoot() {
+  return path.join(__dirname, '..', '..', 'templates', 'images');
+}
+
+function isDirEmptyOrMissing(dir) {
+  if (!fs.existsSync(dir)) return true;
+  const items = fs.readdirSync(dir).filter((n) => n !== '.DS_Store');
+  return items.length === 0;
+}
+
+function copyFile(src, dest) {
+  fs.mkdirSync(path.dirname(dest), { recursive: true });
+  fs.copyFileSync(src, dest);
+}
+
+/**
+ * Materialize a pull-only install dir (compose + scripts + .env.example).
+ * No monorepo source.
+ */
+function materializeImagesInstall(options = {}) {
+  const { installDir = defaultInstallDir(), force = false } = options;
+  const srcRoot = templatesRoot();
+  if (!fs.existsSync(path.join(srcRoot, 'docker-compose.yml'))) {
+    const err = new Error(
+      `Images templates missing in CLI package (${srcRoot}). Reinstall @nitsan-ai/ragsuite-test.`,
+    );
+    err.code = 'IMAGES_TEMPLATE_MISSING';
+    throw err;
+  }
+
+  const target = path.resolve(installDir);
+  if (!isDirEmptyOrMissing(target)) {
+    if (!force) {
+      const err = new Error(
+        `Install directory is not empty: ${target}. Pass --force to replace, or choose another --install-dir.`,
+      );
+      err.code = 'INSTALL_DIR_NONEMPTY';
+      throw err;
+    }
+    fs.rmSync(target, { recursive: true, force: true });
+  }
+
+  fs.mkdirSync(target, { recursive: true });
+  copyFile(
+    path.join(srcRoot, 'docker-compose.yml'),
+    path.join(target, 'docker-compose.yml'),
+  );
+  copyFile(
+    path.join(srcRoot, '.env.example'),
+    path.join(target, '.env.example'),
+  );
+  copyFile(
+    path.join(srcRoot, 'scripts', 'docker-start-images.sh'),
+    path.join(target, 'scripts', 'docker-start-images.sh'),
+  );
+  copyFile(
+    path.join(srcRoot, 'scripts', 'docker-stop-images.sh'),
+    path.join(target, 'scripts', 'docker-stop-images.sh'),
+  );
+  copyFile(
+    path.join(srcRoot, 'scripts', 'docker-doctor-images.sh'),
+    path.join(target, 'scripts', 'docker-doctor-images.sh'),
+  );
+  try {
+    fs.chmodSync(path.join(target, 'scripts', 'docker-start-images.sh'), 0o755);
+    fs.chmodSync(path.join(target, 'scripts', 'docker-stop-images.sh'), 0o755);
+    fs.chmodSync(path.join(target, 'scripts', 'docker-doctor-images.sh'), 0o755);
+  } catch {
+    /* windows */
+  }
+
+  // Minimal package.json so tooling can identify the install dir
+  fs.writeFileSync(
+    path.join(target, 'package.json'),
+    `${JSON.stringify(
+      {
+        name: 'ragsuite-images-install',
+        private: true,
+        description: 'RAGSuite pull-only images install (no source tree)',
+      },
+      null,
+      2,
+    )}\n`,
+    'utf8',
+  );
+
+  return { repoRoot: target };
+}
+
+module.exports = {
+  templatesRoot,
+  materializeImagesInstall,
+  defaultInstallDir,
+};

package/src/utils/paths.js

@@ -4,14 +4,35 @@ const fs = require('fs');
 const path = require('path');
 const { readConfig, CONFIG_DIR } = require('./config');
 
-function looksLikeRepoRoot(dir) {
+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 looksLikeImagesInstall(dir) {
+  const compose = path.join(dir, 'docker-compose.yml');
+  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 */
+    }
+  }
+  // Before config is written, or force-detect by scripts present without docker-start.sh
+  return !fs.existsSync(path.join(dir, 'scripts', 'docker-start.sh'));
+}
+
+function looksLikeRepoRoot(dir) {
+  return looksLikeGitCheckout(dir) || looksLikeImagesInstall(dir);
+}
+
 function looksLikeFullBundleRoot(dir) {
-  if (!looksLikeRepoRoot(dir)) return false;
+  if (!looksLikeGitCheckout(dir)) return false;
   const compose = path.join(dir, 'docker-compose.yml');
   return fs.existsSync(compose);
 }
@@ -42,10 +63,6 @@ function envRepoRoot(env = process.env) {
   return null;
 }
 
-/**
- * Resolve monorepo root:
- * --repo-root → RAGSUITE_REPO_ROOT / RAGSUITE_INSTALL_DIR → walk-up / config.
- */
 function resolveRepoRoot({
   cwd = process.cwd(),
   repoRootFlag,
@@ -56,7 +73,7 @@ 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: ${root} (need git checkout or images install)`,
       );
       err.code = 'NOT_REPO_ROOT';
       throw err;
@@ -91,7 +108,7 @@ function resolveRepoRoot({
   }
 
   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',
+    'Could not find RAGSuite install. Run: ragsuite-test init   OR   ragsuite-test init --from-images',
   );
   err.code = 'NOT_REPO_ROOT';
   throw err;
@@ -107,13 +124,20 @@ 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);
+}
+
 module.exports = {
   looksLikeRepoRoot,
+  looksLikeGitCheckout,
+  looksLikeImagesInstall,
   looksLikeFullBundleRoot,
   walkUpForRepoRoot,
   envRepoRoot,
@@ -121,4 +145,5 @@ module.exports = {
   scriptPath,
   ensureRagsuiteDir,
   nativeLogDir,
+  isImagesInstall,
 };

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