tgbyte/borg-archive

Borg-rsync 归档镜像

镜像概述和主要用途

本镜像整合了rsync文件同步工具与Borg备份归档工具，提供通过rsync同步数据后自动进行Borg归档的一站式解决方案。主要用于服务器数据备份、跨设备文件同步归档、定期数据快照等场景，简化从文件同步到压缩归档的全流程管理。

核心功能和特性

• rsync同步能力：支持增量文件同步，仅传输变更数据，降低网络带宽占用；支持本地/远程（SSH）同步，兼容多种文件系统。
• Borg归档功能：提供数据去重（deduplication）、压缩（lz4/zstd等算法）、加密（AES-256）归档，减少存储空间占用并保障数据安全。
• 轻量级容器化：基于Alpine Linux构建，镜像体积小，资源占用低，支持跨平台部署。
• 自动化流程：同步与归档流程自动化，支持通过环境变量或配置文件自定义同步规则与归档策略。

使用场景和适用范围

• 服务器定期备份：对Web服务器、数据库服务器数据进行定时同步归档，生成可追溯的历史版本。
• 跨设备数据迁移：同步本地与远程设备文件后，生成加密归档包，便于安全传输与长期存储。
• 个人数据管理：对本地文档、媒体文件进行增量同步与压缩归档，节省存储资源。
• CI/CD数据归档：在持续集成流程中同步构建产物，通过Borg归档留存构建历史版本。

使用方法和配置说明

基本使用（docker run）

bash
docker run -d \
  --name borg-rsync-archive \
  -v /local/source:/sync/source \          # 挂载本地同步源目录
  -v /local/borg-repo:/borg/repo \         # 挂载Borg仓库目录（本地或远程挂载）
  -e RSYNC_SOURCE="/sync/source" \         # rsync同步源路径（容器内路径）
  -e RSYNC_DEST="user@remotehost:/path" \  # rsync同步目标（支持本地路径或user@host:/path格式）
  -e BORG_REPO="/borg/repo" \              # Borg仓库路径（容器内路径）
  -e BORG_ARCHIVE_NAME="backup-{now:%Y%m%d_%H%M%S}" \  # 归档名称（支持strftime时间格式）
  -e BORG_PASSPHRASE="your-secure-passphrase" \  # Borg仓库加密密码（必填）
  -e CRON_SCHEDULE="0 3 * * *" \           # 定时任务调度（每日凌晨3点执行，留空则立即执行一次）
  borg-rsync-archive:latest

环境变量配置说明

自定义rsync和Borg配置

如需更复杂的同步或归档规则，可通过挂载配置文件实现：

• rsync配置：挂载自定义rsyncd.conf至/etc/rsyncd.conf，或通过RSYNC_OPTIONS传入高级参数（如--exclude-from=/config/exclude.txt指定排除文件列表）。
• Borg配置：挂载Borg配置文件至/root/.config/borg/，或通过环境变量BORG_OPTIONS添加额外归档参数（如--compression zstd启用zstd压缩）。

示例：本地目录同步归档

bash
# 1. 创建本地Borg仓库（首次使用）
docker run --rm -v /local/borg-repo:/borg/repo borg-rsync-archive:latest borg init --encryption=repokey /borg/repo

# 2. 启动同步归档容器（同步本地/source目录至Borg仓库）
docker run -d \
  --name local-archive \
  -v /local/source:/sync/source \
  -v /local/borg-repo:/borg/repo \
  -e RSYNC_SOURCE="/sync/source" \
  -e RSYNC_DEST="/sync/source" \  # 本地同步（仅归档）
  -e BORG_REPO="/borg/repo" \
  -e BORG_ARCHIVE_NAME="local-backup-{now:%Y%m%d}" \
  -e BORG_PASSPHRASE="mybackup123" \
  borg-rsync-archive:latest

查看归档与恢复数据

bash
# 列出仓库中的归档
docker exec -it local-archive borg list /borg/repo

# 恢复指定归档至本地目录
docker run --rm -v /local/restore:/restore -v /local/borg-repo:/borg/repo \
  -e BORG_PASSPHRASE="mybackup123" \
  borg-rsync-archive:latest borg extract /borg/repo::local-backup-20240101 /restore