/nautical-backup

A simple Docker volume backup tool.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Logo

A simple Docker volume backup tool.



Pulls from DockerHub Docker Image Version (latest semver) Docker Image Size (tag) Code Coverage

Documentation

Full documentation is available at https://minituff.github.io/nautical-backup

Quick Start

Docker Compose

services:
  nautical-backup:
    image: minituff/nautical-backup:2 
    container_name: nautical-backup
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - /config:/config
      - /source:/app/source:ro
      - /destination:/app/destination
    environment: # Optional variables
      - TZ=America/Los_Angeles
      - CRON_SCHEDULE=0 4 * * *
      - SKIP_CONTAINERS=example1,example2,example3

Docker CLI

docker run -d \
  --name nautical-backup \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /config:/config \
  -v /source:/app/source:ro \
  -v /destination:/app/destination \
  -e TZ="America/Los_Angeles" \
  -e CRON_SCHEDULE="0 4 * * *" \
  -e SKIP_CONTAINERS="example1,example2,example3" \
  minituff/nautical-backup:2