Files
SnapOtter/apps/docs/nl/guide/getting-started.md
T
SnapOtterandGitHub 5f21588f6c chore: prepare the 2.2.0 release (#660)
Bumps every version surface to 2.2.0, fixes a latent version-coupling bug in the
OCR runtime tests, and stops an absent GPU runner from silently stalling a
release.

Version surfaces: scripts/sync-version.sh covers the 11 workspaces, APP_VERSION,
and the docs release commands across all locales. Root package.json plus the
three surfaces the script never reaches are done by hand: the DOCKERHUB.md banner
and tag table, the docker-tags.md pinning table in 21 locales, and the example
runtimeVersion in tools/image/ocr.md in 21 locales. The release-notes archive step
is deliberately not pre-run, so the notes text stays editable until the release.

Latent bug: runtime-state rejects any runtime whose compatibility.snapotterVersion
is not exactly APP_VERSION, and five fixtures pinned the literal 2.1.0. Since
semantic-release rewrites APP_VERSION on every release, the first PR after any
bump would have gone red for a reason nobody would trace to the release. The
fixtures now derive from APP_VERSION.

GPU runner: sign-ocr-index needs verify-ocr-nvidia on self-hosted hardware, and
the gated manifest job needs ai-bundles, so a missing runner queued instead of
failing and produced no image tags. preflight-gpu-runner claims the same labels
with no dependencies, so it is scheduled first and validates the GPU before the
90-minute build. An API preflight is impossible because listing self-hosted
runners needs Administration:read, which GITHUB_TOKEN cannot hold, so RELEASE.md
carries the maintainer-side check.
2026-07-27 22:09:31 +08:00

8.0 KiB

description, i18n_source_hash, i18n_provenance, i18n_output_hash, i18n_hash_version
description i18n_source_hash i18n_provenance i18n_output_hash i18n_hash_version
Installeer SnapOtter met Docker in één commando. Inclusief Docker Compose-installatie, bouwen vanaf broncode en een volledig functieoverzicht. 8040133a6982 machine 034d42379189 2

Aan de slag

::: tip Probeer voor je installeert Verken de volledige UI op demo.snapotter.com - geen aanmelding of installatie vereist. :::

Snelstart

docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest

Deze enkele container voert alles uit wat hij nodig heeft: zonder DATABASE_URL ingesteld, start hij zijn eigen PostgreSQL en Redis op de loopback-interface (embedded mode) en bewaart hij alle gegevens in het SnapOtter-data-volume. Het is de snelste manier om SnapOtter uit te proberen of zelf te hosten op een thuislab. Gebruik voor productie de canonieke Docker Compose-stack, die PostgreSQL en Redis in hun eigen containers bewaart. De ingebouwde modus wordt uitgevoerd als root (standaard) en wordt automatisch uitgeschakeld zodra u DATABASE_URL instelt.

Installeer je op een Raspberry Pi, een oude laptop of een kleine VPS? Zie Setups met beperkte resources voor een afgestemd stappenplan en wat je van beperkte hardware kunt verwachten.

Je wordt bij de eerste login gevraagd je wachtwoord te wijzigen.

::: tip Anonieme Productanalytics SnapOtter bevat standaard anonieme productanalytics. Om het uit te schakelen, open je Instellingen → Systeem → Privacy en zet je Anonieme Productanalytics uit. Het stopt onmiddellijk voor de hele instance.

Je kunt ook de omgevingsvariabele SNAPOTTER_TELEMETRY=0 instellen (false en off werken ook) om alle telemetrie voor de instance uit te schakelen zonder herbouw.

Foutmonitoring wordt aangedreven door Sentry, dat SnapOtter sponsort via zijn open-source-programma.

Zie Wat SnapOtter verzamelt voor details over wat er wordt verzameld. :::

::: tip NVIDIA CUDA-versnelling Voeg --gpus all toe voor NVIDIA CUDA-versnelde achtergrondverwijdering, opschaling, gezichtsverbetering en restauratie. OCR blijft CPU-gebaseerd en werkt in dezelfde afbeelding met of zonder GPU-toegang:

docker run -d --name SnapOtter -p 1349:1349 --gpus all -v SnapOtter-data:/data snapotter/snapotter:latest

Vereist de NVIDIA Container Toolkit. Valt automatisch terug naar de CPU wanneer CUDA niet beschikbaar is. Intel/AMD iGPU-versnelling via VA-API, Quick Sync of OpenCL wordt momenteel niet ondersteund voor AI-inferentie. Zie Docker-tags voor benchmarks. Als AI-tools ondanks --gpus all op de CPU draaien, zie dan GPU-versnelling verifiëren. :::

::: details Ook op GHCR

docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data ghcr.io/snapotter-hq/snapotter:latest

Beide registries publiceren bij elke release dezelfde image. :::

Docker Componeer

Gebruik het productiebestand dat bij elke release wordt onderhouden en getest in plaats van een verkort Compose-voorbeeld van deze pagina te kopiëren:

install -d -m 700 snapotter && cd snapotter
curl --proto '=https' --tlsv1.2 -fsSLo docker-compose.yml \
  https://raw.githubusercontent.com/snapotter-hq/SnapOtter/v2.2.0/docker/docker-compose.yml

# Keep generated service credentials out of shell history and world-readable files.
umask 077
POSTGRES_PASSWORD="$(openssl rand -hex 32)"
REDIS_PASSWORD="$(openssl rand -hex 32)"
printf 'POSTGRES_PASSWORD=%s\nREDIS_PASSWORD=%s\n' \
  "$POSTGRES_PASSWORD" "$REDIS_PASSWORD" > .env

docker compose -f docker-compose.yml pull
docker compose -f docker-compose.yml up -d --no-build

De canonieke docker/docker-compose.yml omvat alle vier de runtimevolumes, gezondheidscontroles, resourcelimieten, duurzame Redis-configuratie, vastgezette database-/cache-images en de huidige containerverharding. Wijzig het standaard beheerderswachtwoord onmiddellijk na de eerste keer inloggen. Voor een reproduceerbare implementatie maakt u de SnapOtter-toepassingsimage vast aan de releasetag of -digest die u hebt geverifieerd, in plaats van latest te volgen.

Zie Configuratie voor alle omgevingsvariabelen en Beveiliging en beveiliging voor geheimen, netwerkbeleid en back-uprichtlijnen.

Bouwen vanaf broncode

Vereisten: Node.js 22.22+, pnpm 9+, Docker (voor Postgres + Redis), Python 3.11+ (voor AI-functies), Git.

git clone https://github.com/snapotter-hq/SnapOtter.git
cd SnapOtter
docker compose -f docker-compose.dev.yml up -d   # start Postgres + Redis
pnpm install
pnpm dev

Wat je kunt doen

Bestandsverwerking (200+ tools)

Modaliteit Aantal Voorbeeldtools
Afbeelding 107 Formaat wijzigen, Bijsnijden, Comprimeren, Converteren, Achtergrond verwijderen, Upscale, OCR, Watermerk, Collage, Inkleuren, GIF-tools, formaatpresets
Video 57 Trimmen, Bijsnijden, Comprimeren, Converteren, Samenvoegen, Audio extraheren, Automatische ondertitels, Video naar GIF, Formaat wijzigen, Stabiliseren, formaatpresets
Audio 27 Trimmen, Samenvoegen, Converteren, Normaliseren, Ruisonderdrukking, Transcriberen, Pitch verschuiven, Fade, Beltoonmaker, formaatpresets
PDF / Document 29 Samenvoegen, Splitsen, Comprimeren, OCR, Watermerk, Redigeren, Word naar PDF, Excel naar PDF, Roteren, Beveiligen, Repareren
Bestanden 23 CSV naar JSON, JSON naar XML, CSV's samenvoegen, CSV splitsen, ZIP maken, ZIP uitpakken, Grafiekmaker, YAML/JSON

Pijplijnen

Koppel tools aan elkaar tot workflows met meerdere stappen en pas ze toe op één afbeelding of een hele batch:

  1. Open Pijplijnen in de zijbalk.
  2. Voeg stappen toe (elke tool, alle instellingen).
  3. Draai op één bestand - of een hele batch tegelijk.
  4. Sla de pijplijn op voor later hergebruik.

Pijplijnen staan standaard 20 stappen toe. Stel MAX_PIPELINE_STEPS=0 in om de limiet onbeperkt te maken.

Bestandsbibliotheek

Elk bestand dat je verwerkt, kan worden opgeslagen in je Bestanden-bibliotheek. SnapOtter houdt de volledige versiegeschiedenis bij zodat je elke verwerkingsstap kunt traceren van de oorspronkelijke upload tot de uiteindelijke uitvoer.

Opslaan is expliciet: resultaten die je in de bibliotheek opslaat, blijven bewaard tot je ze verwijdert, terwijl resultaten die je verwerkt en niet opslaat automatisch na 72 uur worden gewist (configureerbaar via FILE_MAX_AGE_HOURS).

REST API & API-sleutels

Elke tool is toegankelijk via HTTP:

curl -X POST http://localhost:1349/api/v1/tools/image/resize \
  -H "Authorization: Bearer si_<your-api-key>" \
  -F "file=@photo.jpg" \
  -F 'settings={"width":800,"height":600,"fit":"cover"}'

Genereer API-sleutels onder Instellingen → API-sleutels. Zie de REST API-referentie voor alle endpoints, of bezoek http://localhost:1349/api/docs voor de interactieve referentie.

Meerdere gebruikers & teams

Schakel meerdere gebruikers in met op rollen gebaseerde toegangscontrole:

  • Beheerder: volledige toegang - beheer gebruikers, teams, instellingen, alle bestanden/pijplijnen/API-sleutels
  • Gebruiker: gebruik tools, beheer eigen bestanden/pijplijnen/API-sleutels

Maak teams aan onder Instellingen → Teams om gebruikers te groeperen.

Stel AUTH_ENABLED=true in (of false voor gebruik met één gebruiker/eigen gebruik zonder login).