rsync用法教程

一、简介

rsync 是一个常用的 Linux 应用程序，用于文件同步。

它可以在本地计算机与远程计算机之间，或者两个本地目录之间同步文件（但不支持两台远程计算机之间的同步）。它也可以当作文件复制工具，替代cp和mv命令。

它名称里面的r指的是 remote，rsync 其实就是”远程同步”（remote sync）的意思。与其他文件传输工具（如 FTP 或 scp）不同，rsync 的最大特点是会检查发送方和接收方已有的文件，仅传输有变动的部分（默认规则是文件大小或修改时间有变动）。

二、安装

如果本机或者远程计算机没有安装 rsync，可以用下面的命令安装。

# Debian
$ sudo apt-get install rsync

# Red Hat
$ sudo yum install rsync

# Arch Linux
$ sudo pacman -S rsync

注意，传输的双方都必须安装 rsync。

三、基本用法

本机使用 rsync 命令时，可以作为cp和mv命令的替代方法，将源目录同步到目标目录。

$ rsync -r source/ destination

上面命令中，-r表示递归，即包含子目录。注意，-r是必须的，否则 rsync 运行不会成功。source目录表示源目录，destination表示目标目录。

如果有多个文件或目录需要同步，可以写成下面这样。

$ rsync -r source1 source2 destination

上面命令中，source1，source2都会被同步到destination目录。

3.2 `-a` 参数

-a参数可以替代-r，除了可以递归同步以外，还可以同步元信息（比如修改时间、权限等）。由于 rsync 默认使用文件大小和修改时间决定文件是否需要更新，所以-a比-r更有用。下面的用法才是常见的写法。

$ rsync -a source destination

目标目录destination如果不存在，rsync 会自动创建。执行上面的命令后，源目录source被完整地复制到了目标目录destination下面，即形成了destination/source的目录结构。

如果只想同步源目录source里面的内容到目标目录destination，则需要在源目录后面加上斜杠。

$ rsync -a source/ destination

上面命令执行后，source目录里面的内容，就都被复制到了destination目录里面，并不会在destination下面创建一个source子目录。

3.3 `-n` 参数

如果不确定 rsync 执行后会产生什么结果，可以先用-n或--dry-run参数模拟执行的结果。

$ rsync -anv source/ destination

上面命令中，-n参数模拟命令执行的结果，并不真的执行命令。-v参数则是将结果输出到终端，这样就可以看到哪些内容会被同步。

3.4 `–delete` 参数

默认情况下，rsync 只确保源目录的所有内容（明确排除的文件除外）都复制到目标目录。它不会使两个目录保持相同，并且不会删除文件。如果要使得目标目录成为源目录的镜像副本，则必须使用--delete参数，这将删除只存在于目标目录、不存在于源目录的文件。

$ rsync -av --delete source/ destination

上面命令中，--delete参数会使得destination成为source的一个镜像。

四、排除文件

4.1 `–exclude` 参数

有时，我们希望同步时排除某些文件或目录，这时可以用--exclude参数指定排除模式。

$ rsync -av --exclude='*.txt' source/ destination
# 或者
$ rsync -av --exclude '*.txt' source/ destination

上面命令排除了所有 TXT 文件。

注意，rsync 会同步以”点”开头的隐藏文件，如果要排除隐藏文件，可以这样写--exclude=".*"。

如果要排除某个目录里面的所有文件，但不希望排除目录本身，可以写成下面这样。

$ rsync -av --exclude 'dir1/*' source/ destination

多个排除模式，可以用多个--exclude参数。

$ rsync -av --exclude 'file1.txt' --exclude 'dir1/*' source/ destination

多个排除模式也可以利用 Bash 的大扩号的扩展功能，只用一个--exclude参数。

$ rsync -av --exclude={'file1.txt','dir1/*'} source/ destination

如果排除模式很多，可以将它们写入一个文件，每个模式一行，然后用--exclude-from参数指定这个文件。

$ rsync -av --exclude-from='exclude-file.txt' source/ destination

4.2 `–include` 参数

--include参数用来指定必须同步的文件模式，往往与--exclude结合使用。

$ rsync -av --include="*.txt" --exclude='*' source/ destination

上面命令指定同步时，排除所有文件，但是会包括 TXT 文件。

五、远程同步

5.1 SSH 协议

rsync 除了支持本地两个目录之间的同步，也支持远程同步。它可以将本地内容，同步到远程服务器。

$ rsync -av source/ username@remote_host:destination

也可以将远程内容同步到本地。

$ rsync -av username@remote_host:source/ destination

如果 ssh 命令有附加的参数，则必须使用-e参数指定所要执行的 SSH 命令。

# 设置端口为22，设置对应的pem等
$ sync -av -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /home/xiaojin/Desktop/temp/ root@8.134.210.33:/root/temp/temp_rsync

5.2 rsync 协议（这个我没验证）

除了使用 SSH，如果另一台服务器安装并运行了 rsync 守护程序，则也可以用rsync://协议（默认端口873）进行传输。具体写法是服务器与目标目录之间使用双冒号分隔::。

$ rsync -av source/ 192.168.122.32::module/destination

注意，上面地址中的module并不是实际路径名，而是 rsync 守护程序指定的一个资源名，由管理员分配。

如果想知道 rsync 守护程序分配的所有 module 列表，可以执行下面命令。

$ rsync rsync://192.168.122.32

rsync 协议除了使用双冒号，也可以直接用rsync://协议指定地址。

$ rsync -av source/ rsync://192.168.122.32/module/destination

六、增量备份（这个我没验证）

rsync 的最大特点就是它可以完成增量备份，也就是默认只复制有变动的文件。

除了源目录与目标目录直接比较，rsync 还支持使用基准目录，即将源目录与基准目录之间变动的部分，同步到目标目录。

具体做法是，第一次同步是全量备份，所有文件在基准目录里面同步一份。以后每一次同步都是增量备份，只同步源目录与基准目录之间有变动的部分，将这部分保存在一个新的目标目录。这个新的目标目录之中，也是包含所有文件，但实际上，只有那些变动过的文件是存在于该目录，其他没有变动的文件都是指向基准目录文件的硬链接。

--link-dest参数用来指定同步时的基准目录。

$ rsync -a --delete --link-dest /compare/path /source/path /target/path

上面命令中，--link-dest参数指定基准目录/compare/path，然后源目录/source/path跟基准目录进行比较，找出变动的文件，将它们拷贝到目标目录/target/path。那些没变动的文件则会生成硬链接。这个命令的第一次备份时是全量备份，后面就都是增量备份了。

下面是一个脚本示例，备份用户的主目录。

#!/bin/bash

# A script to perform incremental backups using rsync

set -o errexit
set -o nounset
set -o pipefail

readonly SOURCE_DIR="${HOME}"
readonly BACKUP_DIR="/mnt/data/backups"
readonly DATETIME="$(date '+%Y-%m-%d_%H:%M:%S')"
readonly BACKUP_PATH="${BACKUP_DIR}/${DATETIME}"
readonly LATEST_LINK="${BACKUP_DIR}/latest"

mkdir -p "${BACKUP_DIR}"

rsync -av --delete \
  "${SOURCE_DIR}/" \
  --link-dest "${LATEST_LINK}" \
  --exclude=".cache" \
  "${BACKUP_PATH}"

rm -rf "${LATEST_LINK}"
ln -s "${BACKUP_PATH}" "${LATEST_LINK}"

上面脚本中，每一次同步都会生成一个新目录${BACKUP_DIR}/${DATETIME}，并将软链接${BACKUP_DIR}/latest指向这个目录。下一次备份时，就将${BACKUP_DIR}/latest作为基准目录，生成新的备份目录。最后，再将软链接${BACKUP_DIR}/latest指向新的备份目录。

七、配置项

-a、--archive参数表示存档模式，保存所有的元数据，比如修改时间（modification time）、权限、所有者等，并且软链接也会同步过去。

--append参数指定文件接着上次中断的地方，继续传输。

--append-verify参数跟--append参数类似，但会对传输完成后的文件进行一次校验。如果校验失败，将重新发送整个文件。

-b、--backup参数指定在删除或更新目标目录已经存在的文件时，将该文件更名后进行备份，默认行为是删除。更名规则是添加由--suffix参数指定的文件后缀名，默认是~。

--backup-dir参数指定文件备份时存放的目录，比如--backup-dir=/path/to/backups。

--bwlimit参数指定带宽限制，默认单位是 KB/s，比如--bwlimit=100。

-c、--checksum参数改变rsync的校验方式。默认情况下，rsync 只检查文件的大小和最后修改日期是否发生变化，如果发生变化，就重新传输；使用这个参数以后，则通过判断文件内容的校验和，决定是否重新传输。

--delete参数删除只存在于目标目录、不存在于源目标的文件，即保证目标目录是源目标的镜像。

-e参数指定使用 SSH 协议传输数据。

--exclude参数指定排除不进行同步的文件，比如--exclude="*.iso"。

--exclude-from参数指定一个本地文件，里面是需要排除的文件模式，每个模式一行。

--existing、--ignore-non-existing参数表示不同步目标目录中不存在的文件和目录。

-h参数表示以人类可读的格式输出。

-h、--help参数返回帮助信息。

-i参数表示输出源目录与目标目录之间文件差异的详细情况。

--ignore-existing参数表示只要该文件在目标目录中已经存在，就跳过去，不再同步这些文件。

--include参数指定同步时要包括的文件，一般与--exclude结合使用。

--link-dest参数指定增量备份的基准目录。

-m参数指定不同步空目录。

--max-size参数设置传输的最大文件的大小限制，比如不超过200KB（--max-size='200k'）。

--min-size参数设置传输的最小文件的大小限制，比如不小于10KB（--min-size=10k）。

-n参数或--dry-run参数模拟将要执行的操作，而并不真的执行。配合-v参数使用，可以看到哪些内容会被同步过去。

-P参数是--progress和--partial这两个参数的结合。

--partial参数允许恢复中断的传输。不使用该参数时，rsync会删除传输到一半被打断的文件；使用该参数后，传输到一半的文件也会同步到目标目录，下次同步时再恢复中断的传输。一般需要与--append或--append-verify配合使用。

--partial-dir参数指定将传输到一半的文件保存到一个临时目录，比如--partial-dir=.rsync-partial。一般需要与--append或--append-verify配合使用。

--progress参数表示显示进展。

-r参数表示递归，即包含子目录。

--remove-source-files参数表示传输成功后，删除发送方的文件。

--size-only参数表示只同步大小有变化的文件，不考虑文件修改时间的差异。

--suffix参数指定文件名备份时，对文件名添加的后缀，默认是~。

-u、--update参数表示同步时跳过目标目录中修改时间更新的文件，即不同步这些有更新的时间戳的文件。

-v参数表示输出细节。-vv表示输出更详细的信息，-vvv表示输出最详细的信息。

--version参数返回 rsync 的版本。

-z参数指定同步时压缩数据。

八、套娃现象

source不带斜杆和带斜杆的区别是，一个是传文件夹过去，一个是传文件夹中的文件过去。

$ rsync -a source/ destination

不会套娃：

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp/synctest/ ubuntu@69.230.236.43:/ldata/temp2/synctest

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp/synctest/ ubuntu@69.230.236.43:/ldata/temp2/synctest/

如果文件已存在，会出现套娃

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp/synctest ubuntu@69.230.236.43:/ldata/temp2/synctest

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp/synctest ubuntu@69.230.236.43:/ldata/temp2/synctest/

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp/ ubuntu@69.230.236.43:/ldata/temp2/synctest

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp/ ubuntu@69.230.236.43:/ldata/temp2/synctest/

那个套两层路径，可能是这个写法

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp ubuntu@69.230.236.43:/ldata/temp2/synctest/

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp ubuntu@69.230.236.43:/ldata/temp2/synctest

不会套娃

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp/synctest ubuntu@69.230.236.43:/ldata/temp2

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp/synctest ubuntu@69.230.236.43:/ldata/temp2/

不会套娃，但会传到上一层目录

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp/synctest/ ubuntu@69.230.236.43:/ldata/temp2

sudo rsync -auv -e 'ssh -p 22 -i /home/xiaojing/MARS.pem' /ldata/temp/synctest/ ubuntu@69.230.236.43:/ldata/temp2/

实例、可以配合宝塔面板的计划任务间隔几分钟或几小时或者几天自动执行同步

rsync -aWv --delete /www/wwwroot/ /home/www/backup/wwwroot
# 同步/www/wwwroot目录下面的文件夹及其子目录和文件到/home/www/backup/wwwroot目录并保持文件夹结构及文件属性和权限 
# -a表示保持文件原属性 
# -W表示直接同步不校验文件，否则大文件很费时间 
# -v表示输出同步信息 
# --delete表示如果原目录有删除文件那么目标目录页删除，就能保持目标目录是原目录的一个镜像文件夹

rsync -aWv --delete /www/backup/ /home/www/backup/backup
# 同步/www/wwwroot目录下面的文件夹及其子目录和文件到/home/www/backup/wwwroot目录并保持文件夹结构及文件属性和权限 
# -a表示保持文件原属性 
# -W表示直接同步不校验文件，否则大文件很费时间 
# -v表示输出同步信息 
# --delete表示如果原目录有删除文件那么目标目录页删除，就能保持目标目录是原目录的一个镜像文件夹

rsync怎么通过ssh把本地服务器文件夹同步到远程服务器

通过SSH来安全地同步本地服务器上的文件夹到远程服务器。基本的命令结构如下：

rsync -avz -e "ssh -p SSH_PORT" LOCAL_DIRECTORY USER@REMOTE_HOST:REMOTE_DIRECTORY

这里是各部分参数的解释：

• -a 参数表示归档模式，它会保持原始文件的权限、时间戳、软硬链接等。
• -v 参数表示详细模式，会显示同步的详细信息。
• -z 参数表示启用压缩，它会在传输时将数据压缩，以减少网络上的数据量。
• -e 参数用于指定使用的shell，这里指定了ssh，后面可以跟ssh的相关参数，比如端口。
• SSH_PORT 是SSH服务器监听的端口，如果是默认的22端口，可以省略-p SSH_PORT部分。
• LOCAL_DIRECTORY 是你想要同步的本地服务器上的文件夹路径。
• USER 是你在远程服务器上的用户名。
• REMOTE_HOST 是远程服务器的地址。
• REMOTE_DIRECTORY 是远程服务器上你想要同步到的目标文件夹路径。

举个例子，如果你要将本地的/var/www文件夹同步到远程服务器192.168.1.10上用户username的主目录下的www文件夹，并且远程服务器SSH端口是2222，你可以这样做：

rsync -avz -e "ssh -p 2222" /var/www/ username@192.168.1.10:~/www/

请注意，如果本地服务器或远程服务器使用的不是默认的SSH密钥，你可能需要使用-i参数来指定私钥文件的路径。

rsync -avz -e "ssh -p SSH_PORT -i /path/to/private_key" LOCAL_DIRECTORY USER@REMOTE_HOST:REMOTE_DIRECTORY

确保在使用rsync之前，本地服务器和远程服务器之间的SSH免密钥登录已经设置好，这样rsync在同步时不会要求你输入密码。

如果远程服务器是使用的用户名和密码怎么同步

如果远程服务器需要用户名和密码进行身份验证，而不是基于SSH密钥的认证，您通常需要在rsync命令执行时输入密码。默认情况下，rsync会提示您输入密码。但是，这种方式不适合自动化脚本，因为它需要交互式输入。

对于自动化脚本，您可以使用sshpass工具来自动输入密码。首先，确保您的系统中已经安装了sshpass。

安装sshpass的命令通常是：

# 在Debian/Ubuntu系统上
sudo apt-get install sshpass

# 在RedHat/CentOS系统上
sudo yum install sshpass

# 在Fedora系统上
sudo dnf install sshpass

然后，使用sshpass结合rsync来同步文件夹：

sshpass -p 'YOUR_PASSWORD' rsync -avz -e "ssh -o StrictHostKeyChecking=no" LOCAL_DIRECTORY USER@REMOTE_HOST:REMOTE_DIRECTORY

这里是各部分参数的解释：

• sshpass -p 'YOUR_PASSWORD' 是sshpass命令，用于自动提供密码。替换YOUR_PASSWORD为您的实际密码。
• -o StrictHostKeyChecking=no 参数是为了避免手动验证远程主机的密钥，这在自动化脚本中很有用。

请注意，使用sshpass来自动输入密码可能会带来安全风险，因为密码是以明文形式在命令行中显示。确保在信任的环境中使用这种方法，并对密码的安全性负责。

最后，如果您不是自动化脚本的环境，建议使用SSH密钥认证方式进行rsync同步，因为这种方式更为安全。如果您没有选择，只能使用用户名和密码，请尽量在命令行中直接输入密码，而不是将密码放在脚本或命令中。

rsync同步能显示进度吗

是的，rsync可以显示同步的进度。要显示单个文件的进度以及整体的传输统计信息，您可以使用--progress或-P标志（这也包括--partial的功能，允许部分传输的文件在中断后继续传输）。此外，使用-h标志可以使输出更易于阅读，因为它会提供人类可读的格式。

下面是一个示例命令，它将显示进度信息：

rsync -avzhP -e "ssh -p SSH_PORT" LOCAL_DIRECTORY USER@REMOTE_HOST:REMOTE_DIRECTORY

在这个命令中：

• -a 是归档模式，它递归并保持几乎所有的文件属性。
• -v 是详细模式，显示更多信息。
• -z 启用压缩以减少网络传输数据量。
• -h 使输出更易于阅读。
• -P 相当于--partial --progress，它允许部分传输和显示进度。
• -e 指定使用的shell，后面跟SSH具体参数。

当您使用-P或--progress时，rsync会在传输每个文件时显示一个进度条，包括已传输的百分比、传输速度和预计剩余时间。

请注意，如果您正在传输很多小文件，单个文件的进度显示可能会过于快速，从而难以阅读。在这种情况下，您仍然可以获得总体传输的统计信息。

例如使用SSH同步宝塔面板的网站和备份数据库到远程服务器例子

备份网站
rsync -aWvhP --delete -e "ssh -p 22" /www/wwwroot/ root@192.168.1.1:/www/ycbackupwwwroot/wwwroot #/www/wwwroot/是本地目录 /www/ycbackupwwwroot/wwwroot是远程目录

备份数据库备份文件
rsync -aWvhP --delete -e "ssh -p 22" /www/backup/ root@192.168.1.1:/www/ycbackupwwwroot/backup #/www/backup/是本地目录 /www/ycbackupwwwroot/backup是远程目录

提示需要输入远程服务器root用户的密码就输入就行，如果想让自动输入密码就按照上面的教程使用sshpass工具来自动输入密码

同步期间终端如果关闭会停止同步，想让关闭终端不停止同步请看
https://www.sanradar.com/archives/566
此篇文章让rsync在后台运行

将远程服务器文件同步到本地例子

sshpass -p '123456' rsync -aWvhP --delete -e "ssh -p 22 -o StrictHostKeyChecking=no" root@192.168.1.1:/www/backup/ /www/wwwroot/ycbackupwwwroot/backup
表示使用ssh连接，端口号是22，自动输入远程服务器192.168.1.1的root用户的ssh密码123456， 将远程服务器的/www/backup/目录 同步到本地的/www/wwwroot/ycbackupwwwroot/backup目录