All 181 docs markdown files translated into 20 languages (apps/docs/<locale>/**). Companion to the i18n code PR; admin-merged because the file count exceeds GitHub's per-PR CI trigger limit. Validated by pnpm i18n:check (all surfaces, 0 stale/missing) and a clean all-locale docs build.
Wszystkie zmienne środowiskowe SnapOtter z wartościami domyślnymi. Skonfiguruj uwierzytelnianie, magazyn, modele AI, analitykę i nie tylko.
8e9e9ca2840c
human
8c7771736b3d
Konfiguracja
Cała konfiguracja odbywa się za pomocą zmiennych środowiskowych. Każda zmienna ma rozsądną wartość domyślną, więc SnapOtter działa od razu po zainstalowaniu bez ustawiania którejkolwiek z nich.
Zmienne środowiskowe
Serwer
Zmienna
Wartość domyślna
Opis
PORT
1349
Port, na którym nasłuchuje serwer.
RATE_LIMIT_PER_MIN
1000
Maksymalna liczba żądań na minutę na adres IP. Ustaw na 0, aby wyłączyć ograniczanie liczby żądań.
CORS_ORIGIN
(puste)
Rozdzielona przecinkami lista dozwolonych źródeł dla CORS albo puste dla wyłącznie tego samego źródła.
LOG_LEVEL
info
Szczegółowość logów. Jedno z: fatal, error, warn, info, debug, trace.
TRUST_PROXY
true
Ufaj nagłówkom X-Forwarded-For od zwrotnego proxy. Ustaw na false, jeśli nie działasz za proxy.
Uwierzytelnianie
Zmienna
Wartość domyślna
Opis
AUTH_ENABLED
false
Ustaw na true, aby wymagać logowania. Obraz Docker domyślnie ma true.
DEFAULT_USERNAME
admin
Nazwa użytkownika początkowego konta administratora. Używana tylko przy pierwszym uruchomieniu.
DEFAULT_PASSWORD
admin
Hasło do początkowego konta administratora. Zmień je po pierwszym zalogowaniu.
MAX_USERS
0 (bez ograniczeń)
Maksymalna liczba zarejestrowanych kont użytkowników. Ustaw na 0 dla braku ograniczeń.
SESSION_DURATION_HOURS
168
Czas życia sesji logowania w godzinach (domyślnie 7 dni).
SKIP_MUST_CHANGE_PASSWORD
-
Ustaw na dowolną niepustą wartość, aby pominąć wymuszony monit o zmianę hasła przy pierwszym zalogowaniu
Magazyn
Zmienna
Wartość domyślna
Opis
STORAGE_MODE
local
local lub s3. S3/MinIO wymaga licencji z funkcją s3_storage.
Ciąg połączenia Redis (używany dla kolejek zadań BullMQ).
WORKSPACE_PATH
./tmp/workspace
Katalog na pliki tymczasowe podczas przetwarzania. Czyszczony automatycznie.
FILES_STORAGE_PATH
./data/files
Katalog na trwałe pliki użytkownika (przesłane obrazy, zapisane wyniki).
Tryb wbudowany
Uruchom obraz bez DATABASE_URL i bez REDIS_URL, a wystartuje on własny PostgreSQL 17 i Redis wewnątrz kontenera, powiązane z pętlą zwrotną (loopback), ze wszystkimi danymi na woluminie /data. Przywraca to jednopoleceniowe doświadczenie docker run na potrzeby szybkiego startu, homelaba i aktualizacji z wersji 1.x. To ścieżka dla wygody, a nie wdrożenie produkcyjne: w środowisku produkcyjnym uruchom 3-kontenerowy stos Compose z osobnymi PostgreSQL i Redis. Tryb wbudowany wymaga uruchomienia kontenera jako root i jest niezgodny ze środowiskami uruchomieniowymi o dowolnym UID (OpenShift, Kubernetes runAsNonRoot); tam użyj Compose.
Zmienna
Wartość domyślna
Opis
EMBEDDED
auto
Włączane automatycznie, gdy zarówno DATABASE_URL, jak i REDIS_URL są nieustawione. Ustaw na 0, aby to wyłączyć (aplikacja wtedy szybko zakończy działanie, jeśli nie ustawiono zewnętrznego DATABASE_URL/REDIS_URL, zamiast po cichu uruchamiać bazę danych wewnątrz kontenera).
REDIS_MAXMEMORY
512mb
Limit pamięci dla wbudowanego Redis (tylko tryb wbudowany). Obniż go na hostach z ograniczoną pamięcią, takich jak Raspberry Pi.
Aktualizacja z wersji 1.x: umieść swój stary plik snapotter.db pod /data/snapotter.db w woluminie, a tryb wbudowany zaimportuje go do wbudowanego PostgreSQL przy pierwszym uruchomieniu. Import przebiega raz; późniejsze uruchomienia go pomijają.
Uwaga o telemetrii: tryb wbudowany dziedziczy domyślne ustawienie analityki obrazu jak każda inna konfiguracja. Publikowany obraz jest dostarczany z włączoną analityką; zbuduj z --build-arg SNAPOTTER_ANALYTICS=off albo użyj wewnątrzaplikacyjnej rezygnacji dla administratora, aby ją wyłączyć.
Limity przetwarzania
Zmienna
Wartość domyślna
Opis
MAX_UPLOAD_SIZE_MB
100
Maksymalny rozmiar pliku na jedno przesłanie w megabajtach. Ustaw na 0 dla braku ograniczeń.
MAX_BATCH_SIZE
100
Maksymalna liczba plików w pojedynczym żądaniu wsadowym. Ustaw na 0 dla braku ograniczeń.
CONCURRENT_JOBS
0 (auto)
Liczba zadań wsadowych uruchamianych równolegle. Ustaw na 0, aby automatycznie wykryć na podstawie dostępnych rdzeni CPU.
MAX_MEGAPIXELS
0 (bez ograniczeń)
Maksymalna dozwolona rozdzielczość obrazu w megapikselach. Ustaw na 0 dla braku ograniczeń.
MAX_WORKER_THREADS
0 (auto)
Maksymalna liczba wątków roboczych do przetwarzania obrazów. Ustaw na 0, aby automatycznie wykryć na podstawie dostępnych rdzeni CPU.
PROCESSING_TIMEOUT_S
0 (bez limitu)
Maksymalny czas przetwarzania na żądanie w sekundach. Ustaw na 0 dla braku limitu czasu.
MAX_PIPELINE_STEPS
20
Maksymalna liczba kroków w potoku. Ustaw na 0 dla braku limitu.
MAX_CANVAS_PIXELS
0 (bez limitu)
Maksymalny rozmiar płótna w pikselach dla obrazów wyjściowych. Ustaw na 0 dla braku limitu.
MAX_SVG_SIZE_MB
0 (bez ograniczeń)
Maksymalny rozmiar pliku SVG w megabajtach. Ustaw na 0 dla braku ograniczeń.
MAX_SPLIT_GRID
100
Maksymalny wymiar siatki dla narzędzia dzielenia obrazu.
MAX_PDF_PAGES
0 (bez ograniczeń)
Maksymalna liczba stron PDF dla konwersji PDF na obraz. Ustaw na 0 dla braku ograniczeń.
Czyszczenie
Zmienna
Wartość domyślna
Opis
FILE_MAX_AGE_HOURS
72
Jak długo niezapisane wyniki przetwarzania (surowe przesłania i wyjścia narzędzi) są przechowywane przed automatycznym usunięciem. Pliki, które jawnie zapiszesz w bibliotece Files, nie są objęte tym mechanizmem i pozostają, dopóki ich nie usuniesz.
CLEANUP_INTERVAL_MINUTES
60
Jak często uruchamiane jest zadanie czyszczenia.
Wygląd
Zmienna
Wartość domyślna
Opis
DEFAULT_THEME
light
Domyślny motyw dla nowych sesji. light lub dark.
DEFAULT_LOCALE
en
Domyślny język interfejsu.
DEFAULT_TOOL_VIEW
sidebar
Domyślny układ narzędzi. sidebar lub fullscreen.
Uprawnienia Docker
Zmienna
Wartość domyślna
Opis
PUID
999
Uruchom proces kontenera jako ten UID. Ustaw tak, aby pasował do Twojego użytkownika hosta dla montowań bind (id -u).
PGID
999
Uruchom proces kontenera jako ten GID. Ustaw tak, aby pasował do Twojej grupy hosta dla montowań bind (id -g).
/data (app) - modele AI, środowisko venv Pythona i pliki użytkownika. Zamontuj to, aby zachować przesłane pliki i zainstalowane pakiety AI między ponownymi uruchomieniami.
/tmp/workspace (app) - tymczasowy magazyn na pliki będące w trakcie przetwarzania. Może być efemeryczny, ale zamontowanie go pozwala uniknąć zapełnienia zapisywalnej warstwy kontenera.
SnapOtter-pgdata (postgres) - katalog danych PostgreSQL. Przechowuje wszystkie dane relacyjne (użytkownicy, ustawienia, potoki, zadania, dziennik audytu). Wykonaj kopię zapasową przez pg_dump lub migawkę woluminu.
SnapOtter-redisdata (redis) - plik append-only Redis dla trwałych kolejek zadań.