mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-08-22 23:34:02 +00:00
d1164e6d97
- Updated docker-compose.dev.yml to include a persistent pnpm store for caching dependencies. - Modified Dockerfile to reconcile node_modules with the lockfile before starting the development server, ensuring consistent dependency management.
350 lines
12 KiB
YAML
350 lines
12 KiB
YAML
# =============================================================================
|
||
# SurfSense — Development Docker Compose
|
||
# =============================================================================
|
||
# Usage (from repo root):
|
||
# docker compose -f docker/docker-compose.dev.yml up --build
|
||
#
|
||
# This file builds from source and includes dev tools like pgAdmin.
|
||
# For production with prebuilt images, use docker/docker-compose.yml instead.
|
||
# =============================================================================
|
||
|
||
name: surfsense-dev
|
||
|
||
x-backend-build: &backend-build
|
||
context: ../surfsense_backend
|
||
args:
|
||
EMBEDDING_MODEL: ${EMBEDDING_MODEL:-sentence-transformers/all-MiniLM-L6-v2}
|
||
|
||
services:
|
||
db:
|
||
image: pgvector/pgvector:pg17
|
||
ports:
|
||
- "${POSTGRES_PORT:-5432}:5432"
|
||
volumes:
|
||
- postgres_data:/var/lib/postgresql/data
|
||
- ./postgresql.conf:/etc/postgresql/postgresql.conf:ro
|
||
environment:
|
||
- POSTGRES_USER=${DB_USER:-postgres}
|
||
- POSTGRES_PASSWORD=${DB_PASSWORD:-postgres}
|
||
- POSTGRES_DB=${DB_NAME:-surfsense}
|
||
command: postgres -c config_file=/etc/postgresql/postgresql.conf
|
||
healthcheck:
|
||
test: ["CMD-SHELL", "pg_isready -U ${DB_USER:-postgres} -d ${DB_NAME:-surfsense}"]
|
||
interval: 10s
|
||
timeout: 5s
|
||
retries: 5
|
||
|
||
# Short-lived schema runner; see docker/docker-compose.yml `migrations`
|
||
# service for the full rationale. Builds from the same backend context as
|
||
# the dev backend/celery services.
|
||
migrations:
|
||
build: *backend-build
|
||
env_file:
|
||
- ../surfsense_backend/.env
|
||
environment:
|
||
- DATABASE_URL=${DATABASE_URL:-postgresql+asyncpg://${DB_USER:-postgres}:${DB_PASSWORD:-postgres}@${DB_HOST:-db}:${DB_PORT:-5432}/${DB_NAME:-surfsense}}
|
||
- PYTHONPATH=/app
|
||
- SERVICE_ROLE=migrate
|
||
- MIGRATION_TIMEOUT=${MIGRATION_TIMEOUT:-900}
|
||
depends_on:
|
||
db:
|
||
condition: service_healthy
|
||
restart: "no"
|
||
|
||
pgadmin:
|
||
image: dpage/pgadmin4
|
||
ports:
|
||
- "${PGADMIN_PORT:-5050}:80"
|
||
environment:
|
||
- PGADMIN_DEFAULT_EMAIL=${PGADMIN_DEFAULT_EMAIL:-admin@surfsense.com}
|
||
- PGADMIN_DEFAULT_PASSWORD=${PGADMIN_DEFAULT_PASSWORD:-surfsense}
|
||
volumes:
|
||
- pgadmin_data:/var/lib/pgadmin
|
||
depends_on:
|
||
- db
|
||
|
||
redis:
|
||
image: redis:8-alpine
|
||
ports:
|
||
- "${REDIS_PORT:-6379}:6379"
|
||
volumes:
|
||
- redis_data:/data
|
||
command: redis-server --appendonly yes
|
||
healthcheck:
|
||
test: ["CMD", "redis-cli", "ping"]
|
||
interval: 10s
|
||
timeout: 5s
|
||
retries: 5
|
||
|
||
searxng:
|
||
image: searxng/searxng:2026.3.13-3c1f68c59
|
||
ports:
|
||
- "${SEARXNG_PORT:-8888}:8080"
|
||
volumes:
|
||
- ./searxng:/etc/searxng
|
||
environment:
|
||
- SEARXNG_SECRET=${SEARXNG_SECRET:-surfsense-searxng-secret}
|
||
healthcheck:
|
||
test: ["CMD", "wget", "--spider", "-q", "http://localhost:8080/healthz"]
|
||
interval: 10s
|
||
timeout: 5s
|
||
retries: 5
|
||
|
||
# Spawns sandbox containers on the host daemon as siblings, so it needs the
|
||
# socket. Its own config path is baked into the image's CMD.
|
||
opensandbox-server:
|
||
image: opensandbox/server:v0.2.2
|
||
ports:
|
||
- "${OPENSANDBOX_PORT:-8080}:8080"
|
||
volumes:
|
||
- /var/run/docker.sock:/var/run/docker.sock
|
||
- ./opensandbox/sandbox.toml:/etc/opensandbox/config.toml:ro
|
||
- opensandbox_data:/data
|
||
extra_hosts:
|
||
- "host.docker.internal:host-gateway"
|
||
environment:
|
||
- OPENSANDBOX_SERVER_API_KEY=${OPENSANDBOX_API_KEY:-surfsense-dev-sandbox}
|
||
mem_limit: ${OPENSANDBOX_SERVER_MEMORY_LIMIT:-512m}
|
||
restart: unless-stopped
|
||
# The runtime image ships neither curl nor wget; python is on PATH.
|
||
healthcheck:
|
||
test: ["CMD", "python", "-c", "import urllib.request,sys; sys.exit(0 if urllib.request.urlopen('http://127.0.0.1:8080/health', timeout=3).status == 200 else 1)"]
|
||
interval: 10s
|
||
timeout: 5s
|
||
retries: 5
|
||
start_period: 15s
|
||
|
||
# Builds the sandbox image and exits. Sandbox containers are created by
|
||
# opensandbox-server outside compose, so nothing else would put
|
||
# surfsense-sandbox:dev on the host daemon.
|
||
sandbox-image:
|
||
build:
|
||
context: ./sandbox
|
||
image: surfsense-sandbox:dev
|
||
entrypoint: ["/bin/true"]
|
||
restart: "no"
|
||
|
||
otel-lgtm:
|
||
image: grafana/otel-lgtm:latest
|
||
ports:
|
||
- "${OTEL_GRPC_PORT:-4317}:4317"
|
||
- "${OTEL_HTTP_PORT:-4318}:4318"
|
||
- "${OTEL_GRAFANA_PORT:-3001}:3000"
|
||
- "${OTEL_TEMPO_PORT:-3200}:3200"
|
||
restart: unless-stopped
|
||
|
||
backend:
|
||
build: *backend-build
|
||
ports:
|
||
- "${BACKEND_PORT:-8000}:8000"
|
||
volumes:
|
||
- ../surfsense_backend/app:/app/app
|
||
- shared_temp:/shared_tmp
|
||
- object_store:/app/.local_object_store
|
||
env_file:
|
||
- ../surfsense_backend/.env
|
||
extra_hosts:
|
||
- "host.docker.internal:host-gateway"
|
||
environment:
|
||
- DATABASE_URL=${DATABASE_URL:-postgresql+asyncpg://${DB_USER:-postgres}:${DB_PASSWORD:-postgres}@${DB_HOST:-db}:${DB_PORT:-5432}/${DB_NAME:-surfsense}}
|
||
- CELERY_BROKER_URL=${REDIS_URL:-redis://redis:6379/0}
|
||
- CELERY_RESULT_BACKEND=${REDIS_URL:-redis://redis:6379/0}
|
||
- REDIS_APP_URL=${REDIS_URL:-redis://redis:6379/0}
|
||
- CELERY_TASK_DEFAULT_QUEUE=surfsense
|
||
- PYTHONPATH=/app
|
||
- UVICORN_LOOP=asyncio
|
||
- UNSTRUCTURED_HAS_PATCHED_LOOP=1
|
||
- FILE_STORAGE_LOCAL_PATH=/app/.local_object_store
|
||
- LANGCHAIN_TRACING_V2=false
|
||
- LANGSMITH_TRACING=false
|
||
- AUTH_TYPE=${AUTH_TYPE:-LOCAL}
|
||
- NEXT_FRONTEND_URL=${NEXT_FRONTEND_URL:-http://localhost:3000}
|
||
- WHATSAPP_BRIDGE_URL=${WHATSAPP_BRIDGE_URL:-http://whatsapp-bridge:9929}
|
||
- SEARXNG_URL=${SEARXNG_URL:-http://searxng:8080}
|
||
- MAX_FILE_SIZE_MB=${MAX_FILE_SIZE_MB:-500}
|
||
# Daytona – uncomment with SANDBOX_PROVIDER=daytona for cloud execution
|
||
# - DAYTONA_API_KEY=${DAYTONA_API_KEY:-}
|
||
# - DAYTONA_API_URL=${DAYTONA_API_URL:-https://app.daytona.io/api}
|
||
# - DAYTONA_TARGET=${DAYTONA_TARGET:-us}
|
||
- SANDBOX_ENABLED=${SANDBOX_ENABLED:-TRUE}
|
||
- SANDBOX_PROVIDER=${SANDBOX_PROVIDER:-opensandbox}
|
||
- OPENSANDBOX_DOMAIN=${OPENSANDBOX_DOMAIN:-opensandbox-server:8080}
|
||
- OPENSANDBOX_API_KEY=${OPENSANDBOX_API_KEY:-surfsense-dev-sandbox}
|
||
- SANDBOX_IMAGE=${SANDBOX_IMAGE:-surfsense-sandbox:dev}
|
||
- SERVICE_ROLE=api
|
||
depends_on:
|
||
db:
|
||
condition: service_healthy
|
||
redis:
|
||
condition: service_healthy
|
||
migrations:
|
||
condition: service_completed_successfully
|
||
opensandbox-server:
|
||
condition: service_healthy
|
||
healthcheck:
|
||
test: ["CMD", "curl", "-f", "http://localhost:8000/ready"]
|
||
interval: 15s
|
||
timeout: 5s
|
||
retries: 30
|
||
start_period: 200s
|
||
|
||
whatsapp-bridge:
|
||
build: ../surfsense_backend/scripts/whatsapp-bridge
|
||
profiles:
|
||
- whatsapp
|
||
ports:
|
||
- "127.0.0.1:${WHATSAPP_BRIDGE_PORT:-9929}:9929"
|
||
volumes:
|
||
- whatsapp_sessions:/data/sessions
|
||
environment:
|
||
- PORT=9929
|
||
- WHATSAPP_MODE=${WHATSAPP_MODE:-self-chat}
|
||
- WHATSAPP_SESSION_DIR=/data/sessions
|
||
restart: unless-stopped
|
||
healthcheck:
|
||
test: ["CMD", "wget", "-qO-", "http://localhost:9929/health"]
|
||
interval: 30s
|
||
timeout: 5s
|
||
retries: 5
|
||
|
||
celery_worker:
|
||
build: *backend-build
|
||
volumes:
|
||
- ../surfsense_backend/app:/app/app
|
||
- shared_temp:/shared_tmp
|
||
- object_store:/app/.local_object_store
|
||
env_file:
|
||
- ../surfsense_backend/.env
|
||
extra_hosts:
|
||
- "host.docker.internal:host-gateway"
|
||
environment:
|
||
- DATABASE_URL=${DATABASE_URL:-postgresql+asyncpg://${DB_USER:-postgres}:${DB_PASSWORD:-postgres}@${DB_HOST:-db}:${DB_PORT:-5432}/${DB_NAME:-surfsense}}
|
||
- CELERY_BROKER_URL=${REDIS_URL:-redis://redis:6379/0}
|
||
- CELERY_RESULT_BACKEND=${REDIS_URL:-redis://redis:6379/0}
|
||
- REDIS_APP_URL=${REDIS_URL:-redis://redis:6379/0}
|
||
- CELERY_TASK_DEFAULT_QUEUE=surfsense
|
||
- PYTHONPATH=/app
|
||
- FILE_STORAGE_LOCAL_PATH=/app/.local_object_store
|
||
- SEARXNG_URL=${SEARXNG_URL:-http://searxng:8080}
|
||
- SERVICE_ROLE=worker
|
||
depends_on:
|
||
db:
|
||
condition: service_healthy
|
||
redis:
|
||
condition: service_healthy
|
||
migrations:
|
||
condition: service_completed_successfully
|
||
backend:
|
||
condition: service_healthy
|
||
|
||
celery_beat:
|
||
build: *backend-build
|
||
env_file:
|
||
- ../surfsense_backend/.env
|
||
environment:
|
||
- DATABASE_URL=${DATABASE_URL:-postgresql+asyncpg://${DB_USER:-postgres}:${DB_PASSWORD:-postgres}@${DB_HOST:-db}:${DB_PORT:-5432}/${DB_NAME:-surfsense}}
|
||
- CELERY_BROKER_URL=${REDIS_URL:-redis://redis:6379/0}
|
||
- CELERY_RESULT_BACKEND=${REDIS_URL:-redis://redis:6379/0}
|
||
- CELERY_TASK_DEFAULT_QUEUE=surfsense
|
||
- PYTHONPATH=/app
|
||
- SERVICE_ROLE=beat
|
||
depends_on:
|
||
db:
|
||
condition: service_healthy
|
||
redis:
|
||
condition: service_healthy
|
||
migrations:
|
||
condition: service_completed_successfully
|
||
celery_worker:
|
||
condition: service_started
|
||
|
||
zero-cache:
|
||
image: rocicorp/zero:1.6.0
|
||
ports:
|
||
- "${ZERO_CACHE_PORT:-4848}:4848"
|
||
extra_hosts:
|
||
- "host.docker.internal:host-gateway"
|
||
depends_on:
|
||
db:
|
||
condition: service_healthy
|
||
migrations:
|
||
condition: service_completed_successfully
|
||
environment:
|
||
- ZERO_UPSTREAM_DB=${ZERO_UPSTREAM_DB:-postgresql://${DB_USER:-postgres}:${DB_PASSWORD:-postgres}@${DB_HOST:-db}:${DB_PORT:-5432}/${DB_NAME:-surfsense}?sslmode=${DB_SSLMODE:-disable}}
|
||
- ZERO_CVR_DB=${ZERO_CVR_DB:-postgresql://${DB_USER:-postgres}:${DB_PASSWORD:-postgres}@${DB_HOST:-db}:${DB_PORT:-5432}/${DB_NAME:-surfsense}?sslmode=${DB_SSLMODE:-disable}}
|
||
- ZERO_CHANGE_DB=${ZERO_CHANGE_DB:-postgresql://${DB_USER:-postgres}:${DB_PASSWORD:-postgres}@${DB_HOST:-db}:${DB_PORT:-5432}/${DB_NAME:-surfsense}?sslmode=${DB_SSLMODE:-disable}}
|
||
- ZERO_REPLICA_FILE=/data/zero.db
|
||
- ZERO_ADMIN_PASSWORD=${ZERO_ADMIN_PASSWORD:-surfsense-zero-admin}
|
||
- ZERO_APP_PUBLICATIONS=${ZERO_APP_PUBLICATIONS:-zero_publication}
|
||
- ZERO_AUTO_RESET=${ZERO_AUTO_RESET:-true}
|
||
- ZERO_NUM_SYNC_WORKERS=${ZERO_NUM_SYNC_WORKERS:-4}
|
||
- ZERO_UPSTREAM_MAX_CONNS=${ZERO_UPSTREAM_MAX_CONNS:-20}
|
||
- ZERO_CVR_MAX_CONNS=${ZERO_CVR_MAX_CONNS:-30}
|
||
- ZERO_QUERY_URL=${ZERO_QUERY_URL:-http://frontend:3000/api/zero/query}
|
||
- ZERO_MUTATE_URL=${ZERO_MUTATE_URL:-http://frontend:3000/api/zero/mutate}
|
||
- ZERO_QUERY_FORWARD_COOKIES=${ZERO_QUERY_FORWARD_COOKIES:-true}
|
||
- ZERO_QUERY_API_KEY=${ZERO_QUERY_API_KEY:-}
|
||
- ZERO_AUTH_REVALIDATE_INTERVAL_SECONDS=${ZERO_AUTH_REVALIDATE_INTERVAL_SECONDS:-60}
|
||
- ZERO_AUTH_RETRANSFORM_INTERVAL_SECONDS=${ZERO_AUTH_RETRANSFORM_INTERVAL_SECONDS:-60}
|
||
volumes:
|
||
- zero_cache_data:/data
|
||
restart: unless-stopped
|
||
stop_grace_period: 300s
|
||
healthcheck:
|
||
test: ["CMD", "curl", "-f", "http://localhost:4848/keepalive"]
|
||
interval: 10s
|
||
timeout: 5s
|
||
retries: 5
|
||
start_period: 600s
|
||
|
||
frontend:
|
||
build:
|
||
context: ../surfsense_web
|
||
target: dev
|
||
# Live source, same idea as the backend's app/ mount: edit on the host and
|
||
# `next dev` recompiles — no rebuild or restart for source edits. On restart,
|
||
# the dev image reconciles node_modules with the bind-mounted lockfile.
|
||
volumes:
|
||
- ../surfsense_web:/app
|
||
# Anonymous volumes keep the image's musl-built node_modules and the dev
|
||
# server's cache from being shadowed by the bind mount above.
|
||
- /app/node_modules
|
||
- /app/.next
|
||
# Persist pnpm's content-addressable store so dependency updates only
|
||
# download packages that are not already cached.
|
||
- pnpm_store:/root/.local/share/pnpm/store
|
||
ports:
|
||
- "${FRONTEND_PORT:-3000}:3000"
|
||
env_file:
|
||
- ../surfsense_web/.env
|
||
environment:
|
||
AUTH_TYPE: ${AUTH_TYPE:-LOCAL}
|
||
ETL_SERVICE: ${ETL_SERVICE:-DOCLING}
|
||
DEPLOYMENT_MODE: ${DEPLOYMENT_MODE:-self-hosted}
|
||
SURFSENSE_BACKEND_INTERNAL_URL: http://backend:8000
|
||
MAX_FILE_SIZE_MB: ${MAX_FILE_SIZE_MB:-500}
|
||
depends_on:
|
||
backend:
|
||
condition: service_healthy
|
||
zero-cache:
|
||
condition: service_healthy
|
||
|
||
volumes:
|
||
postgres_data:
|
||
name: surfsense-dev-postgres
|
||
pgadmin_data:
|
||
name: surfsense-dev-pgadmin
|
||
redis_data:
|
||
name: surfsense-dev-redis
|
||
shared_temp:
|
||
name: surfsense-dev-shared-temp
|
||
object_store:
|
||
name: surfsense-dev-object-store
|
||
zero_cache_data:
|
||
name: surfsense-dev-zero-cache
|
||
whatsapp_sessions:
|
||
name: surfsense-dev-whatsapp-sessions
|
||
opensandbox_data:
|
||
name: surfsense-dev-opensandbox
|
||
pnpm_store:
|
||
name: surfsense-dev-pnpm-store
|