Automatic Backups - Revision history

AlexN: Redirected page to Backups

2018-03-04T15:24:35Z

Redirected page to Backups

Andrew at 11:30, 11 August 2017

2017-08-11T11:30:01Z

Andrew: Created page with "Automatic Backups WHMCS can automatically backup your database and upload to a SFTP/FTP location and/or email it to a designated email address. From WHMCS 7.3, it is also po..."

2017-08-11T11:25:17Z

Created page with "Automatic Backups WHMCS can automatically backup your database and upload to a SFTP/FTP location and/or email it to a designated email address. From WHMCS 7.3, it is also po..."

New page

Automatic Backups

WHMCS can automatically backup your database and upload to a SFTP/FTP location and/or email it to a designated email address.

From WHMCS 7.3, it is also possible to request a full cPanel backup for a specific user as part of the automatic backup process.

==Enabling Automatic Backups==

All backup configuration is completed in ''Setup'' > ''Other'' > ''Database Backups''.

The available options are SFTP/FTP backup, Email backup and full cPanel Account backup.

===Testing Connection===

The SFTP/FTP and cPanel Backup options require a connection test being successful before activation. A connection test ensures the details are valid and the WHMCS installation can connect to the server. Any connection issue allows a resolution before a backup attempt occurs meaning less chance of a failed connection.

==SFTP/FTP Backup==

This backup will place the WHMCS generated zipped sql file on the specified remote server.

Checking the "Use Secure FTP/SFTP (Recommended)" box will ensure the backup upload is completed using an SFTP connection.

===FTP Destination===

This value should be relative to the login folder for the FTP/SFTP account being used.
No initial slash should be used, for example, if upon logging in using those FTP details the folder is /home/user/ and the backup should be in /home/user/backups, then enter backups/ as the FTP Destination.
If the login folder is where the backup file is to be uploaded, leave this field empty.

<div class="docs-alert-info">Why not create a separate FTP account jailed to a certain directory?</div>

==cPanel Backup==

The cPanel Backup option uses the [https://documentation.cpanel.net/display/ALD/Backup+Wizard#BackupWizard-FullBackup Full Backup] feature of WHM/cPanel's backup wizard.

===cPanel Username===
<div class="docs-alert-info">The cPanel Username is the name of the account to be backed up.</div>

===Backup Destination===
* Home Directory — Select this option to save the backup file to the server.
* Remote FTP Server — Select this option to use FTP to store the backup file on a remote server.
* Remote FTP Server (Passive Mode Transfer) — Select this option to use passive FTP to store the backup file on a remote server.
* SCP — Select this option to use SCP to store the backup file on a remote server.

<div class="docs-alert-warning">Using Home Directory will generate the backup file in the home directory of the cPanel user. This will count against any disk space limits and should be manually moved to a better location after completion.</div>

The System Cron will only request the start of a full backup. Completion, and relocation of the backup occurs within cPanel and will not be notified though WHMCS.

==Troubleshooting==

A number of errors may appear in the Activity Log when a backup is being completed by the WHMCS Cron.

===Table 'xxx' doesn't exist when using LOCK TABLES===
Indicates the named table 'xxx' is crashed or corrupted. Running a MySQL repair operation can resolve this. Tables can be repaired via the MySQL Databases page within cPanel or using a tool such as phpmyadmin.

===Database backup unavailable due to missing required zip extension===
This refers to the ZipArchive PHP class which is required by WHMCS to compress the backup. Please recompile PHP with support for this class: http://php.net/manual/en/class.ziparchive.php

===Database backup error 'Please provide a valid dump path'===
This indicates that WHMCS is unable to access the /tmp working directory during the backup generation process. Please ensure that the [http://php.net/manual/en/ini.core.php#ini.open-basedir open_basedir] value is set to ''Off'' in your PHP configuration, that the PHP /tmp directory is writeable and is not full.

← Older revision		Revision as of 15:24, 4 March 2018
Line 1:		Line 1:
		+	#REDIRECT [[Backups]]
	WHMCS can automatically backup your database and upload to a SFTP/FTP location and/or email it to a designated email address.		WHMCS can automatically backup your database and upload to a SFTP/FTP location and/or email it to a designated email address.

@@ Line 1: / Line 1: @@
 WHMCS can automatically backup your database and upload to a SFTP/FTP location and/or email it to a designated email address.
@@ Line 27: / Line 25: @@
 If the login folder is where the backup file is to be uploaded, leave this field empty.
-<div class="docs-alert-info">Why not create a separate FTP account jailed to a certain directory?</div>
+<div class="docs-alert-info"><i class="fa fa-question-circle"></i> Why not create a separate FTP account jailed to a certain directory?</div>
 ==cPanel Backup==
@@ Line 34: / Line 32: @@
 ===cPanel Username===
-<div class="docs-alert-info">The cPanel Username is the name of the account to be backed up.</div>
+<div class="docs-alert-info"><i class="fa fa-info"></i> The cPanel Username is the name of the account to be backed up.</div>
 ===Backup Destination===
@@ Line 42: / Line 40: @@
 * SCP — Select this option to use SCP to store the backup file on a remote server.
-<div class="docs-alert-warning">Using Home Directory will generate the backup file in the home directory of the cPanel user. This will count against any disk space limits and should be manually moved to a better location after completion.</div>
+<div class="docs-alert-warning"><i class="fa fa-exclamation-triangle"></i> Using Home Directory will generate the backup file in the home directory of the cPanel user. This will count against any disk space limits and should be manually moved to a better location after completion.</div>
 The System Cron will only request the start of a full backup. Completion, and relocation of the backup occurs within cPanel and will not be notified though WHMCS.