vimagick/rsyncd

rsyncd Docker镜像文档

概述

rsyncd是rsync的守护进程模式Docker镜像，基于开源工具https://rsync.samba.org构建。rsync是一款提供快速增量文件传输功能的工具，而rsyncd则以守护进程模式运行，支持通过网络进行文件共享和同步。

核心功能和特性

• 快速增量传输：利用rsync的核心算法，仅传输文件的差异部分，提高传输效率
• UTF-8字符集支持：默认配置支持UTF-8字符集，确保文件名称的正确显示
• 连接数控制：可配置最大连接数，防止服务器过载
• 灵活的访问控制：支持限制允许访问的主机、配置认证用户等
• 可自定义配置：允许通过挂载自定义rsyncd.conf文件覆盖默认配置
• 持久化存储：通过卷挂载实现共享文件的持久化存储

使用场景

• 服务器间文件同步与备份
• 局域网内文件共享服务
• 多客户端文件分发
• 自动化备份系统的文件传输节点

使用方法

1. Docker Compose配置

创建docker-compose.yml文件，内容如下：

yaml
rsyncd:
  image: docker.xuanyuan.run/vimagick/rsyncd
  ports:
    - "873:873"  # rsync默认端口
  volumes:
    # - ./rsyncd.conf:/etc/rsyncd.conf  # 可选：挂载自定义配置文件
    - ./share:/share  # 挂载共享目录
  restart: always  # 容器退出后自动重启

2. 启动服务

在docker-compose.yml所在目录执行以下命令启动服务：

bash
docker-compose up -d

3. 客户端使用

客户端可通过rsync命令访问共享资源：

bash
rsync -avz easypi.info::share /path/to/folder

其中：

• -a：归档模式，保留文件权限、时间等属性
• -v：详细输出模式
• -z：传输时压缩文件数据
• easypi.info：rsyncd服务器地址
• share：共享模块名称
• /path/to/folder：本地目标目录

配置说明

默认配置文件（rsyncd.conf）

容器内置默认配置文件如下：

[global]
charset = utf-8          # 使用UTF-8字符集
max connections = 8      # 最大连接数限制为8
reverse lookup = no      # 禁用反向DNS查找

[share]                  # 共享模块名称
path = /share            # 共享目录路径
read only = yes          # 只读模式（禁止写入）
#hosts allow = 192.168.0.0/16  # 可选：限制允许访问的IP段
#auth users = *          # 可选：允许的认证用户
#secrets file = /etc/rsyncd.secrets  # 可选：密码文件路径
#strict modes = false    # 可选：是否严格检查文件权限

自定义配置

如需修改配置，可创建本地rsyncd.conf文件，然后通过卷挂载覆盖默认配置：

yaml
volumes:
  - ./rsyncd.conf:/etc/rsyncd.conf  # 挂载自定义配置文件

关键配置项说明

• [global]段：全局配置

  • charset：设置字符集，确保文件名称正确显示
  • max connections：限制同时连接的客户端数量
  • reverse lookup：是否对客户端进行反向DNS查找，禁用可提高性能

• [share]段：共享模块配置（可配置多个模块）

  • path：共享目录在容器内的路径
  • read only：是否设为只读模式（yes/no）
  • hosts allow：允许访问的IP地址或网段（如192.168.0.0/16）
  • auth users：允许访问的认证用户（需配合secrets file使用）
  • secrets file：存储用户名和密码的文件路径，格式为用户名:密码
  • strict modes：是否严格检查密码文件的权限（建议设为false以避免权限问题）