helmuthb/rsnapshot

rsnapshot Docker镜像

镜像概述和主要用途

该Docker镜像允许运行（持续的）rsnapshot备份，支持从本地文件夹或远程服务器进行本地备份。通过卷挂载、文件挂载和环境变量配置，可灵活定制备份策略，包括备份频率、保留数量及备份源等。

核心功能和特性

Volumes

• /backup：备份的目标文件夹，必填卷。若不挂载，备份将存储在容器的临时磁盘空间中。
• /data：待备份数据所在的文件夹，本地备份时需挂载，远程备份可忽略。

File Mounts

• /ssh-id：运行时提供SSH密钥，远程服务器备份时需挂载，本地备份可忽略。
• /backup.cfg：添加额外备份步骤的配置文件，内容为rsnapshot配置文件中的backup语句或其他语句，可选。

环境变量

• BACKUP_NAME：备份源名称，将作为/backup卷下daily.X等文件夹中的子文件夹名。默认值：localhost。
• BACKUP_SOURCE：备份源路径。本地备份默认值为/data（与/data卷对应）；远程服务器备份格式为user@server:/folder。
• BACKUP_OPTS：rsnapshot额外选项，默认值one_fs=1（不跨文件系统备份）。
• BACKUP_SSH_ARGS：SSH额外参数，例如非标准端口-p 222。
• BACKUP_HOURLY：保留的每小时备份数量，默认值0（不执行每小时备份）。
• BACKUP_DAILY：保留的每日备份数量，默认值3。
• BACKUP_WEEKLY：保留的每周备份数量，默认值3。
• BACKUP_MONTHLY：保留的每月备份数量，默认值3。
• BACKUP_YEARLY：保留的每年备份数量，默认值3。
• CRON_HOURLY：每小时备份的crontab时间模式，默认值0 * * * *（每整点）。仅当BACKUP_HOURLY非零时生效。
• CRON_DAILY：每日备份的crontab时间模式，默认值30 23 * * *（每晚23:30）。仅当BACKUP_DAILY非零时生效。
• CRON_WEEKLY：每周备份的crontab时间模式，默认值0 23 * * 0（每周日23:00）。仅当BACKUP_WEEKLY非零时生效。
• CRON_MONTHLY：每月备份的crontab时间模式，默认值30 22 1 * *（每月1日22:30）。仅当BACKUP_MONTHLY非零时生效。
• CRON_YEARLY：每年备份的crontab时间模式，默认值0 22 1 1 *（每年1月1日22:00）。仅当BACKUP_YEARLY非零时生效。

使用场景和适用范围

• 本地备份：需备份主机本地文件夹（如/etc、/home）到指定存储位置。
• 远程备份：需从远程服务器（通过SSH）备份数据到本地存储。
• 定制备份策略：需灵活配置备份频率（每小时、每日、每周等）及保留数量。

使用方法和配置说明

1. 卷挂载：

   • 必须挂载/backup卷以指定备份目标路径。
   • 本地备份需额外挂载/data卷，指向待备份数据路径。

2. 文件挂载：

   • 远程备份需挂载/ssh-id卷，提供SSH密钥文件。
   • 如需添加额外备份步骤，可挂载/backup.cfg文件，包含backup语句。

3. 环境变量配置：

   • 根据需求设置BACKUP_NAME、BACKUP_SOURCE等环境变量，定制备份源、名称及策略。
   • 调整BACKUP_HOURLY至BACKUP_YEARLY设置备份保留数量，通过CRON_*变量设置备份时间。

部署示例

示例1：本地备份/etc到/srv/backup，命名为etc-folder

bash
docker run -d -v /etc:/data -v /srv/backup:/backup \
           -e BACKUP_NAME=etc-folder helmuthb/rsnapshot 

示例2：远程备份服务器example.com的/home到/srv/backup，命名为remote

bash
docker run -d -v $HOME/.ssh/id_rsa:/ssh-id \
           -v /srv/backup:/backup \
           -e BACKUP_NAME=remote \
           -e BACKUP_SOURCE=root@example.com \
           helmuthb/rsnapshot

示例3：使用backup.cfg添加多个备份步骤

创建backup.cfg文件：

backup		/etc	etc-folder/
backup		/boot	boot-folder/
backup		/home	home-folder/

运行容器：

bash
docker run -d -v backup.cfg:/backup.cfg -v /srv/backup:/backup \
           -e BACKUP_NAME=root -e BACKUP_SOURCE=/ helmuthb/rsnapshot