mgbi/borg

Borg Docker镜像

基于BorgBackup客户端工具的Docker镜像，包含sshfs支持。Borg是一款支持重复数据删除、压缩和加密的备份程序，具有高效性，无需常规完整备份即可支持数据修剪。

快速开始

首先拉取镜像以保持更新，然后创建并运行borg备份容器。本示例中，主机的/etc和/home目录以只读方式挂载到容器，这些是待备份目录。备份数据将存储在borg-repo Docker卷中，并使用my-secret-pw密码保护。若主机使用SELinux，需添加--security-opt label:disable标志，以避免重新标记/etc和/home目录同时确保容器有权访问。备份完成后，数据将按默认策略修剪并检查错误。容器内Borg以详细模式运行，会打印备份详细输出。最后删除容器（使用单独的docker rm命令，因为docker run的--rm选项会同时删除Docker卷，这是我们不希望的）。每次备份时删除容器并从仓库拉取镜像可保持容器最新。

bash
docker pull mgbi/borg
docker run \
  -e BORG_REPO=/borg/repo \
  -e BORG_PASSPHRASE=my-secret-pw \
  -e BACKUP_DIRS=/borg/data \
  -e EXCLUDE='*/.cache*;*.tmp;/borg/data/etc/shadow' \
  -e COMPRESSION=lz4 \
  -e PRUNE=1 \
  -v borg-config:/root/.config/borg \
  -v borg-cache:/root/.cache/borg \
  -v borg-repo:/borg/repo \
  -v /etc:/borg/data/etc:ro \
  -v /home:/borg/data/home:ro \
  --security-opt label:disable \
  --name borg-backup \
  mgbi/borg
docker rm borg-backup

更多示例

将Docker卷备份到远程位置（远程需运行Borg服务器模式），从本地文件读取BORG_PASSPHRASE变量

bash
docker run \
  -e BORG_REPO='user@hostname:/path/to/repo' \
  -e ARCHIVE=wordpress-$(date +%Y-%m-%d) \
  -e BORG_PASSPHRASE_FILE=/run/secrets/my-secret-pw-file \
  -e BACKUP_DIRS=/borg/data \
  -e COMPRESSION=lz4 \
  -e PRUNE=1 \
  -v borg-config:/root/.config/borg \
  -v borg-cache:/root/.cache/borg \
  -v mariadb-data:/borg/data/mariadb:ro \
  -v worpdress-data:/borg/data/wordpress:ro \
  --name borg-backup \
  mgbi/borg

使用sshfs（当远程未安装Borg时）

bash
docker run \
  -e SSHFS='user@hostname:/path/to/repo' \
  -e SSHFS_PASSWORD=my-ssh-password \
  -e BORG_PASSPHRASE=my-secret-pw \
  -e BACKUP_DIRS=/borg/data \
  -e COMPRESSION=lz4 \
  -e PRUNE=1 \
  -v borg-config:/root/.config/borg \
  -v borg-cache:/root/.cache/borg \
  -v mariadb-data:/borg/data/mariadb:ro \
  -v worpdress-data:/borg/data/wordpress:ro \
  --cap-add SYS_ADMIN --device /dev/fuse --security-opt label:disable \
  --name borg-backup \
  mgbi/borg

使用sshfs与ssh密钥认证

bash
docker run \
  -e SSHFS='user@hostname:/path/to/repo' \
  -e SSHFS_IDENTITY_FILE=/root/ssh-key/key \
  -e SSHFS_GEN_IDENTITY_FILE=1 \
  -e BORG_PASSPHRASE=my-secret-pw \
  -e BACKUP_DIRS=/borg/data \
  -e COMPRESSION=lz4 \
  -e PRUNE=1 \
  -v borg-config:/root/.config/borg \
  -v borg-cache:/root/.cache/borg \
  -v borg-ssh-key:/root/ssh-key \
  -v mariadb-data:/borg/data/mariadb:ro \
  -v worpdress-data:/borg/data/wordpress:ro \
  --cap-add SYS_ADMIN --device /dev/fuse --security-opt label:disable \
  --name borg-backup \
  mgbi/borg

从特定日期恢复文件到主机文件夹

bash
docker run \
  -e BORG_REPO='user@hostname:/path/to/repo' \
  -e ARCHIVE=wordpress-2016-05-25 \
  -e BORG_PASSPHRASE=my-secret-pw \
  -e EXTRACT_TO=/borg/restore \
  -e EXTRACT_WHAT=only/this/file \
  -v borg-config:/root/.config/borg \
  -v borg-cache:/root/.cache/borg \
  -v /opt/restore:/borg/restore \
  --security-opt label:disable \
  --name borg-backup \
  mgbi/borg

运行自定义borg命令

bash
docker run \
  -e BORG_REPO='user@hostname:/path/to/repo' \
  -e BORG_PASSPHRASE=my-secret-pw \
  -e BORG_PARAMS='list ::2016-05-26' \
  -v borg-config:/root/.config/borg \
  -v borg-cache:/root/.cache/borg \
  --name borg-backup \
  mgbi/borg

环境变量

以下是所有接受的环境变量说明。

核心变量

• BORG_REPO - 仓库位置
• BORG_REMOTE_PATH - Borg可执行文件的远程路径（若已安装），默认为borg
• ARCHIVE - Borg仓库的归档参数，若为空，默认值为"${HOSTNAME}_$(date +%Y-%m-%d)"，更多信息见Borg文档
• BACKUP_DIRS - 待备份目录
• EXCLUDE - 要从备份中排除的路径/模式（路径用;分隔，例如：-e EXCLUDE='/my path/one;/path two;*.tmp'）
• BORG_PARAMS - 在容器内运行自定义borg命令，若设置此变量，将仅执行该变量指定的命令，而非默认命令（例如list或list ::2016-05-26，无需指定仓库，因为borg会默认使用BORG_REPO环境变量）
• BORG_SKIP_CHECK - 设为1可跳过备份结束时的borg check命令

压缩

• COMPRESSION - 使用的压缩方式，默认为无，更多信息

加密

• BORG_PASSPHRASE - repokey模式下用于加密备份数据的密码，默认为无，此Docker镜像仅支持repokey模式加密，更多信息
• BORG_PASSPHRASE_FILE - 包含BORG_PASSPHRASE的文件路径，用于替代直接传递变量

提取（恢复）文件

• EXTRACT_TO - 提取（恢复）borg归档的目录，若设置此变量，将仅执行提取操作，而非默认命令，仓库和归档通过BORG_REPO和ARCHIVE变量指定，更多信息
• EXTRACT_WHAT - 应提取的文件和目录子集

修剪

• PRUNE - 若设置，备份后修剪仓库，默认为空，更多信息
• PRUNE_PREFIX - 按归档前缀过滤要修剪的数据，默认为空（修剪所有数据）
• KEEP_DAILY - 保留的每日备份数量，默认为7
• KEEP_WEEKLY - 保留的每周备份数量，默认为4
• KEEP_MONTHLY - 保留的每月备份数量，默认为6
• KEEP_LAST - 保留的最近备份数量，默认为10

SSHFS

• SSHFS - sshfs目标，格式为user@host:/path，使用sshfs时，容器需特殊权限：--cap-add SYS_ADMIN --device /dev/fuse；若使用SELinux：--security-opt label:disable；若使用apparmor：--security-opt apparmor:unconfined
• SSHFS_PASSWORD - ssh认证密码
• SSHFS_IDENTITY_FILE - ssh密钥路径
• SSHFS_GEN_IDENTITY_FILE - 若设置，当SSHFS_IDENTITY_FILE已设置但密钥文件不存在时，生成ssh密钥对（生成4096位rsa密钥），生成后公钥部分将打印到stdout，容器停止，以便在首次备份前配置服务器端