DerekMarcinyshyn / monashee-backup by monashee

Laravel MySQL backup utility and upload to AWS S3.
192
1
1
Package Data
Maintainer Username: monashee
Maintainer Contact: derek@marcinyshyn.com (Derek Marcinyshyn)
Package Create Date: 2014-09-23
Package Last Update: 2014-09-30
Language: PHP
License: MIT
Last Refreshed: 2021-07-28 03:02:56
Package Statistics
Total Downloads: 192
Monthly Downloads: 0
Daily Downloads: 0
Total Stars: 1
Total Watchers: 1
Total Forks: 0
Total Open Issues: 0

Monashee Backup

Build Status

A simple Laravel artisan utility to backup MySQL database to AWS S3 bucket.

I use it by creating a backup mysql user and attaching that user to all of the databases I want to backup. In a multi database environment it makes it easier to only select those databases that are in production.

It saves to a temp folder then after uploading to AWS S3 it removes the $database.sql.gz files.

It also cleans up the S3 folder by removing daily backups from 2 months ago but leaving the first one of the month.

Events

MonasheeBackupSuccess fires on completion and passes the $databases array

MonasheeBackupFail fires on Exception and passes the $e->getTraceAsString()

Installation

Requires

  • PHP 5.4+
  • Laravel 4.2+

Install via Composer by adding the following line to the require block of your composer.json file

"monashee/backup": "dev-master"

Then run composer update

Add this line to the providers array in your app/config/app.php file:

'Monashee\Backup\BackupServiceProvider',

Configuration

Create or edit your .env.php file in your root directory. Copy the config settings and edit the fields.

<?php

return [
    'BACKUP_MYSQL_HOST'     => 'host',
    'BACKUP_MYSQL_USER'     => 'user',
    'BACKUP_MYSQL_PASSWORD' => 'password',
    'BACKUP_MYSQLDUMP_PATH' => '/usr/bin/mysqldump',
    'BACKUP_AWS_KEY'        => 'key',
    'BACKUP_AWS_SECRET'     => 'secret',
    'BACKUP_S3_BUCKET'      => 'bucket',
    'BACKUP_S3_REGION'      => 'us-west-2',
    'BACKUP_STORAGE_PATH'   => 'monashee/backup/'
];

AWS S3 Regions http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

Usage

php artisan monashee:backup

Test in console to make sure it runs without errors. I find it easier to create a MySQL user called backup and add that user to all of the databases I want to backup.

Set a cron job to trigger the command when needed.

Notes

It uses the mysqldump command for creating the backup. More info mysqldump

mysqldump requires at least the SELECT privilege for dumped tables, SHOW VIEW for dumped views, TRIGGER for dumped triggers, and LOCK TABLES if the --single-transaction option is not used. Certain options might require other privileges as noted in the option descriptions.

To reload a dump file, you must have the same privileges needed to create each of the dumped objects by issuing CREATE statements manually.

\Monashee\Backup\Dump.php has the mysqldump options