mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
A release-readiness QA pass over the whole product. The commits split into defects a user would hit and gates that were reporting green while measuring nothing. ## Fixes that change behaviour Rate limiting was bypassable on every install: TRUST_PROXY defaulted to true, so request.ip came from a client-set header and a forged X-Forwarded-For got past the login limiter. The default is now a private-network trust list. A transient Postgres outage stranded in-flight jobs, leaving finished output on disk with no row pointing at it. A reconciler now resolves those rows and adopts the bytes rather than dropping the work. A Redis connection that moved to a new address wedged every read-blocked consumer, so completions stopped signalling while health still answered 200. Socket timeouts plus subscriber pings recover it. Installing more than one AI bundle left the shared venv multi-versioned and silently broke three tools. The installer now reconciles distributions to one version each. Converting an image to JXL at quality 1 through 4 returned a 500, because libjxl 0.7 rejects the distance those values compute. The quality is floored at what the encoder honours. A missing ffmpeg was also reported to the user as a corrupt upload; it now says the engine is unavailable. RAW uploads reached an unpatched LibRaw on arm64, so it is built from source at 0.22.2, and the release scan was split so it can fail on an unfixed critical instead of hiding it behind ignore-unfixed. ## Gates that could not fail Two mutation lanes ran zero mutants because Stryker crawled the gitignored docs build; coverage discarded its whole report on any failing test; the lint gate skipped root tests, scripts, and two workspaces; and several generated matrices counted a host missing ffmpeg as a passing tool. Each now measures what it claims. Full evidence and the outstanding release items are tracked locally and are not part of this branch.
208 lines
7.2 KiB
YAML
208 lines
7.2 KiB
YAML
name: SnapOtter
|
|
|
|
# NVIDIA GPU deployment — requires nvidia-container-toolkit.
|
|
# Install: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html
|
|
# Usage: docker compose -f docker-compose-gpu.yml up -d
|
|
# Verify: docker logs SnapOtter 2>&1 | grep GPU
|
|
|
|
services:
|
|
SnapOtter:
|
|
build:
|
|
context: ..
|
|
dockerfile: docker/Dockerfile
|
|
args:
|
|
SNAPOTTER_ANALYTICS: "on"
|
|
image: snapotter/snapotter:latest
|
|
container_name: SnapOtter
|
|
ports:
|
|
# For internet-facing deployments, bind to localhost only:
|
|
# - "127.0.0.1:1349:1349"
|
|
- "1349:1349"
|
|
volumes:
|
|
- SnapOtter-data:/data # AI models, user files
|
|
- SnapOtter-workspace:/tmp/workspace # Temp processing (auto-cleaned)
|
|
environment:
|
|
- AUTH_ENABLED=true
|
|
- DEFAULT_USERNAME=admin
|
|
# Set a strong password. Default is 'admin' -- CHANGE THIS for any non-local deployment.
|
|
# - DEFAULT_PASSWORD=your-strong-password-here
|
|
- DEFAULT_PASSWORD=admin
|
|
- SKIP_MUST_CHANGE_PASSWORD=${SKIP_MUST_CHANGE_PASSWORD:-false}
|
|
- MAX_UPLOAD_SIZE_MB=${MAX_UPLOAD_SIZE_MB:-0}
|
|
- MAX_BATCH_SIZE=${MAX_BATCH_SIZE:-0}
|
|
- MAX_MEGAPIXELS=${MAX_MEGAPIXELS:-0}
|
|
- CONCURRENT_JOBS=${CONCURRENT_JOBS:-0}
|
|
- MAX_WORKER_THREADS=${MAX_WORKER_THREADS:-0}
|
|
- PROCESSING_TIMEOUT_S=${PROCESSING_TIMEOUT_S:-0}
|
|
- MAX_PIPELINE_STEPS=${MAX_PIPELINE_STEPS:-20}
|
|
- RATE_LIMIT_PER_MIN=${RATE_LIMIT_PER_MIN:-1000}
|
|
- MAX_USERS=${MAX_USERS:-0}
|
|
- SESSION_DURATION_HOURS=${SESSION_DURATION_HOURS:-168}
|
|
# Believe X-Forwarded-For only from a peer on a private network. Set to
|
|
# `true` only if a proxy you control sits in front on a public address.
|
|
- TRUST_PROXY=${TRUST_PROXY:-loopback,linklocal,uniquelocal}
|
|
- DATABASE_URL=postgres://${POSTGRES_USER:-snapotter}:${POSTGRES_PASSWORD:-snapotter}@postgres:5432/${POSTGRES_DB:-snapotter}
|
|
- REDIS_URL=redis://:${REDIS_PASSWORD:-snapotter}@redis:6379
|
|
# 1.x upgrade: uncomment to import the old SQLite database on first boot;
|
|
# re-comment after the migration succeeds.
|
|
# - SQLITE_MIGRATE_PATH=/data/snapotter.db
|
|
# OIDC Authentication (optional)
|
|
# - EXTERNAL_URL=https://photos.example.com
|
|
# - OIDC_ENABLED=false
|
|
# - OIDC_ISSUER_URL=
|
|
# - OIDC_CLIENT_ID=
|
|
# - OIDC_CLIENT_SECRET=
|
|
# - OIDC_SCOPES=openid profile email
|
|
# - OIDC_AUTO_CREATE_USERS=true
|
|
# - OIDC_DEFAULT_ROLE=user
|
|
# - OIDC_AUTO_LINK_USERS=false
|
|
# - OIDC_PROVIDER_NAME=
|
|
# - OIDC_USERNAME_CLAIM=preferred_username
|
|
# - OIDC_CLOCK_TOLERANCE=30
|
|
# - COOKIE_SECRET=
|
|
#
|
|
# Docker secrets (_FILE convention): mount secrets as files instead of
|
|
# passing them as plain-text env vars. Supported for sensitive vars only.
|
|
# - DEFAULT_PASSWORD_FILE=/run/secrets/snapotter_password
|
|
# - S3_ACCESS_KEY_ID_FILE=/run/secrets/s3_access_key
|
|
# - S3_SECRET_ACCESS_KEY_FILE=/run/secrets/s3_secret_key
|
|
# - OIDC_CLIENT_SECRET_FILE=/run/secrets/oidc_secret
|
|
# - COOKIE_SECRET_FILE=/run/secrets/cookie_secret
|
|
# - SNAPOTTER_LICENSE_KEY_FILE=/run/secrets/license_key
|
|
restart: unless-stopped
|
|
depends_on:
|
|
postgres:
|
|
condition: service_healthy
|
|
redis:
|
|
condition: service_healthy
|
|
# --- Security hardening ---
|
|
mem_limit: 8g
|
|
memswap_limit: 8g
|
|
cpus: 8
|
|
pids_limit: 1024
|
|
cap_drop:
|
|
- ALL
|
|
cap_add:
|
|
- CHOWN
|
|
- SETUID
|
|
- SETGID
|
|
- DAC_OVERRIDE
|
|
- FOWNER
|
|
# KILL lets tini (PID 1, root) forward SIGTERM to the gosu-dropped
|
|
# snapotter process on shutdown. Without it, root minus CAP_KILL cannot
|
|
# signal a different-UID process, so docker stop is ungraceful
|
|
# ("[FATAL tini] forwarding signal: Operation not permitted" -> SIGKILL).
|
|
- KILL
|
|
# The entrypoint can still drop from root to the snapotter user while this
|
|
# prevents setuid binaries from granting privileges to untrusted processes.
|
|
security_opt:
|
|
- no-new-privileges:true
|
|
# NOTE: read_only: true is not set because PUID/PGID remapping requires
|
|
# writing to /etc/passwd and /etc/group. Consider using Docker --user flag
|
|
# instead of PUID/PGID for read-only rootfs support.
|
|
healthcheck:
|
|
test: ["CMD", "curl", "-sf", "--max-time", "5", "http://localhost:1349/api/v1/health"]
|
|
interval: 30s
|
|
timeout: 5s
|
|
start_period: 60s
|
|
retries: 3
|
|
shm_size: "2gb" # Required for PyTorch CUDA shared memory
|
|
deploy:
|
|
resources:
|
|
reservations:
|
|
devices:
|
|
- driver: nvidia
|
|
count: all
|
|
capabilities: [gpu]
|
|
logging:
|
|
driver: json-file
|
|
options:
|
|
max-size: "50m"
|
|
max-file: "5"
|
|
|
|
postgres:
|
|
image: postgres:17-alpine@sha256:742f40ea20b9ff2ff31db5458d127452988a2164df9e17441e191f3b72252193
|
|
container_name: SnapOtter-postgres
|
|
environment:
|
|
POSTGRES_USER: ${POSTGRES_USER:-snapotter}
|
|
# Set a strong password. CHANGE THIS for any non-local deployment.
|
|
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-snapotter}
|
|
POSTGRES_DB: ${POSTGRES_DB:-snapotter}
|
|
volumes:
|
|
- SnapOtter-pgdata:/var/lib/postgresql/data
|
|
restart: unless-stopped
|
|
# --- Security hardening ---
|
|
mem_limit: 1g
|
|
memswap_limit: 1g
|
|
cpus: 2
|
|
pids_limit: 256
|
|
# The official image starts as root and su-execs down to the postgres user,
|
|
# so setuid/setgid + chown caps are required. A read-only rootfs is omitted
|
|
# because the entrypoint must initialize and adjust its data directory.
|
|
cap_drop:
|
|
- ALL
|
|
cap_add:
|
|
- CHOWN
|
|
- DAC_OVERRIDE
|
|
- FOWNER
|
|
- SETGID
|
|
- SETUID
|
|
security_opt:
|
|
- no-new-privileges:true
|
|
healthcheck:
|
|
test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER:-snapotter} -d ${POSTGRES_DB:-snapotter}"]
|
|
interval: 10s
|
|
timeout: 5s
|
|
retries: 12
|
|
start_period: 15s
|
|
|
|
redis:
|
|
image: redis:8-alpine@sha256:9d317178eceac8454a2284a9e6df2466b93c745529947f0cd42a0fa9609d7005
|
|
container_name: SnapOtter-redis
|
|
command: >-
|
|
redis-server
|
|
--maxmemory-policy noeviction
|
|
--maxmemory 512mb
|
|
--appendonly yes
|
|
--requirepass ${REDIS_PASSWORD:-snapotter}
|
|
volumes:
|
|
- SnapOtter-redisdata:/data
|
|
restart: unless-stopped
|
|
# --- Security hardening ---
|
|
mem_limit: 1g
|
|
memswap_limit: 1g
|
|
cpus: 2
|
|
pids_limit: 256
|
|
# The official image starts as root and gosu-drops to the redis user, so
|
|
# setuid/setgid + chown caps are required. A read-only rootfs is omitted
|
|
# because the entrypoint must initialize and adjust its data directory.
|
|
cap_drop:
|
|
- ALL
|
|
cap_add:
|
|
- CHOWN
|
|
- DAC_OVERRIDE
|
|
- FOWNER
|
|
- SETGID
|
|
- SETUID
|
|
security_opt:
|
|
- no-new-privileges:true
|
|
healthcheck:
|
|
test: ["CMD", "redis-cli", "-a", "${REDIS_PASSWORD:-snapotter}", "--no-auth-warning", "ping"]
|
|
interval: 10s
|
|
timeout: 5s
|
|
retries: 12
|
|
start_period: 10s
|
|
|
|
# Uncomment to use Docker secrets (requires Docker Swarm or compose v2.23+):
|
|
# secrets:
|
|
# snapotter_password:
|
|
# file: ./secrets/snapotter_password.txt
|
|
# oidc_secret:
|
|
# file: ./secrets/oidc_secret.txt
|
|
|
|
volumes:
|
|
SnapOtter-data:
|
|
SnapOtter-workspace:
|
|
SnapOtter-pgdata:
|
|
SnapOtter-redisdata:
|