toelke158/docker-rsync

docker-rsync 镜像文档

概述

docker-rsync是一个基于Alpine Linux构建的轻量级Docker镜像，提供了rsync工具的完整功能。rsync是一款功能强大的文件同步工具，能够高效地在本地或远程系统之间同步文件和目录。该镜像设计简洁，配置灵活，既可以作为rsync服务器运行，也可以作为客户端使用，适用于各种文件备份和同步场景。

核心功能与特性

• 轻量级设计：基于Alpine Linux构建，镜像体积小，资源占用低
• 双重角色支持：既可作为rsync服务器，也可作为rsync客户端使用
• 灵活配置：支持通过环境变量或自定义配置文件配置rsync
• 安全可靠：支持SSH加密传输和访问控制
• 简单易用：提供直观的使用方式和丰富的示例

使用场景

• 本地系统文件备份与同步
• 远程服务器文件同步
• 网站或应用程序数据备份
• 多服务器间文件分发
• 开发环境与生产环境文件同步
• 自动化备份脚本集成

快速开始

作为rsync客户端使用

bash
# 从远程服务器同步文件到本地
docker run --rm -v /local/directory:/data toelke/rsync rsync user@remotehost:/remote/path /data

# 从本地同步文件到远程服务器
docker run --rm -v /local/directory:/data toelke/rsync rsync /data user@remotehost:/remote/path

作为rsync服务器使用

bash
# 基本服务器模式
docker run -d -p 873:873 -v /data:/data toelke/rsync

配置选项

环境变量配置

可以通过以下环境变量配置rsync服务器：

• RSYNC_UID: rsync运行用户ID (默认: 1000)
• RSYNC_GID: rsync运行用户组ID (默认: 1000)
• RSYNC_PORT: rsync监听端口 (默认: 873)
• RSYNC_MAX_CONNECTIONS: 最大连接数 (默认: 5)
• RSYNC_TIMEOUT: 连接超时时间(秒) (默认: 300)
• RSYNC_MOTD_FILE: 消息文件路径 (默认: /etc/rsyncd.motd)

模块配置

可以通过环境变量定义rsync模块，格式为RSYNC_MODULE_<NAME>_<OPTION>：

• RSYNC_MODULE_data_PATH: 模块路径 (例如: /data)
• RSYNC_MODULE_data_COMMENT: 模块描述
• RSYNC_MODULE_data_READ_ONLY: 是否只读 (true/false)
• RSYNC_MODULE_data_LIST: 是否可列目录 (true/false)
• RSYNC_MODULE_data_AUTH_USERS: 授权用户
• RSYNC_MODULE_data_SECRET_FILE: 密码文件路径

高级使用示例

带认证的rsync服务器

bash
docker run -d -p 873:873 \
  -v /host/data:/data \
  -v /host/rsyncd.secrets:/etc/rsyncd.secrets \
  -e RSYNC_MODULE_data_PATH=/data \
  -e RSYNC_MODULE_data_COMMENT="My data module" \
  -e RSYNC_MODULE_data_READ_ONLY=false \
  -e RSYNC_MODULE_data_AUTH_USERS=backupuser \
  -e RSYNC_MODULE_data_SECRET_FILE=/etc/rsyncd.secrets \
  toelke/rsync

使用docker-compose

yaml
version: '3'
services:
  rsync:
    image: toelke/rsync
    ports:
      - "873:873"
    volumes:
      - ./data:/data
      - ./rsyncd.secrets:/etc/rsyncd.secrets
    environment:
      - RSYNC_MODULE_data_PATH=/data
      - RSYNC_MODULE_data_COMMENT="My data module"
      - RSYNC_MODULE_data_READ_ONLY=false
      - RSYNC_MODULE_data_AUTH_USERS=backupuser
      - RSYNC_MODULE_data_SECRET_FILE=/etc/rsyncd.secrets
    restart: always

自定义配置文件

bash
docker run -d -p 873:873 \
  -v /host/data:/data \
  -v /host/rsyncd.conf:/etc/rsyncd.conf \
  toelke/rsync

客户端使用示例

从rsync服务器同步文件

bash
# 基本同步
docker run --rm -v /local/data:/data toelke/rsync rsync rsync://server/data/ /data

# 带认证的同步
docker run --rm -v /local/data:/data toelke/rsync rsync backupuser@server::data /data

通过SSH同步

bash
docker run --rm -v /local/data:/data -v ~/.ssh:/root/.ssh toelke/rsync rsync -avz -e ssh user@remotehost:/remote/path /data

注意事项

• 确保挂载的数据目录具有正确的权限
• 作为服务器使用时，建议设置适当的认证机制
• 使用SSH模式时，确保正确挂载SSH密钥
• 生产环境中建议使用自定义配置文件以获得更精细的控制
• 定期更新镜像以获取最新的安全补丁

维护与更新

bash
# 拉取最新镜像
docker pull toelke/rsync

# 查看rsync版本
docker run --rm toelke/rsync rsync --version

故障排除

• 检查容器日志: docker logs <container-id>
• 验证端口映射是否正确
• 确认防火墙设置允许rsync端口(默认873)通信
• 检查挂载目录权限是否正确
• 验证rsync配置是否正确应用
• 使用rsync --verbose或rsync --debug获取详细输出进行问题诊断