ainullcode/borg-ui

Borg Web UI

https://github.com/karanhudia/borg-ui/workflows/Build%20and%20Publish%20Docker%20Images/badge.svg](https://github.com/karanhudia/borg-ui/actions) https://github.com/karanhudia/borg-ui/workflows/Tests/badge.svg](https://github.com/karanhudia/borg-ui/actions/workflows/tests.yml) ![codecov]([***]

Borg Backup的现代Web界面。零配置部署，即开即用。

https://karanhudia.github.io/borg-ui | https://hub.docker.com/r/ainullcode/borg-ui

---

[!NOTE] 本项目使用Claude Code作为开发助手。我是一名拥有10年以上经验的全栈开发者，会在合并前亲自审核所有AI生成的代码。架构决策、安全实践和测试均由人工主导。Claude Code在git提交中被列为合著者。所有代码均开源供社区审查——您的备份值得仔细审查，我鼓励社区参与。

---

截图

---

核心功能

• 备份管理 - 创建、调度和监控备份，支持实时进度跟踪
• 归档浏览器 - 浏览并从任何备份归档中恢复文件
• 仓库管理 - 支持本地、SSH和SFTP仓库，提供多种压缩选项
• 任务调度 - 可视化Cron任务构建器，带执行历史记录
• 备份前后钩子 - 备份前后运行自定义脚本（如停止Docker容器、数据库转储）
• 通知功能 - 通过100+服务（电子邮件、Slack、、、Pushover等）获取备份失败和完成的警报
• SSH密钥管理 - 生成、导入和部署用于远程仓库的SSH密钥
• 实时监控 - 备份实时进度、系统指标和健康检查
• 多平台支持 - 支持amd64、arm64和armv7架构

---

快速开始

Docker Compose（推荐）

创建docker-compose.yml：

yaml
version: '3.8'

services:
  borg-ui:
    image: ainullcode/borg-ui:latest
    container_name: borg-web-ui
    restart: unless-stopped
    ports:
      - "8081:8081"
    volumes:
      - borg_data:/data
      - borg_cache:/home/borg/.cache/borg
      # 挂载你想要备份的目录（替换为实际路径）
      - /home/yourusername:/local:rw           # 替换为你的目录路径
      # - /mnt/data:/local/data:rw             # 根据需要添加更多目录
    environment:
      - TZ=America/Chicago  # 设置你的时区
      - PUID=1000
      - PGID=1000

volumes:
  borg_data:
  borg_cache:

⚠️ 安全注意事项： 将/home/yourusername替换为实际目录路径。只挂载你想要备份的目录。详见https://karanhudia.github.io/borg-ui/configuration%E8%8E%B7%E5%8F%96%E6%9B%B4%E5%A4%9A%E7%A4%BA%E4%BE%8B%E5%92%8C%E5%AE%89%E5%85%A8%E6%9C%80%E4%BD%B3%E5%AE%9E%E8%B7%B5%E3%80%82

启动容器：

bash
docker compose up -d

访问http://localhost:8081

默认凭据： admin / admin123（首次登录时会提示修改）

Docker Run

bash
docker volume create borg_data
docker volume create borg_cache

docker run -d \
  --name borg-web-ui \
  --restart unless-stopped \
  -p 8081:8081 \
  -e TZ=America/Chicago \
  -e PUID=1000 \
  -e PGID=1000 \
  -v borg_data:/data \
  -v borg_cache:/home/borg/.cache/borg \
  -v /home/yourusername:/local:rw \
  ainullcode/borg-ui:latest

注意：

• 将/home/yourusername替换为实际目录路径（如/home/john、/Users/sarah、/mnt/data）
• 将1000替换为你的用户/组ID。可通过id -u && id -g命令查看
• 添加更多-v参数挂载需要备份的其他目录
• 详见https://karanhudia.github.io/borg-ui/configuration%E8%8E%B7%E5%8F%96%E5%AE%89%E5%85%A8%E6%9C%80%E4%BD%B3%E5%AE%9E%E8%B7%B5

---

文档

https://karanhudia.github.io/borg-ui - 完整指南和教程

• https://karanhudia.github.io/borg-ui/installation - 所有平台的详细安装说明
• https://karanhudia.github.io/borg-ui/configuration - 环境变量和设置选项
• Docker容器钩子 - 备份期间停止/启动Docker容器
• https://karanhudia.github.io/borg-ui/notifications - 配置电子邮件、Slack、***等警报
• https://karanhudia.github.io/borg-ui/ssh-keys - 设置远程备份的SSH
• https://karanhudia.github.io/borg-ui/security - 最佳实践和安全建议
• API文档 - 交互式API文档（安装后访问）

---

配置说明

首次运行自动配置

• SECRET_KEY - 随机生成并持久化存储
• 数据库 - SQLite数据库位于/data/borg_web_ui.db
• SSH密钥 - 存储在/data/ssh_keys

可选环境变量

---

数据持久化

使用两个卷存储持久化数据：

• borg_data - 应用数据、数据库、SSH密钥、日志
• borg_cache - Borg仓库缓存，提升性能

备份源目录挂载

⚠️ 重要安全考虑：

容器需要访问你想要备份的目录。不要挂载整个文件系统（/:/local:rw），只挂载需要备份的特定目录：

yaml
volumes:
  # ✅ 推荐：挂载特定目录
  - /home/yourusername:/local:rw       # 替换为你的路径
  - /mnt/data:/local/data:rw           # 按需添加更多目录

  # ❌ 不推荐：完整文件系统访问
  # - /:/local:rw  # 安全风险 - 除非必要，否则避免使用

最佳实践：

• 只挂载包含需备份数据的目录
• 对于仅备份的目录，使用只读权限（:ro）
• 如需备份多个目录，添加多个-v参数而非挂载根目录
• 详见https://karanhudia.github.io/borg-ui/configuration/%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E7%A4%BA%E4%BE%8B

---

支持资源

• https://karanhudia.github.io/borg-ui - 详细指南和教程
• 问题报告 - https://github.com/karanhudia/borg-ui/issues
• 讨论交流 - https://github.com/karanhudia/borg-ui/discussions

---

开发指南

供希望贡献代码的开发者：

bash
git clone https://github.com/karanhudia/borg-ui.git
cd borg-ui
docker compose up -d --build

详见CONTRIBUTING.md获取贡献指南。

---

许可证

本项目采用GNU通用公共许可证v3.0授权 - 详见LICENSE文件。

---

基于Borg Backup、FastAPI、React和Material-UI构建

由https://github.com/karanhudia%E5%BC%80%E5%8F%91