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.
Alle SnapOtter-Umgebungsvariablen mit Standardwerten. Konfiguriere Auth, Storage, KI-Modelle, Analyse und mehr.
25970c776f7c
human
89c266bf51be
2
Konfiguration
Die gesamte Konfiguration erfolgt über Umgebungsvariablen. Jede Variable hat einen sinnvollen Standardwert, sodass SnapOtter ohne das Setzen einer einzigen davon sofort funktioniert.
Umgebungsvariablen
Server
Variable
Standard
Beschreibung
PORT
1349
Port, auf dem der Server lauscht.
RATE_LIMIT_PER_MIN
1000
Maximale Anzahl von Anfragen pro Minute pro IP. Auf 0 setzen, um die Ratenbegrenzung zu deaktivieren.
CORS_ORIGIN
(leer)
Kommagetrennte erlaubte Origins für CORS, oder leer für ausschließlich Same-Origin.
LOG_LEVEL
info
Log-Ausführlichkeit. Eines von: fatal, error, warn, info, debug, trace.
TRUST_PROXY
loopback,linklocal,uniquelocal
Welche Gegenstellen die Client-IP über X-Forwarded-For setzen dürfen. Der Standard glaubt nur einer Gegenstelle aus einem privaten Netz, also gilt ein Reverse-Proxy im Docker-Netzwerk oder im LAN als vertrauenswürdig, der gefälschte Header eines öffentlichen Clients dagegen nicht. Setze true nur dann, wenn ein von dir kontrollierter Proxy unter einer öffentlichen Adresse davorsitzt.
Authentifizierung
Die beiden folgenden Booleans akzeptieren nur true und false. Alles andere, ob 1, yes oder on, scheitert an der Validierung, und der Server beendet sich, bevor er zu lauschen beginnt.
Variable
Standard
Beschreibung
AUTH_ENABLED
true
Eine Anmeldung erzwingen. Auf false setzen, um ganz ohne Konten zu laufen; das gibt jeder Anfrage Admin-Rechte, beschränke das also auf ein vertrauenswürdiges Netzwerk.
DEFAULT_USERNAME
admin
Benutzername für das anfängliche Admin-Konto. Wird nur beim ersten Start verwendet.
DEFAULT_PASSWORD
admin
Passwort für das anfängliche Admin-Konto. Ändere dies nach der ersten Anmeldung.
MAX_USERS
0 (unbegrenzt)
Maximale Anzahl registrierter Benutzerkonten. Auf 0 setzen für unbegrenzt.
SESSION_DURATION_HOURS
168
Lebensdauer der Anmeldesitzung in Stunden (Standard sind 7 Tage).
SKIP_MUST_CHANGE_PASSWORD
false
Auf true setzen, um die erzwungene Passwortänderungsaufforderung bei der ersten Anmeldung zu überspringen.
Storage
Variable
Standard
Beschreibung
STORAGE_MODE
local
local oder s3. S3 und MinIO benötigen eine Lizenz mit dem Feature s3_storage sowie die untenstehenden S3_*-Variablen.
PostgreSQL-Verbindungszeichenfolge. Der Compose-Stack richtet sie auf seinen postgres-Dienst; lass sie (zusammen mit REDIS_URL) ungesetzt, um den eingebetteten Modus zu bekommen.
REDIS_URL
redis://localhost:6379
Redis-Verbindungszeichenfolge (wird für BullMQ-Job-Warteschlangen verwendet). Compose richtet sie auf seinen redis-Dienst.
WORKSPACE_PATH
./tmp/workspace
Verzeichnis für temporäre Dateien während der Verarbeitung. Wird automatisch aufgeräumt. Das Image setzt /tmp/workspace.
FILES_STORAGE_PATH
./data/files
Verzeichnis für persistente Benutzerdateien (hochgeladene Bilder, gespeicherte Ergebnisse). Das Image setzt /data/files.
S3-Objektspeicher
Wird nur gelesen, wenn STORAGE_MODE=s3 gilt. Fehlt eine der drei erforderlichen Variablen, schlägt der Start fehl und nennt den Namen der Variable, die du weggelassen hast.
Variable
Standard
Beschreibung
S3_BUCKET
(leer)
Bucket, der Uploads und Ausgaben enthält. Erforderlich.
S3_ACCESS_KEY_ID
(leer)
Access Key. Erforderlich. Im Container kannst du ihn stattdessen einhängen, über S3_ACCESS_KEY_ID_FILE.
Eigener Endpunkt für MinIO, R2, Backblaze und andere S3-kompatible Speicher. Leer bedeutet AWS.
S3_FORCE_PATH_STYLE
false
Auf true setzen für MinIO und alles andere, das endpoint/bucket/key statt der Virtual-Host-Adressierung erwartet.
S3_PREFIX
(leer)
Schlüsselpräfix, damit ein Bucket mehrere Instanzen aufnehmen kann.
Verschlüsselung im Ruhezustand
Variable
Standard
Beschreibung
DATA_ENCRYPTION_KEY
(leer)
64 Hex-Zeichen (32 Byte). Verschlüsselt sensible Einstellungen, die in der Datenbank gespeichert sind. Alles, was nicht 64 Hex-Zeichen lang ist, wird beim Start abgelehnt.
DATA_ENCRYPTION_KEY_PREVIOUS
(leer)
Der Schlüssel, von dem du wegrotierst, im gleichen Format. Setze während einer Rotation beide, damit vorhandene Zeilen weiterhin entschlüsselt werden, und entferne diesen danach.
Eingebetteter Modus
Wenn du das Image ohne DATABASE_URL und ohne REDIS_URL startest, startet es sein eigenes PostgreSQL 17 und Redis im Container, an Loopback gebunden, mit allen Daten auf dem /data-Volume. Das stellt das Erlebnis docker run mit einem einzigen Befehl für Schnellstart, Homelab und Upgrades von 1.x wieder her. Es ist ein Komfortpfad, kein Produktions-Deployment: Für die Produktion betreibe den 3-Container-Compose-Stack mit separatem PostgreSQL und Redis. Der eingebettete Modus erfordert, den Container als Root zu betreiben, und ist mit Runtimes mit beliebiger UID (OpenShift, Kubernetes runAsNonRoot) nicht kompatibel; verwende dort Compose.
Variable
Standard
Beschreibung
EMBEDDED
auto
Automatisch aktiviert, wenn sowohl DATABASE_URL als auch REDIS_URL nicht gesetzt sind. Auf 0 setzen, um es zu deaktivieren (die App schlägt dann sofort fehl, wenn kein externes DATABASE_URL/REDIS_URL gesetzt ist, statt stillschweigend eine In-Container-Datenbank zu starten).
REDIS_MAXMEMORY
512mb
Speicherobergrenze für das eingebettete Redis (nur im eingebetteten Modus). Senke sie auf speicherbeschränkten Hosts wie einem Raspberry Pi.
Upgrade von 1.x: Lege deine alte snapotter.db unter /data/snapotter.db im Volume ab, und der eingebettete Modus importiert sie beim ersten Start in das eingebettete PostgreSQL. Der Import läuft einmal; spätere Starts überspringen ihn.
Telemetrie-Hinweis: Der eingebettete Modus übernimmt den Analyse-Standard des Images wie jede andere Konfiguration. Das veröffentlichte Image wird mit aktivierter Analyse ausgeliefert; baue mit --build-arg SNAPOTTER_ANALYTICS=off oder nutze das In-App-Admin-Opt-out, um sie zu deaktivieren.
Verarbeitungslimits
Variable
Standard
Beschreibung
MAX_UPLOAD_SIZE_MB
0 (unbegrenzt)
Maximale Dateigröße pro Upload in Megabyte. Auf 0 setzen für unbegrenzt. Das veröffentlichte Image wird mit 0 ausgeliefert; ein Build aus dem Quellcode startet bei 100.
MAX_BATCH_SIZE
0 (unbegrenzt)
Maximale Anzahl von Dateien in einer einzelnen Stapelanfrage. Auf 0 setzen für unbegrenzt. Das veröffentlichte Image wird mit 0 ausgeliefert; ein Build aus dem Quellcode startet bei 100.
CONCURRENT_JOBS
0 (auto)
Anzahl der Stapeljobs, die parallel laufen. Auf 0 setzen, um automatisch anhand der verfügbaren CPU-Kerne zu erkennen.
MAX_MEGAPIXELS
0 (unbegrenzt)
Maximal erlaubte Bildauflösung in Megapixeln. Auf 0 setzen für unbegrenzt.
MAX_WORKER_THREADS
0 (auto)
Maximale Worker-Threads für die Bildverarbeitung. Auf 0 setzen, um automatisch anhand der verfügbaren CPU-Kerne zu erkennen.
PROCESSING_TIMEOUT_S
0 (kein Limit)
Maximale Verarbeitungszeit pro Anfrage in Sekunden. Auf 0 setzen für kein Timeout.
MAX_PIPELINE_STEPS
20
Maximale Anzahl von Schritten in einer Pipeline. Auf 0 setzen für kein Limit.
MAX_CANVAS_PIXELS
0 (kein Limit)
Maximale Leinwandgröße in Pixeln für Ausgabebilder. Auf 0 setzen für kein Limit.
MAX_SVG_SIZE_MB
50
Größte SVG-Datei, die vor der Bereinigung akzeptiert wird, in Megabyte. 0 verhält sich hier anders als in den umliegenden Zeilen. Es entfernt die Größenbeschränkung vor dem Parsen vollständig, statt sie anzuheben, lass diesen Wert also gesetzt.
MAX_PDF_PAGES
0 (unbegrenzt)
Maximale Anzahl von PDF-Seiten für die PDF-zu-Image-Konvertierung. Auf 0 setzen für unbegrenzt.
Bereinigung
Variable
Standard
Beschreibung
FILE_MAX_AGE_HOURS
72
Wie lange ungespeicherte Verarbeitungsergebnisse (rohe Uploads und Werkzeugausgaben) vor der automatischen Löschung aufbewahrt werden. Dateien, die du explizit in der Files-Bibliothek speicherst, sind davon nicht betroffen und bleiben bestehen, bis du sie löschst.
CLEANUP_INTERVAL_MINUTES
60
Wie oft der Bereinigungsjob läuft.
Erscheinungsbild
Variable
Standard
Beschreibung
DEFAULT_THEME
light
Standard-Theme für neue Sitzungen. light, dark oder system.
DEFAULT_LOCALE
en
Standard-Oberflächensprache.
DEFAULT_TOOL_VIEW
sidebar
Standard-Werkzeuglayout. sidebar oder fullscreen.
Docker-Berechtigungen
Variable
Standard
Beschreibung
PUID
999
Den Containerprozess als diese UID ausführen. Setze sie passend zu deinem Host-Benutzer für Bind-Mounts (id -u).
PGID
999
Den Containerprozess als diese GID ausführen. Setze sie passend zu deiner Host-Gruppe für Bind-Mounts (id -g).
Docker-Beispiel
services:SnapOtter:image:snapotter/snapotter:latestports:- "1349:1349"volumes:- SnapOtter-data:/data- SnapOtter-workspace:/tmp/workspaceenvironment:- AUTH_ENABLED=true- DEFAULT_USERNAME=admin- DEFAULT_PASSWORD=changeme- DATABASE_URL=postgres://snapotter:snapotter@postgres:5432/snapotter- REDIS_URL=redis://redis:6379- MAX_UPLOAD_SIZE_MB=200- CONCURRENT_JOBS=4- FILE_MAX_AGE_HOURS=12depends_on:postgres:condition:service_healthyredis:condition:service_healthyrestart:unless-stoppedpostgres:image:postgres:17-alpineenvironment:POSTGRES_USER:snapotterPOSTGRES_PASSWORD:snapotter # Ändern Sie dies für nicht lokale BereitstellungenPOSTGRES_DB:snapottervolumes:- SnapOtter-pgdata:/var/lib/postgresql/datarestart:unless-stoppedhealthcheck:test:["CMD-SHELL","pg_isready -U snapotter -d snapotter"]interval:10stimeout:5sretries:12redis:image:redis:8-alpinecommand:["redis-server","--maxmemory-policy","noeviction","--appendonly","yes"]volumes:- SnapOtter-redisdata:/datarestart:unless-stoppedhealthcheck:test:["CMD","redis-cli","ping"]interval:10stimeout:5sretries:12volumes:SnapOtter-data:SnapOtter-workspace:SnapOtter-pgdata:SnapOtter-redisdata:
Volumes
Der Docker-Compose-Stack verwendet vier Volumes:
/data (app) - KI-Modelle, Python-venv und Benutzerdateien. Mounte dies, um hochgeladene Dateien und installierte KI-Bundles über Neustarts hinweg zu behalten.
/tmp/workspace (app) - Temporärer Speicher für Dateien, die gerade verarbeitet werden. Dies kann flüchtig sein, aber ein Mount vermeidet, dass die beschreibbare Schicht des Containers voll läuft.
SnapOtter-pgdata (postgres) - PostgreSQL-Datenverzeichnis. Dies enthält alle relationalen Daten (Benutzer, Einstellungen, Pipelines, Jobs, Audit-Log). Sichere es über pg_dump oder einen Volume-Snapshot.
SnapOtter-redisdata (redis) - Redis-Append-only-Datei für dauerhafte Job-Warteschlangen.