nautical-backup,A simple Docker volume backup tool.

A simple Docker volume backup tool.

Introduction

Essentially, this is an automated and configurable backup tool built around rsync.

The Basics

Nautical runs on a CRON schedule to:

  1. Stop the container (if configured)
  2. Run the backup via rsync
  3. Restart the container (if stopped)

⚗️ Need more control? There are many more options available via variables and labels.

Sample Configuration

Nautical requires almost no configuration when container volumes are all in a folder matching its container-name within the source directory. Of course, we can use variables and labels to override these defaults.

Let's take a look at an example:

Container NameSource Data DirectoryDestination Data Directory
homepage/opt/docker-volumes/homepage/mnt/nfs-share/backups/homepage
trilium/opt/docker-volumes/trilium/mnt/nfs-share/backups/trilium
dozzleN/A (no data folder)N/A (no backup needed)

Here is how Nautical fits into the Sample Configuration

Docker ComposeDocker Cli

services:
nautical-backup:
image: minituff/nautical-backup:2.14
container_name: nautical-backup
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /config:/config
- /opt/docker-volumes:/app/source
- /mnt/nfs-share/backups:/app/destination

Subscribe to SweetHome

Don’t miss out on the latest issues. Sign up now to get access to the library of members-only issues.
jamie@example.com
Subscribe