Difference between revisions of "Rsync"

From ArchWiki
Jump to: navigation, search
m
(Automated backup with systemd and inotify: Updated grammar and phrasing.)
(26 intermediate revisions by 15 users not shown)
Line 1: Line 1:
[[Category:Utilities (English)]]
+
{{Lowercase_title}}
[[Category:System recovery (English)]]
+
[[Category:Data compression and archiving]]
[[Category:HOWTOs (English)]]
+
[[Category:Networking]]
 +
[[Category:System recovery]]
 +
[[zh-CN:Rsync]]
 +
{{Article summary start}}
 +
{{Article summary text|Instructions on using rsync.}}
 +
{{Article summary heading|Related}}
 +
{{Article summary wiki|Full System Backup with rsync}}
 +
{{Article summary wiki|Backup Programs}}
 +
{{Article summary end}}
 +
 
 
[http://samba.anu.edu.au/rsync/ rsync] is an open source utility that provides fast incremental file transfer.
 
[http://samba.anu.edu.au/rsync/ rsync] is an open source utility that provides fast incremental file transfer.
  
==Installation==
+
== Installation ==
Install the {{package Official|rsync}} package using [[pacman]]:
+
# pacman -S rsync
+
  
==Usage==
+
[[pacman|Install]] the {{Pkg|rsync}} from the [[official repositories]].
For more examples, search the [http://bbs.archlinux.org/viewforum.php?id=27 Community Contributions] and [http://bbs.archlinux.org/viewforum.php?id=33 General Programming] forums.
+
  
===As a cp alternative===
+
== Usage ==
rsync can be used as an advanced cp alternative, especially for copying larger files:
+
$ rsync -P src dest
+
  
The {{Codeline|-P}} option is the same as {{Codeline|--partial --progress}}, which keeps partially transferred files and shows a progress bar during transfer.
+
For more examples, search the [https://bbs.archlinux.org/viewforum.php?id=27 Community Contributions] and [https://bbs.archlinux.org/viewforum.php?id=33 General Programming] forums.
  
You may want to use the {{Codeline|-r --recursive}} option to recurse into directories, or the {{Codeline|-R}} option for using relative path names (recreating entire folder hierarchy on the destination folder).
+
=== As a cp alternative ===
  
===As a backup utility===
+
rsync can be used as an advanced alternative for the {{ic|cp}} command, especially for copying larger files:
The rsync protocol can easily be used for backups, only transferring files that have changed since the last backup. This section describes a very simple scheduled backup script using rsync, typically used for copying to removable media. For a more thorough example, see [[Full System Backup with rsync]].
+
  
====Automated backup====
+
$ rsync -P source destination
For the sake of this example, the script is created in the {{Filename|/etc/cron.daily}} directory, and will be run on a daily basis if a cron [[daemon]] is installed and properly configured. Configuring and using [[cron]] is outside the scope of this article.
+
 
 +
The {{ic|-P}} option is the same as {{Ic|--partial --progress}}, which keeps partially transferred files and shows a progress bar during transfer.
 +
 
 +
You may want to use the {{ic|-r --recursive}} option to recurse into directories, or the {{ic|-R}} option for using relative path names (recreating entire folder hierarchy on the destination folder).
 +
 
 +
=== As a backup utility ===
 +
 
 +
The rsync protocol can easily be used for backups, only transferring files that have changed since the last backup. This section describes a very simple scheduled backup script using rsync, typically used for copying to removable media. For a more thorough example and '''additional options required to preserve some system files''', see [[Full System Backup with rsync]].
 +
 
 +
==== Automated backup ====
 +
 
 +
For the sake of this example, the script is created in the {{ic|/etc/cron.daily}} directory, and will be run on a daily basis if a cron [[daemon]] is installed and properly configured. Configuring and using [[cron]] is outside the scope of this article.
  
 
First, create a script containing the appropriate command options:
 
First, create a script containing the appropriate command options:
{{File|name=/etc/cron.daily/backup|content=
+
 
 +
{{hc|/etc/cron.daily/backup|
 
#!/bin/bash
 
#!/bin/bash
 
rsync -a --delete /folder/to/backup /location/to/backup &> /dev/null}}
 
rsync -a --delete /folder/to/backup /location/to/backup &> /dev/null}}
  
; {{Codeline|-a}} : indicates that files should be archived, meaning that all of their attributes are preserved
+
; {{ic|-a}} : indicates that files should be archived, meaning that most of their characteristics are preserved (but '''not''' ACLs, hard links or extended attributes such as capabilities)
; {{Codeline|--delete}} : means files deleted on the source are to be deleted on the backup aswell
+
; {{ic|--delete}} : means files deleted on the source are to be deleted on the backup aswell
  
Here, {{Filename|/folder/to/backup}} should to be changed to what needs to be backed-up ({{Filename|/home}}, for example) and {{Filename|/location/to/backup}} is where the backup should be saved ({{Filename|/media/disk}}, for instance).
+
Here, {{ic|/folder/to/backup}} should be changed to what needs to be backed-up ({{ic|/home}}, for example) and {{ic|/location/to/backup}} is where the backup should be saved ({{ic|/media/disk}}, for instance).
  
 
Finally, the script must be executable:
 
Finally, the script must be executable:
 +
 
  # chmod +x /etc/cron.daily/rsync.backup
 
  # chmod +x /etc/cron.daily/rsync.backup
  
====Automated backup with SSH====
+
==== Automated backup with SSH ====
 +
 
 
If backing-up to a remote host using [[SSH]], use this script instead:
 
If backing-up to a remote host using [[SSH]], use this script instead:
{{File|name=/etc/cron.daily/backup|content=
+
 
 +
{{hc|/etc/cron.daily/backup|
 
#!/bin/bash
 
#!/bin/bash
 
rsync -a --delete -e ssh /folder/to/backup remoteuser@remotehost:/location/to/backup &> /dev/null}}
 
rsync -a --delete -e ssh /folder/to/backup remoteuser@remotehost:/location/to/backup &> /dev/null}}
  
; {{Codeline|-e ssh}} : tells rsync to use SSH
+
; {{ic|-e ssh}} : tells rsync to use SSH
; {{Codeline|remoteuser}} : is the user on the host {{Codeline|remotehost}}
+
; {{ic|remoteuser}} : is the user on the host {{ic|remotehost}}
; {{Codeline|-a}} : group all this options {{Codeline|-rlptgoD}} recursive, links, perms, times, group, owner, devices
+
; {{ic|-a}} : groups all these options {{ic|-rlptgoD}} (recursive, links, perms, times, group, owner, devices)
  
 +
==== Automated backup with NetworkManager ====
  
====Automated backup with NetworkManager====
 
 
This script starts a backup when you plugin your wire.
 
This script starts a backup when you plugin your wire.
  
 
First, create a script containing the appropriate command options:
 
First, create a script containing the appropriate command options:
{{File|name=/etc/NetworkManager/dispatcher.d/backup|content=
+
 
 +
{{hc|/etc/NetworkManager/dispatcher.d/backup|2=
 
#!/bin/bash
 
#!/bin/bash
  
if [ x"$2" = "xup" ] : then
+
if [ x"$2" = "xup" ] ; then
 
   rsync --force --ignore-errors -a --delete --bwlimit=2000 --files-from=files.rsync /folder/to/backup /location/to/backup
 
   rsync --force --ignore-errors -a --delete --bwlimit=2000 --files-from=files.rsync /folder/to/backup /location/to/backup
 
fi}}
 
fi}}
  
; {{Codeline|-a}} : group all this options {{Codeline|-rlptgoD}} recursive, links, perms, times, group, owner, devices
+
; {{ic|-a}} : group all this options {{ic|-rlptgoD}} recursive, links, perms, times, group, owner, devices
; {{Codeline|--files-from}} : read the relative path of ''/folder/to/backup'' from this file
+
; {{ic|--files-from}} : read the relative path of ''/folder/to/backup'' from this file
; {{Codeline|--bwlimit}} : limit I/O bandwidth; KBytes per second
+
; {{ic|--bwlimit}} : limit I/O bandwidth; KBytes per second
 +
 
 +
==== Automated backup with systemd and inotify ====
 +
 
 +
{{Note|Due to the limitations of inotify and systemd (see [http://www.quora.com/Linux-Kernel/Inotify-monitoring-of-directories-is-not-recursive-Is-there-any-specific-reason-for-this-design-in-Linux-kernel this question and answer]), recursive filesystem monitoring is not possible. Although you can watch a directory and its contents, it will not recurse into subdirectories and watch the contents of them; you must explicitly specify every directory to watch, even if that directory is a child of an already watched directory.}}
 +
 
 +
{{Note|This setup is based on a [[systemd/User]] instance.}}
 +
 
 +
Instead of running time interval backups with time based schedules, such as those implemented in [[cron]], it is possible to run a backup every time one of the files you're backing up changes. {{ic|systemd.path}} units use {{ic|inotify}} to monitor the filesystem, and can be used in conjunction with {{ic|systemd.service}} files to start any process (in this case your [[rsync]] backup) based on a filesystem event.
 +
 
 +
First, create the {{ic|systemd.path}} file that will monitor the files you're backing up:
 +
 
 +
{{hc|~/.config/systemd/user/backup.path|<nowiki>
 +
[Unit]
 +
Description=Checks if paths that are currently being backed up have changed
 +
 
 +
[Path]
 +
PathChanged=%h/documents
 +
PathChanged=%h/music
 +
 
 +
[Install]
 +
WantedBy=default.target</nowiki>}}
 +
 
 +
Then create a {{ic|systemd.service}} file that will be activated when it detects a change. By default a service file of the same name as the path unit (in this case {{ic|backup.path}}) will be activated, except with the {{ic|.service}} extension instead of {{ic|.path}} (in this case {{ic|backup.service}}).
 +
 
 +
{{Note|If you need to run multiple rsync commands, use {{ic|1=Type=oneshot}}. This allows you to specify multiple {{ic|1=ExecStart=}} parameters, one for each [[rsync]] command, that will be executed. Alternatively, you can simply write a script to perform all of your backups, just like [[cron]] scripts.}}
 +
 
 +
{{hc|~/.config/systemd/user/backup.service|<nowiki>
 +
[Unit]
 +
Description=Backs up files
 +
 
 +
[Service]
 +
ExecStart=/usr/bin/rsync %h/./documents %h/./music -CERrltm --delete ubuntu:</nowiki>}}
 +
 
 +
Now all you have to do is start/enable {{ic|backup.path}} like a normal systemd service and it will start monitoring file changes and automatically starting {{ic|backup.service}}:
 +
 
 +
{{bc|systemctl --user start backup.path
 +
systemctl --user enable backup.path}}
 +
 
 +
==== Differential backup on a week ====
  
====Differential backup on a week====
 
 
This is a useful option of rsync, creating a full backup and a differential backup for each day of a week.
 
This is a useful option of rsync, creating a full backup and a differential backup for each day of a week.
  
 
First, create a script containing the appropriate command options:
 
First, create a script containing the appropriate command options:
{{File|name=/etc/cron.daily/backup|content=
+
 
 +
{{hc|/etc/cron.daily/backup|2=
 
#!/bin/bash
 
#!/bin/bash
  
Line 79: Line 137:
 
rsync -a --delete --inplace --backup --backup-dir=/location/to/backup/incr/$DAY /folder/to/backup/ /location/to/backup/full/ &> /dev/null}}
 
rsync -a --delete --inplace --backup --backup-dir=/location/to/backup/incr/$DAY /folder/to/backup/ /location/to/backup/full/ &> /dev/null}}
  
; {{Codeline|--inplace}} : implies {{Codeline|--partial}} update destination files in-place
+
; {{ic|--inplace}} : implies {{ic|--partial}} update destination files in-place
 +
 
 +
==== Snapshot backup ====
  
====Snapshot backup====
 
 
The same idea can be used to maintain a tree of snapshots of your files. In other words, a directory with date-ordered copies of the files. The copies are made using hardlinks, which means that only files that did change will occupy space. Generally speaking, this is the idea behind Apple's TimeMachine.
 
The same idea can be used to maintain a tree of snapshots of your files. In other words, a directory with date-ordered copies of the files. The copies are made using hardlinks, which means that only files that did change will occupy space. Generally speaking, this is the idea behind Apple's TimeMachine.
  
 
This script implements a simple version of it:
 
This script implements a simple version of it:
  
{{File|name=/usr/local/bin/rsnapshot.sh|content=<nowiki>
+
{{hc|/usr/local/bin/rsnapshot.sh|<nowiki>
 
#!/bin/bash
 
#!/bin/bash
  
Line 116: Line 175:
 
   if [ ! -e $SNAP/$DATETAG ] ; then
 
   if [ ! -e $SNAP/$DATETAG ] ; then
 
       cp -al $SNAP/latest $SNAP/$DATETAG
 
       cp -al $SNAP/latest $SNAP/$DATETAG
 +
      chmod u+w $SNAP/$DATETAG
 
       mv $SNAP/rsync.log $SNAP/$DATETAG
 
       mv $SNAP/rsync.log $SNAP/$DATETAG
 +
      chmod u-w $SNAP/$DATETAG
 
   fi
 
   fi
 
fi
 
fi
 
</nowiki>}}
 
</nowiki>}}
  
To make things really, really simple this script can be run out of /etc/rc.local (this is how i run it myself).
+
To make things really, really simple this script can be run from a Systemd unit.

Revision as of 01:08, 15 June 2013

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary end

rsync is an open source utility that provides fast incremental file transfer.

Installation

Install the rsync from the official repositories.

Usage

For more examples, search the Community Contributions and General Programming forums.

As a cp alternative

rsync can be used as an advanced alternative for the cp command, especially for copying larger files:

$ rsync -P source destination

The -P option is the same as --partial --progress, which keeps partially transferred files and shows a progress bar during transfer.

You may want to use the -r --recursive option to recurse into directories, or the -R option for using relative path names (recreating entire folder hierarchy on the destination folder).

As a backup utility

The rsync protocol can easily be used for backups, only transferring files that have changed since the last backup. This section describes a very simple scheduled backup script using rsync, typically used for copying to removable media. For a more thorough example and additional options required to preserve some system files, see Full System Backup with rsync.

Automated backup

For the sake of this example, the script is created in the /etc/cron.daily directory, and will be run on a daily basis if a cron daemon is installed and properly configured. Configuring and using cron is outside the scope of this article.

First, create a script containing the appropriate command options:

/etc/cron.daily/backup
#!/bin/bash
rsync -a --delete /folder/to/backup /location/to/backup &> /dev/null
-a 
indicates that files should be archived, meaning that most of their characteristics are preserved (but not ACLs, hard links or extended attributes such as capabilities)
--delete 
means files deleted on the source are to be deleted on the backup aswell

Here, /folder/to/backup should be changed to what needs to be backed-up (/home, for example) and /location/to/backup is where the backup should be saved (/media/disk, for instance).

Finally, the script must be executable:

# chmod +x /etc/cron.daily/rsync.backup

Automated backup with SSH

If backing-up to a remote host using SSH, use this script instead:

/etc/cron.daily/backup
#!/bin/bash
rsync -a --delete -e ssh /folder/to/backup remoteuser@remotehost:/location/to/backup &> /dev/null
-e ssh 
tells rsync to use SSH
remoteuser 
is the user on the host remotehost
-a 
groups all these options -rlptgoD (recursive, links, perms, times, group, owner, devices)

Automated backup with NetworkManager

This script starts a backup when you plugin your wire.

First, create a script containing the appropriate command options:

/etc/NetworkManager/dispatcher.d/backup
#!/bin/bash

if [ x"$2" = "xup" ] ; then
  rsync --force --ignore-errors -a --delete --bwlimit=2000 --files-from=files.rsync /folder/to/backup /location/to/backup
fi
-a 
group all this options -rlptgoD recursive, links, perms, times, group, owner, devices
--files-from 
read the relative path of /folder/to/backup from this file
--bwlimit 
limit I/O bandwidth; KBytes per second

Automated backup with systemd and inotify

Note: Due to the limitations of inotify and systemd (see this question and answer), recursive filesystem monitoring is not possible. Although you can watch a directory and its contents, it will not recurse into subdirectories and watch the contents of them; you must explicitly specify every directory to watch, even if that directory is a child of an already watched directory.
Note: This setup is based on a systemd/User instance.

Instead of running time interval backups with time based schedules, such as those implemented in cron, it is possible to run a backup every time one of the files you're backing up changes. systemd.path units use inotify to monitor the filesystem, and can be used in conjunction with systemd.service files to start any process (in this case your rsync backup) based on a filesystem event.

First, create the systemd.path file that will monitor the files you're backing up:

~/.config/systemd/user/backup.path
[Unit]
Description=Checks if paths that are currently being backed up have changed

[Path]
PathChanged=%h/documents
PathChanged=%h/music

[Install]
WantedBy=default.target

Then create a systemd.service file that will be activated when it detects a change. By default a service file of the same name as the path unit (in this case backup.path) will be activated, except with the .service extension instead of .path (in this case backup.service).

Note: If you need to run multiple rsync commands, use Type=oneshot. This allows you to specify multiple ExecStart= parameters, one for each rsync command, that will be executed. Alternatively, you can simply write a script to perform all of your backups, just like cron scripts.
~/.config/systemd/user/backup.service
[Unit]
Description=Backs up files

[Service]
ExecStart=/usr/bin/rsync %h/./documents %h/./music -CERrltm --delete ubuntu:

Now all you have to do is start/enable backup.path like a normal systemd service and it will start monitoring file changes and automatically starting backup.service:

systemctl --user start backup.path
systemctl --user enable backup.path

Differential backup on a week

This is a useful option of rsync, creating a full backup and a differential backup for each day of a week.

First, create a script containing the appropriate command options:

/etc/cron.daily/backup
#!/bin/bash

DAY=$(date +%A)

if [ -e /location/to/backup/incr/$DAY ] ; then
  rm -fr /location/to/backup/incr/$DAY
fi

rsync -a --delete --inplace --backup --backup-dir=/location/to/backup/incr/$DAY /folder/to/backup/ /location/to/backup/full/ &> /dev/null
--inplace 
implies --partial update destination files in-place

Snapshot backup

The same idea can be used to maintain a tree of snapshots of your files. In other words, a directory with date-ordered copies of the files. The copies are made using hardlinks, which means that only files that did change will occupy space. Generally speaking, this is the idea behind Apple's TimeMachine.

This script implements a simple version of it:

/usr/local/bin/rsnapshot.sh
#!/bin/bash

## my own rsync-based snapshot-style backup procedure
## (cc) marcio rps AT gmail.com

# config vars

SRC="/home/username/files/" #dont forget trailing slash!
SNAP="/snapshots/username"
OPTS="-rltgoi --delay-updates --delete --chmod=a-w"
MINCHANGES=20

# run this process with real low priority

ionice -c 3 -p $$
renice +12  -p $$

# sync

rsync $OPTS $SRC $SNAP/latest >> $SNAP/rsync.log

# check if enough has changed and if so
# make a hardlinked copy named as the date

COUNT=$( wc -l $SNAP/rsync.log|cut -d" " -f1 )
if [ $COUNT -gt $MINCHANGES ] ; then
   DATETAG=$(date +%Y-%m-%d)
   if [ ! -e $SNAP/$DATETAG ] ; then
      cp -al $SNAP/latest $SNAP/$DATETAG
      chmod u+w $SNAP/$DATETAG
      mv $SNAP/rsync.log $SNAP/$DATETAG
      chmod u-w $SNAP/$DATETAG
   fi
fi

To make things really, really simple this script can be run from a Systemd unit.