edirom/backup-cron

backup-cron 镜像文档

镜像概述

backup-cron是一个通过ssh/rsync和cron实现的备份服务镜像。该服务设计为每日运行一次，在远程备份主机上为每一天创建新文件夹。每次新备份通过硬链接基于前一天的备份生成，随后rsync仅更新变更的文件（并删除已移除的文件），以提高备份效率。

核心功能和特性

• 每日自动备份：通过cron调度，每日执行一次备份任务
• 增量备份优化：利用硬链接基于前一天备份创建新备份，减少存储空间占用
• 高效文件同步：使用rsync仅同步变更文件，删除已移除文件，提升同步效率
• 灵活备份模式：支持本地数据备份和远程到远程（remote2remote）备份两种模式

使用场景和适用范围

• 需要每日自动备份数据的场景
• 对备份效率和存储空间有要求的环境
• 需通过ssh/rsync协议进行远程备份的场景
• 支持本地目录备份或跨远程主机间的数据备份

使用方法和配置说明

前提条件

环境变量

必须设置以下环境变量：

• BACKUP_TARGET_HOST：远程备份目标主机地址
• BACKUP_TARGET_PATH：远程备份目标路径
• BACKUP_SOURCE_PATH：备份源路径

可选环境变量：

• BACKUP_SOURCE_HOST：若指定此变量，将触发远程到远程（remote2remote）备份模式；未指定时默认备份本地BACKUP_SOURCE_PATH路径下的数据

SSH连接配置

需确保以下SSH连接可用（使用密钥认证）：

• 容器与BACKUP_TARGET_HOST之间的SSH连接
• 若指定了BACKUP_SOURCE_HOST，则容器与BACKUP_SOURCE_HOST之间，以及BACKUP_SOURCE_HOST与BACKUP_TARGET_HOST之间均需建立SSH连接

所有必要的SSH密钥和配置文件需挂载到容器内的/root/.ssh目录。

Docker部署示例

本地数据备份示例

bash
docker run --rm -it \
  -e "BACKUP_TARGET_HOST=myTargetHost" \
  -e "BACKUP_SOURCE_PATH=/source/to/backup/" \
  -e "BACKUP_TARGET_PATH=/target/path/" \
  -v /path/to/.ssh:/root/.ssh \
  -v /local/path/to/source:/source/to/backup \
  edirom/backup-cron

参数说明：

• -e：设置环境变量，指定备份目标主机、源路径和目标路径
• -v /path/to/.ssh:/root/.ssh：挂载本地SSH密钥和配置文件到容器
• -v /local/path/to/source:/source/to/backup：挂载本地需备份的目录到容器内的BACKUP_SOURCE_PATH路径

远程到远程备份示例

当需要从一个远程主机备份数据到另一个远程主机时，需额外指定BACKUP_SOURCE_HOST环境变量：

bash
docker run --rm -it \
  -e "BACKUP_TARGET_HOST=myTargetHost" \
  -e "BACKUP_SOURCE_HOST=mySourceHost" \
  -e "BACKUP_SOURCE_PATH=/remote/source/path/" \
  -e "BACKUP_TARGET_PATH=/target/path/" \
  -v /path/to/.ssh:/root/.ssh \
  edirom/backup-cron