FUEL CMS User Guide : Version 1.4


Backup Module Documentation

This Backup module documentation is for version 1.0.

Overview

The Backup module can be used to backup the FUEL database as well as the assets folder. It comes with a controller to backup the database with options to include the assets folder as well as email it as an attachment. The Backup module can be used along with the Cronjobs module to do periodic backups.

Backup Configuration

The following configuration parameters can be found in the modules/backup/config/backup.php configuration file. It is recommended that you copy the config file and place it in your fuel/application/config directory which will override the defaults and make it easier for future updates.

Property Default Value Description
file_prefix
'AUTO'
used for the name of the backup file. A value of AUTO will automatically create the name
file_date_format
'Y-m-d'
date format to append to file name
zip
TRUE
ZIP up the file or not
download
TRUE
download the file or not from the browser
days_to_keep
30
number of days to hold backups. A value of 0 or FALSE will be forever
allow_overwrite
FALSE
number of days to hold backups. A value of 0 or FALSE will be forever
include_assets
FALSE
determines whether to backup assets by default
cron_email
''
the email address to send the backup cron notification
cron_email_file
TRUE
determines whether to send files in an email with cron backup
cron_backup_command
'php '. FCPATH . SELF .' backup/cron'
cronjob backup command
backup_path
INSTALL_ROOT.'data_backup/'
backup path for data. Deafult is at the same level as the system and application folder
db_backup_prefs
array(
'ignore'      => array(),            list of tables to omit from the backup
'add_drop'    => TRUE,               whether to add DROP TABLE statements to backup file
'add_insert'  => TRUE,               whether to add INSERT data to backup file
)
database backup preferences
allow_ftp
FALSE
allow FTP backup
ftp_prefs
array(
'hostname'  => '',                   the host to send the backup to
'username'  => '',                   the username to FTP
'password'  => '',                   the FTP user's password (warning if saving in FUEL settings... it's not encrypted!)
'port'      => 21,					 port on hostname
'passive'   => TRUE,					 FTP mode
'remote_dir' => '',                  the remote directory to ftp to
'delete_local' => TRUE,              will delete the local server version upon successful FTP transfer
)
FTP backup preferences
settings
array()
create configurable settings from with the Settings module. You can add/remove field that you don't want configured

Libraries