Skip to main content

Incremental btrfs snapshot backups with push/pull support via SSH

Project description

Btrfs snapshot backup utility * Push/pull support via SSH * Syslog logging * Compression of transferred data

System dependencies


The following packages have to be available on both source and destination * btrfs-progs

The system executing btrfs-backup requires * python3


  • ssh (for remote push/pull, not required for local operation)
  • lzop (for compression support if desired)
  • pv (provides progress indication if installed)


pip install <btrfs-sxbackup-archive.tar.gz>


  • when using ssh, public/private key authentication should be set up

Usage examples ssh:// /backup/myhost

Pulls snapshot backups of / on remote host to local subvolume /backup/myhost / ssh://

Pushes snapshot backups of local subvolume / to remote subvolume /backup/myhost on host

usage: btrfs-sxbackup [-h] [-sm SOURCE_MAX_SNAPSHOTS]
                      [-dm DESTINATION_MAX_SNAPSHOTS]
                      [-ss SOURCE_CONTAINER_SUBVOLUME] [-c] [-li LOG_IDENT]
                      [-q] [--version]
                      source_subvolume destination_container_subvolume

positional arguments:
  source_subvolume      Source subvolume to backup. Local path or SSH url.
                        Destination subvolume receiving snapshots. Local path
                        or SSH url.

optional arguments:
  -h, --help            show this help message and exit
                        Maximum number of source snapshots to keep (defaults
                        to 10).
                        Maximum number of destination snapshots to keep
                        (defaults to 10).
                        Override path to source snapshot container subvolume.
                        Both absolute and relative paths are possible.
                        (defaults to 'sxbackup', relative to source subvolume)
  -c, --compress        Enables compression, requires lzop to be installed on
                        both source and destination
  -li LOG_IDENT, --log-ident LOG_IDENT
                        Log ident used for syslog logging, defaults to script
  -q, --quiet           Do not log to STDOUT
  --version             show program's version number and exit

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for btrfs-sxbackup, version 0.3.4
Filename, size File type Python version Upload date Hashes
Filename, size btrfs-sxbackup-0.3.4.tar.gz (7.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page