mlapaglia/borgitory

Borgitory

Borgitory是一个全面的基于Web的BorgBackup仓库管理界面，提供实时监控、自动调度和云同步功能。它支持完整的备份生命周期管理，包括按需备份、自动修剪策略、带文件下载功能的交互式归档浏览，以及通过Rclone与S3兼容存储的云同步。该系统由FastAPI驱动，采用HTMX和Tailwind CSS构建现代响应式Web界面。

核心功能与特性

• Web管理界面：直观的响应式界面，便于管理BorgBackup仓库
• 实时监控：实时跟踪备份任务状态和仓库健康状况
• 自动调度：配置定时备份任务，支持灵活的时间策略
• 备份生命周期管理：实现备份创建、修剪、删除的全流程管理
• 交互式归档浏览：挂载Borg归档并通过Web界面浏览、下载文件
• 云同步：通过Rclone与S3兼容存储服务同步备份数据
• 安全存储：数据库和加密密钥集中管理，确保数据安全

使用场景与适用范围

• 个人或企业级BorgBackup仓库集中管理
• 需要自动化备份和定期修剪的场景
• 多设备、多地点备份任务的统一监控
• 需要通过Web界面便捷访问和下载归档文件的场景
• 需将本地Borg仓库同步至云存储的备份策略实施

使用方法与配置说明

前提条件

• Docker部署（推荐）：安装Docker及Docker Compose
• PyPI部署：Python 3.14+环境（非Docker方式）

Docker安装（推荐）

直接使用Docker命令

bash
docker run -d \
  -p 8000:8000 \
  -v ./data:/app/data \
  -v /path/to/backup/sources:/backup/sources:ro \
  -v /path/to/borg/repos:/repos \
  --cap-add SYS_ADMIN \
  --device /dev/fuse \
  --name borgitory \
  mlapaglia/borgitory:latest

使用Docker Compose

创建docker-compose.yml文件：

yaml
version: '3.8'
services:
  borgitory:
    image: mlapaglia/borgitory:latest
    ports:
      - "8000:8000"
    volumes:
      - ./data:/app/data  # 数据库和加密密钥存储位置
      - /path/to/backup/sources:/sources:ro  # 备份源目录（只读）
      - /path/to/any/backup/repos:/repos:ro  # Borg仓库目录（只读）
    cap_add:
      - SYS_ADMIN  # 可选，用于挂载Borg归档进行浏览
    devices:
      - /dev/fuse  # Borg使用FUSE挂载归档
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

访问Web界面

1. 打开浏览器访问 http://localhost:8000
2. 首次使用时创建管理员账户

配置说明

• 卷挂载：

  • /app/data：存储数据库和加密密钥，需持久化
  • /backup/sources：备份源文件目录，建议设为只读（:ro）
  • /repos：Borg仓库存储目录，建议设为只读（:ro）

• 系统权限：

  • --cap-add SYS_ADMIN：允许挂载Borg归档（浏览功能需要）
  • --device /dev/fuse：提供FUSE设备支持，用于归档挂载

PyPI安装（非Docker方式）

bash
# 从PyPI安装稳定版
pip install borgitory

# 启动服务器
borgitory serve

# 自定义配置启动
borgitory serve --host 0.0.0.0 --port 8000

PyPI安装要求：

• Python 3.14或更高版本
• BorgBackup已安装并添加到PATH
• Rclone（可选，用于云同步功能）
• FUSE（可选，用于归档浏览）

Windows系统要求：

• 必须安装并配置WSL2
• 在WSL2内需安装：
  • BorgBackup（如 sudo apt install borgbackup）
  • Python 3.14+
  • Rclone（可选）
• 由于BorgBackup无原生Windows可执行文件，所有备份操作需在WSL2中进行