社区 › Linux › rsync 使用笔记

阡陌 发表于 2024-2-1 12:27:17

rsync 使用笔记


官网网址：http://rsync.samba.org/

## 服务端

```
/etc/rsyncd.conf

#motd file = /etc/rsyncd.motd
log file = /var/log/rsyncd.log
pid file = /var/run/rsyncd.pid
lock file = /var/run/rsync.lock
uid = root
gid = root
use chroot = no
list = no
read only = false
#允许进行rsync的客户端网段或IP
hosts allow = 192.168.1.223 #192.168.1.0/24
secrets file = /etc/rsyncd.secrets


path = /volume1/yanfa.svn.backup
comment = yanfa.svn rsync
list = yes
#当多个用户时，用逗号分隔
auth users = rsync_usr

path = /volume1/zhongshi.svn.backup
comment = zhongshi.svn rsync
list = yes
#当多个用户时，用逗号分隔
auth users = rsync_usr

path = /volume1/yanfa.git.backup
comment = yanfa.git rsync
list = yes
#当多个用户时，用逗号分隔
auth users = rsync_usr
```

中括号内的是模块（module）的名字，在这之前的定义是全局的。配置文件中可以定义多个模块。

motd file

"motd file" 参数用来指定一个消息文件，当客户连接服务器时该文件的内容显示给客户，默认是没有 motd 文件的。该文件有无都不影响 rsync 的正常使用。

log file

"log file" 指定 rsync 的日志文件，而不将日志发送给 syslog。

pid file

指定 rsync 的 pid 文件。

syslog facility

指定 rsync 发送日志消息给 syslog 时的消息级别，常见的消息级别是：uth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, security, sys-log, user, uucp, local0, local1, local2, local3,local4, local5, local6 和 local7。默认值是 daemon。

comment

给模块指定一个描述，该描述连同模块名在客户连接得到模块列表时显示给客户。默认没有描述定义。

path

指定该模块的供备份的目录树路径，该参数是必须指定的。

use chroot

如果 "use chroot" 指定为 true，那么 rsync 在传输文件以前首先 chroot 到 path 参数所指定的目录下。这样做的原因是实现额外的安全防护，但是缺点是需要 root 权限，并且不能备份指向外部的符号连接所指向的目录文件。默认情况下 chroot 值为 true。

max connections

指定该模块的最大并发连接数量以保护服务器，超过限制的连接请求将被告知随后再试。默认值是 0，也就是没有限制。

lock file

指定支持 max connections 参数的锁文件，默认值是 /var/run/rsyncd.lock。

read only

该选项设定是否允许客户上载文件。如果为 true 那么任何上载请求都会失败，如果为 false 并且服务器目录读写权限允许那么上载是允许的。默认值为 true。

list

该选项设定当客户请求可以使用的模块列表时，该模块是否应该被列出。如果设置该选项为 false，可以创建隐藏的模块。默认值是 true。

uid

该选项指定当该模块传输文件时守护进程应该具有的 uid，配合 gid 选项使用可以确定哪些可以访问怎么样的文件权限，默认值是 "nobody"。

gid

该选项指定当该模块传输文件时守护进程应该具有的 gid。默认值为 "nobody"。

exclude

用来指定多个由空格隔开的多个模式列表，并将其添加到 exclude 列表中。这等同于在客户端命令中使用 --exclude 来指定模式，不过配置文件中指定的 exclude 模式不会传递给客户端，而仅仅应用于服务器。一个模块只能指定一个 exclude 选项，但是可以在模式前面使用 "-" 和 "+" 来指定是 exclude 还是 include。

但是需要注意的一点是该选项有一定的安全性问题，客户很有可能绕过 exclude 列表，如果希望确保特定的文件不能被访问，那就最好结合 uid/gid 选项一起使用。

exclude from

指定一个包含 exclude 模式的定义的文件名，服务器从该文件中读取 exclude 列表定义。

include

用来指定多个由空格隔开的多个 rsync 并应该 exlude 的模式列表。这等同于在客户端命令中使用 --include 来指定模式，结合 include 和 exclude 可以定义复杂的 exclude/include 规则 。一个模块只能指定一个 include 选项，但是可以在模式前面使用 "-" 和 "+" 来指定是 exclude 还是 include。

include from

指定一个包含 include 模式的定义的文件名，服务器从该文件中读取 include 列表定义。

auth users

该选项指定由空格或逗号分隔的用户名列表，只有这些用户才允许连接该模块。这里的用户和系统用户没有任何关系。如果 "auth users" 被设置，那么客户端发出对该模块的连接请求以后会被 rsync 请求 challenged 进行验证身份,这里使用的 challenge/response 认证协议。用户的名和密码以明文方式存放在 "secrets file" 选项指定的文件中。默认情况下无需密码就可以连接模块(也就是匿名方式)。

secrets file

该选项指定一个包含定义 用户名:密码 对的文件。只有在 "auth users" 被定义时，该文件才有作用。文件每行包含一个 username:passwd 对。一般来说密码最好不要超过 8 个字符。没有默认的 secures file 名，需要限式指定一个。(例如：/etc/rsyncd.secrets)

strict modes

该选项指定是否监测密码文件的权限，如果该选项值为 true 那么密码文件只能被 rsync 服务器运行身份的用户访问，其他任何用户不可以访问该文件。默认值为 true。

hosts allow

该选项指定哪些IP的客户允许连接该模块。客户模式定义可以是以下形式：

xxx.xxx.xxx.xxx，客户主机只有完全匹配该 IP 才允许访问。例如：192.167.0.1

a.b.c.d/n，属于该网络的客户都允许连接该模块。例如：192.168.0.0/24

a.b.c.d/e.f.g.h，属于该网络的客户都允许连接该模块。例如：192.168.0.0/255.255.255.0

一个主机名，客户主机只有拥有该主机名才允许访问，例如：backup.mculoop.com。

*.mculoop.com，所有属于该域的主机都允许。

默认是允许所有主机连接。

hosts deny

指定不允许连接 rsync 服务器的机器，可以使用 hosts allow 的定义方式来进行定义。默认是没有 hosts deny 定义。

ignore errors

指定 rsyncd 在判断是否运行传输时的删除操作时忽略 server 上的 IP 错误，一般来说 rsync 在出现 IO 错误时将将跳过 --delete 操作，以防止因为暂时的资源不足或其它 IO 错误导致的严重问题。

ignore nonreadable

指定 rysnc 服务器完全忽略那些用户没有访问权限的文件。这对于在需要备份的目录中有些文件是不应该被备份者得到的情况是有意义的。

transfer logging

使 rsync 服务器使用 ftp 格式的文件来记录下载和上载操作在自己单独的日志中。

log format

通过该选项用户在使用 transfer logging 可以自己定制日志文件的字段。其格式是一个包含格式定义符的字符串，可以使用的格式定义符如下所示：

%h 远程主机名

%a 远程 IP 地址

%l 文件长度字符数

%p 该次 rsync 会话的进程 id

%o 操作类型："send" 或 "recv"

%f 文件名

%P 模块路径

%m 模块名

%t 当前时间

%u 认证的用户名(匿名时是 null)

%b 实际传输的字节数

%c 当发送文件时，该字段记录该文件的校验码

默认 log 格式为："%o %h [%a] %m (%u) %f %l"，一般来说,在每行的头上会添加 "%t [%p] "。在源代码中同时发布有一个叫 rsyncstats 的 perl 脚本程序来统计这种格式的日志文件。

timeout

通过该选项可以覆盖客户指定的IP超时时间。通过该选项可以确保 rsync 服务器不会永远等待一个崩溃的客户端。超时单位为秒钟，0 表示没有超时定义，这也是默认值。对于匿名 rsync 服务器来说，一个理想的数字是 600。

refuse options

通过该选项可以定义一些不允许客户对该模块使用的命令参数列表。这里必须使用命令全名，而不能是简称。但发生拒绝某个命令的情况时服务器将报告错误信息然后退出。如果要防止使用压缩，应该是："dont compress = *"。

dont compress

用来指定那些不进行压缩处理再传输的文件，默认值是 *.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz。

auth users 指定的用户与系统用户没有关系，是独立的。需要创建一个文本文件用于认证（比如 rsyncd.secrets），格式为 username:password（明文），每行一个用户密码对。



## 客户端

客户端使用 rsync 命令进行同步操作，命令的参数表：

-v, --verbose 详细模式输出

-q, --quiet 精简输出模式

-c, --checksum 打开校验开关，强制对文件传输进行校验

-a, --archive 归档模式，表示以递归方式传输文件，并保持所有文件属性，等于 -rlptgoD

-r, --recursive 对子目录以递归模式处理

-R, --relative 使用相对路径信息

-b, --backup 创建备份，也就是对于目的已经存在有同样的文件名时，将老的文件重新命名为 ~filename。可以使用 --suffix 选项来指定不同的备份文件前缀。

--backup-dir 将备份文件(如 ~filename)存放在在目录下。

-suffix=SUFFIX 定义备份文件前缀

-u, --update 仅仅进行更新，也就是跳过所有已经存在于 DST，并且文件时间晚于要备份的文件。(不覆盖更新的文件)

-l, --links 保留软链结

-L, --copy-links 想对待常规文件一样处理软链结

--copy-unsafe-links 仅仅拷贝指向 SRC 路径目录树以外的链结

--safe-links 忽略指向 SRC 路径目录树以外的链结

-H, --hard-links 保留硬链结

-p, --perms 保持文件权限

-o, --owner 保持文件属主信息

-g, --group 保持文件属组信息

-D, --devices 保持设备文件信息

-t, --times 保持文件时间信息

-S, --sparse 对稀疏文件进行特殊处理以节省 DST 的空间

-n, --dry-run 现实哪些文件将被传输

-W, --whole-file 拷贝文件，不进行增量检测

-x, --one-file-system 不要跨越文件系统边界

-B, --block-size=SIZE 检验算法使用的块尺寸，默认是 700 字节

-e, --rsh=COMMAND 指定替代 rsh 的 shell 程序

--rsync-path=PATH 指定远程服务器上的 rsync 命令所在路径信息

-C, --cvs-exclude 使用和 CVS 一样的方法自动忽略文件，用来排除那些不希望传输的文件

--existing 仅仅更新那些已经存在于 DST 的文件，而不备份那些新创建的文件

--delete 删除那些 DST 中 SRC 没有的文件

--delete-excluded 同样删除接收端那些被该选项指定排除的文件

--delete-after 传输结束以后再删除

--ignore-errors 及时出现 IO 错误也进行删除

--max-delete=NUM 最多删除 NUM 个文件

--partial 保留那些因故没有完全传输的文件，以是加快随后的再次传输

--force 强制删除目录，即使不为空

--numeric-ids 不将数字的用户和组 ID 匹配为用户名和组名

--timeout=TIME IP 超时时间，单位为秒

-I, --ignore-times 不跳过那些有同样的时间和长度的文件

--size-only 当决定是否要备份文件时，仅仅察看文件大小而不考虑文件时间

--modify-window=NUM 决定文件是否时间相同时使用的时间戳窗口，默认为 0

-T --temp-dir=DIR 在 DIR 中创建临时文件

--compare-dest=DIR 同样比较 DIR 中的文件来决定是否需要备份

-P 等同于 --partial

--progress 显示备份过程

-z, --compress 对备份的文件在传输时进行压缩处理

--exclude=PATTERN 指定排除不需要传输的文件模式

--include=PATTERN 指定不排除而需要传输的文件模式

--exclude-from=FILE 排除 FILE 中指定模式的文件

--include-from=FILE 不排除 FILE 指定模式匹配的文件

--version 打印版本信息

--address 绑定到特定的地址

--config=FILE 指定其他的配置文件，不使用默认的 rsyncd.conf 文件

--port=PORT 指定其他的 rsync 服务端口

--blocking-io 对远程 shell 使用阻塞 IO

-stats 给出某些文件的传输状态

--progress 在传输时现实传输过程

--log-format=FORMAT 指定日志文件格式

--password-file=FILE 从 FILE 中得到密码

--bwlimit=KBPS 限制 I/O 带宽，KBytes per second

-h, --help 显示帮助信息

常用参数为 -avz

rsync 的命令格式可以为以下六种：

rsync ... SRC DEST

rsync ... SRC HOST:DEST

rsync ... HOST:SRC DEST

rsync ... HOST::SRC DEST

rsync ... SRC HOST::DEST

rsync ... rsync://HOST[:PORT]/SRC

将本地文档备份到服务器：
```
rsync -avz --progress --delete --password-file=./rsync.passwd /cygdrive/C/Repositories rsync_usr@192.168.5.198::yanfa.svn
```

注意，Windows 下不能直接使用 Windows 路径 “C:\Repositories”，要转换为 “/cygdrive/C/Repositories” 的形式。rsync.passwd 文件（Linux 下权限应为 600）的内容仅为单个用户的明文密码，如果不使用 --password-file参数，则每次都需要输入密码。

/cygdrive/C/Repositories 会将 Repositories 文件夹本身同步到服务器上，而 /cygdrive/C/Repositories/ 则会将 Repositories 文件夹的内容同步到服务器上。

其它实例：
```
#!/bin/sh

rsync -avz --progress --delete --password-file=/root/rsync.passwd /data/git-data rsync_usr@192.168.5.198::yanfa.git

rsync -avz --progress --delete --password-file=/root/rsync.passwd /backups/gitlab/ rsync_usr@192.168.5.198::yanfa.git/gitlab-backups

rsync -avz --progress --delete --password-file=/root/rsync.passwd /data/svn1 rsync_usr@192.168.5.198::zhongshi.svn

rsync -avz --progress --delete --password-file=/root/rsync.passwd /data/svnadmin1 rsync_usr@192.168.5.198::zhongshi.svn

rsync -avz --delete --rsh=ssh ~/src root@10.2.3.129:/root/dest
```

查看完整版本: rsync 使用笔记