bbx0/borgbackup

BorgBackup容器

基于https://hub.docker.com/_/python的https://github.com/docker-library/official-images#what-are-official-images构建的BorgBackup分发版本。提供SSH客户端和https://rclone.org（仅borg2），用于备份到远程存储。

该容器镜像适合作为备份客户端，也可作为其他项目的基础镜像。

这是https://github.com/borgbackup/community的用户贡献项目。

共享标签

https://github.com/borgbackup/borg/blob/master/SECURITY.mdBorgBackup版本通过https://github.com/bbx0/container-borgbackup/actions/workflows/main.yaml持续构建并发布为共享标签。

你需要自行管理任何https://borgbackup.readthedocs.io/en/stable/usage/upgrade.html#when-you-do-not-need-borg-upgrade操作。切换到新版本标签前，请务必阅读BorgBackup的https://borgbackup.readthedocs.io/en/stable/changes.html#change-log。本镜像没有`:latest`标签，以降低破坏仓库数据的风险。

容器镜像为多平台构建，支持：linux/amd64、linux/arm64、linux/arm/v7。

-distroless变体基于Google的https://github.com/GoogleContainerTools/distroless#distroless-container-images，包含`borg`、`cat`、`rclone`（仅borg2）和`ssh`的二进制文件。

使用方法

快速开始

使用SSH仓库URL的简单示例。

yaml
# docker-compose.yaml
name: backup
services:
  borg:
    image: docker.xuanyuan.run/bbx0/borgbackup:1.4
    read_only: true
    environment:
      BORG_PASSPHRASE: mysecret
      BORG_REPO: ssh://user@example.com:22/./repos/myrepo
      BORG_RSH: ssh -i /run/secrets/borg.sshkey -o BatchMode=yes -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o LogLevel=ERROR
      BORG_HOST_ID: mycontainer-quickstart-2f1c4b@example.net
    working_dir: /mnt/src
    volumes:
      - borg:/borg # BorgBackup需要持久化内部卷`/borg`用于数据和缓存
      - ./borg.sshkey:/run/secrets/borg.sshkey:ro # 已存在的ssh私钥文件
      - ./mydata:/mnt/src/mydata:ro,z # 要备份的源数据挂载在`working_dir`下
volumes:
  borg:

bash
docker-compose run --rm borg init --encryption=repokey
docker-compose run --rm borg create ::{now} mydata # 源数据相对于`working_dir`的路径
docker-compose run --rm borg info
docker-compose run --rm borg list ::

配置

BorgBackup允许通过https://borgbackup.readthedocs.io/en/stable/usage/general.html#environment-variables进行配置，这是本容器推荐的配置方式。部分环境变量预配置了默认值。borg2的选项为实验性，可能会在未预先通知的情况下变更。

有关所有可用环境变量，请查看BorgBackup文档https://borgbackup.readthedocs.io/en/stable/usage/general.html#environment-variables部分。

建议

• 当在启用selinux的本地文件系统上备份或恢复时，使用--security-opt label=disable以防止文件系统重标记。
• 使用临时容器（--rm）。当/borg作为持久化卷提供且设置了BORG_HOST_ID时，命令执行后无需保留容器。
• 使用只读容器（--read-only）。容器不需要对自身根文件系统有写权限。
• 不要在/root/.ssh中提供任何ssh配置。通过-i标志挂载密钥文件，并在BORG_RSH中使用-o标志提供配置选项。可将配置文件挂载到/etc/ssh/ssh_config或/etc/ssh/ssh_known_hosts。
• 利用宿主环境的原生调度器（如systemd.timer或Kubernetes CronJobs）触发备份。这允许通过容器运行时直接控制任何启动/停止依赖项。

更多示例（如使用https://github.com/bbx0/container-borgbackup/blob/main/docs/example-caddy.md）请参见https://github.com/bbx0/container-borgbackup/tree/main/docs。