Download Latest Version do-backup-2.3.0.tar.gz (16.9 kB)
Email in envelope

Get an email when there's a new version of doBackup

Home
Name Modified Size InfoDownloads / Week
README.md 2026-05-31 2.8 kB
0
do-backup-2.3.0.checksums 2026-05-31 211 Bytes
0
do-backup-2.3.0.tar.gz 2026-05-31 16.9 kB
0
LICENSE 2026-03-17 65 Bytes
0
Totals: 4 Items   20.0 kB 0

doBackup / doRestore

XML-driven backup and restore system for Linux

This repository contains two complementary tools:

  • doBackup – performs full and incremental backups
  • doRestore – restores previously backed-up assets to their original hosts

Both tools are fully controlled by a shared XML configuration file (backuptab.xml).
They support parallel execution, host-specific settings, optional VPN connectivity, and flexible rsync options.

A comprehensive, interactive documentation is available in:

readme.html

(This file is a TiddlyWiki instance containing the full user manual.)

Features

doBackup

  • Full and incremental backups
  • XML-driven host and task definitions
  • Global, host-level and task-level rsync options
  • Optional authentication filters (e.g., SSHPASS)
  • Optional WireGuard VPN per host
  • Automatic full/incremental decision based on backup policies
  • Parallel execution of multiple backup tasks
  • Per-task logs and a global job log
  • Optional indexing of backed-up files

doRestore

  • Restore of individual assets or entire directories
  • Automatic resolution of host, share and backup folder
  • Same XML configuration as doBackup
  • Host-specific rsync options also apply during restore
  • Optional WireGuard VPN with reference-counted tunnel management
  • Parallel restore tasks
  • Deterministic exit codes and structured logging

Requirements

The following tools must be available in $PATH:

  • rsync, ssh, sshpass, nc
  • xmlstarlet, parallel, jq, wg-quick
  • Standard Unix tools (awk, grep, sed, readlink, dirname, ...)

Configuration

All configuration is stored in a single XML file:

/etc/backuptab.xml

This file defines:

  • global settings
  • hosts
  • tasks
  • rsync options
  • backup policies
  • VPN definitions
  • authentication filters
  • pre/post execution per task
  • logical execution groups

The configuration must declare version 2.3 and can be validated against backuptab.xsd.

Usage

Running a backup

doBackup [options]

Running a restore

doRestore [options] <asset1> <asset2> ...

Both tools support:

  • -h – show help
  • -d – override backup root directory
  • -f – use custom XML configuration file
  • -j – override number of parallel jobs
  • -p – logical execution group

Documentation

The full documentation is provided in:

readme.html

This TiddlyWiki includes:

  • complete XML reference
  • examples
  • schema definition
  • backup and restore workflows
  • VPN integration
  • limitations
  • future extensions

Copyright / License

(c) 2009 - 2026 by Hans-Hermann Froehlich coffie@co-de-co.de All rights reserved.

For full license information, see readme.html -> Copyright / License

Source: README.md, updated 2026-05-31