zerobyte/examples/README.md

Examples

This folder contains runnable, copy/paste-friendly examples for running Zerobyte in different setups.

Table of contents

Basic usage

• Basic Docker Compose — standard deployment with remote mount support (includes SYS_ADMIN + /dev/fuse).
• Simplified Docker Compose (no remote mounts) — reduced-privilege deployment (no SYS_ADMIN, no /dev/fuse).
• Bind-mount a local directory — back up a host folder by mounting it into the container.
• Mount an rclone config — use rclone-based repository backends by mounting your rclone config.
• Secret placeholders + Docker secrets — keep secrets out of the DB using env://... and file://... references.

Advanced setups

• Tailscale sidecar — run Zerobyte behind a Tailscale sidecar using shared networking.

Conventions

• Each example should be runnable on its own (ideally via Docker Compose).
• Each example should include a README with prerequisites, troubleshooting, etc.
• If configuration is needed, include a .env.example.