Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Driver to seamlessly integrate the Backup Manager into Laravel applications.
https://github.com/backup-manager/laravel

Last synced: 6 days ago
JSON representation

Driver to seamlessly integrate the Backup Manager into Laravel applications.

Awesome Lists containing this project

README 

        
# Laravel Driver for the Database Backup Manager



This package pulls in the framework agnostic [Backup Manager](https://github.com/backup-manager/backup-manager) and provides seamless integration with **Laravel**.



[Watch a video tour](https://www.youtube.com/watch?v=vWXy0R8OavM) to get an idea what is possible with this package.



> Note: This package is for Laravel integration only. For information about the framework-agnostic core package (or the Symfony driver) please see [the base package repository](https://github.com/backup-manager/backup-manager).



### Table of Contents



- [Stability Notice](#stability-notice)

- [Requirements](#requirements)

- [Installation](#installation)

- [Scheduling Backups](#scheduling-backups)

- [Contribution Guidelines](#contribution-guidelines)

- [Maintainers](#maintainers)

- [License](#license)

- [Changelog](#changelog)



### Stability Notice



It's stable enough, you'll need to understand filesystem permissions.



This package is being actively developed, and we would like to get feedback to improve it. [Please feel free to submit feedback.](https://github.com/backup-manager/laravel/issues/new)



### Requirements



- PHP 7.3+

- Laravel 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/laravel

```



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



```shell

# to support s3 or google cs

composer require league/flysystem-aws-s3-v3



# to support dropbox

composer require srmklive/flysystem-dropbox-v2



# to support rackspace

composer require league/flysystem-rackspace



# to support sftp

composer require league/flysystem-sftp



# to support gcs

composer require superbalist/flysystem-google-storage

```



#### Laravel 5 Configuration



To install into a Laravel project, first do the composer install then add *ONE *of the following classes to your config/app.php service providers list.



```php

// FOR LARAVEL 5.5 +

BackupManager\Laravel\Laravel55ServiceProvider::class,

```



Publish the storage configuration file.



```php

php artisan vendor:publish --provider="BackupManager\Laravel\Laravel55ServiceProvider"

```



The Backup Manager will make use of Laravel's database configuration. But, it won't know about any connections that might be tied to other environments, so it can be best to just list multiple connections in the `config/database.php` file.



We can also add extra parameters on our backup manager commands by configuring extra params on `.env` file:



```

BACKUP_MANAGER_EXTRA_PARAMS="--column-statistics=0 --max-allowed-packet"

```



#### Lumen Configuration



To install into a Lumen project, first do the composer install then add the configuration file loader and *ONE* of the following service providers to your `bootstrap/app.php`.



```php

// FOR LUMEN 5.5 AND ABOVE

$app->configure('backup-manager');

$app->register(BackupManager\Laravel\Lumen55ServiceProvider::class);

```



Copy the `vendor/backup-manager/laravel/config/backup-manager.php` file to `config/backup-manager.php` and configure it to suit your needs.



**IoC Resolution**



`BackupManager\Manager` can be automatically resolved through constructor injection thanks to Laravel's IoC container.



```php

use BackupManager\Manager;



public function __construct(Manager $manager) {

    $this->manager = $manager;

}

```



It can also be resolved manually from the container.



```php

$manager = App::make(\BackupManager\Manager::class);

```



**Artisan Commands**



There are three commands available `db:backup`, `db:restore` and `db:list`.



All will prompt you with simple questions to successfully execute the command.



**Example Command for 24hour scheduled cronjob**



```

php artisan db:backup --database=mysql --destination=dropbox --destinationPath=project --timestamp="d-m-Y" --compression=gzip

```



This command will backup your database to dropbox using mysql and gzip compresion in path /backups/project/DATE.gz (ex: /backups/project/31-7-2015.gz)



### Scheduling Backups



It's possible to schedule backups using Laravel's scheduler.



```PHP

/**

 * Define the application's command schedule.

 *

 * @param  \Illuminate\Console\Scheduling\Schedule  $schedule

 * @return void

 */

 protected function schedule(Schedule $schedule) {

     $environment = config('app.env');

     $schedule->command(

         "db:backup --database=mysql --destination=s3 --destinationPath=/{$environment}/projectname --timestamp="Y_m_d_H_i_s" --compression=gzip"

         )->twiceDaily(13,21);

 }

```



### 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:



- 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](https://github.com/backup-manager/laravel/issues/new) to ensure compatibility with the project's goals.



### Maintainers



This package is maintained by [Shawn McCool](http://shawnmc.cool) and [open-source heroes](https://github.com/backup-manager/laravel/pulls?q=is%3Apr+is%3Aclosed).



### License



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



### Changelog



**2.0**



_Released on 2020-04-30_



Remove support for all Laravel versions below 5.5. All older versions should use the backup-manager `^1.0`.



Since so many dependencies in Laravel / Symfony have changed it became impossible to support newer versions in the same code-base. Release `^1.0` is stable and is always accepting new stability fixes (we haven't seen anything to fix in a long time).