Add readme.

This commit is contained in:
redxef 2023-06-07 23:05:18 +02:00
parent dbfa74aa26
commit d13519229b
Signed by: redxef
GPG key ID: 7DAC3AA211CBD921

20
README.md Normal file
View file

@ -0,0 +1,20 @@
# tarback
Create a tar archive from remote resources.
This is more or less equivalent to `ssh host tar files | xz | split
output-file` and its reverse.
Two plugins are available:
- `ssh` handles all the ssh command and filename escaping necessary
- `docker` instead of backing up a remote volume, back up a docker volume
## usage
`tarback -p ssh,docker -s 'ssh $user@$host' create "$remote_volume_name" "$local_tar_archive"`
Create a split tar archive of the remote volume, with the extensions `part{a-z,a-z}`.
`tarback -p ssh,docker -s 'ssh $user@$host' restore "$local_tar_archive" "$remote_volume_name"`
Restore the backup to the remote docker volume.