配置¶
本页介绍容器的环境变量、模板提供的挂载、安全模型、通过 SSH 的虚拟机备份,以及异地设置。备份存到哪里,是在应用内以存储位置来设置的,不是通过环境变量。
环境变量¶
| 变量 | 必填 | 说明 |
|---|---|---|
APP_KEY |
是 | 32 字节的十六进制密钥(64 个十六进制字符),用来派生 restic 仓库的密码。用 openssl rand -hex 32 生成。请妥善保管:丢失它会让加密的备份无法恢复。 |
LIBVIRT_HOST |
虚拟机和 ZFS 数据集需要 | 虚拟机和 ZFS 数据集备份通过 SSH 连接的 Unraid 主机(模板字段 Host SSH: Address,默认 host.docker.internal)。模板预填的占位符 192.168.x.x 算作未设置。使用你 Unraid 的局域网 IP,在自定义的 br0.x 网络上必须这样做。当 host.docker.internal 无法解析(例如在 TrueNAS 应用里),而且 LIBVIRT_URI 也没有指明主机时,BombVault 会使用容器的默认网关,启动日志里会写出它。 |
LIBVIRT_SSH_PORT |
否 | 虚拟机和 ZFS 数据集备份所用的主机 SSH 端口(模板字段 Host SSH: Port,默认 22)。 |
LIBVIRT_SSH_USER |
否 | 虚拟机和 ZFS 数据集备份在主机上使用的 SSH 用户(模板字段 Host SSH: User,默认 root)。 |
LIBVIRT_URI |
否 | 完整的 libvirt 连接 URI,会被原样使用,而不是用上面三个 LIBVIRT_* 变量来拼出一个(这时它们对连接字符串不起作用)。默认不设置。在 TrueNAS Scale 上需要它,因为它的 libvirtd 监听的是一个非标准套接字,拼接的形式表达不了:qemu+ssh://<user>@<truenas-host>/system?socket=/run/truenas_libvirt/libvirt-sock。参见虚拟机备份指南。当它是 qemu+ssh:// URI 时,LIBVIRT_HOST、LIBVIRT_SSH_USER 和 LIBVIRT_SSH_PORT 中没有设置的,都会从它取值,BombVault 自己的 SSH 命令(NVRAM 传输、ZFS 数据集)也一样。 |
PORT |
否 | HTTP 端口(默认 3000。仅在 HTTP_ONLY=true 时使用)。 |
HTTPS_PORT |
否 | HTTPS 端口(默认 3443。模板以 1:1 发布它,所以网页界面在 https://<ip>:3443 应答)。 |
HTTP_ONLY |
否 | 设为 true 会关闭自签名的 HTTPS 监听,只提供纯 HTTP(用于终止 TLS 的反向代理后面)。 |
BIND_HOST |
否 | 网页界面监听的地址(默认 0.0.0.0,所有接口)。在容器里请保持不设置,因为发布的端口需要所有接口。127.0.0.1 适合在 Docker 之外运行。健康检查询问的也是同一个地址。 |
TRUSTED_PROXY |
否 | BombVault 前面的反向代理的地址或 CIDR 范围,用逗号分隔(例如 192.168.20.11 或 10.0.0.0/8)。只有来自这些跳点的 X-Forwarded-For 才会被采信,登录限流这时按真实客户端而不是把代理后面的所有人放进同一个桶里来统计失败次数。不设置(默认)则不信任任何人:无条件采信的头会让任何调用方自己选择桶。 |
HOST_SOURCE_ROOT |
否 | 挂载为 Host Data 的主机路径(默认 /mnt)。BombVault 会把 Docker 报告的绑定挂载源,转换为这个挂载之下的路径。只有在你挂载了不同的主机根目录时才需要更改。 |
HOST_MOUNT_ROOT |
否 | Host Data 在容器内挂载的位置(默认 /host/user)。在 TrueNAS 上,Host Data 挂载在它自己的主机路径上,所以这个变量和 HOST_SOURCE_ROOT 写的都是那个路径,例如 /mnt/tank(参见 TrueNAS SCALE)。 |
DATA_ROOT_SEGMENTS |
否 | 用逗号分隔的路径片段名称,用来把某个绑定挂载源标记为备份数据(默认 appdata,对应 Unraid 的 /mnt/user/appdata/<container> 约定)。当列出的任一片段作为完整路径片段出现在容器绑定挂载的主机源里,这个绑定挂载就会被自动选为备份。例如 DATA_ROOT_SEGMENTS=appdata,config 也会选中 .../config 绑定。匹配不区分大小写,所以默认值也涵盖 ZimaOS 的 /DATA/AppData/<container>。容器的数据文件夹还有其他始终开启的查找方式,参见备份源检测。 |
PLATFORM |
否 | 强制指定 BombVault 认为自己运行在哪个平台上,而不是自动检测:unraid、generic 或 truenas(默认不设置:通过探测闪存挂载下的 dockerMan 标记自动检测 Unraid,否则为 generic。无法识别的值也会回退到 generic,并记录日志)。在通用 Docker 主机或 TrueNAS Scale 上请显式设置,而不是依赖只针对 Unraid 的自动探测。通用的 compose 文件就是这样做的。它会改变 appdata 回退约定、跨实例恢复目标的默认值,以及是否尝试仅限 Unraid 的通知和配套插件步骤(参见 internal/platform)。 |
BOMBVAULT_SELF_CONTAINER |
否 | BombVault 容器自己的名称,这样它就不会备份(也就不会停止)自己。 |
BACKUP_MAX_HOURS |
否 | 单次备份运行占用其领域锁的最长挂钟小时数,超过就会被强制取消(一道保险,避免卡住的运行永远堵住领域)。留空(默认)使用 48。对于非常大或很慢的云备份请调高它(在上限处被取消的运行会以 context deadline exceeded 失败)。设为 0 则完全取消上限。清理也受同一个上限约束,而检查或清理只要 restic 持续报告进展就会一直运行。 |
BACKUP_STALL_HOURS |
否 | 备份完全没有进展多少小时之后会被取消。留空(默认)使用 2。设为 0 则永远不因停滞而取消。这是两道保险里更精细的一道,通常是它起作用:它看的是有没有事情还在发生,而不是运行用了多久,所以缓慢但健康的数 TB 备份不会被打扰,而卡在无响应共享上的备份会在几小时而不是几天内被停止。在任何东西被取消之前,30 分钟没有动静时会记录一条警告。扫描算作进展:restic 在遍历大目录树时不写入任何字节,这个阶段是通过文件和字节总数而不是写入的字节来监视的。这两个变量互相独立,而 BACKUP_MAX_HOURS 仍然约束备份本身之后的阶段(保留、统计、异地复制),那些阶段没有可监视的计数器。 |
DB_DUMP_MAX_HOURS |
否 | 一次自动数据库转储最多运行多少小时,超过就会被停止。留空(默认)使用 6。允许的值是 1 到 48,并且上限会比 BACKUP_MAX_HOURS 小一个小时(当后者不足两小时时取它的一半),这样长时间的转储是被自己的上限切断并如实报告,而不是把整个备份拖垮。没有进展的转储会更早停止,也就是在 BACKUP_STALL_HOURS 之后。被停止的转储会单独失败,容器备份继续进行。在 Unraid 上,用 Add another Path, Port, Variable 把它添加到 BombVault 容器。 |
TZ |
否 | 调度器的时区(例如 Europe/Berlin)。不设置的话,所有计划都按 UTC 运行:设为 02:30 的计划会在 UTC 的 02:30 触发,而不是你自己的墙上时间。在 Unraid 上你无需自己设置:系统会把自己的时区传给每个容器。启动日志会写出它解析成了哪个时区。有夏令时的时区会在春天跳过一次运行,在秋天运行两次,而 UTC 两者都没有,但每年会有两次与你的时钟相差一小时。 |
DATA_DIR |
否 | BombVault 存放数据库、密钥和缓存的位置(默认 /config)。在容器里请不要动它。在 Docker 之外运行二进制文件时它才有意义。 |
FLASH_DIR、FLASH_TEMPLATES_DIR |
否 | 闪存及其 Docker 模板在容器内的挂载位置(默认 /host/boot 和 /host/boot/config/plugins/dockerMan/templates-user)。它们跟随模板的 /boot 挂载,所以请保持不设置。 |
MODE |
否 | full(默认)运行完整的应用。node 运行一个节点:没有网页界面,也没有自己的计划,只做它的主实例吩咐的事。其他任何值都会让启动停止并给出提示。主实例会在节点的 compose 文件里替你填好。 |
NODE_HOME |
节点需要 | 节点属于哪个主实例,连同主实例的密钥和中继,合成一个以 bvhome1. 开头的值。主实例会把它写进节点的 compose 文件。没有它节点也能启动,但没有主实例能访问到它。已被某个主实例接收的节点,如果 NODE_HOME 指向另一个主实例,会拒绝启动,直到原来的主实例释放它。 |
NODE_NAME |
否 | 节点的名称,由主实例根据你起的名字填入。 |
挂载¶
按 CA 模板所示挂载 Docker 套接字、闪存(/boot)和 Host Data 根目录(/mnt)。备份的来源和目标都在 Host Data 之下,它以 slave 方式挂载,这样在容器启动之后才挂载的远程共享(例如在 /mnt/remotes 下)不用重启就能看到。
在 TrueNAS 上,Host Data 是数据集路径,例如 /mnt/tank,绝不是 ixVolume。应用放在 ixVolume 里的数据在它之外,不会被备份。参见 TrueNAS SCALE。
ZFS 数据集备份同样需要这种方式:主机只会在容器启动之后才挂载数据集的快照。参见 ZFS 数据集。
本地仓库默认放在 /mnt/user/bombvault/{container,vms,flash,config,files,zfs},在第一次备份时创建。它们是各分区的专属文件夹,构成本地存储位置。在目标下它自己的页面上,连接卡片可以更改每个分区的文件夹。
分区的专属文件夹也可以放在你已有的存储位置里,例如 NAS 或 S3 存储桶:该位置页面上的用作专属文件夹会把它搬到那里,并先说明已有的备份会怎样。参见分区的专属文件夹。
本地仓库文件夹的权限保持为 0755 和 0644,这样通过 SMB 的非 root 同步用户不会被挡在外面,而仓库是加密的,所以这不会暴露任何东西。恢复定义放在每个仓库内部,所以复制出来的文件夹本身就是完整的。自我备份的仓库仍然只有 root 可读。
主机集成检查
概览上的主机集成卡片(在自定义下添加)会探测每个挂载和命令行工具(Docker 套接字、libvirt、restic、qemu-img、rclone),并报告缺少的部分。
备份源检测¶
对每个容器,BombVault 会自动选出要备份的绑定挂载和命名卷。符合下列任一条件的路径都会被选中(你随时可以在容器设置标签页的备份文件夹卡片里覆盖结果):
- 数据根片段匹配: 绑定挂载的主机源包含某个
DATA_ROOT_SEGMENTS片段,作为完整的路径组成部分(默认只有appdata)。 - Docker 命名卷始终会被包含,因为它们没有可以丢弃的对应物,也没有什么需要过滤,但前提是卷的真实主机存储路径本身可以通过 Host Data 挂载访问到,和 BombVault 备份的任何其他主机路径一样。Docker 默认的 local 卷驱动把卷存放在守护进程自己的数据根目录下(
/var/lib/docker/volumes/<name>/_data,除非你自定义过。可用docker info -f '{{.DockerRootDir}}'检查),而通用的docker-compose.yml默认使用的、只覆盖单个目录的狭窄 Host Data 挂载并不涵盖它。无法访问的卷会被默默跳过,不是错误。要在通用主机上真正备份命名卷,请把 Host Data(和HOST_SOURCE_ROOT)指向一个同时涵盖 Docker 数据根目录的共同上级目录。compose 文件里的 Host Data 注释解释了其中的取舍(Unraid 出于同样的原因,通过挂载整个/mnt绕开了这个问题,那是它自己通用的顶层约定)。 - Docker Compose 项目目录: 如果容器带有标准的
com.docker.compose.project.working_dir标签(docker compose up会自动设置),那个目录也会被加入,不论是否有绑定挂载匹配了数据根片段。 bombvault.data标签覆盖: 在容器上设置标签bombvault.data=true,会包含它所有的绑定挂载,适用于上面两种约定都没有涵盖的布局(例如单个/srv/plex/config绑定,且没有 Compose 项目)。除false之外的任何非空值都算作真。没有标签或bombvault.data=false不会改变任何东西。bombvault.dbdump标签: 在容器上设置bombvault.dbdump=false会关闭它的自动数据库转储(0、no和off效果相同),也可以写出引擎名称(postgres、mysql、mariadb),来转储 BombVault 自己认不出的容器。这个标签优先于容器设置标签页上数据库卡片里的开关,在 Unraid 上应该用那张卡片来做。
安全模型¶
等同于主机 root 的控制权
通过 Docker 套接字,BombVault 可以停止、删除和重新创建容器,并读写 appdata。做虚拟机备份时,它会通过 SSH 登录主机(qemu+ssh://,默认 root)来运行 virsh。任何能访问它的网页界面的人,实际上都拥有主机的 root 权限。
登录¶
- 可选的密码保护(设置、安全下的密码卡片):设置密码即要求登录,清除即关闭。默认关闭,适合受信任的局域网使用。密码用 Argon2id 加上以
APP_KEY为密钥的 pepper 保存,所以复制出来的/config没有密钥就一文不值,有密钥也很难攻击。新密码至少需要 12 个字符。现有的较短密码在更改之前仍然有效。会话是签名的(由APP_KEY派生的 HMAC),更改密码会使它们失效。登录限制为每个客户端每分钟五次失败。更改或清除密码时会要求输入当前密码,开启两步验证时还要输入验证码。 - 有些事情需要密码。 下载恢复工具包、错误报告和闪存备份的 ZIP、导出闪存备份或自我备份、把密钥托管给密钥保管端、允许交出托管副本、生成新的取回码、导出带凭据的设置、两步验证、通行密钥、添加节点、再次显示节点的 compose 文件以及打开节点的条目,在设置登录密码之前都会被拒绝,并且需要在实例本身登录。删除备份不需要密码。设置了密码时,删除同样需要在实例本身登录。
- 存储位置不显示密码。 存储位置里可以带凭据,例如
rest:https://user:password@host/repo,而无论有没有登录密码,每个页面和每个 API 回答都把它显示为rest:https://[redacted]@host/repo。修改它后面的路径时,保存的密码会保留。要把存储位置指向另一台服务器,请连同密码输入完整的位置,因为隐藏的密码只属于它原来的服务器。 - 两步验证(设置、安全):在密码之外再加一个来自验证器应用的时间验证码,并在开启时一次性发放八个一次性恢复码。共享密钥用
APP_KEY加密保存,再次关闭这个因素需要当前的验证码。 - 通行密钥(WebAuthn)在设置密码之后放在它们自己的卡片上,与密码并存,绝不会取代它,所以移除所有通行密钥不会把任何人锁在外面。它们需要真实的域名和浏览器信任的证书。默认的
https://<ip>:3443恰好是 WebAuthn 所拒绝的,卡片会这样说明,而不是提供一个会失败的按钮。开启两步验证时,通行密钥必须校验你的 PIN、指纹或面容,否则登录时还会要求输入验证码。 - 配置恢复(应急向导里的恢复设置)会结束所有会话、移除所有通行密钥,并撤销所有 API 令牌和 MCP 密钥,因为恢复的设置可能会带回在保存之后已被移除的那些。请用密码登录,并在设置、安全下重新设置通行密钥。
- 忘记的密码在登录页面上重置。忘记密码?会让 BombVault 把一个 12 个字符、分成三组、每组四个的代码写进它的容器日志(在 Unraid 上:Docker 标签页,BombVault 图标,Logs)。这个代码加上新密码就能让你登录。重置还会关闭两步验证、移除所有通行密钥、撤销所有 API 令牌、MCP 密钥和 OAuth 登录、结束所有其他会话、让所有已配对的手机退出登录,并关闭手机配对。之后页面会列出哪些东西没有了。代码的有效期是 10 分钟,猜错不会消耗它。小组件和 metrics 令牌会保留,因为它们只能读取。
- 能读到容器日志的人就能重置密码。 这指的是主机上的 root,也包括 Dozzle 这样的日志查看器、任何获得了 Docker 套接字的容器(只读就够了),以及转发容器输出的日志转发器。只把这些交给你会信任其密码的人。只能访问网页界面的人永远看不到这个代码。
手机和组成员¶
- 已配对的手机只能访问一份允许清单。 知道组的十二个单词的手机,只要设置、安全下 Android 应用卡片里的允许手机用群组的十二个单词配对是开着的,就可以不用密码登录。它的会话只能访问应用展示的内容:概览、运行、可以查看的备份、启动和恢复、可以阅读的异常,以及可以查看的实例页面。存储位置和命令到达它时,地址和密钥都已去除,替换原件的恢复会先备份当前状态。恢复到文件夹时只接受还原文件夹里的新文件夹或空文件夹,手机也看不到其他任何文件夹的内容。其他一切都会回答需要在实例本身登录:密钥、恢复工具包、密钥托管、设置、删除备份。重置密码会关闭手机配对,直到你再次打开。从实例页面移除的手机,或在详情里关闭了查询此实例的手机,会立即失去会话,被移除的手机再次打开它的应用时,会以关闭状态回来。
- 离家在外时,手机通过中继打开页面。 页面的每个请求都用组的密钥封存(中继读不了也改不了),并用手机自己的密钥签名,服务器在手机第一次调用时把这把密钥固定下来,等有人在配对页面上批准这部手机后才放它进来。服务器只运行一次请求,而且只在请求还新的时候。它只回答实例页面上列出的手机,且只在手机配对开启时,也只用它交给那部手机的会话,所以全部退出登录和重置密码也会让这些页面结束。服务器会给每个回答签名,应用会用它为那台服务器固定的密钥核对签名,密钥变化时会发出警告。这样的页面访问的允许清单与已配对的手机相同,无论有没有登录密码,再加上页面最先读取的登录状态。登录和退出、密码重置以及下载仍然只能在服务器自己的地址上进行,一个回答的上限是 16 MB。
- 成员为自己的请求签名。 角色请求及其回答、存储提议、把 restic 密码交给接收端或拉取端、接收端登录以及密钥托管,都用每个成员自己的密钥签名,实例在第一次见到该成员时把这把密钥固定下来。用另一把密钥签名的调用会被拒绝。实例详情里的忘记密钥会丢弃固定的密钥,适用于这里已知的密钥并不是该成员自己的情况。成员在下一次签名调用时会被再次询问它的密钥。BombVault 9.x 上的成员不签名,任何有这些单词的人都可以冒充,和 9.9 一样。来自 10.4 或更早版本成员的角色请求或存储提议会被拒绝,直到该成员更新。
- 十二个单词就是密码。 任何拥有它们的人都能加入组,查看成员的保护状态,并请求角色,不过另一个实例上仍然需要有人同意。没有登录密码时,任何能打开网页界面的人都能读到它们,配对卡片会这样提示,直到设置了密码。
密钥¶
- APP_KEY 做两件事。 它封存这个安装保存的内容(密码、登录凭据、令牌),它也是备份的密钥:restic 密码由它派生,容器和虚拟机的定义也用它封存。
- 接管的密钥单独保存。 当应急向导接管另一台服务器的备份时,这个安装仍然用自己的 APP_KEY 封存,并把另一台服务器的密钥作为它的备份密钥保存,和其他所有密钥一样被封存。恢复工具包随后会打印两者。如果之后更改了 APP_KEY,备份密钥就无法再打开:BombVault 会停止备份,并在需要处理下说明,而不是用错误的密钥写入。请在恢复、紧急下再次上传恢复工具包,或把 APP_KEY 改回去。参见应急向导。
- 加密默认开启(设置、安全下加密卡片里的加密备份)。备份由 restic 用从备份密钥派生的密码加密。
- 密钥托管。 你组里的密钥保管端保存这台服务器的恢复工具包的一份封存副本,它自己无法打开。只有 20 个字符的取回码能打开它,而且保管端只有在那边有人点击允许之后才会交出。参见密钥保管端。
节点¶
节点是没有网页界面的 BombVault,它听从一个主实例的指令。
- 主实例掌控节点。 节点挂载它所在服务器的 Docker 套接字,这在那台服务器上就等于 root,而主实例控制着节点。如果主实例被攻破,攻击者也就控制了它的所有节点。请给主实例设置登录密码,并且不要把它的网页界面暴露在互联网上。
- 节点持有的东西很少。 如果某个节点被攻破,攻击者拿不到配对组、堡垒、其他节点或其他仓库。节点只有一条通往它的主实例的连接、接收服务器上一个属于它自己的登录,以及存储位置上一个属于它自己的文件夹。在接收服务器上它删不掉历史,因为服务器是 append-only 的。它能把服务器的磁盘写满,因为 rest-server 不设配额,所以请给接收服务器留足空间,或者给它一个单独的共享。在存储位置上,它的凭据通常可以删除那里的内容。保留在节点上的备份会落入攻击者手中,这正是主实例要拉取一份副本的原因。
- 连接是私有且签名的。 主实例和节点通过中继,用一条它们自己的连接通信,这条连接用从节点的
APP_KEY派生的密钥封存。双方在第一次调用之前就知道对方的密钥,所以没有批准步骤。主实例用自己的密钥和一个计数器为每次调用签名,节点会拒绝不是主实例签名的调用,或者它已经接收过的调用。节点只会向主实例发送它的问候,别的一概不调用。 - 主实例只能访问一份固定列表。 主实例转发给节点的请求只在节点路由的一份固定列表上运行,这份列表见
GET /api/nodes/routes,节点只用 JSON 应答。列表上没有任何删除操作,也没有任何能访问设置、存储、密钥、组或令牌的路由。在主实例上,它们需要用密码登录:已配对的手机、API 令牌和 MCP 密钥都访问不到节点。以这种方式启动的备份和还原显示为由主实例启动。 - 密钥托管带有节点的密钥。 主实例保存每个节点的
APP_KEY,恢复工具包会在节点章节里打印出来,所以密钥托管副本里也有它。拿到托管副本和取回码的密钥保管端可以打开你的节点的仓库,但无法指挥节点,因为那需要主实例的签名。 - 释放是永久的。 被释放的节点不能再用同一个
APP_KEY归属任何主实例。释放时不在线的节点,会在回来后从主实例得知此事。
网络¶
- 更改需要 JSON。 更改东西的请求必须发送
Content-Type: application/json,且不能被浏览器标记为跨站,所以另一个网站上的页面无法让你的浏览器去更改局域网地址上的设置。驱动 API 的脚本会发送这个头。其他一切都会以415拒绝。 - 因为这道门是可选的,不设置时,整个界面和 API(包括存储位置、防篡改测试路由和恢复路由)对任何能访问这个端口的人都是开放的。一旦用到异地、append-only 备份或加密,请设置登录密码。
- 请只在受信任、不对外暴露的网络上运行 BombVault。需要远程访问时,把它放在会增加认证和 TLS 的反向代理后面。响应带有基本的安全头(CSP、
nosniff、X-Frame-Options、Referrer-Policy)。 - 在反向代理后面,每个请求带的都是代理的地址,所以没有
TRUSTED_PROXY时,登录限流会把所有客户端算进同一个桶里,攻击者的失败也会把你锁在外面。请在TRUSTED_PROXY里写上代理,以恢复按客户端计数。 - BombVault 前面的反向代理必须把
Authorization或X-API-Key头透传到/mcp,并且不能缓冲它的响应,否则助手无法连接。参见 MCP 服务器。 - 在密钥存在或通过 OAuth 登录开启之前,MCP 端点
/mcp返回404,而且即使登录密码关闭,它也会向每个客户端要求密钥或令牌。没有任何豁免的地址,localhost也不例外。它没有恢复或删除工具,恢复配置备份会撤销所有密钥。参见 MCP 服务器。 - 使用
HTTP_ONLY=true时,会话 cookie 会失去Secure标志(这是在纯 HTTP 下工作所必需的),所以如果保密性重要,只在终止 TLS 的代理后面启用密码。 - 虚拟机备份的 SSH 连接在第一次连接时信任主机密钥(TOFU),之后就固定下来。如果容器到主机的路径不受信任,请通过其他渠道核对主机的密钥。
- 链接不会通向挂载点之外。 如果路径上方的某个链接通向主机挂载点之外,备份或原地恢复会停下并给出提示,因为一个写入自己共享的容器可能会放置这样的链接。主机或 rclone 远端以
-开头的存储位置也会同样被拒绝,在保存时和下次运行时都是如此,因为ssh或rclone会把它当成选项。
MCP 服务器¶
MCP 服务器不需要任何环境变量。你在设置、集成、MCP 服务器下创建一个密钥来开启它,它在和网页界面相同的端口上的 /mcp 应答(例如 https://192.168.1.10:3443/mcp)。没有有效的密钥时,这个路径返回 404。客户端、证书和限制见 MCP 服务器。
通过 SSH 的虚拟机备份¶
BombVault 备份 KVM/libvirt 虚拟机时不挂载任何 libvirt 路径。它通过 SSH(qemu+ssh://)在主机上运行 virsh,所以绝不会影响你主机上的虚拟机管理器。
在 Unraid 上,把主机的 libvirt 套接字挂载进容器很脆弱:虚拟机管理器拥有这些路径,切换"Enable VMs"可能让 libvirt 无法启动。SSH 密钥授予的是主机上的 root,和 BombVault 已在使用的 Docker 套接字是同一级别的信任。
快速设置:
- 设置、集成、主机 SSH: 复制显示的公钥。
- 把它追加到 Unraid 的
/root/.ssh/authorized_keys(同时保存到闪存,以便重启后仍然存在)。 - 点击测试连接。
模板会加上 --add-host=host.docker.internal:host-gateway,让容器可以访问主机。如果这个名称无法解析(例如容器运行在自定义的 br0.x 网络上),请把 LIBVIRT_HOST 设为你 Unraid 的局域网 IP。如果你更改过 Unraid 的 SSH 端口,请把 LIBVIRT_SSH_PORT 设成一致。实时快照还需要虚拟机里有 qemu guest agent,并且磁盘在 /mnt/cache 上(不是 /mnt/user)。
完整的虚拟机设置和网络指南
完整的分步指南(启用 SSH、持久的密钥授权、自定义网络和 VLAN 路由、每台虚拟机的方式以及主机端故障排除)见虚拟机备份指南。
异地设置¶
异地副本发往存储位置。从它的设置磁贴(或固定到侧边栏)打开目标,选择添加目标。完整的流程(防删除保护、防篡改测试和 DR 演练)见异地与恢复。简言之:
- 后端: 无需主机挂载、通过 rclone 的 SMB/CIFS 和 WebDAV,NFS(在主机上挂载导出,并把它当作本地文件夹使用),不需要 rclone 的原生 restic 后端(
s3:...、rest:http://host:8000/repo、sftp:user@host:/repo),或任何 rclone 远端(rclone:<remote>:<bucket>/path)。Backblaze B2 在这里没有原生后端:请通过它的 S3 端点(s3:https://s3.<region>.backblazeb2.com/<bucket>/<path>)访问,把密钥 ID 和应用密钥作为 S3 凭据。 - 登录凭据加密保存,作为设置、目标下凭据卡片里已保存凭据的一个列表。星标标出默认项,在没有选择凭据的地方使用。位置自己的页面在它的凭据卡片里选择它所用的那个。参见登录凭据。
- SSH 目标在对方不需要安装任何东西。
sftp:只需要一个 SSH 服务器。把设置、集成、主机 SSH 里的公钥(也在/config/ssh/id_ed25519.pub)添加到目标用户的~/.ssh/authorized_keys,或者在添加目标里用添加密钥,凭账户的密码把它放进去。 - 使用自签名证书的 rest-server: 把它的证书,或签发它的机构的证书,作为 PEM 文件放进 BombVault 数据文件夹的
certs文件夹(容器里是/config/certs,Unraid 上是appdata/bombvault/certs)。备份、复制和防删除保护测试无需重启就会信任它。 - 异地副本: BombVault 在(通常是本地的)主仓库之上,尽力用
restic copy复制新的快照。位置的复制卡片设置它是在每次备份后复制,还是按自己的计划复制,设置、计划、按分区的异地副本则给某个分区单独的复制计划。立即复制在设置、目标下异地副本卡片里该分区的那一行。 - 每个分区多个存储位置: 目标页面上的按分区划分的目标卡片,一键就能开关从分区到位置的每一行,包括本地。只有异地位置的分区直接备份到它们,每一行都关闭的分区则不会被备份。位置的按分区划分的规则可以给某个分区在那里使用自己的仓库、保留或压缩。
- 按条目放置: 每个容器、虚拟机和文件夹集,在它设置标签页的计划和目标卡片里,点亮本地和接收其备份的位置。没有自己选择的条目跟随它们的分区。参见按条目放置。
- 保留: 每个存储位置按它的保留多久卡片保留备份,分区可以在按分区划分的规则下保留自己的值。这包括分区异地字段里的副本。全部为零则绝不修剪位置的快照。
- 带宽限制: 在设置、目标下的异地带宽卡片里限制 restic 的上传和下载速率,或在位置的复制卡片里按位置限制。你输入 KiB/s,字段会同时显示以 MB/s 和 Mbit/s 表示的同一速率。
- 串流优先: 在目标页面的串流卡片里,选择媒体服务器(Plex、Jellyfin 和 Emby 按镜像名称预先选中)、发送速率达到多少算作串流、串流期间的上传限制,以及串流结束后多久恢复正常限制。
- 冷存储和归档存储类别(S3): 对于 S3 存储位置,在它的页面上选择可恢复读取的层级(Standard、Standard-IA、One Zone-IA、Intelligent-Tiering、Glacier Instant Retrieval)。rclone 远端在 rclone 配置里设置它们的类别。
- 专属文件夹放在存储位置里而不是本地: 分区的专属文件夹可以放在上面的某个存储位置里,没有本地副本,也没有复制步骤。参见分区的专属文件夹。
异常¶
异常检测不需要任何环境变量。它在设置、验证下的异常卡片里设置,说明见异常。
可携带的设置(导出和导入)¶
设置、系统下的导出 / 导入设置卡片会把你的整个 BombVault 配置(分区设置、存储位置、计划、保留、通知)写成一个可携带的 JSON 文件,你可以在另一个实例上导入,所以搬到新机器或克隆一套设置不必再手动重新输入所有内容。导入会先显示预览并要求确认,而且绝不会碰你的备份数据或历史。文件中指向已不存在的存储位置或仓库的链接会被略去,预览会点名它们。ZFS 副本运行期间,导入会在写入任何东西之前被拒绝。
导出可能包含凭据
你可以选择是否把异地、通知和 MQTT 代理的凭据放进文件。包含凭据时,导出的敏感程度和你的恢复工具包一样,所以请存放在安全的地方。不包含时,文件里只有非机密的设置。
APP_KEY 不会随文件一起迁移
仓库用一个由 APP_KEY 派生的密码锁定,而文件里不含这个密钥。如果是有计划的迁移,请在新机器的模板里填入旧的 APP_KEY,或者在紧急下用恢复工具包接管这个密钥。换成另一个密钥时,仓库会回答密码错误。什么都没有丢失,设置正确的密钥后就能再次打开它们。