goabout/tarsnap-backup

tarsnap-backup

镜像概述和主要用途

tarsnap-backup是一个基于Docker的备份工具，用于通过tarsnap（安全的在线备份服务）备份指定的/backup目录。该镜像提供灵活的配置选项，支持定时备份、自定义数据生成脚本、备份目录清理及归档数量管理，适用于各类数据备份场景。

核心功能和特性

• 目录备份：将/backup目录内容备份到tarsnap服务
• 定时任务：通过SCHEDULE环境变量配置定时备份计划（支持cron表达式或@daily等特殊格式）
• 脚本执行：可运行自定义SCRIPT生成备份数据到/backup目录
• 目录清理：支持在执行脚本前清理/backup目录（CLEAR_BEFORE_SCRIPT）
• 归档管理：通过MAX_ARCHIVES设置保留的最大备份归档数量，自动删除旧归档

使用场景和适用范围

• 数据库备份：执行数据库dump脚本（如pg_dump）生成备份文件后进行归档
• 文档备份：直接挂载用户文档目录到/backup进行备份
• 服务器数据备份：配置定时任务实现重要数据的自动化备份

使用方法和配置说明

环境变量配置

挂载卷要求

• tarsnap密钥：必须挂载tarsnap密钥文件到/run/secrets/tarsnap.key（只读权限）
• 缓存目录：建议挂载/var/cache/tarsnap为持久卷以提高备份效率
• 备份目录：必须挂载/backup目录（可通过外部目录挂载或SCRIPT生成内容）

部署示例

示例1：备份PostgreSQL数据库

通过执行pg_dump命令将数据库导出到/backup目录，配置每日备份并保留最近7个归档：

bash
docker run \
    -e NAME=postgres.$(date +%Y-%m-%d_%H-%M-%S) \
    -e SCHEDULE='@daily' \
    -e SCRIPT='pg_dump postgres://database/mydb -f /backup/postgres_dump.sql' \
    -e CLEAR_BEFORE_SCRIPT=true \
    -e MAX_ARCHIVES=7 \
    -v $PWD/tarsnap.key:/run/secrets/tarsnap.key:ro \
    -v /tmp/tarsnap.cache:/var/cache/tarsnap \
    goabout/tarsnap-backup

示例2：备份用户文档

直接挂载用户Documents目录到/backup，配置每日备份：

bash
docker run \
    -e NAME=documents.$(date +%Y-%m-%d_%H-%M-%S) \
    -e SCHEDULE='@daily' \
    -v $PWD/tarsnap.key:/run/secrets/tarsnap.key:ro \
    -v /tmp/tarsnap.cache:/var/cache/tarsnap \
    -v /home/user/Documents:/backup \
    goabout/tarsnap-backup