These exmaples used Docker Compose syntax. See the Installation section to fit them into your configuration.
+Don't have all your container volumes in the same directory? That's okay, we can use Docker volume mappings to help.
+Remember the folder naming convention
+container-name must match the source and destination folder names.volumes:
+ # Standard config
+ - /var/run/docker.sock:/var/run/docker.sock
+ - /source:/app/source
+ - /destination:/app/destination
+ # Alternative source directories examples
+ - /opt/pihole:/app/source/pihole
+ - /mnt/docker_volumes/plex:/app/source/plex
+This config allows the addition of volumes outside the traditional source directory.
We added 2 additional source volumes: pihole and plex. The end result will have a source directory inside the Nautical container that looks like this:
<Nautical Backup>/app/source:
+ - container1-data #(1)!
+ - container2-data #(2)!
+ - pihole # Mapped from /opt/pihole
+ - plex # Mapped from /mnt/docker_volumes/plex
+/source directory/source directoryvolumes:
+ # Standard config
+ - /var/run/docker.sock:/var/run/docker.sock
+ - /destination:/app/destination
+ # Alternative source directories examples
+ - /opt/pihole:/app/source/pihole
+ - /opt/trilium:/app/source/trilium
+ - /mnt/docker_volumes/plex:/app/source/plex
+ - /var/data/portainer:/app/source/portainer
+<Nautical Backup>/app/source:
+ - pihole # Mapped from /opt/pihole
+ - trilium # Mapped from /opt/trilium
+ - plex # Mapped from /mnt/docker_volumes/plex
+ - portainer # Mapped from /var/data/portainer
+We can also remap the distination directory for any container we'd like.
+Remember the folder naming convention
+container-name must match the source and destination folder names.volumes:
+ # Standard config
+ - /var/run/docker.sock:/var/run/docker.sock
+ - /source:/app/source
+ - /destination:/app/destination
+ # Alternative destination directories examples
+ - /opt/pihole-backup:/app/destination/pihole
+ - /mnt/docker_volume-backups/plex:/app/destination/plex
+This config allows the addition of volumes outside the traditional destination directory.
We added 2 additional destination volumes: pihole and plex. The end result will have a destination directory inside the Nautical container that looks like this:
<Nautical Backup>/app/destination:
+ - container1-data #(1)!
+ - container2-data #(2)!
+ - pihole # Mapped to /opt/pihole-backup
+ - plex # Mapped to /mnt/docker_volume-backups/plex
+/source directory/source directoryvolumes:
+ # Standard config
+ - /var/run/docker.sock:/var/run/docker.sock
+ - /destination:/app/destination
+ # Alternative destination directories examples
+ - /opt/pihole:/app/destination/pihole
+ - /opt/trilium:/app/destination/trilium
+ - /mnt/docker_volumes/plex:/app/destination/plex
+ - /var/data/portainer:/app/destination/portainer
+<Nautical Backup>/app/destination:
+ - pihole # Mapped to /opt/pihole
+ - trilium # Mapped to /opt/trilium
+ - plex # Mapped to /mnt/docker_volumes/plex
+ - portainer # Mapped to /var/data/portainer
+Nautical provides configuration in the form of Docker enviornment variables.
+See the Installation Section, which contains a few examples of applying enviornment variables.
+Sets the time-zone to be used by the CRON schedule. If this environment variable is not set, Nautical will use the default time-zone: Etc/UTC.
To change the time-zone, see this Wikipedia page, find your location and use the value in TZ Database Name, e.g America/Los_Angeles.
++Default: Etc/UTC
+
TZ=America/Los_Angeles
+docker exec nautical-backup date
+Allow changing the schedule for when the backup is started.
+++Default: 0 4 * * *
+
CRON_SCHEDULE=0 4 * * *
+Tell Nautical to skip backup of containers in this list.
+This list can either be the container name or full id.
++Default: empty
+
SKIP_CONTAINERS=container-name1,container-name2,container-name3
+SKIP_CONTAINERS=container-name1,056bd2e970c1338782733fdbf1009c6e158c715d0d105b11de88bd549430e7f5
+Getting the full container ID
+Usally, it's easier to just use the container-name, but if you need to use the full ID, these commands will help:
docker ps --no-truncdocker inspect <container name>++Default: empty
+
OVERRIDE_SOURCE_DIR=example1:example1-new-source-data,ctr2:ctr2-new-source
+| Container Name | +Old Source Directory | +New Source Directory | +
|---|---|---|
| example1 | +src/example1 |
+src/example1-new-dest-data |
+
| ctr2 | +src/ctr2 |
+src/newdest |
+
++Default: empty
+
OVERRIDE_DEST_DIR=example1:example1-new-dest-data,ctr2:newdest
+The example above would yield the following results:
+| Container Name | +Old Destination Directory | +New Destination Directory | +
|---|---|---|
| example1 | +dest/example1 |
+dest/example1-new-dest-data |
+
| ctr2 | +dest/ctr2 |
+dest/newdest |
+
Enable or Disable the automatically generated report file.
+++Default: true
+
REPORT_FILE=true
+Bypass stopping the container before performing a backup. This can be useful for containers with minimal configuration.
+++Default: empty
+
SKIP_STOPPING=example1,example2
+Not stoppping containers can produce corrupt backups.
+Containers with databases--particularly SQL--need to be shutdown before backup.
+Only do this on containers you know for certain do not need to be shutdown before backup.
+Will immediatly perform a backup when the container is started in addition to the CRON sheduled backup.
+++Default: false
+
BACKUP_ON_START=true
+