Skip to main content
Run snapr in a container instead of installing the binary on the host.

Run the container

Inside the container, snapr looks for snapr.yaml in /etc/snapr/ by default.

Volumes and paths

Inside the container, snapr runs as user snapr (uid 1001). Mount:
  • the config file read-only at /etc/snapr/snapr.yaml
  • any source path you want to back up — read-only is fine
  • any local storage path — must be writable by uid 1001. If the host directory is owned by another user, either chown 1001 it or run the container with a matching --user.

Environment variables

Use environment variables with env: references in snapr.yaml:
snapr.yaml
See Configuration → Overview for the full env-ref behavior.

Dev stack with Docker Compose

The repo ships a dev stack with MinIO (S3), PostgreSQL, SFTP, and WebDAV containers — useful for trying every storage backend locally. The stack only starts the storage targets; snapr itself runs from source via pnpm run dev (see examples/dev/README.md).
The dev config binds the API on :47100 with admin / admin — for local testing only. Never reuse these credentials in production.