Questa pagina è stata tradotta automaticamente. Hai notato un errore?Aiutaci a migliorarla.
Skip to content

Configurazione

Tutta la configurazione avviene tramite variabili d'ambiente. Ogni variabile ha un valore predefinito sensato, quindi SnapOtter funziona out of the box senza impostarne nessuna.

Variabili d'ambiente

Server

VariabilePredefinitoDescrizione
PORT1349Porta su cui il server è in ascolto.
RATE_LIMIT_PER_MIN1000Numero massimo di richieste al minuto per IP. Imposta a 0 per disabilitare il rate limiting.
CORS_ORIGIN(vuoto)Origini consentite per CORS separate da virgola, oppure vuoto per solo same-origin.
LOG_LEVELinfoVerbosità dei log. Uno tra: fatal, error, warn, info, debug, trace.
TRUST_PROXYloopback,linklocal,uniquelocalQuali peer possono impostare l'IP del client tramite X-Forwarded-For. Il valore predefinito crede solo a un peer su rete privata, quindi un reverse proxy su una rete Docker o su una LAN è attendibile, mentre l'intestazione falsificata di un client pubblico non lo è. Imposta true solo quando davanti c'è un proxy che controlli tu, su un indirizzo pubblico.

Autenticazione

I due booleani qui sotto accettano solo true e false. Qualsiasi altro valore, che sia 1, yes oppure on, non supera la validazione e il server termina prima di mettersi in ascolto.

VariabilePredefinitoDescrizione
AUTH_ENABLEDtrueRichiede il login. Imposta a false per funzionare senza alcun account, il che concede a ogni richiesta i diritti di admin, quindi tienilo su una rete fidata.
DEFAULT_USERNAMEadminNome utente per l'account admin iniziale. Usato solo alla prima esecuzione.
DEFAULT_PASSWORDadminPassword per l'account admin iniziale. Cambiala dopo il primo login.
MAX_USERS0 (illimitato)Numero massimo di account utente registrati. Imposta a 0 per illimitato.
SESSION_DURATION_HOURS168Durata della sessione di login in ore (il predefinito è 7 giorni).
SKIP_MUST_CHANGE_PASSWORDfalseImposta a true per saltare la richiesta forzata di cambio password al primo login.

Archiviazione

VariabilePredefinitoDescrizione
STORAGE_MODElocallocal o s3. S3 e MinIO richiedono una licenza con la funzionalità s3_storage, oltre alle variabili S3_* qui sotto.
DATABASE_URLpostgres://snapotter:snapotter@localhost:5432/snapotterStringa di connessione PostgreSQL. Lo stack Compose la punta al suo servizio postgres; lasciala non impostata (insieme a REDIS_URL) per ottenere la modalità embedded.
REDIS_URLredis://localhost:6379Stringa di connessione Redis (usata per le code di lavori BullMQ). Compose la punta al suo servizio redis.
WORKSPACE_PATH./tmp/workspaceDirectory per i file temporanei durante l'elaborazione. Pulita automaticamente. L'immagine imposta /tmp/workspace.
FILES_STORAGE_PATH./data/filesDirectory per i file utente persistenti (immagini caricate, risultati salvati). L'immagine imposta /data/files.

Archiviazione oggetti S3

Lette solo quando STORAGE_MODE=s3. Se manca una delle tre obbligatorie, l'avvio fallisce indicando il nome della variabile che hai tralasciato.

VariabilePredefinitoDescrizione
S3_BUCKET(vuoto)Bucket che contiene upload e output. Obbligatorio.
S3_ACCESS_KEY_ID(vuoto)Access key. Obbligatoria. Nel container puoi invece montarla, tramite S3_ACCESS_KEY_ID_FILE.
S3_SECRET_ACCESS_KEY(vuoto)Secret key. Obbligatoria. Stessa convenzione per i file: S3_SECRET_ACCESS_KEY_FILE.
S3_REGIONus-east-1Regione del bucket.
S3_ENDPOINT(vuoto)Endpoint personalizzato per MinIO, R2, Backblaze e altri store compatibili con S3. Vuoto significa AWS.
S3_FORCE_PATH_STYLEfalseImposta a true per MinIO e per qualsiasi altro servizio che si aspetta endpoint/bucket/key invece dell'indirizzamento virtual-host.
S3_PREFIX(vuoto)Prefisso delle chiavi, così un solo bucket può ospitare più istanze.

Crittografia a riposo

VariabilePredefinitoDescrizione
DATA_ENCRYPTION_KEY(vuoto)64 caratteri esadecimali (32 byte). Cifra le impostazioni sensibili salvate nel database. Qualsiasi cosa che non sia di 64 caratteri esadecimali viene rifiutata all'avvio.
DATA_ENCRYPTION_KEY_PREVIOUS(vuoto)La chiave che stai abbandonando durante una rotazione, nello stesso formato. Impostale entrambe durante la rotazione così le righe esistenti restano decifrabili, poi rimuovi questa.

Modalità embedded

Esegui l'immagine senza DATABASE_URL e senza REDIS_URL e avvia il proprio PostgreSQL 17 e Redis all'interno del container, associati al loopback, con tutti i dati sul volume /data. Questo ripristina l'esperienza a comando singolo docker run per l'avvio rapido, l'homelab e gli aggiornamenti dalla 1.x. È un percorso di comodità, non un deployment di produzione: per la produzione, esegui lo stack Compose a 3 container con PostgreSQL e Redis separati. La modalità embedded richiede l'esecuzione del container come root ed è incompatibile con i runtime a UID arbitrario (OpenShift, Kubernetes runAsNonRoot); lì usa Compose.

VariabilePredefinitoDescrizione
EMBEDDEDautoAbilitata automaticamente quando sia DATABASE_URL sia REDIS_URL non sono impostate. Imposta a 0 per disabilitarla (l'app allora fallisce rapidamente se non è impostato alcun DATABASE_URL/REDIS_URL esterno, invece di avviare silenziosamente un database in-container).
REDIS_MAXMEMORY512mbLimite di memoria per il Redis embedded (solo modalità embedded). Abbassalo su host con memoria limitata come un Raspberry Pi.

Aggiornamento dalla 1.x: metti il tuo vecchio snapotter.db in /data/snapotter.db nel volume e la modalità embedded lo importa nel PostgreSQL embedded al primo avvio. L'importazione avviene una volta sola; gli avvii successivi la saltano.

Nota sulla telemetria: la modalità embedded eredita il valore predefinito delle analisi dell'immagine come qualsiasi altra configurazione. L'immagine pubblicata viene fornita con le analisi attive; compila con --build-arg SNAPOTTER_ANALYTICS=off, oppure usa l'opt-out admin in-app, per disabilitarla.

Limiti di elaborazione

VariabilePredefinitoDescrizione
MAX_UPLOAD_SIZE_MB0 (illimitato)Dimensione massima del file per upload in megabyte. Imposta a 0 per illimitato. L'immagine pubblicata viene fornita con 0; una build dai sorgenti parte da 100.
MAX_BATCH_SIZE0 (illimitato)Numero massimo di file in una singola richiesta batch. Imposta a 0 per illimitato. L'immagine pubblicata viene fornita con 0; una build dai sorgenti parte da 100.
CONCURRENT_JOBS0 (auto)Numero di lavori batch che girano in parallelo. Imposta a 0 per rilevarlo automaticamente in base ai core CPU disponibili.
MAX_MEGAPIXELS0 (illimitato)Risoluzione massima dell'immagine consentita in megapixel. Imposta a 0 per illimitato.
MAX_WORKER_THREADS0 (auto)Numero massimo di thread worker per l'elaborazione delle immagini. Imposta a 0 per rilevarlo automaticamente in base ai core CPU disponibili.
PROCESSING_TIMEOUT_S0 (nessun limite)Tempo massimo di elaborazione per richiesta in secondi. Imposta a 0 per nessun timeout.
MAX_PIPELINE_STEPS20Numero massimo di passaggi in una pipeline. Imposta a 0 per nessun limite.
MAX_CANVAS_PIXELS0 (nessun limite)Dimensione massima del canvas in pixel per le immagini di output. Imposta a 0 per nessun limite.
MAX_SVG_SIZE_MB50Il più grande SVG accettato prima della sanificazione, in megabyte. Qui 0 si comporta diversamente rispetto alle righe vicine. Rimuove del tutto il limite di dimensione applicato prima del parsing invece di alzarlo, quindi lascia questo valore impostato.
MAX_PDF_PAGES0 (illimitato)Numero massimo di pagine PDF per la conversione PDF-a-immagine. Imposta a 0 per illimitato.

Pulizia

VariabilePredefinitoDescrizione
FILE_MAX_AGE_HOURS72Per quanto tempo i risultati di elaborazione non salvati (upload grezzi e output degli strumenti) vengono conservati prima dell'eliminazione automatica. I file che salvi esplicitamente nella libreria File non sono interessati e persistono finché non li elimini.
CLEANUP_INTERVAL_MINUTES60Con quale frequenza viene eseguito il lavoro di pulizia.

Aspetto

VariabilePredefinitoDescrizione
DEFAULT_THEMElightTema predefinito per le nuove sessioni. light, dark o system.
DEFAULT_LOCALEenLingua predefinita dell'interfaccia.
DEFAULT_TOOL_VIEWsidebarLayout predefinito degli strumenti. sidebar o fullscreen.

Permessi Docker

VariabilePredefinitoDescrizione
PUID999Esegui il processo del container come questo UID. Imposta per corrispondere al tuo utente host per i bind mount (id -u).
PGID999Esegui il processo del container come questo GID. Imposta per corrispondere al tuo gruppo host per i bind mount (id -g).

Esempio Docker

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     # Modificarlo per distribuzioni non locali
      POSTGRES_DB: snapotter
    volumes:
      - SnapOtter-pgdata:/var/lib/postgresql/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U snapotter -d 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:

Volumi

Lo stack Docker Compose usa quattro volumi:

  • /data (app) - Modelli AI, venv Python e file utente. Montalo per conservare i file caricati e i bundle AI installati tra i riavvii.
  • /tmp/workspace (app) - Archiviazione temporanea per i file in elaborazione. Può essere effimera, ma montarlo evita di riempire il livello scrivibile del container.
  • SnapOtter-pgdata (postgres) - Directory dati di PostgreSQL. Contiene tutti i dati relazionali (utenti, impostazioni, pipeline, lavori, log di audit). Esegui il backup tramite pg_dump o snapshot del volume.
  • SnapOtter-redisdata (redis) - File append-only di Redis per code di lavori durevoli.