b2un0/rsync

docker rsync

!Docker Pulls !Docker Stars !MicroBadger Size

镜像概述和主要用途

b2un0/rsync是一个轻量级Docker容器，旨在通过rsync工具实现文件同步功能。它支持定时任务调度、SSH安全认证、自定义同步规则及rsync选项，适用于需要自动化、灵活配置的文件同步场景。

核心功能和特性

• 定时同步：通过SCHEDULE环境变量配置crontab表达式，实现周期性自动同步
• SSH认证支持：可配置SSH密钥和连接选项，确保远程同步的安全性
• 自定义rsync选项：通过RSYNC_OPTIONS参数灵活配置rsync同步行为
• 包含列表管理：支持外部包含列表文件，精确控制需要同步的文件和目录
• 持久化配置：通过挂载卷实现配置文件和数据的持久化存储

使用场景和适用范围

• 服务器间定时文件备份
• 跨设备数据同步（本地与远程服务器）
• 自动化日志、文档等文件传输
• 需要自定义同步规则的场景（特定文件夹、文件类型同步）
• Synology等NAS设备的文件同步

使用方法和配置说明

Docker Compose配置示例

yaml
services:
    rsync-sync:
        image: b2un0/rsync:latest
        restart: unless-stopped
        network_mode: bridge
        volumes:
            - /本地待同步目录:/here/get/my/stuff/:ro  # 本地源目录（只读）
            - ./config/syncer.list:/tmp/include.list:ro  # 同步包含列表文件（只读）
            - ~/.ssh/id_ed25519:/tmp/ssh_key:ro  # SSH密钥文件（只读）
        environment:
            SCHEDULE: "15 3 * * *"  # 每天凌晨3点15分执行同步（crontab格式）
            HOST: "some.target.tld"  # 远程目标主机地址
            PORT: 1337  # 远程SSH端口
            LOGIN: "syncer"  # 远程登录用户名
            SOURCE: "/here/get/my/stuff/"  # 容器内源目录路径
            TARGET: "/volume1/stuff/"  # 远程目标目录路径
            SSH_OPTIONS: "-i /tmp/ssh_key -o StrictHostKeyChecking=no"  # SSH连接选项
            # RSYNC_OPTIONS: "--rsync-path=/bin/rsync"  # Synology等设备可能需要指定rsync路径
            # RSYNC_OPTIONS: "--list-only"  # 仅列出文件，不执行实际同步
            # RSYNC_OPTIONS: "--dry-run"  # 模拟同步，不实际传输文件

环境变量说明

包含列表文件格式

通过挂载/tmp/include.list文件定义rsync同步包含规则，示例如下（./config/syncer.list）：

text
+ Folder_A/***  # 包含Folder_A目录下所有文件及子目录（递归）
+ Folder_B/Every***  # 包含Folder_B目录下以"Every"开头的所有文件及子目录
+ Folder_C/BLA.ext  # 包含特定文件Folder_C/BLA.ext
+ Folder_D/  # 包含Folder_D目录本身
+ Folder_D/SUB_FOLDER/***  # 包含Folder_D/SUB_FOLDER目录下所有内容

格式说明：

• 使用+前缀表示需要包含的路径
• ***通配符表示递归包含所有子目录和文件
• 未显式包含的路径将默认不被同步