27 users online | 27 Guests and 0 Registered

Version 1.8 - Configuration Guide

  1. Open up the file configuration.php in Notepad.
  2. Enter in your details as follows

Configuration Settings Explained

$licensekey = "PRO-1234567890";
$contact_email = "you@yoursite.com";

Once you have registered for a license key at https://www.cpbackup.info/billing/order, enter the license key you received into the $licensekey variable inbetween the 2 speech marks.
For more information about why you should enter the $contact_email value please visit Contact_email.

$config["cpbackup"] = array(
"reseller_ip" => "",
"reseller_username" => "",
"reseller_password" => "",
"sleep" => "20",
"overall_notification" => "",
"output_debug" => "1",
"owned_exclusive" => "0",

Reseller IP: Enter either your domain or the ip which your website is hosted on.
Reseller Username: Enter your cPanel/WHM username.
Reseller Password: Enter your cPanel/WHM password.
Sleep: This is how long it should wait before each backup this is important so the server doesn't get overloaded. Please note, so we don't over burden the hosting server. We have embedded in a safety feature to ensure there is a minimum time of 20 seconds between each account.
Overall Notification: Receive the output from this backup script directly to your email.
Output Debug: When this is set to 1. cPBackup will export the report displayed and emailed to the email set in overall_notification to debug/output.html every time the backup is run. *Added Version 1.3*.
Owned Exclusive: (1) Only backup accounts owned by "reseller_username", (0) Backup all accounts no matter who owns the account.

$default = array(
"backup_mode" => "ftp",
"backup_host" => "",
"backup_user" => "",
"backup_pass" => "",
"backup_port" => "",
"backup_dir" => "",
"per_account_email" => "",

Backup Mode: (homedir | ftp | passiveftp | scp)

  • homedir: Stores the backup in the users home directory.
  • ftp: Transfers the backup to an offsite ftp server.
  • passiveftp: Transfers the backup to an offsite ftp server using Passive FTP mode.
  • scp: Transfers the backup to an offsite server using Secure Copy (SCP).

The following are only required if the FTP mode is set to either ftp, passiveftp or scp.
Backup Host: FTP/SCP server hostname/ip.
Backup User: FTP/SCP server username.
Backup Password: FTP/SCP server password.
Backup Port: FTP/SCP server port.
Backup Dir: FTP/SCP server remote directory location. (%USER%, %DOMAIN%, %PACKAGE%, %DAILY%, %MONTHLY%, %ANNUALLY%, %OWNER%)
Per Account Email: The email address to receive the backup confirmation email sent from cPanel (This sends 1 for each account and contains information concerning FTP success/failure.

$config["dropbox"] = array(
"enabled" => "0",
"ftp_root_dir" => "/",
"ftp_delete_files" => "1",
"dropbox_dir" => "/",
"output_debug" => "1"

Enabled: Set to 1 to use Dropbox Uploader
FTP Root Director: The FTP Folder to upload to DropBox.
FTP Delete File: Should the FTP files be deleted once they have been uploaded to DropBox?
Dropbox Directory: The folder to upload the files to on DropBox.

$debug["info"] = "0";

Debug Info: Having problems? Set $debug["info"] to 1 and re-run either run.php or run_dropbox.php. You will now have a lot more information to help resolve problems. If you are struggling please forward the report to admin@cpbackup.info.

For information about Custom Overrides and excluding accounts check out our other pages.


What To Do Next?

Visit our page Performing The Backup

Tags: configuration
Last update:
2016-03-21 23:55
Average rating:0 (0 Votes)

You cannot comment on this entry

Chuck Norris has counted to infinity. Twice.