Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nachoparker/btrfs-sync
Smart and easy sync of BTRFS snapshots, locally or through SSH
https://github.com/nachoparker/btrfs-sync
btrfs synchronization
Last synced: about 1 month ago
JSON representation
Smart and easy sync of BTRFS snapshots, locally or through SSH
- Host: GitHub
- URL: https://github.com/nachoparker/btrfs-sync
- Owner: nachoparker
- License: gpl-3.0
- Created: 2018-03-09T13:31:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-31T07:01:28.000Z (almost 3 years ago)
- Last Synced: 2023-03-01T08:35:44.495Z (almost 2 years ago)
- Topics: btrfs, synchronization
- Language: Shell
- Size: 144 KB
- Stars: 72
- Watchers: 3
- Forks: 17
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# btrfs-sync
Smart and easy sync of BTRFS snapshots, locally or through SSH.
Can be used in conjunction with [btrfs-snp](https://ownyourbits.com/2017/12/27/schedule-btrfs-snapshots-with-btrfs-snp/)
```
# btrfs-sync --verbose --delete /home/user/.snapshots user@server:/media/USBdrive/home-snapshots
* Skip existing '/home/user/.snapshots/monthly_2018-01-09_200102'
* Skip existing '/home/user/.snapshots/monthly_2018-02-08_200102'
* Skip existing '/home/user/.snapshots/weekly_2018-02-09_140102'
* Skip existing '/home/user/.snapshots/weekly_2018-02-16_150102'
* Skip existing '/home/user/.snapshots/weekly_2018-02-23_150102'
* Skip existing '/home/user/.snapshots/weekly_2018-03-02_180102'
* Skip existing '/home/user/.snapshots/daily_2018-03-03_000101'
* Skip existing '/home/user/.snapshots/daily_2018-03-04_080101'
* Skip existing '/home/user/.snapshots/daily_2018-03-05_100102'
* Skip existing '/home/user/.snapshots/daily_2018-03-06_100102'
* Skip existing '/home/user/.snapshots/daily_2018-03-07_110102'
* Synchronizing '/home/user/.snapshots/hourly_2018-03-08_090101' using seed '.snapshots/hourly_2018-03-07_090101'...
time elapsed [0:00:24] | rate [11.1MiB/s] | total size [ 132MiB]
* Synchronizing '/home/user/.snapshots/hourly_2018-03-08_100101' using seed '.snapshots/hourly_2018-03-09_090101'...
time elapsed [0:01:05] | rate [11.1MiB/s] | total size [ 275MiB]
* Deleting non existent snapshots...
Delete subvolume (no-commit): '/media/USBdrive/home-snapshots/hourly_2018-03-08_090101'
Delete subvolume (no-commit): '/media/USBdrive/home-snapshots/hourly_2018-03-08_100101'
```
## Features
- Simple syntax
- Progress indication
- Support for _xz_ or _pbzip2_ compression in order to save bandwidth.
- Retention policy
- Automatic incremental synchronization
- Cron friendly
## Usage
The syntax is similar to that of _scp_
```
Usage:
btrfs-sync [options] [...] [[user@]host:]
-k|--keep NUM keep only last sync'ed snapshots
-d|--delete delete snapshots in that don't exist in
-z|--xz use xz compression. Saves bandwidth, but uses one CPU
-Z|--pbzip2 use pbzip2 compression. Saves bandwidth, but uses all CPUs
-q|--quiet don't display progress
-v|--verbose display more information
-h|--help show usage
can either be a single snapshot, or a folder containing snapshots
requires privileged permissions at for the 'btrfs' command
```
## Examples
### Manual
Synchronize snapshots of _home_ to a USB drive
```
# btrfs-sync /home/user/.snapshots /media/USBdrive/home-snapshots
```
Synchronize snapshots of _home_ to a USB drive in another machine
```
# btrfs-sync /home/user/.snapshots user@server:/media/USBdrive/home-snapshots
```
Synchronize one snapshot of _home_ to a USB drive in another machine
```
# btrfs-sync /home/user/.snapshots/monthly_2018-02-08_200102 user@server:/media/USBdrive/home-snapshots
```
Synchronize only monthly snapshots of _home_ to a USB drive in another machine
```
# btrfs-sync /home/user/.snapshots/monthly_* user@server:/media/USBdrive/home-snapshots
```
### Cron
Daily synchronization over the internet, keep only last 50
```
cat > /etc/cron.daily/btrfs-sync < /etc/cron.daily/btrfs-sync <