README

PHP CLI For Auto Backup DB.

You can run it as a cron job on Windows/Ubuntu servers to do daily backup of your database.

Features

Easy to install and configure
Can be run as a cron job on Windows and Ubuntu servers
Create it as a composer package
Supports multiple database servers (Multiple connections)
Supports different database engines (Coming Soon)
Supports automatic restoration of backups (Coming Soon)
Supports email notifications (Coming Soon)
Supports OneDrive integration (Coming soon)
Supports cloud storage (Coming Soon)
Supports encryption of backups (Coming Soon)

Roadmap

I plan to continue developing and enhancing the Backfire in the future. Below is a list of features I plan to add in the future:

Easy to install and configure
Can be run as a cron job on Windows and Ubuntu servers Customizable backup frequency and destination
Create it as a composer package: Currently, Backfire is not available as a composer package. In the future, I plan to create it as a composer package to make it easier for users to install and use Backfire.
Implement support for multiple database servers: Currently, Backfire only supports backing up databases on a single server. In the future, I plan to add support for backing up databases on multiple servers.
Add support for different database engines: The script currently only supports MySQL databases. In the future, I plan to add support for other database engines such as PostgreSQL and SQL Server.
Improve error handling: I plan to improve Backfire's error handling to make it more robust and user-friendly.
Add support for automatic restoration of backups: Currently, Backfire only supports creating backups. In the future, I plan to add support for automatically restoring backups in case of data loss.
Add support for email notifications: I plan to add the ability to send email notifications to users when a backup is created or when an error occurs.
Improve documentation and examples: I plan to improve the documentation and examples provided in the repository to make it easier for users to get started with Backfire.
Add support for cloud storage: Currently, Backfire only supports saving backups to a local folder. In the future, I plan to add support for other cloud storage providers such as OneDrive, Google Drive and Dropbox.
Add support for encryption of backups: I plan to add the ability to encrypt backups to protect sensitive data. This roadmap represents our current plans for the development of the Backfire, but it is subject to change as I receive feedback and suggestions from users.

I welcome any feedback or ideas you have for improving Backfire, and I look forward to continuing to develop and enhance it in the future.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

1.1 Prerequisites

You need to have PHP >=8.0 and Composer installed on your machine.

1.2 Installing

Run install command

  composer global require bsaqqa/backfire

Run install command to install package dependencies and initialize it

  backfire install

Open ~/.backfire/backfire.config.php file or using below command to edit it with your database credentials

  backfire open-config

Edit the following variables to match your DB information and backup folder path:

"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 How to use

You can run it with below command:

  backfire backup

1.4 How to setup cron job on Windows

You can setup cron job on Windows using schedule with below steps:

Open Task Scheduler
Click Create a Basic Task
Enter a name for the task
Select "Run whether user is logged on or not"
Check "Run with highest privileges"
Click on "Triggers"
Click New
Select "Daily"
Click OK
Click on "Actions"
Click New
Select "Start a program"
Enter the path to "backfire.bat" in the field
Enter backup argument in the "Add arguments" field
Click OK

1.5 How to setup cron job on Ubuntu

You can setup cron job on Ubuntu using crontab with below steps:

Open terminal
Run crontab
```
 crontab -e
```
Add the following line to the end of the file:
```
 0 0 * * * backfire backup
```
Save and exit

License

This project is licensed under the MIT License - see the LICENSE.md file for details

bsaqqa / backfire

Maintainers

Details