aterfax/pbs-client

Proxmox Backup Server Client - Docker化镜像文档

镜像概述和主要用途

本镜像为Docker化的Proxmox Backup Server (PBS)客户端，提供轻量级容器环境用于运行PBS客户端工具。通过将需要备份的数据目录挂载到容器内/backups路径，可实现对任意目录的备份。支持自动生成或用户提供的加密密钥，支持基于cron的定时备份或手动触发备份，并包含辅助脚本以简化操作流程。推荐通过Docker Hub镜像直接使用或本地构建，配置通过.env文件管理，首次运行时需查看日志以安全保存自动生成的密钥和密码。

核心功能和特性

• 轻量级设计：容器体积小，资源占用低，适合各类环境部署
• 目录备份支持：可备份所有挂载到容器/backups目录的外部数据
• 加密保护：默认启用并强烈推荐备份加密，支持自动生成密钥或用户提供自定义密钥
• 灵活备份触发：支持基于cron的定时自动备份或手动触发备份
• 辅助脚本：内置便捷辅助脚本，简化备份配置和管理流程
• 密钥管理：支持自动生成加密密钥（需妥善保存）或导入用户预定义密钥

使用场景和适用范围

• 服务器数据备份：适用于需要通过PBS服务端集中管理备份的服务器环境
• 个人/团队数据备份：适合个人用户或小型团队对重要数据进行加密备份
• 自动化备份需求：需定时自动执行备份任务的场景
• 加密备份需求：对数据安全性有要求，需要加密存储备份的场景
• 简化PBS客户端部署：希望避免直接在主机安装PBS客户端依赖，通过容器化方式快速部署的场景

使用方法和配置说明

获取镜像

• Docker Hub镜像（推荐）：直接拉取官方镜像

  bash
  docker pull docker.xuanyuan.run/aterfax/pbs-client:latest
  

• 本地构建：从GitHub仓库克隆源码后构建

  bash
  git clone https://github.com/Aterfax/pbs-client-docker.git
  cd pbs-client-docker
  docker build -t pbs-client:local .
  

基本运行配置

1. 准备数据目录：将要备份的数据目录准备好，例如/path/to/your/data
2. 创建环境变量配置文件（.env）：根据需求配置PBS服务端地址、仓库名称、认证信息等，具体配置项参考GitHub仓库示例
3. 运行容器：挂载数据目录到/backups，并挂载环境变量文件

   bash
   docker run -d \
     --name pbs-client \
     --env-file .env \
     -v /path/to/your/data:/backups \
     docker.xuanyuan.run/aterfax/pbs-client:latest
   

关键注意事项

• 首次运行日志：容器首次启动时会生成加密密钥（若未提供），需通过docker logs pbs-client查看并安全保存生成的密钥和密码，丢失将导致备份无法恢复
• 加密配置：默认启用加密，若需使用自定义密钥，需在.env中配置相关密钥路径并挂载到容器内
• 定时备份：通过配置.env中的cron表达式实现定时备份，例如CRON_SCHEDULE="0 3 * * *"表示每日凌晨3点执行备份

参考资源

• 配置示例、故障排除及辅助脚本说明详见GitHub仓库：https://github.com/Aterfax/pbs-client-docker