This page was machine-translated. Spotted a mistake?Help improve it.
Skip to content

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

VariableStandardBeschreibung
PORT1349Port, auf dem der Server lauscht.
RATE_LIMIT_PER_MIN1000Maximale 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_LEVELinfoLog-Ausführlichkeit. Eines von: fatal, error, warn, info, debug, trace.
TRUST_PROXYtrueX-Forwarded-For-Headern von einem Reverse-Proxy vertrauen. Auf false setzen, wenn nicht hinter einem Proxy.

Authentifizierung

VariableStandardBeschreibung
AUTH_ENABLEDfalseAuf true setzen, um eine Anmeldung zu erzwingen. Das Docker-Image verwendet standardmäßig true.
DEFAULT_USERNAMEadminBenutzername für das anfängliche Admin-Konto. Wird nur beim ersten Start verwendet.
DEFAULT_PASSWORDadminPasswort für das anfängliche Admin-Konto. Ändere dies nach der ersten Anmeldung.
MAX_USERS0 (unbegrenzt)Maximale Anzahl registrierter Benutzerkonten. Auf 0 setzen für unbegrenzt.
SESSION_DURATION_HOURS168Lebensdauer der Anmeldesitzung in Stunden (Standard sind 7 Tage).
SKIP_MUST_CHANGE_PASSWORD-Auf einen beliebigen nicht-leeren Wert setzen, um die erzwungene Passwortänderungsaufforderung bei der ersten Anmeldung zu umgehen

Storage

VariableStandardBeschreibung
STORAGE_MODElocallocal oder s3. S3/MinIO erfordert eine Lizenz mit dem Feature s3_storage.
DATABASE_URLpostgres://snapotter:snapotter@postgres:5432/snapotterPostgreSQL-Verbindungszeichenfolge.
REDIS_URLredis://redis:6379Redis-Verbindungszeichenfolge (wird für BullMQ-Job-Warteschlangen verwendet).
WORKSPACE_PATH./tmp/workspaceVerzeichnis für temporäre Dateien während der Verarbeitung. Wird automatisch aufgeräumt.
FILES_STORAGE_PATH./data/filesVerzeichnis für persistente Benutzerdateien (hochgeladene Bilder, gespeicherte Ergebnisse).

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.

VariableStandardBeschreibung
EMBEDDEDautoAutomatisch 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_MAXMEMORY512mbSpeicherobergrenze 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

VariableStandardBeschreibung
MAX_UPLOAD_SIZE_MB100Maximale Dateigröße pro Upload in Megabyte. Auf 0 setzen für unbegrenzt.
MAX_BATCH_SIZE100Maximale Anzahl von Dateien in einer einzelnen Stapelanfrage. Auf 0 setzen für unbegrenzt.
CONCURRENT_JOBS0 (auto)Anzahl der Stapeljobs, die parallel laufen. Auf 0 setzen, um automatisch anhand der verfügbaren CPU-Kerne zu erkennen.
MAX_MEGAPIXELS0 (unbegrenzt)Maximal erlaubte Bildauflösung in Megapixeln. Auf 0 setzen für unbegrenzt.
MAX_WORKER_THREADS0 (auto)Maximale Worker-Threads für die Bildverarbeitung. Auf 0 setzen, um automatisch anhand der verfügbaren CPU-Kerne zu erkennen.
PROCESSING_TIMEOUT_S0 (kein Limit)Maximale Verarbeitungszeit pro Anfrage in Sekunden. Auf 0 setzen für kein Timeout.
MAX_PIPELINE_STEPS20Maximale Anzahl von Schritten in einer Pipeline. Auf 0 setzen für kein Limit.
MAX_CANVAS_PIXELS0 (kein Limit)Maximale Leinwandgröße in Pixeln für Ausgabebilder. Auf 0 setzen für kein Limit.
MAX_SVG_SIZE_MB0 (unbegrenzt)Maximale SVG-Dateigröße in Megabyte. Auf 0 setzen für unbegrenzt.
MAX_SPLIT_GRID100Maximale Rasterdimension für das Bildaufteilungswerkzeug.
MAX_PDF_PAGES0 (unbegrenzt)Maximale Anzahl von PDF-Seiten für die PDF-zu-Image-Konvertierung. Auf 0 setzen für unbegrenzt.

Bereinigung

VariableStandardBeschreibung
FILE_MAX_AGE_HOURS72Wie 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_MINUTES60Wie oft der Bereinigungsjob läuft.

Erscheinungsbild

VariableStandardBeschreibung
DEFAULT_THEMElightStandard-Theme für neue Sitzungen. light oder dark.
DEFAULT_LOCALEenStandard-Oberflächensprache.
DEFAULT_TOOL_VIEWsidebarStandard-Werkzeuglayout. sidebar oder fullscreen.

Docker-Berechtigungen

VariableStandardBeschreibung
PUID999Den Containerprozess als diese UID ausführen. Setze sie passend zu deinem Host-Benutzer für Bind-Mounts (id -u).
PGID999Den Containerprozess als diese GID ausführen. Setze sie passend zu deiner Host-Gruppe für Bind-Mounts (id -g).

Docker-Beispiel

yaml
services:
  SnapOtter:
    image: snapotter/snapotter:latest
    ports:
      - "1349:1349"
    volumes:
      - SnapOtter-data:/data
      - SnapOtter-workspace:/tmp/workspace
    environment:
      - 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=12
    depends_on:
      postgres:
        condition: service_healthy
      redis:
        condition: service_healthy
    restart: unless-stopped

  postgres:
    image: postgres:17-alpine
    environment:
      POSTGRES_USER: snapotter
      POSTGRES_PASSWORD: snapotter
      POSTGRES_DB: snapotter
    volumes:
      - SnapOtter-pgdata:/var/lib/postgresql/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U snapotter"]
      interval: 10s
      timeout: 5s
      retries: 12

  redis:
    image: redis:8-alpine
    command: ["redis-server", "--maxmemory-policy", "noeviction", "--appendonly", "yes"]
    volumes:
      - SnapOtter-redisdata:/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 10s
      timeout: 5s
      retries: 12

volumes:
  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.