php-backup

PHP library to create and archive backups

zenstruck/backup

Build Status Scrutinizer Code Quality Code Coverage SensioLabs Insight StyleCI Latest Stable Version License

Create and archive backups. A Symfony Bundle and a Laravel package is available that wraps this library.

An "executor" takes a backup profile and processes it. A backup "profile" consists of 4 parts:

  1. Source(s): What to backup (ie database/files). The source fetches files and copies them to a "scratch" directory. These files are typically persisted between backups (improves rsync performance) but can be cleared by the "executor".
  2. Processor: Convert to a single file (ie zip/tar.gz). This step uses a Namer to name the file.
  3. Namer: Generates a filename to be used by the above processor.
  4. Destination: Where to send the backup (ie filesystem/S3).

Installation

  1. Install this library:

     composer require zenstruck/backup
    
  2. (Optional) Install process (used by some Destinations, Sources and Processors):

     composer require symfony/process
    
  3. (Optional) Install console (for the console command):

     composer require symfony/console
    

The MIT License (MIT)

Copyright (c) 2015 Kevin Bond

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.