backup-x

镜像概述和主要用途

带Web界面的数据库/文件备份增强工具，通过执行自定义shell命令输出文件实现备份，支持文件、MySQL、PostgreSQL等多种数据类型。提供Web界面管理备份任务，支持周期设置、多项目备份、对象存储、备份文件自动清理及webhook通知，确保数据安全。

核心功能和特性

• 支持自定义命令，灵活适配各种备份需求
• 通过执行shell命令输出文件实现备份，理论上支持所有数据库和文件备份
• 灵活的备份周期设置，从几分钟到一年均可配置
• 支持多项目备份，最多16个项目
• 备份文件可另存至对象存储，防止数据丢失
• 可设置备份文件最大保存天数，自动清理过期文件
• 支持webhook通知，备份结果实时推送
• 加密关键信息（v1.3.0+版本新增）

使用场景和适用范围

适用于需要定期备份数据库或文件的场景，如服务器数据备份、多项目数据管理、需要远程存储备份文件的个人或企业用户，尤其适合缺乏复杂备份系统但需要可靠数据保护的环境。

详细使用方法和配置说明

Docker中使用

1. 运行Docker容器（/opt/backup-x-files可替换为主机实际目录，用于存储备份文件）：

   bash
   docker run -d --name backup-x --restart=always \
     -p 9977:9977 \
     -v /opt/backup-x-files:/app/backup-x-files \
     jeessy/backup-x
   

   • 参数说明：
     • -p 9977:9977：映射容器端口9977到主机，用于Web界面访问
     • -v /opt/backup-x-files:/app/backup-x-files：挂载主机目录到容器内备份文件存储路径，确保备份文件持久化
     • --restart=always：容器退出后自动重启，保证服务持续运行

2. 登录Web界面配置：访问[***]，通过Web界面配置备份任务

3. 容器预装工具：默认安装default-mysql-client和postgres-client，方便直接执行MySQL和PostgreSQL备份命令

备份脚本参考

PostgreSQL

MySQL/MariaDB

文件备份

Webhook通知配置

支持备份结果通过webhook推送，备份成功或失败时回调指定URL，支持GET/POST请求（RequestBody为空时为GET，否则为POST）。

支持的变量

配置示例

• Server酱：
  [***][SCKEY].send?text=#{projectName}项目备份#{result},文件名:#{fileName},文件大小:#{fileSize}

• Bark：
  [***][YOUR_KEY]/#{projectName}项目备份#{result},文件名:#{fileName},文件大小:#{fileSize}

• 钉钉：

  1. 钉钉电脑端→群设置→智能群助手→添加机器人→自定义
  2. 勾选“自定义关键词”，输入关键词（如“项目备份”，需包含在请求内容中）
  3. URL填写钉钉提供的Webhook地址
  4. RequestBody填写：
     {"msgtype": "text","text": {"content": "#{projectName}项目备份#{result},文件名:#{fileName},文件大小:#{fileSize}"}}

说明

该工具从backup-db发展而来，因支持范围扩展至所有文件备份，故更名为backup-x，旨在提供全面的数据备份解决方案。