mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
Phase 1 — Docker Artifact Optimization: - Replace broad `COPY . .` with targeted frontend source copies (API/Python changes no longer bust the frontend build cache) - Replace build-essential with gcc/g++ (leaner runtime) - Fix LOG_LEVEL=debug → info for production - Harden .dockerignore (exclude worktrees, IDE, CI, test artifacts) Phase 2 — State & Persistence: - Add PUID/PGID support in entrypoint.sh for bind mount compatibility - Guard against PUID=0/PGID=0 to prevent accidental root execution - Evict conflicting system users (e.g. node:1000) before UID remap Phase 3 — Security: - Always register @fastify/rate-limit so login brute-force protection works even when global rate limit is disabled (RATE_LIMIT_PER_MIN=0) - Add trustProxy support (TRUST_PROXY env var, default true) so rate limiting and audit logs use real client IPs behind reverse proxies - Strip stack traces from 500 error responses in production - Fix FSTDEP022 deprecation: maxParamLength → routerOptions - Add multi-file guard on single-file tool endpoint with clear error message pointing to the /batch endpoint Phase 4 — Graceful Degradation: - Add consolidated hardware detection startup banner (GPU, rate limit, upload limit, proxy status) - Add ConnectionMonitor component with health polling and reconnecting overlay that auto-dismisses when the server comes back Phase 5 — Deployment Docs: - Rewrite deployment.md with copy-paste CPU and GPU compose templates - Add hardware requirements table (minimum, recommended, heavy workloads) - Add PUID/PGID bind mount documentation - Add complete env var reference table - Add reverse proxy guides for Nginx, Nginx Proxy Manager, Traefik, and Cloudflare Tunnels
266 lines
8.5 KiB
TypeScript
266 lines
8.5 KiB
TypeScript
import { isGpuAvailable } from "@ashim/ai";
|
|
import { APP_VERSION } from "@ashim/shared";
|
|
import cors from "@fastify/cors";
|
|
import rateLimit from "@fastify/rate-limit";
|
|
import Fastify from "fastify";
|
|
import { env } from "./config.js";
|
|
import { db, schema } from "./db/index.js";
|
|
import { runMigrations } from "./db/migrate.js";
|
|
import { startCleanupCron } from "./lib/cleanup.js";
|
|
import { ensureAiDirs, recoverInterruptedInstalls } from "./lib/feature-status.js";
|
|
import { shutdownWorkerPool } from "./lib/worker-pool.js";
|
|
import { authMiddleware, authRoutes, ensureDefaultAdmin, requireAdmin } from "./plugins/auth.js";
|
|
import { registerStatic } from "./plugins/static.js";
|
|
import { registerUpload } from "./plugins/upload.js";
|
|
import { apiKeyRoutes } from "./routes/api-keys.js";
|
|
import { registerBatchRoutes } from "./routes/batch.js";
|
|
import { brandingRoutes } from "./routes/branding.js";
|
|
import { docsRoutes } from "./routes/docs.js";
|
|
import { registerFeatureRoutes } from "./routes/features.js";
|
|
import { fileRoutes } from "./routes/files.js";
|
|
import { registerPipelineRoutes } from "./routes/pipeline.js";
|
|
import { recoverStaleJobs, registerProgressRoutes } from "./routes/progress.js";
|
|
import { settingsRoutes } from "./routes/settings.js";
|
|
import { teamsRoutes } from "./routes/teams.js";
|
|
import { registerToolRoutes } from "./routes/tools/index.js";
|
|
import { userFileRoutes } from "./routes/user-files.js";
|
|
|
|
// Run before anything else
|
|
runMigrations();
|
|
console.log("Database initialized");
|
|
|
|
// Create default admin user if no users exist
|
|
await ensureDefaultAdmin();
|
|
|
|
// Mark any jobs left in processing/queued from a previous unclean shutdown
|
|
recoverStaleJobs();
|
|
|
|
// Set up AI feature directories and recover from interrupted installs
|
|
ensureAiDirs();
|
|
recoverInterruptedInstalls();
|
|
|
|
const app = Fastify({
|
|
logger: { level: env.LOG_LEVEL },
|
|
bodyLimit: env.MAX_UPLOAD_SIZE_MB > 0 ? env.MAX_UPLOAD_SIZE_MB * 1024 * 1024 : 1073741824,
|
|
trustProxy: env.TRUST_PROXY,
|
|
routerOptions: { maxParamLength: 500 },
|
|
});
|
|
|
|
app.setErrorHandler((error: Error & { statusCode?: number }, request, reply) => {
|
|
const statusCode = error.statusCode ?? 500;
|
|
request.log.error(
|
|
{ err: error, url: request.url, method: request.method },
|
|
"Unhandled request error",
|
|
);
|
|
const isProduction = process.env.NODE_ENV === "production";
|
|
reply.status(statusCode).send({
|
|
error: statusCode >= 500 ? "Internal server error" : error.message,
|
|
...(statusCode < 500 && { details: error.message }),
|
|
...(!isProduction && statusCode >= 500 && { details: error.stack ?? error.message }),
|
|
});
|
|
});
|
|
|
|
// Plugins
|
|
await app.register(cors, {
|
|
origin: env.CORS_ORIGIN
|
|
? env.CORS_ORIGIN.split(",").map((s) => s.trim())
|
|
: process.env.NODE_ENV !== "production",
|
|
});
|
|
|
|
// Security headers
|
|
app.addHook("onSend", async (_request, reply) => {
|
|
reply.header("X-Content-Type-Options", "nosniff");
|
|
reply.header("X-Frame-Options", "DENY");
|
|
reply.header("X-XSS-Protection", "0");
|
|
reply.header("Referrer-Policy", "strict-origin-when-cross-origin");
|
|
reply.header("Permissions-Policy", "camera=(), microphone=(), geolocation=()");
|
|
if (process.env.NODE_ENV === "production") {
|
|
reply.header("Strict-Transport-Security", "max-age=31536000; includeSubDomains");
|
|
const csp = _request.url.startsWith("/api/docs")
|
|
? "default-src 'self'; script-src 'self' 'unsafe-inline'; style-src 'self' 'unsafe-inline'; img-src 'self' blob: data:; connect-src 'self'; font-src 'self' data:; object-src 'none'; base-uri 'self'; form-action 'self'"
|
|
: "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' blob: data: https://tile.openstreetmap.org; connect-src 'self'; font-src 'self' data:; object-src 'none'; frame-ancestors 'none'; base-uri 'self'; form-action 'self'";
|
|
reply.header("Content-Security-Policy", csp);
|
|
}
|
|
});
|
|
|
|
// Always register rate-limit plugin so per-route limits (login brute-force protection) work.
|
|
// When RATE_LIMIT_PER_MIN=0, the global limit is set high enough to be effectively unlimited
|
|
// while still enabling per-route overrides like the login endpoint.
|
|
await app.register(rateLimit, {
|
|
max: env.RATE_LIMIT_PER_MIN > 0 ? env.RATE_LIMIT_PER_MIN : 50000,
|
|
timeWindow: "1 minute",
|
|
allowList: (request) => !request.url.startsWith("/api/"),
|
|
});
|
|
|
|
// Multipart upload support
|
|
await registerUpload(app);
|
|
|
|
// Auth middleware (must be registered before routes it protects)
|
|
await authMiddleware(app);
|
|
|
|
// Auth routes
|
|
await authRoutes(app);
|
|
|
|
// File upload/download routes
|
|
await fileRoutes(app);
|
|
|
|
// User file library routes (persistent file management with versioning)
|
|
await userFileRoutes(app);
|
|
|
|
// Tool routes (generic factory-based)
|
|
await registerToolRoutes(app);
|
|
|
|
// Batch processing routes (must be after tool routes so the registry is populated)
|
|
await registerBatchRoutes(app);
|
|
|
|
// Pipeline routes (must be after tool routes so the registry is populated)
|
|
await registerPipelineRoutes(app);
|
|
|
|
// Progress SSE routes
|
|
await registerProgressRoutes(app);
|
|
|
|
// API key management routes
|
|
await apiKeyRoutes(app);
|
|
|
|
// Settings routes
|
|
await settingsRoutes(app);
|
|
|
|
// Feature management routes (AI feature bundle install/uninstall)
|
|
await registerFeatureRoutes(app);
|
|
|
|
// Branding routes (logo upload/serve/delete)
|
|
await brandingRoutes(app);
|
|
|
|
// Teams routes
|
|
await teamsRoutes(app);
|
|
|
|
// API docs (Scalar)
|
|
await docsRoutes(app);
|
|
|
|
// Public health check (checks core dependencies)
|
|
app.get("/api/v1/health", async (_request, reply) => {
|
|
let dbOk = false;
|
|
try {
|
|
db.select().from(schema.settings).limit(1).get();
|
|
dbOk = true;
|
|
} catch {
|
|
/* db unreachable */
|
|
}
|
|
|
|
const status = dbOk ? "healthy" : "unhealthy";
|
|
const code = dbOk ? 200 : 503;
|
|
return reply.code(code).send({
|
|
status,
|
|
version: APP_VERSION,
|
|
});
|
|
});
|
|
|
|
// Admin health check (full diagnostics)
|
|
app.get("/api/v1/admin/health", async (request, reply) => {
|
|
const admin = requireAdmin(request, reply);
|
|
if (!admin) return;
|
|
|
|
let dbOk = false;
|
|
try {
|
|
db.select().from(schema.settings).limit(1).all();
|
|
dbOk = true;
|
|
} catch {
|
|
/* db unreachable */
|
|
}
|
|
return {
|
|
status: dbOk ? "healthy" : "degraded",
|
|
version: APP_VERSION,
|
|
uptime: `${process.uptime().toFixed(0)}s`,
|
|
storage: { mode: env.STORAGE_MODE, available: "N/A" },
|
|
database: dbOk ? "ok" : "error",
|
|
queue: { active: 0, pending: 0 },
|
|
ai: { gpu: isGpuAvailable() },
|
|
};
|
|
});
|
|
|
|
// Public config endpoint (for frontend to know if auth is required)
|
|
app.get("/api/v1/config/auth", async () => ({
|
|
authEnabled: env.AUTH_ENABLED,
|
|
}));
|
|
|
|
// Serve SPA in production
|
|
if (process.env.NODE_ENV === "production") {
|
|
await registerStatic(app);
|
|
}
|
|
|
|
// Start workspace cleanup cron
|
|
const cleanupCron = startCleanupCron();
|
|
|
|
// Start
|
|
try {
|
|
await app.listen({ port: env.PORT, host: "0.0.0.0" });
|
|
const gpu = isGpuAvailable();
|
|
console.log(
|
|
[
|
|
`ashim v${APP_VERSION} running on port ${env.PORT}`,
|
|
gpu
|
|
? "[INFO] GPU detected — AI tools will use CUDA acceleration"
|
|
: "[WARN] No GPU detected — AI tools will use CPU (slower)",
|
|
`[INFO] Rate limit: ${env.RATE_LIMIT_PER_MIN > 0 ? `${env.RATE_LIMIT_PER_MIN}/min` : "disabled"}`,
|
|
`[INFO] Upload limit: ${env.MAX_UPLOAD_SIZE_MB > 0 ? `${env.MAX_UPLOAD_SIZE_MB} MB` : "unlimited"}`,
|
|
`[INFO] Trust proxy: ${env.TRUST_PROXY}`,
|
|
].join("\n"),
|
|
);
|
|
} catch (err) {
|
|
app.log.error(err);
|
|
process.exit(1);
|
|
}
|
|
|
|
// Graceful shutdown
|
|
const SHUTDOWN_TIMEOUT_MS = 30000;
|
|
let shuttingDown = false;
|
|
async function shutdown(signal: string) {
|
|
if (shuttingDown) return;
|
|
shuttingDown = true;
|
|
console.log(`\n${signal} received, shutting down gracefully...`);
|
|
|
|
const forceExit = setTimeout(() => {
|
|
console.error("Shutdown timed out, forcing exit");
|
|
process.exit(1);
|
|
}, SHUTDOWN_TIMEOUT_MS);
|
|
forceExit.unref();
|
|
|
|
cleanupCron.stop();
|
|
|
|
try {
|
|
await app.close();
|
|
console.log("HTTP server closed");
|
|
} catch (err) {
|
|
console.error("Error closing HTTP server:", err);
|
|
}
|
|
|
|
try {
|
|
await shutdownWorkerPool();
|
|
console.log("Worker pool shut down");
|
|
} catch (err) {
|
|
console.error("Error shutting down worker pool:", err);
|
|
}
|
|
|
|
try {
|
|
const { shutdownDispatcher } = await import("@ashim/ai");
|
|
shutdownDispatcher();
|
|
console.log("Python dispatcher shut down");
|
|
} catch {
|
|
// AI package may not be available
|
|
}
|
|
|
|
try {
|
|
const { sqlite: sqliteConn } = await import("./db/index.js");
|
|
sqliteConn.close();
|
|
console.log("Database connection closed");
|
|
} catch (err) {
|
|
console.error("Error closing database:", err);
|
|
}
|
|
|
|
clearTimeout(forceExit);
|
|
process.exit(0);
|
|
}
|
|
|
|
process.on("SIGTERM", () => shutdown("SIGTERM"));
|
|
process.on("SIGINT", () => shutdown("SIGINT"));
|