ioagel/rsync-backup

镜像概述

本镜像基于Rsync、SSH和CRON工具，实现自动化远程数据备份，并支持邮件通知备份结果，帮助用户构建安全高效的定时备份解决方案。

核心功能

• 通过SSH协议完成Rsync远程备份
• 自定义CRON定时任务，灵活设置备份频率
• 可选邮件通知功能，实时推送备份状态
• 支持Swarm Secrets管理敏感信息（如SSH密钥、SMTP密码），提升安全性

使用场景

• 服务器数据定时备份到远程存储主机
• 需要自动通知备份结果的企业/个人数据保护场景
• 轻量级自动化备份需求，适用于中小规模数据备份

配置说明

以下环境变量可根据需求自定义：

REMOTE_HOST             # 必选，远程主机地址
REMOTE_PATH             # 必选，远程备份路径
RSYNC_OPTIONS           # 可选，默认值为'-a --delete'
RSYNC_SSH_KEY           # 可选，默认路径为/run/secrets/rsync_ssh_key（推荐用Swarm Secrets挂载）
USER                    # 可选，默认值为root
CRON_SCHEDULE           # 可选，默认值为'0 0 * * *'（每天凌晨12点）
MAILTO                  # 可选，启用邮件功能需填写（不填则不发送邮件）
# 若设置MAILTO，以下变量为必选
MAILFROM                # 必选，发件人邮箱（如username@gmail.com）
SMTP_HOST               # 必选，SMTP服务器地址（如smtp.gmail.com）
SMTP_PORT               # 必选，SMTP端口（如587）
SMTP_USER               # 必选，SMTP用户名（如username@gmail.com）
SMTP_PASSWD[_FILE]      # 必选，SMTP密码（推荐用_FILE结合Swarm Secrets）

小贴士

即使单主机运行，也建议使用SWARM模式，其资源开销极低，且可利用Swarm的Secret、Config功能管理敏感信息，增强安全性。

部署示例

Docker Run命令

bash
docker run -d \
  --name rsync-backup \
  -e REMOTE_HOST=your_remote_host \
  -e REMOTE_PATH=/path/to/backup \
  -e CRON_SCHEDULE='0 2 * * *' \
  -v /local/path/to/ssh/key:/run/secrets/rsync_ssh_key \
  docker.xuanyuan.run/ioagel/rsync-backup

Docker Compose（Swarm模式）

yaml
version: '3.8'
services:
  rsync-backup:
    image: ioagel/rsync-backup
    environment:
      REMOTE_HOST: your_remote_host
      REMOTE_PATH: /path/to/backup
      CRON_SCHEDULE: '0 2 * * *'
      MAILTO: ***
      MAILFROM: ***
      SMTP_HOST: smtp.example.com
      SMTP_PORT: 587
      SMTP_USER: ***
      SMTP_PASSWD_FILE: /run/secrets/smtp_passwd
    secrets:
      - rsync_ssh_key
      - smtp_passwd
    deploy:
      replicas: 1

secrets:
  rsync_ssh_key:
    file: ./rsync_ssh_key
  smtp_passwd:
    file: ./smtp_passwd