rsync-time-backup/README.md

52 lines
1.7 KiB
Markdown
Raw Normal View History

2013-10-27 04:31:06 +00:00
# Rsync time backup
2013-10-27 03:57:45 +00:00
2013-10-27 04:31:06 +00:00
Time Machine style backup with rsync. Should work on Linux, Mac OS X and Windows with Cygwin.
# Installation
2013-10-27 04:34:05 +00:00
git clone https://github.com/laurent22/rsync-time-backup
2013-10-27 04:31:06 +00:00
# Usage
2013-10-27 04:34:05 +00:00
rsync_tmbackup.sh <source> <destination> [excluded-pattern-path]
2013-10-27 04:31:06 +00:00
## Examples
2013-10-27 04:34:05 +00:00
2013-10-27 06:19:37 +00:00
* Backup the home folder to backup_drive
2013-10-27 04:34:05 +00:00
2013-10-27 06:22:37 +00:00
rsync_tmbackup.sh /home /mnt/backup_drive
2013-10-27 04:34:05 +00:00
2013-10-27 06:19:37 +00:00
* Backup with exclusion list:
2013-10-27 04:34:05 +00:00
2013-10-27 06:22:37 +00:00
rsync_tmbackup.sh /home /mnt/backup_drive excluded_patterns.txt
2013-10-27 04:34:05 +00:00
2013-10-27 04:31:06 +00:00
## Exclude file
2013-10-27 04:34:05 +00:00
An optional exclude file can be provided as a third parameter. It should be compabible with the `--exclude-from` parameter of rsync. See [this tutorial] (https://sites.google.com/site/rsync2u/home/rsync-tutorial/the-exclude-from-option) for more information.
2013-10-27 04:31:06 +00:00
# Features
* Each backup is on its own folder named after the current timestamp. Files can be copied and restored directly, without any intermediate tool.
* Files that haven't changed from one backup to the next are hard-linked to the previous backup so take very little extra space.
* Safety check - the backup will only happen if the destination has explicitely been marked as a backup destination.
* Resume feature - if a backup has failed or was interrupted, the tool will resume from there on the next backup.
2013-10-27 04:34:05 +00:00
* Exclude file - support for pattern-based exclusion via the `--exclude-from` rsync parameter.
2013-10-27 04:31:06 +00:00
* The application is one bash script that can be easily edited.
# TODO
* Check if there's enough space in the destination before doing the backup. Also automatically delete old backups.
2013-10-28 07:47:57 +00:00
# LICENSE
[MIT](http://opensource.org/licenses/MIT)
2013-10-28 17:04:53 +00:00
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/laurent22/rsync-time-backup/trend.png)](https://bitdeli.com/free "Bitdeli Badge")