PLUGIN README
AutoBackup - Automatically create versioned database backups at hourly, daily,
weekly, and monthly intervals.
-------------------------------------------------------------------------------


TECHNICAL OVERVIEW
-------------------------------------------------------------------------------
This plugin automatically creates backups of the database anytime the admin
program or viewers are accessed.  It maintains a number of backups at hourly,
daily, weekly, and monthly intervals and automatically removes old backup
files.

This allows you to easily restore the database as it existed a few hours ago,
a few days ago, a few weeks ago, or a few months ago.  All while minimizing the
amount of disk space required.


IMPORTANT CONSIDERATIONS
-------------------------------------------------------------------------------
Note that while this add-on works well for the majority of website databases,
for extremely large databases this add-on may not be sufficient and additional
backup procedures may be required.  When in doubt test the backup time and do
a test restore process.

As with any backup system you should periodically check that the backups are
continuing to function as desired.  Additionally, you should periodically do
a "test restore" to a different server to ensure that you are familiar with
the recovery process and that everything is working as expected.


BACKUP FILES
-------------------------------------------------------------------------------
Backup files are created in the [cmsb]/data/backups/ folder.  Backup file
names contain the current hostname, software version, backup type (daily,
weekly, or monthly) and date identifier (hour number, day names, week number
or month name).

Here are some example filenames:

Monthly Backup Files:
[cmsb]/data/backups/example.com-v1.00-monthly-Jan.sql.php
[cmsb]/data/backups/example.com-v1.00-monthly-Feb.sql.php
[cmsb]/data/backups/example.com-v1.00-monthly-Mar.sql.php

Weekly Backup Files:
[cmsb]/data/backups/example.com-v1.00-weekly-01.sql.php
[cmsb]/data/backups/example.com-v1.00-weekly-02.sql.php
[cmsb]/data/backups/example.com-v1.00-weekly-03.sql.php

Daily Backup Files:
[cmsb]/data/backups/example.com-v1.00-daily-Mon.sql.php
[cmsb]/data/backups/example.com-v1.00-daily-Tue.sql.php
[cmsb]/data/backups/example.com-v1.00-daily-Wed.sql.php

Hourly Backup Files:
[cmsb]/data/backups/example.com-v1.00-hourly-11.sql.php
[cmsb]/data/backups/example.com-v1.00-hourly-12.sql.php
[cmsb]/data/backups/example.com-v1.00-hourly-13.sql.php



USER CONFIGURABLE SETTINGS
-------------------------------------------------------------------------------
For advanced users who have some comfort and familiarity with PHP, the
following settings within the plugin file can be modified:

$GLOBALS['AUTOBACKUP_HOURS'] = 24;
// This is the number of hours old hourly backups will be kept for.

$GLOBALS['AUTOBACKUP_DAYS']   = 3;
// This is the number of days old daily backups will be kept for.

$GLOBALS['AUTOBACKUP_WEEKS']  = 3;
// This is the number of weeks old weekly backups will be kept for.

$GLOBALS['AUTOBACKUP_MONTHS'] = 3;
// This is the number of months old monthly backups will be kept for.

$GLOBALS['AUTOBACKUP_DEFAULT_PREFIX'] = '';
// Backup file prefix, defaults to domain name if not specified.  Example: example.com-v2.03-daily-Wed.sql.php

$GLOBALS['AUTOBACKUP_EMAIL'] = '';
// If defined, backups will be emailed to this address (only the most frequent backup type will be sent)

$GLOBALS['AUTOBACKUP_EMAIL_FREQUENCY'] = 'hourly';
// How often to send backup emails: hourly, daily, weekly, or monthly


-------------------------------------------------------------------------------
end of file.
