mirror of
https://github.com/nicotsx/zerobyte.git
synced 2026-06-13 11:00:28 -04:00
aed2c15709
Aligns the project with the current Compose Specification, which designates compose.yaml as the canonical filename and treats the docker-compose.yml name as a legacy fallback. Renames every compose file in the repo (the root dev/e2e stack, the deployment examples under examples/, and the integration-test infra stack) and updates all documentation, the integration test runner, the capability hint messages, and the .gitattributes pattern accordingly. No top-level version field was present to remove. Functional behavior is unchanged: docker compose discovers either filename, so existing deployments are not affected by the rename. Reference: https://docs.docker.com/compose/intro/compose-application-model/
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.
- Provisioned repositories and volumes — operator-managed provisioning with env/file references kept in a mounted JSON file.
Advanced setups
- Tailscale sidecar — run Zerobyte behind a Tailscale sidecar using shared networking.