Backrest 适用于家庭与 NAS 的备份方案

概述#

Backrest 是一个基于 restic 构建的、可通过 Web 访问的备份解决方案。Backrest 提供了一个 Web UI，该 Web UI 封装了 restic 命令行界面，可以轻松创建仓库、浏览快照和恢复文件。此外，Backrest 可以在后台运行，并采用有主见的策略来调度快照和编排仓库健康操作。

通过在 restic 之上构建，Backrest 利用了其成熟、快速、可靠和安全的备份功能，同时增加了一个直观的界面。

主要特性#

• Web 界面：本地或远程访问（非常适合 NAS 部署）
• 多平台支持：
  • Linux
  • macOS
  • Windows
  • FreeBSD
  • Docker
• 备份管理：
  • 导入现有 restic 仓库
  • Cron 定时备份和维护（例如 prune、check、forget 等）
  • 浏览和恢复快照中的文件
  • 可配置通知（Discord、Slack、Shoutrrr、Gotify、Healthchecks）
  • 备份前/后命令钩子，用于执行 shell 脚本
• 存储选项：
  • 兼容 rclone 远程
  • 支持所有 restic 存储后端（S3、B2、Azure、GCS、本地、SFTP 以及 所有 rclone 远程）

安装 Backrest#

1
version: "3.8"
2
services:
3
  backrest:
4
    image: garethgeorge/backrest:latest
5
    container_name: backrest
6
    hostname: backrest
7
    volumes:
8
      - ./backrest/data:/data
9
      - ./backrest/config:/config
10
      - ./backrest/cache:/cache
11
      - ./backrest/tmp:/tmp
12
      - ./backrest/rclone:/root/.config/rclone # 使用 rclone 挂载网盘时配置此项
13
    # - /boot/config/plugins/rclone/.rclone.conf:/root/.config/rclone # Unraid 使用此 rclone 路径
14
      - /path/to/backup/data:/userdata  # 备份路径
15
      - /path/to/local/repos:/repos     # repos 路径
16
    environment:
17
      - BACKREST_DATA=/data
18
      - BACKREST_CONFIG=/config/config.json
19
      - XDG_CACHE_HOME=/cache
20
      - TMPDIR=/tmp
21
      - TZ=Asia/Shanghai
22
    ports:
23
      - "9898:9898"
24
    restart: unless-stopped

配置 Backrest#

• 第一次打开需要创建账户和密码；如果在纯内网环境使用，可跳过对外访问相关配置。
• 在 Plans 中可以添加备份计划，在 Repositories 中可以添加备份仓库。

概述#

OpenList 是一个由 OpenList 团队维护的、社区驱动的 AList 分支，旨在通过其韧性和长期治理来保护开源项目免受基于信任的攻击。该项目在 AGPL-3.0 许可下开源，所有代码和服务均在 GitHub 上免费提供，且目前没有付费计划或商业部署。

安装 OpenList#

1
services:
2
  openlist:
3
    restart: always
4
    volumes:
5
      - '/etc/openlist:/opt/openlist/data'
6
    ports:
7
      - '5244:5244'
8
      - '5245:5245'
9
    environment:
10
      - PUID=0
11
      - PGID=0
12
      - UMASK=022
13
      - TZ=UTC
14
    container_name: openlist
15
    image: 'openlistteam/openlist:latest'

通过 OpenList 挂载网盘为 S3#

此功能是将 OpenList 映射为 S3 协议，可以使用 S3 客户端进行访问与查看，就像 OpenList 可以映射为 WebDAV 一样。

• 可以是整个 OpenList（根目录），也可以是单独某个文件夹

1. 如果是第一次使用，先打开 OpenList 后台生成一下 访问客户端 ID 和 访问密钥 保存，然后停止 OpenList，打开配置文件启用 S3 服务

   如果你后续更新访问 ID 和密钥，更新保存，再重启 OpenList 才可以生效

2. 打开 配置文件，将 enable 字段改成 true 启用 S3 服务

1
  "s3": {
2
    "enable": true,
3
    "port": 5246,
4
    "ssl": false
5
  }

3. 前两步操作完成后启动 OpenList，进入后台 S3 配置页面，选择希望映射为对象存储桶的路径

   • 左侧是对外显示的存储桶名字，右侧是 OpenList 已有的列表目录路径，如果想将整个根目录全部映射出去可以选择列表中的 root 路径
   • 手动填写可能会出现错误，建议使用右侧 选择 按钮进行选择

OpenList S3 文档

配置 Backrest#

概述#

当目标网盘不直接支持 S3（如 OneDrive、Google Drive、阿里云盘等）时，可以通过 rclone 作为 restic 的后端：在 Backrest 中把仓库地址写成 rclone:<远程名>:<路径> 即可。

准备 rclone 配置#

• 在任意主机上执行 rclone config 创建远程（以远程名 cloud 为例）。
• 运行 rclone config file 可查看 rclone.conf 的实际路径，然后将该文件复制到宿主机 ./backrest/rclone/ 目录。
• 确保文件名为 rclone.conf，容器内会通过卷挂载到 /root/.config/rclone/rclone.conf。
• 可选：如需自定义路径，可在服务中添加环境变量 RCLONE_CONFIG=/root/.config/rclone/rclone.conf。

在 Backrest 中配置 Repositories#

TIP

• RCLONE_BW_LIMIT：限速，支持如 8M、8000k。
• RCLONE_TRANSFERS/RCLONE_CHECKERS：并发传输与校验线程，带宽与远端限流允许时可适当提高。
• RCLONE_FAST_LIST：对部分网盘显著降低列目录开销。

在 Backrest 中配置 Plans#

TIP

• 建议在计划中设置 Cron 表达式，避开业务高峰时段（如每日 03:00）。
• restic ≥ 0.16 可加 --compression auto 在多数远端取得更优的体积/速度平衡。

可选：排除规则（exclude）#

在 ./backrest/config/ 下新建 exclude.txt，并在 Plan 的 Backup Flags 中引用 --exclude-file /config/exclude.txt。

1
# 常见临时/缓存目录
2
**/.cache/**
3
**/node_modules/**
4
**/.venv/**
5
**/venv/**
6
**/.git/**
7
**/.DS_Store
8
**/Thumbs.db
9
**/@eaDir/**
10
**/@Recycle/**
11
**/Downloads/**
12
**/tmp/**

TIP

也可在 Backup Flags 直接使用多次 --exclude 指定路径/通配符。

恢复与校验#

• 恢复：在 Backrest Web UI 的 Snapshots 中选择快照 → Browse → Restore。
  • 目标目录必须是容器可写目录（如挂载的 /userdata/restore）。
  • 可按需添加恢复参数（如 --target、--include/--exclude）。
• 校验：在 Repositories → Maintenance 中添加 check 任务，建议每周执行一次。
  • Check Flags 可用 --read-data-subset=3% 在速度与信心之间取得平衡。

维护与保留策略#

• 忘记策略（forget）：建议按以下之一配置（任选其一，放入 Forget Flags）：
  • --keep-daily 7 --keep-weekly 4 --keep-monthly 12
  • 或 --keep-last 30
• 数据瘦身（prune）：在维护任务中勾选/添加 prune，定期清理未引用数据。
• 一般调度建议：
  • 备份：每日 03:00
  • check：每周日 02:00（带 --read-data-subset=3%）
  • forget + prune：每月 04:00

Windows 与权限注意事项#

• Windows + Docker Desktop：卷路径示例 C:/Backups:/userdata（注意使用绝对盘符）。
• 确保 Docker 对对应盘符开启文件共享；路径含空格时请使用引号。
• 若出现权限不足（Permission denied）：
  • 确认宿主目录具备写入权限并已挂载到容器。
  • 在 NAS 上可确保目录属主与容器用户匹配，或放宽权限后再试。

常见问题（FAQ）#

• 初始化仓库失败或超时：
  • 检查远端凭据/网络连通；若是 S3，确认时钟同步避免 RequestTimeTooSkewed。
  • rclone 后端检查 rclone.conf 的远程名是否与 URI 一致。
• repository is locked：在 Maintenance 中执行 unlock，或稍后重试。
• 恢复失败（目标不可写）：确保恢复到挂载进容器的目录，如 /userdata/restore。
• 速度慢：
  • 适当提高 RCLONE_TRANSFERS/RCLONE_CHECKERS，或在高延迟环境使用较大的 --pack-size（64 或 128）。
  • 对带宽紧张时设置 --limit-upload/--limit-download 或 RCLONE_BW_LIMIT。

参考#

• Backrest 项目主页
• restic 文档
• rclone 文档与环境变量