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
  • Housekeeping
  • Email notifications
  • Compression of transferred data
  • Syslog logging

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)
  • sendmail (for email notifications if desired)


pip install btrfs-sxbackup


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

Usage examples

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

btrfs-sxbackup ssh:// /backup/myhost

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

btrfs-sxbackup / ssh://


Cronhob performing a local and remote pull backup job

# /etc/cron.d/btrfs-sxbackup
30 2    * * *     root     btrfs-sxbackup / /mnt/backup/localsystem/ -sk 3 -dk "1d = 4/d, 1w = daily, 2m = none"
0 3     * * *     root     btrfs-sxbackup ssh://root@remotesystem/ /mnt/backup/remotesystem/ -sk 3 -dk "1d = 4/d, 1w = daily, 2m = none"

Synopsis and options

usage: btrfs-sxbackup [-h] [-c] [-q] [-sk SOURCE_KEEP] [-dk DESTINATION_KEEP]
                      [-ss SOURCE_CONTAINER_SUBVOLUME] [-m [MAIL]]
                      [-li LOG_IDENT] [--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
  -c, --compress        Enables compression during transmission, requires lzop
                        to be installed on both source and destination
  -q, --quiet           Do not log to STDOUT
  -sk SOURCE_KEEP, --source-keep SOURCE_KEEP
                        Expression defining which source snapshots to
                        keep/cleanup. Can be a static number (of backups) or
                        more complex expression like "1d=4/d,1w=daily,2m=none"
                        literally translating to: "1 day from now keep 4
                        backups a day, 1 week from now keep daily backups, 2
                        months from now keep none". Default is 10
                        Expression defining which destination snapshots to
                        keep/cleanup. Can be a static number (of backups) or
                        more complex expression (see --source-keep arguemnt).
                        Default is 10
                        Override path to source snapshot container subvolume.
                        Both absolute and relative paths are possible. Default
                        is 'sxbackup', relative to source subvolume
  -m [MAIL], --mail [MAIL]
                        Enables email notifications. If an email address is
                        given, it overrides the default email-recipient
                        setting in /etc/btrfs-sxbackup.conf
  -li LOG_IDENT, --log-ident LOG_IDENT
                        Log ident used for syslog logging, defaults to script
  --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.4.3
Filename, size File type Python version Upload date Hashes
Filename, size btrfs-sxbackup-0.4.3.tar.gz (12.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