nold360/borgserver

BorgServer - Docker镜像

基于Debian的容器镜像，运行openssh-daemon，仅允许用户“borg”通过SSH公钥认证访问，使用borgbackup作为客户端。备份仓库、客户端SSH密钥和SSH主机密钥将存储在持久化存储中。每添加一个SSH密钥，会自动创建一个独立的borg仓库。

注意：本文档假设您了解SSH密钥的概念以及如何生成和使用它。如果不了解，建议从Arch Wiki开始学习。

快速示例

以下是配置和运行此镜像的快速示例：

创建持久化sshkey存储

 $ mkdir -p borg/sshkeys/clients

确保sshkey文件夹权限正确：

 $ chown 1000:1000 borg/sshkeys

（生成并）复制客户端SSH公钥到持久化存储

记住：文件名 = Borg仓库名称！

 $ cp ~/.ssh/my_machine.pub borg/sshkeys/clients/my_machine

OpenSSH守护进程将在22/tcp端口暴露，因此您可能需要将其重定向到其他端口，如下例所示：

docker run -td \
	-p 2222:22  \
	--volume ./borg/sshkeys:/sshkeys \
	--volume ./borg/backup:/backup \
	nold360/borgserver:latest

Borgserver配置

• 将Borg客户端的SSH公钥放置在持久化存储中
• 客户端备份目录将以在/sshkeys/clients/中找到的文件名命名

环境变量

BORG_SERVE_ARGS

用于设置内部使用的“borg serve”命令的特殊选项。

有关所有可用参数的文档，请参见：borgbackup.readthedocs.io

示例

docker run --rm -e BORG_SERVE_ARGS="--progress --debug" (...) nold360/borgserver

BORG_APPEND_ONLY

如果希望客户端只能追加数据而不能修剪仓库，请将此变量设置为**"yes"**。

BORG_ADMIN

当BORG_APPEND_ONLY激活时，没有客户端能够修剪其仓库。
由于您可能需要在某些时候清理仓库，可以将一个客户端声明为borg“管理员”。

此客户端将对所有客户端的仓库拥有完全访问权限！因此它可以执行添加、修剪等任何操作。

要将客户端声明为管理员，请将此变量设置为添加到/sshkeys/clients目录中的客户端/sshkey名称。

示例

docker run --rm -e BORG_APPEND_ONLY="yes" -e BORG_ADMIN="nolds_notebook" (...) nold360/borgserver

要修剪其他客户端的仓库，必须在客户端目录中指定仓库路径：

borg prune --keep-last 100 --keep-weekly 1 (...) borgserver:/clientA/clientA

PUID

用于设置容器内“borg”用户的用户ID。当容器需要以特定用户ID访问主机资源时，此参数很有用。

PGID

用于设置容器内“borg”组的组ID。当容器需要以特定组ID访问主机资源时，此参数很有用。

持久化存储与客户端配置

要使borgserver正常工作，需要两个持久化存储目录。

/sshkeys

此目录包含两个子目录：

/sshkeys/clients/

此处存放所有需要备份的borg客户端的SSH公钥。每个密钥必须是单独的文件，仅包含一行密钥内容。文件名将成为客户端连接所需的borg仓库名称。

这意味着每个客户端都有自己的仓库。因此，您可能希望使用客户端的主机名作为sshkey文件的名称。

隐藏文件和隐藏目录中的文件将被忽略！

例如：/sshkeys/clients/webserver.mydomain.com

然后客户端需要像这样初始化borg仓库：

webserver.mydomain.com ~$ borg init ssh://borg@borgserver-container/backup/webserver.mydomain.com/my_first_repo

！重要！：只有当此目录中至少存在一个ssh密钥文件时，容器才会启动SSH守护进程！

/sshkeys/host/

此目录将在首次启动时自动创建。run.sh脚本也会将SSH主机密钥复制到此处，以便客户端可以验证borgserver的SSH主机密钥。

/backup

borg将在此目录中写入所有客户端数据。最好从空目录开始使用。

示例设置

docker-compose.yml

以下是使用docker-compose运行borgserver的快速示例：

services:
 borgserver:
  image: nold360/borgserver
  volumes:
   - /backup:/backup
   - ./sshkeys:/sshkeys
  ports:
   - "2222:22"
  environment:
   BORG_SERVE_ARGS: ""
   BORG_APPEND_ONLY: "no"
   BORG_ADMIN: ""
   PUID: 1000
   PGID: 1000

客户端的~/.ssh/config

通过此配置（在borg客户端上），您可以轻松连接到borgserver：

Host backup
	Hostname my.docker.host
	Port 2222
	User borg

现在可以像这样初始化borg仓库：

 $ borg init backup:my_first_borg_repo

并创建您的第一个备份！

 $ borg create backup:my_first_borg_repo::documents-2017-11-01 /home/user/MyImportentDocs