Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/backup-manager/backup-manager

Database backup manager for dumping to and restoring databases from S3, Dropbox, FTP, SFTP, and Rackspace Cloud
https://github.com/backup-manager/backup-manager

backup backup-manager cloud database framework-agnostic laravel mysql php postgresql restore symfony

Last synced: 5 days ago
JSON representation

Database backup manager for dumping to and restoring databases from S3, Dropbox, FTP, SFTP, and Rackspace Cloud

Awesome Lists containing this project

README 

        
# Database Backup Manager



![Packagist Version](https://img.shields.io/packagist/v/backup-manager/backup-manager)

![Packagist License](https://img.shields.io/packagist/l/backup-manager/backup-manager)

![Installs](https://img.shields.io/packagist/dt/backup-manager/backup-manager)



This package provides a framework-agnostic database backup manager for dumping to and restoring databases from S3, Dropbox, FTP, SFTP, and Rackspace Cloud.



- use version 2+ for >=PHP 7.3

- use version 1 for <PHP 7.2



[Watch a video tour](https://www.youtube.com/watch?v=vWXy0R8OavM) showing the Laravel driver in action to give you an idea what is possible.



- supports `MySQL` and `PostgreSQL`

- compress with `Gzip`

- framework-agnostic

- dead simple configuration

- [Laravel Driver](http://github.com/backup-manager/laravel)

- [Symfony Driver](http://github.com/backup-manager/symfony)



### Table of Contents



- [Database Backup Manager](#database-backup-manager)

    - [Table of Contents](#table-of-contents)

    - [Quick and Dirty](#quick-and-dirty)

    - [Requirements](#requirements)

    - [Installation](#installation)

    - [Usage](#usage)

    - [Contribution Guidelines](#contribution-guidelines)

    - [Maintainers](#maintainers)

    - [Backwards Compatibility Breaks](#backwards-compatibility-breaks)

    - [License](#license)



### Quick and Dirty



**Configure your databases.**



```php

// config/database.php

'development' => [

    'type' => 'mysql',

    'host' => 'localhost',

    'port' => '3306',

    'user' => 'root',

    'pass' => 'password',

    'database' => 'test',

    // If singleTransaction is set to true, the --single-transcation flag will be set.

    // This is useful on transactional databases like InnoDB.

    // http://dev.mysql.com/doc/refman/5.7/en/mysqldump.html#option_mysqldump_single-transaction

    'singleTransaction' => false,

    // Do not dump the given tables

    // Set only table names, without database name

    // Example: ['table1', 'table2']

    // http://dev.mysql.com/doc/refman/5.7/en/mysqldump.html#option_mysqldump_ignore-table

    'ignoreTables' => [],

    // using ssl to connect to your database - active ssl-support (mysql only):

    'ssl'=>false,

    // add additional options to dump-command (like '--max-allowed-packet')

    'extraParams'=>null,

],

'production' => [

    'type' => 'postgresql',

    'host' => 'localhost',

    'port' => '5432',

    'user' => 'postgres',

    'pass' => 'password',

    'database' => 'test',

],

```



**Configure your filesystems.**



```php

// config/storage.php

'local' => [

    'type' => 'Local',

    'root' => '/path/to/working/directory',

],

's3' => [

    'type' => 'AwsS3',

    'key'    => '',

    'secret' => '',

    'region' => 'us-east-1',

    'version' => 'latest',

    'bucket' => '',

    'root'   => '',

    'use_path_style_endpoint' => false,

],

'b2' => [

    'type' => 'B2',

    'key'    => '',

    'accountId' => '',

    'bucket' => '',

],

'gcs' => [

    'type' => 'Gcs',

    'key'    => '',

    'secret' => '',

    'version' => 'latest',

    'bucket' => '',

    'root'   => '',

],

'rackspace' => [

    'type' => 'Rackspace',

    'username' => '',

    'key' => '',

    'container' => '',

    'zone' => '',

    'root' => '',

],

'dropbox' => [

    'type' => 'DropboxV2',

    'token' => '',

    'key' => '',

    'secret' => '',

    'app' => '',

    'root' => '',

],

'ftp' => [

    'type' => 'Ftp',

    'host' => '',

    'username' => '',

    'password' => '',

    'root' => '',

    'port' => 21,

    'passive' => true,

    'ssl' => true,

    'timeout' => 30,

],

'sftp' => [

    'type' => 'Sftp',

    'host' => '',

    'username' => '',

    'password' => '',

    'root' => '',

    'port' => 21,

    'timeout' => 10,

    'privateKey' => '',

],

'flysystem' => [

    'type' => 'Flysystem',

    'name' => 's3_backup',

    //'prefix' => 'upload',

],

'doSpaces' => [

    'type' => 'AwsS3',

    'key' => '',

    'secret' => '',

    'region' => '',

    'bucket' => '',

    'root' => '',

    'endpoint' => '',

    'use_path_style_endpoint' => false,

],

'webdav' => [

    'type' => 'Webdav',

    'baseUri' => 'http://myserver.com',

    'userName' => '',

    'password' => '',

    'prefix' => '',

],

```



**Backup to / restore from any configured database.**



Backup the development database to `Amazon S3`. The S3 backup path will be `test/backup.sql.gz` in the end, when `gzip` is done with it.



```php

use BackupManager\Filesystems\Destination;



$manager = require 'bootstrap.php';

$manager->makeBackup()->run('development', [new Destination('s3', 'test/backup.sql')], 'gzip');

```



**Backup to / restore from any configured filesystem.**



Restore the database file `test/backup.sql.gz` from `Amazon S3` to the `development` database.



```php

$manager = require 'bootstrap.php';

$manager->makeRestore()->run('s3', 'test/backup.sql.gz', 'development', 'gzip');

```



> This package does not allow you to backup from one database type and restore to another. A MySQL dump is not compatible with PostgreSQL.



### Requirements



- PHP 5.5

- MySQL support requires `mysqldump` and `mysql` command-line binaries

- PostgreSQL support requires `pg_dump` and `psql` command-line binaries

- Gzip support requires `gzip` and `gunzip` command-line binaries



### Installation



**Composer**



Run the following to include this via Composer



```shell

composer require backup-manager/backup-manager

```



Then, you'll need to select the appropriate packages for the adapters that you want to use.



```shell

# to support s3

composer require league/flysystem-aws-s3-v3



# to support b2

composer require mhetreramesh/flysystem-backblaze



# to support google cs

composer require league/flysystem-aws-s3-v2



# to install the preferred dropbox v2 driver

composer required spatie/flysystem-dropbox



# to install legacy dropbox v2 driver

composer require srmklive/flysystem-dropbox-v2



# to support rackspace

composer require league/flysystem-rackspace



# to support sftp

composer require league/flysystem-sftp



# to support webdav (supported by owncloud nad many other)

composer require league/flysystem-webdav

```



### Usage



Once installed, the package must be bootstrapped (initial configuration) before it can be used.



We've provided a native PHP example [here](https://github.com/backup-manager/backup-manager/tree/master/examples).



The required bootstrapping can [be found in the example here](https://github.com/backup-manager/backup-manager/blob/master/examples/standalone/bootstrap.php).



### Contribution Guidelines



We recommend using the vagrant configuration supplied with this package for development and contribution. Simply install VirtualBox, Vagrant, and Ansible then run `vagrant up` in the root folder. A virtualmachine specifically designed for development of the package will be built and launched for you.



When contributing please consider the following guidelines:



- Code style is PSR-2

    - Interfaces should NOT be suffixed with `Interface`, Traits should NOT be suffixed with `Trait`.

- All methods and classes must contain docblocks.

- Ensure that you submit tests that have minimal 100% coverage. Given the project's simplicity it just makes sense.

- When planning a pull-request to add new functionality, it may be wise to [submit a proposal](https://github.com/backup-manager/backup-manager/issues/new) to ensure compatibility with the project's goals.



### Maintainers



This package is maintained by [Shawn McCool](http://shawnmc.cool) and you!



### Backwards Compatibility Breaks



#### 3.0



Remove support for symfony 2. Specifically symfony/process versions < 3.x



### License



This package is licensed under the [MIT license](https://github.com/backup-manager/backup-manager/blob/master/LICENSE). Go wild.