nelsonkopliku/backup-manager

A framework agnostic database backup manager with user-definable procedures and support for S3, Dropbox, FTP, SFTP, and more with drivers for popular frameworks.

Database Backup Manager 1.0

, _(*1)

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

Watch a video tour showing the Laravel driver in action to give you an idea what is possible., _(*3)

• supports MySQL and PostgreSQL
• compress with Gzip
• framework-agnostic
• dead simple configuration
• Laravel Driver
• Symfony Driver

Table of Contents

• Stability Notice
• Quick and Dirty
• Requirements
• Installation
• Usage
• Contribution Guidelines
• Maintainers
• License

Stability Notice

It's stable enough, you'll need to understand permissions., _(*4)

This package is actively being developed and we would like to get feedback to improve it. Please feel free to submit feedback., _(*5)

Quick and Dirty

Configure your databases., _(*6)

// config/database.php
'development' => [
    'type' => 'mysql',
    'host' => 'localhost',
    'port' => '3306',
    'user' => 'root',
    'pass' => 'password',
    'database' => 'test',
],
'production' => [
    'type' => 'postgresql',
    'host' => 'localhost',
    'port' => '5432',
    'user' => 'postgres',
    'pass' => 'password',
    'database' => 'test',
],

Configure your filesystems., _(*7)

// config/storage.php
'local' => [
    'type' => 'Local',
    'root' => '/path/to/working/directory',
],
's3' => [
    'type' => 'AwsS3',
    'key'    => '',
    'secret' => '',
    'region' => 'us-east-1',
    'version' => 'latest',
    'bucket' => '',
    'root'   => '',
],
'gcs' => [
    'type' => 'Gcs',
    'key'    => '',
    'secret' => '',
    'version' => 'latest',
    'bucket' => '',
    'root'   => '',
],
'rackspace' => [
    'type' => 'Rackspace',
    'username' => '',
    'key' => '',
    'container' => '',
    'zone' => '',
    'root' => '',
],
'dropbox' => [
    'type' => 'Dropbox',
    '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' => '',
],

Backup to / restore from any configured database., _(*8)

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., _(*9)

$manager = require 'bootstrap.php';
$manager->makeBackup()->run('development', 's3', 'test/backup.sql', 'gzip');

Backup to / restore from any configured filesystem., _(*10)

Restore the database file test/backup.sql.gz from Amazon S3 to the development database., _(*11)

$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., _(*12)

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, _(*13)

Run the following to include this via Composer, _(*14)

composer require backup-manager/backup-manager

Then, you'll need to select the appropriate packages for the adapters that you want to use., _(*15)

# to support s3 or google cs
composer require league/flysystem-aws-s3-v3

# to support dropbox
composer require league/flysystem-dropbox

# to support rackspace
composer require league/flysystem-rackspace

# to support sftp
composer require league/flysystem-sftp

Usage

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

We've provided a native PHP example here., _(*17)

The required bootstrapping can be found in the example here., _(*18)

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., _(*19)

When contributing please consider the following guidelines:, _(*20)

• please conform to the code style of the project, it's essentially PSR-2 with a few differences.
  1. The NOT operator when next to parenthesis should be surrounded by a single space. if ( ! is_null(...)) {.
  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.
• When planning a pull-request to add new functionality, it may be wise to submit a proposal to ensure compatibility with the project's goals.

Maintainers

This package is maintained by Shawn McCool, Mitchell van Wijngaarden, and you!, _(*21)

License

This package is licensed under the MIT license., _(*22)