SnapOtter
Stack
File toolkit with over 200 tools for images, PDFs, video, audio and data files, like compressing, converting, OCR, background removal and transcription, with saved pipelines and a REST API. Source: https://github.com/snapotter-hq/SnapOtter
Source details
Configuration
TypeComposelinuxSNAPOTTER_DB_PASSWORD=''SNAPOTTER_PORT=1349unless-stoppedTemplate by NotAFlightRisk·Source
Report issueNotes
openssl rand -hex 16), and keep it the same on every redeploy. It's a big pull, about 3.7 GB on amd64 (the CUDA libraries for NVIDIA cards ride along) and 1.8 GB on arm64. Open it on port 1349 and log in with admin / admin, which makes you pick a new password straight away, so do that before anyone else on your network does. Add more people under Settings --> People. Out of the box it sends anonymous usage stats and crash reports to its makers, so switch that off under Settings --> System Settings --> Privacy if you'd rather it didn't. Results you don't save to Files are deleted after 72 hours. The AI tools (background removal, upscaling and so on) need their models installed first under Settings --> AI Features, at several GB each. Saved files and those models live in the snapotter-data volume, and accounts, settings and pipelines in Postgres (postgres-data). Docs: docs.snapotter.comServices
snapotter
Configuration
Imagesnapotter/snapotter:2${SNAPOTTER_PORT:-1349}:1349/data : snapotter-data/tmp/workspace : snapotter-workspaceDATABASE_URL=postgres://snapotter_app:${SNAPOTTER_DB_PASSWORD:?Set a database password}@postgres:5432/snapotterDATABASE_MIGRATION_URL=postgres://snapotter:${SNAPOTTER_DB_PASSWORD:?Set a database password}@postgres:5432/snapotterREDIS_URL=redis://redis:6379unless-stoppedImage details
postgres
Configuration
Imagepostgres:17-alpine/var/lib/postgresql/data : postgres-dataPOSTGRES_DB=snapotterPOSTGRES_USER=snapotterPOSTGRES_PASSWORD=${SNAPOTTER_DB_PASSWORD:?Set a database password}unless-stoppedImage details
redis
Configuration
Imageredis:8-alpineredis-server,--maxmemory-policy,noeviction,--appendonly,yes/data : redis-dataunless-stoppedImage details
Standalone Install
Select an install method, to see config/commands for deploying SnapOtter
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select SnapOtter, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
Original stackfile
The compose file this template deploys, straight from its repo:
services:
snapotter:
image: snapotter/snapotter:2
restart: unless-stopped
ports:
- "${SNAPOTTER_PORT:-1349}:1349"
environment:
DATABASE_URL: postgres://snapotter_app:${SNAPOTTER_DB_PASSWORD:?Set a database password}@postgres:5432/snapotter
DATABASE_MIGRATION_URL: postgres://snapotter:${SNAPOTTER_DB_PASSWORD:?Set a database password}@postgres:5432/snapotter
REDIS_URL: redis://redis:6379
volumes:
- snapotter-data:/data
- snapotter-workspace:/tmp/workspace
shm_size: 2gb
depends_on:
postgres:
condition: service_healthy
redis:
condition: service_healthy
postgres:
image: postgres:17-alpine
restart: unless-stopped
environment:
POSTGRES_DB: snapotter
POSTGRES_USER: snapotter
POSTGRES_PASSWORD: ${SNAPOTTER_DB_PASSWORD:?Set a database password}
volumes:
- postgres-data:/var/lib/postgresql/data
healthcheck:
test: ["CMD-SHELL", "pg_isready -U snapotter -d snapotter"]
interval: 10s
timeout: 5s
retries: 5
redis:
image: redis:8-alpine
restart: unless-stopped
command: ["redis-server", "--maxmemory-policy", "noeviction", "--appendonly", "yes"]
volumes:
- redis-data:/data
healthcheck:
test: ["CMD", "redis-cli", "ping"]
interval: 10s
timeout: 5s
retries: 5
volumes:
snapotter-data:
snapotter-workspace:
postgres-data:
redis-data:
Or deploy it directly from the source:
git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/snapotter/compose.yml up -dMore install options in our documentation, or see snapotter-hq/SnapOtter for app-specific guidance.
Container Documentation
snapotter Documentation
Open-source file toolkit for PDF, image, video and audio, with local AI. 200+ tools, your server.
postgres Documentation
The PostgreSQL object-relational database system provides reliability and data integrity.
redis Documentation
Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.
Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs <container> - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Image won't pull
Test the pull directly on the host: docker pull snapotter/snapotter:2
- "manifest unknown" means the tag no longer exists.
- "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect <container> --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Stack won't deploy
Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.
- YAML only accepts spaces for indentation, a single tab breaks the whole file.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on snapotter-hq/SnapOtter
- Template not working: Open an issue on NotAFlightRisk/portainer-templates-extras
- This website not working: Open an issue on lissy93/portainer-templates
A Compose stack
SnapOtter is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.
The services
This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:
snapotterrunssnapotter/snapotter:2, starts after postgres, redispostgresrunspostgres:17-alpineredisrunsredis:8-alpine
Volumes
A volume is where SnapOtter keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/datakept in thesnapotter-datavolume Docker manages/tmp/workspacekept in thesnapotter-workspacevolume Docker manages/var/lib/postgresql/datakept in thepostgres-datavolume Docker manages/datakept in theredis-datavolume Docker manages
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. SnapOtter takes 6 of them, and one needs a value before it'll start properly:
DATABASE_URL, defaults topostgres://snapotter_app:@postgres:5432/snapotterDATABASE_MIGRATION_URL, defaults topostgres://snapotter:@postgres:5432/snapotterREDIS_URL, defaults toredis://redis:6379POSTGRES_DB, defaults tosnapotterPOSTGRES_USER, defaults tosnapotterPOSTGRES_PASSWORD, needs a value
Restart policy
The restart policy here is unless-stopped, so Docker restarts SnapOtter after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Networking
Portainer puts these services on one shared private network, so they can find each other by name (like snapotter) while only the ports above are open to you.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Open source license
SnapOtter is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set SnapOtter up. Add the template list to Portainer once, then deploying SnapOtter is a click rather than a wall of config.