bsaqqa / backfire

是PHP的备份数据库命令行工具

1.0.0 2023-01-10 14:54 UTC

This package is auto-updated.

Last update: 2024-09-10 21:11:14 UTC


README

PHP CLI For Auto Backup DB.

您可以在Windows/Ubuntu服务器上将其作为cron作业运行,以每天备份您的数据库。

功能

  • 易于安装和配置
  • 可以在Windows和Ubuntu服务器上作为cron作业运行
  • 将其作为composer包创建
  • 支持多个数据库服务器(多连接)
  • 支持不同的数据库引擎(即将推出)
  • 支持自动恢复备份(即将推出)
  • 支持电子邮件通知(即将推出)
  • 支持OneDrive集成(即将推出)
  • 支持云存储(即将推出)
  • 支持备份加密(即将推出)

路线图

我计划在未来继续开发和改进Backfire。以下是我计划在未来添加的功能列表

  • 易于安装和配置

  • 可以在Windows和Ubuntu服务器上作为cron作业运行,可自定义备份频率和目标位置

  • 将其作为composer包创建:目前,Backfire不是composer包。在未来,我计划将其作为composer包创建,以便用户更容易安装和使用Backfire。

  • 实现支持多个数据库服务器:目前,Backfire仅支持在单个服务器上备份数据库。在未来,我计划添加对在多个服务器上备份数据库的支持。

  • 添加对不同的数据库引擎的支持:当前脚本仅支持MySQL数据库。在未来,我计划添加对其他数据库引擎的支持,如PostgreSQL和SQL Server。

  • 改进错误处理:我计划改进Backfire的错误处理,使其更健壮且用户友好。

  • 添加对自动恢复备份的支持:目前,Backfire仅支持创建备份。在未来,我计划添加在数据丢失时自动恢复备份的功能。

  • 添加对电子邮件通知的支持:我计划添加在备份创建或发生错误时向用户发送电子邮件通知的能力。

  • 改进文档和示例:我计划改进存储库中提供的文档和示例,以便用户更容易开始使用Backfire。

  • 添加对云存储的支持:目前,Backfire仅支持将备份保存到本地文件夹。在未来,我计划添加对其他云存储提供商的支持,如OneDrive、Google Drive和Dropbox。

  • 添加对备份加密的支持:我计划添加加密备份的能力,以保护敏感数据。此路线图代表我们对Backfire开发的当前计划,但可能会根据我收到的用户反馈和建议而发生变化。

欢迎您对改进Backfire的任何反馈或想法,我期待在未来继续开发和改进它。

入门

以下说明将帮助您在本地机器上运行项目副本,用于开发和测试。

1.1 先决条件

您需要在您的机器上安装PHP >=8.0和Composer

1.2 安装

  1. 运行安装命令
  composer global require bsaqqa/backfire
  1. 运行安装命令以安装包依赖项并初始化它
  backfire install
  1. 打开~/.backfire/backfire.config.php文件或使用以下命令使用您的数据库凭据编辑它
  backfire open-config   
  1. 编辑以下变量以匹配您的DB信息和备份文件夹路径
"connections" => [
  "default" => [ // connection name that will be used in the command line to select the connection (you can add more than one connection)
      'type' => 'mysql', // in the future we will support more types
      'host' => 'localhost',
      'port' => 3306,
      'username' => 'root',
      'password' => '',
      'database' => 'backfire',
  ],
  // ... more connections -> You can add more connections
],
 /**
     * Storage config
     *
     */
    "storage" => [
        //...,
        'path' => 'storage/backups', // relative to the user home directory
    ],

1.3 使用方法

您可以使用以下命令运行它

  backfire backup

1.4 如何在Windows上设置cron作业

image

您可以使用以下步骤在Windows上设置cron作业

  1. 打开任务计划程序
  2. 点击创建基本任务
  3. 为任务输入名称
  4. 选择“无论用户是否登录都运行”
  5. 勾选“以最高权限运行”
  6. 点击“触发器”
  7. 点击新建
  8. 选择“每天”
  9. 点击确定
  10. 点击“操作”
  11. 点击新建
  12. 选择“启动程序”
  13. 在字段中输入"backfire.bat"的路径
  14. 在“添加参数”字段中输入backup参数
  15. 点击确定

1.5 在Ubuntu上设置cron作业的方法

您可以使用以下步骤在Ubuntu上使用crontab设置cron作业

  1. 打开终端

  2. 运行crontab

     crontab -e
    
  3. 将以下行添加到文件末尾

     0 0 * * * backfire backup
    
  4. 保存并退出

许可协议

本项目受MIT许可协议许可 - 有关详细信息,请参阅LICENSE.md文件