borgwarehouse/borgwarehouse

BorgWarehouse Docker镜像文档

概述

BorgWarehouse是一个图形化界面，用于管理BorgBackup中央仓库服务器。它解决了传统命令行管理方式的复杂性，自动处理用户创建、SSH密钥关联、配额分配等系统管理任务，提供直观的可视化界面，简化仓库的添加、编辑、删除等日常操作，并提供备份状态监控和数据量管理功能。

核心功能

• 仓库管理：支持添加、编辑和删除BorgBackup仓库
• 状态监控：实时监控备份状态，当备份不及时时发送警报
• 数据管理：跟踪各仓库的数据量使用情况
• 配额控制：为每个仓库灵活配置存储配额
• 自动化运维：自动处理用户创建、SSH密钥关联等系统级任务，无需手动操作终端

使用场景

• 系统管理员需要集中管理多个BorgBackup客户端备份
• 团队需要简化BorgBackup仓库的日常维护流程
• 需为不同项目或用户分配独立备份空间并控制配额
• 希望通过可视化界面替代命令行操作，提高管理效率

使用方法

Docker部署

BorgWarehouse提供Docker镜像，可快速部署。详细部署指南请参考官方Docker安装文档。

基本启动命令示例

bash
docker run -d \
  --name borgwarehouse \
  -p 3000:3000 \
  -v /path/to/local/data:/data \
  -v /path/to/ssh/keys:/etc/ssh \
  --env-file .env \
  docker.xuanyuan.run/borgwarehouse/borgwarehouse:latest

Docker Compose配置示例

yaml
version: '3'
services:
  borgwarehouse:
    image: docker.xuanyuan.run/borgwarehouse/borgwarehouse:latest
    container_name: borgwarehouse
    ports:
      - "3000:3000"
    volumes:
      - ./data:/data
      - ./ssh:/etc/ssh
    env_file:
      - .env
    restart: unless-stopped

环境变量配置

运行容器前需配置必要的环境变量，完整列表请参考官方环境变量文档。常用环境变量包括：

• TZ：容器时区设置（如Asia/Shanghai）
• DATABASE_URL：数据库连接字符串（支持SQLite、PostgreSQL等）
• APP_URL：应用访问URL（用于生成正确的链接）
• SSH_PORT：SSH服务端口（默认22）

访问与初始化

容器启动后，通过浏览器访问http://<服务器IP>:3000进入Web界面。首次登录使用默认管理员账户（具体凭据请参考官方文档），建议立即修改密码并配置SMTP服务器以启用警报功能。

注意事项

• 确保挂载的本地目录（如/data和/ssh）具有正确的权限，避免容器内权限错误
• 定期备份/data目录中的数据，防止配置和仓库信息丢失
• 根据实际需求调整资源限制（CPU、内存），特别是在管理大量仓库时
• 生产环境中建议配置HTTPS以保障数据传输安全