Bu sayfa makine çevirisidir. Bir hata mı fark ettiniz?İyileştirmemize yardım edin.
Skip to content

Yapılandırma ​

Tüm yapılandırma ortam değişkenleri üzerinden yapılır. Her değişkenin makul bir varsayılan değeri vardır, bu yüzden SnapOtter hiçbirini ayarlamadan da kutudan çıktığı gibi çalışır.

Ortam değişkenleri ​

Sunucu ​

DeğişkenVarsayılanAçıklama
PORT1349Sunucunun dinlediği port.
BASE_PATH(boş)Genel dağıtım yolu, örn. /snapotter. Boş bırakılırsa veya / verilirse alan adının kökünden sunulur. Çalışma zamanında uygulanır; imajın yeniden derlenmesi gerekmez.
RATE_LIMIT_PER_MIN1000IP başına dakikadaki en fazla istek sayısı. Hız sınırlamasını kapatmak için 0 yapın.
CORS_ORIGIN(boş)CORS için izin verilen kaynakların virgülle ayrılmış listesi. Boşsa yalnızca aynı kaynağa izin verilir.
LOG_LEVELinfoGünlük ayrıntı düzeyi. Şunlardan biri: fatal, error, warn, info, debug, trace.
TRUST_PROXYloopback,linklocal,uniquelocalHangi eşlerin istemci IP'sini X-Forwarded-For üzerinden ayarlayabileceği. Varsayılan değer yalnızca özel ağdaki bir eşe güvenir; böylece Docker ağındaki veya LAN'daki bir ters vekil sunucu (reverse proxy) güvenilir sayılır, genel ağdaki bir istemcinin taklit ettiği başlık ise sayılmaz. true değerini yalnızca önünüzde, genel bir adreste kontrol ettiğiniz bir vekil sunucu varsa ayarlayın.

Kimlik doğrulama ​

Aşağıdaki iki boolean değişken yalnızca true ve false değerlerini kabul eder. Bunun dışındaki her değer (1, yes veya on) doğrulamadan geçemez ve sunucu dinlemeye başlamadan çıkar.

DeğişkenVarsayılanAçıklama
AUTH_ENABLEDtrueOturum açmayı zorunlu kılar. Hiç hesap olmadan çalıştırmak için false yapın; bu durumda her isteğe yönetici hakları verilir, bu yüzden yalnızca güvenilir bir ağda kullanın.
DEFAULT_USERNAMEadminİlk yönetici hesabının kullanıcı adı. Yalnızca ilk çalıştırmada kullanılır.
DEFAULT_PASSWORDadminİlk yönetici hesabının parolası. İlk oturum açmadan sonra değiştirin.
MAX_USERS0 (sınırsız)Kayıtlı kullanıcı hesaplarının en fazla sayısı. Sınırsız için 0 yapın.
SESSION_DURATION_HOURS168Oturum ömrü, saat cinsinden (varsayılan 7 gündür).
SKIP_MUST_CHANGE_PASSWORDfalseİlk oturum açmadaki zorunlu parola değiştirme istemini atlamak için true yapın.

Depolama ​

DeğişkenVarsayılanAçıklama
STORAGE_MODElocallocal veya s3. S3 ve MinIO, s3_storage özelliğini içeren bir lisansın yanı sıra aşağıdaki S3_* değişkenlerini gerektirir.
DATABASE_URLpostgres://snapotter:snapotter@localhost:5432/snapotterPostgreSQL bağlantı dizesi ve her isteğin sunulduğu bağlantı. 2.3.0 ve sonrasında DATABASE_MIGRATION_URL değerini de ayarlayın; bu durumda bu bağlantı, uygulamanın tabloları üzerinde yalnızca DML yetkisine sahip olan en düşük yetkili çalışma zamanı rolü olur. Compose yığını bunu postgres servisine yönlendirir; gömülü modu kullanmak için bunu (REDIS_URL ile birlikte) ayarlamadan bırakın.
DATABASE_MIGRATION_URL(boş)Yalnızca açılış sırasında, migrasyonları çalıştırmak ve çalışma zamanı rolüne yetki vermek için kullanılan, ilk istekten önce kapatılan yetkili bağlantı. Boş bırakırsanız SnapOtter tek rolle çalışır ve her iki işi de DATABASE_URL yapar. Bkz. En düşük yetkili roller.
REDIS_URLredis://localhost:6379Redis bağlantı dizesi (BullMQ iş kuyrukları için kullanılır). Compose bunu redis servisine yönlendirir.
WORKSPACE_PATH./tmp/workspaceİşleme sırasında geçici dosyalar için dizin. Otomatik olarak temizlenir. İmaj /tmp/workspace değerini ayarlar.
FILES_STORAGE_PATH./data/filesKalıcı kullanıcı dosyaları (yüklenen görseller, kaydedilen sonuçlar) için dizin. İmaj /data/files değerini ayarlar.

S3 nesne depolama ​

Yalnızca STORAGE_MODE=s3 olduğunda okunur. Zorunlu üç değişkenden biri eksikse başlatma, atladığınız değişkenin adıyla birlikte başarısız olur.

DeğişkenVarsayılanAçıklama
S3_BUCKET(boş)Yüklemeleri ve çıktıları tutan bucket. Zorunlu.
S3_ACCESS_KEY_ID(boş)Erişim anahtarı. Zorunlu. Konteynerde bunun yerine S3_ACCESS_KEY_ID_FILE üzerinden bağlayabilirsiniz.
S3_SECRET_ACCESS_KEY(boş)Gizli anahtar. Zorunlu. Aynı dosya kuralı geçerlidir: S3_SECRET_ACCESS_KEY_FILE.
S3_REGIONus-east-1Bucket bölgesi.
S3_ENDPOINT(boş)MinIO, R2, Backblaze ve diğer S3 uyumlu depolar için özel uç nokta. Boşsa AWS kullanılır.
S3_FORCE_PATH_STYLEfalseMinIO ve sanal ana makine adresleme yerine endpoint/bucket/key isteyen her şey için true yapın.
S3_PREFIX(boş)Anahtar öneki; böylece tek bir bucket birden fazla örneği barındırabilir.

Hareketsiz durumda şifreleme ​

DeğişkenVarsayılanAçıklama
DATA_ENCRYPTION_KEY(boş)64 onaltılık karakter (32 bayt). Veritabanında saklanan hassas ayarları şifreler. 64 onaltılık karakter olmayan her değer başlatmada reddedilir.
DATA_ENCRYPTION_KEY_PREVIOUS(boş)Terk ettiğiniz anahtar, aynı biçimde. Mevcut satırların şifresi çözülebilsin diye rotasyon sırasında ikisini de ayarlayın, ardından bunu kaldırın.

Gömülü mod ​

İmajı DATABASE_URL ve REDIS_URL olmadan çalıştırırsanız imaj, konteynerin içinde kendi PostgreSQL 17 ve Redis'ini başlatır; ikisi de loopback'e bağlıdır ve tüm veriler /data biriminde durur. Bu, hızlı başlangıç, homelab ve 1.x'ten yükseltmeler için tek komutluk docker run deneyimini geri getirir. Bu bir kolaylık yoludur, üretim dağıtımı değildir: üretimde ayrı PostgreSQL ve Redis içeren 3 konteynerli Compose yığınını çalıştırın. Gömülü mod konteynerin root olarak çalışmasını gerektirir ve keyfi UID kullanan çalışma zamanlarıyla (OpenShift, Kubernetes runAsNonRoot) uyumsuzdur; orada Compose kullanın.

DeğişkenVarsayılanAçıklama
EMBEDDEDautoDATABASE_URL ve REDIS_URL ikisi de ayarlı değilse otomatik olarak etkinleşir. Kapatmak için 0 yapın (bu durumda harici bir DATABASE_URL/REDIS_URL ayarlı değilse uygulama, konteyner içinde sessizce bir veritabanı başlatmak yerine hemen hata verir).
REDIS_MAXMEMORY512mbGömülü Redis için bellek sınırı (yalnızca gömülü mod). Raspberry Pi gibi belleği kısıtlı ana makinelerde düşürün.
EMBEDDED_REDIS_TIMEOUT_S180Açılışın, vazgeçmeden önce gömülü Redis'in PING yanıtını vermesini beklediği saniye sayısı. Zaman aşımında konteyner takılıp kalmak yerine durur ve nedenini günlüğe yazar. 1 ile 999999 arasında tam saniye; sınırsız değer yoktur, çünkü sonsuza kadar beklemek bu sınırın önlemek için var olduğu hatanın ta kendisidir. Yalnızca yavaş bir ana makine bu sınıra takılıyorsa artırın.
EMBEDDED_POSTGRES_TIMEOUT_S600Gömülü PostgreSQL için aynısı. Süre, ilk açılıştaki initdb bittikten sonra başlar; bu nedenle ilk veritabanı oluşturmayı değil, sunucu başlatmayı ve çökme kurtarmayı kapsar.

1.x'ten yükseltme: eski snapotter.db dosyanızı birimde /data/snapotter.db konumuna koyun; gömülü mod, ilk açılışta onu gömülü PostgreSQL'e aktarır. İçe aktarma bir kez çalışır; sonraki açılışlar onu atlar.

Telemetri notu: gömülü mod, diğer tüm yapılandırmalar gibi imajın analitik varsayılanını devralır. Yayımlanan imaj analitik açık olarak gelir; kapatmak için --build-arg SNAPOTTER_ANALYTICS=off ile derleyin veya uygulama içi yönetici devre dışı bırakma seçeneğini kullanın.

İşleme sınırları ​

DeğişkenVarsayılanAçıklama
MAX_UPLOAD_SIZE_MB0 (sınırsız)Yükleme başına en büyük dosya boyutu, megabayt cinsinden. Sınırsız için 0 yapın. Yayımlanan imaj 0 ile gelir; kaynaktan derlemede değer 100 ile başlar.
MAX_BATCH_SIZE0 (sınırsız)Tek bir toplu istekteki en fazla dosya sayısı. Sınırsız için 0 yapın. Yayımlanan imaj 0 ile gelir; kaynaktan derlemede değer 100 ile başlar.
CONCURRENT_JOBS0 (otomatik)Paralel çalışan toplu iş sayısı. Kullanılabilir CPU çekirdeklerine göre otomatik algılamak için 0 yapın.
MAX_MEGAPIXELS0 (sınırsız)İzin verilen en yüksek görsel çözünürlüğü, megapiksel cinsinden. Sınırsız için 0 yapın.
MAX_WORKER_THREADS0 (otomatik)Görsel işleme için en fazla worker thread sayısı. Kullanılabilir CPU çekirdeklerine göre otomatik algılamak için 0 yapın.
PROCESSING_TIMEOUT_S0 (sınır yok)İstek başına en uzun işleme süresi, saniye cinsinden. Zaman aşımı olmaması için 0 yapın.
MAX_PIPELINE_STEPS20Bir pipeline'daki en fazla adım sayısı. Sınır olmaması için 0 yapın.
MAX_CANVAS_PIXELS0 (sınır yok)Çıktı görselleri için piksel cinsinden en büyük tuval boyutu. Sınır olmaması için 0 yapın.
MAX_SVG_SIZE_MB50Temizlemeden önce kabul edilen en büyük SVG, megabayt cinsinden. 0 burada çevresindeki satırlardan farklı davranır. Ön ayrıştırma boyut sınırını yükseltmek yerine tamamen kaldırır, bu yüzden bunu ayarlı bırakın.
MAX_PDF_PAGES0 (sınırsız)PDF'den görsele dönüştürmede en fazla PDF sayfa sayısı. Sınırsız için 0 yapın.

Motorlar ​

SnapOtter her işleme ikili dosyasını konteyner içinde $PATH üzerinde arar; bu yüzden kendi derlemenizi bağlamadığınız sürece bunlar boş kalır.

DeğişkenVarsayılanAçıklama
FFMPEG_PATH(boş)Video ve ses araçlarının arkasındaki ffmpeg ikili dosyasının yolu.
FFPROBE_PATH(boş)Medya dosyalarını işlenmeden önce okuyan ffprobe yolu. FFMPEG_PATH ile aynı derlemeye yönlendirin.
QPDF_PATH(boş)PDF araçları tarafından ve yüklenen PDF'leri denetlemek için kullanılan qpdf yolu.
SOFFICE_PATH(boş)Ofis belgesi dönüştürmeleri için kullanılan LibreOffice'in soffice yolu.
PDFCPU_PATH(boş)Bazı PDF araçlarının kullandığı pdfcpu yolu.
SNAPOTTER_HW_ACCEL(boş)Donanım video kodlayıcı ailesi, nvenc veya vaapi. Boşsa yazılımla kodlar.

SNAPOTTER_HW_ACCEL için o kodlayıcı ailesiyle derlenmiş bir ffmpeg gerekir ve imajdaki ffmpeg ikisine de sahip değildir. İmajın kendi ikili dosyasıyla bu ayar yazılımla kodlamaya geri döner ve bunu açılış günlüğünde belirtir. Kullanmak için kendi ffmpeg derlemenizi bağlayın, FFMPEG_PATH ve FFPROBE_PATH değişkenlerini ona yönlendirin ve konteynere GPU aygıtını verin. nvenc için ayrıca NVIDIA_DRIVER_CAPABILITIES=compute,utility,video değerini de ayarlayın: imaj yalnızca compute,utility ister ve video olmadan NVIDIA çalışma zamanı kodlama kitaplığını bağlamaz; bu durumda kodlayıcı listelenir ama her kodlama başarısız olur. Var olmayan veya çalıştırılabilir olmayan bir yol geçersiz kılması da açılış günlüğünde adıyla belirtilir ve o ikili dosyayı gerektiren her iş, yolu düzeltene veya ayarı kaldırana kadar başarısız olur.

Yayımlanan Compose dosyaları altısını da .env dosyasından aktarır, bu yüzden orada ayarlamak yeterlidir.

Temizlik ​

DeğişkenVarsayılanAçıklama
FILE_MAX_AGE_HOURS72Kaydedilmemiş işleme sonuçlarının (ham yüklemeler ve araç çıktıları) otomatik silinmeden önce ne kadar süre tutulacağı. Dosyalar kitaplığına açıkça kaydettiğiniz dosyalar etkilenmez ve siz silene kadar kalır.
CLEANUP_INTERVAL_MINUTES60Temizlik işinin ne sıklıkta çalıştığı.

Görünüm ​

DeğişkenVarsayılanAçıklama
DEFAULT_THEMElightYeni oturumlar için varsayılan tema. light, dark veya system.
DEFAULT_LOCALEenVarsayılan arayüz dili.
DEFAULT_TOOL_VIEWsidebarVarsayılan araç düzeni. sidebar veya fullscreen.

Docker izinleri ​

DeğişkenVarsayılanAçıklama
PUID999Konteyner işlemini bu UID ile çalıştırır. Bind mount'lar için ana makinedeki kullanıcınızla eşleşecek şekilde ayarlayın (id -u).
PGID999Konteyner işlemini bu GID ile çalıştırır. Bind mount'lar için ana makinedeki grubunuzla eşleşecek şekilde ayarlayın (id -g).

Docker örneği ​

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     # Change this for non-local deployments
      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:

Birimler ​

Docker Compose yığını dört birim kullanır:

  • /data (app) - AI modelleri, Python venv ve kullanıcı dosyaları. Yüklenen dosyaları ve kurulu AI paketlerini yeniden başlatmalar boyunca korumak için bunu bağlayın.
  • /tmp/workspace (app) - İşlenmekte olan dosyalar için geçici depolama. Geçici olabilir, ancak bağlamak konteynerin yazılabilir katmanının dolmasını önler.
  • SnapOtter-pgdata (postgres) - PostgreSQL veri dizini. Tüm ilişkisel veriler (kullanıcılar, ayarlar, pipeline'lar, işler, denetim günlüğü) burada tutulur. pg_dump veya birim anlık görüntüsü ile yedekleyin.
  • SnapOtter-redisdata (redis) - Kalıcı iş kuyrukları için Redis append-only dosyası.