https://github.com/minituff/nautical-backup

A simple Docker volume backup tool.
https://github.com/minituff/nautical-backup

automation bash devops docker

Last synced: 17 days ago
JSON representation

A simple Docker volume backup tool.

• Host: GitHub
• URL: https://github.com/minituff/nautical-backup
• Owner: Minituff
• License: gpl-3.0
• Created: 2023-10-08T17:31:45.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-11T23:12:34.000Z (19 days ago)
• Last Synced: 2025-04-12T00:23:28.606Z (19 days ago)
• Topics: automation, bash, devops, docker
• Language: Python
• Homepage: https://minituff.github.io/nautical-backup/
• Size: 3.83 MB
• Stars: 317
• Watchers: 1
• Forks: 7
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

    

A simple Docker bind mount (volume) backup tool.


---




  [![Pulls from DockerHub](https://img.shields.io/docker/pulls/minituff/nautical-backup?logo=docker)](https://hub.docker.com/r/minituff/nautical-backup)

  [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/minituff/nautical-backup/latest?label=latest%20version)](https://hub.docker.com/r/minituff/nautical-backup)

  [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/minituff/nautical-backup/latest?label=size)](https://hub.docker.com/r/minituff/nautical-backup)

  [![Code Coverage](https://codecov.io/gh/Minituff/nautical-backup/graph/badge.svg?token=90PUDWN9XU)](https://codecov.io/gh/Minituff/nautical-backup)



### Documentation

Full documentation is available at [https://minituff.github.io/nautical-backup](https://minituff.github.io/nautical-backup)

### Quick Start

Docker Compose

```yaml

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

```bash

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  

```