Backups - Revision history

SarahK at 20:39, 18 April 2022

2022-04-18T20:39:31Z

PeterM: /* Automated Database Backup */

2022-03-29T10:46:19Z

‎Automated Database Backup

AlexN: /* Limitations */

2022-01-23T15:04:20Z

‎Limitations

AlexN: /* Limitations */

2022-01-23T15:04:00Z

‎Limitations

SarahK: /* Troubleshooting */

2022-01-19T18:58:19Z

‎Troubleshooting

SarahK at 18:06, 19 January 2022

2022-01-19T18:06:21Z

SarahK at 17:29, 19 January 2022

2022-01-19T17:29:29Z

AlexN: /* Executing Backup Task Manually */

2021-10-05T13:43:01Z

‎Executing Backup Task Manually

SarahK: /* Executing Backup Task Manually */

2021-04-22T12:45:19Z

‎Executing Backup Task Manually

AlexN: /* Executing Backup Task Manually */

2021-04-21T14:17:00Z

‎Executing Backup Task Manually

@@ Line 5: / Line 5: @@
 WHMCS can automatically back up your database and upload it to a SFTP/FTP location or email it to a designated email address.
-To enable automatic backups, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings  > [[Database Backups]]'''.
+To enable automatic backups, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings  > [[Database Backups]]''' or, prior to WHMCS 8.0, '''Setup > Database Backups'''.
 ==Manual Database Backup==
@@ Line 12: / Line 12: @@
 ==Executing Backup Task Manually==
 The backup options configured are executed once per day via the cron. However, the task can be executed manually to check the configured backup options are working or as a separate cron command configured to execute the backup task more often:
@@ Line 24: / Line 25: @@
 ==Limitations==
 As a database grows, it becomes too big for a PHP script like the WHMCS cron job to handle, due to the amount of data in it exceeding various server limits, usually when the database exceeds 20 MB. The size prevents the system from completing an FTP or Email backup.
@@ Line 44: / Line 46: @@
 ===Onscreen Errors===
-A number of errors may occur onscreen when you generate a manual database backup, or in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' (or '''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier) when generating an automated database backup:
+A number of errors may occur onscreen when you generate a manual database backup, or in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' (or '''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier) when generating an automated database backup:
 ====Table 'xxx' doesn't exist when using LOCK TABLES====

@@ Line 5: / Line 5: @@
 WHMCS can automatically back up your database and upload it to a SFTP/FTP location or email it to a designated email address.
-To enable automatic backups, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Other > [[Database Backups]]'''.
+To enable automatic backups, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings  > [[Database Backups]]'''.
 ==Manual Database Backup==

@@ Line 26: / Line 26: @@
 As a database grows, it becomes too big for a PHP script like the WHMCS cron job to handle, due to the amount of data in it exceeding various server limits, usually when the database exceeds 20 MB. The size prevents the system from completing an FTP or Email backup.
-In this case, we recommend switching to the '''[[#https://docs.whmcs.com/Database_Backups#cPanel_Backup|cPanel Backup]]''' option instead (if you installed WHMCS on a cPanel server). By off-loading the backup tasks from PHP to the cPanel system processes, it allows you to generate much larger backups without impacting performance of your website.
+In this case, we recommend switching to the '''[[Database_Backups#cPanel_Backup|cPanel Backup]]''' option instead (if you installed WHMCS on a cPanel server). By off-loading the backup tasks from PHP to the cPanel system processes, it allows you to generate much larger backups without impacting performance of your website.
 When switching to cPanel or external backups, you will need to ensure that you have disabled the FTP and Email Backup features in your WHMCS installation to prevent errors with the cron due to the large database size.

@@ Line 26: / Line 26: @@
 As a database grows, it becomes too big for a PHP script like the WHMCS cron job to handle, due to the amount of data in it exceeding various server limits, usually when the database exceeds 20 MB. The size prevents the system from completing an FTP or Email backup.
-In this case, we recommend switching to the '''[[#cPanel_Backup|cPanel Backup]]''' option instead (if you installed WHMCS on a cPanel server). By off-loading the backup tasks from PHP to the cPanel system processes, it allows you to generate much larger backups without impacting performance of your website.
+In this case, we recommend switching to the '''[[#https://docs.whmcs.com/Database_Backups#cPanel_Backup|cPanel Backup]]''' option instead (if you installed WHMCS on a cPanel server). By off-loading the backup tasks from PHP to the cPanel system processes, it allows you to generate much larger backups without impacting performance of your website.
 When switching to cPanel or external backups, you will need to ensure that you have disabled the FTP and Email Backup features in your WHMCS installation to prevent errors with the cron due to the large database size.

@@ Line 37: / Line 37: @@
 ==Troubleshooting==
 A number of errors may occur onscreen when you generate a manual database backup, or in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' (or '''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier) when generating an automated database backup:
-===Table 'xxx' doesn't exist when using LOCK TABLES===
+====Table 'xxx' doesn't exist when using LOCK TABLES====
 This indicates that the named table <tt>xxx</tt> has crashed or is corrupted. Running a MySQL® repair operation will resolve this. You can repair tables via the '''MySQL Databases''' page within cPanel or using a tool such as phpMyAdmin.
-===Database backup unavailable due to missing required zip extension===
+====Database backup unavailable due to missing required zip extension====
 This indicates that you need to [http://php.net/manual/en/class.ziparchive.php recompile PHP] after enabling the ZipArchive PHP class, which WHMCS requires to compress the backup.
-===Database backup error 'Please provide a valid dump path'===
+====Database backup error 'Please provide a valid dump path'====
 This indicates that WHMCS is unable to access the <tt>/tmp</tt> working directory during the backup generation process. Make sure that the <tt>[http://php.net/manual/en/ini.core.php#ini.open-basedir open_basedir]</tt> value is ''Off'' in your PHP configuration, and that the PHP <tt>/tmp</tt> directory is writeable and is not full.

@@ Line 3: / Line 3: @@
 ==Automated Database Backup==
-<div class="docs-alert-info"><i class="fa fa-info"></i> We added functionality for automated backups in WHMCS 7.3.</div>
+WHMCS can automatically back up your database and upload it to a SFTP/FTP location or email it to a designated email address.
-WHMCS can automatically back up your database and upload it to a SFTP/FTP location or email it to a designated email address. Starting in WHMCS 7.3, you can also request a full cPanel backup for a specific user as part of the automatic backup process.
+To enable automatic backups, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Other > [[Database Backups]]'''.
 ==Manual Database Backup==
@@ Line 74: / Line 33: @@
 ==Optimise Tables==
 In normal operation, MySQL® tables can generate overhead. You can optimise your databases to reduce this problem at '''Utilities > System > [[Database Status]]'''.

@@ Line 60: / Line 60: @@
 <div class="source-cli">
-php -q cron.php do --databasebackups
+php -q cron.php do --DatabaseBackup
 </div>
 For more information, refer to the [[Crons#Task_Options_for_skip_and_do|Cron documentation]],

@@ Line 57: / Line 57: @@
 ==Executing Backup Task Manually==
-The backup options configured are executed once per day via the cron, however, the task can be executed manually to check the configured backup options are working (or a separate cron command configured to execute the backup task more often):
+The backup options configured are executed once per day via the cron, however, the task can be executed manually to check the configured backup options are working or a separate cron command configured to execute the backup task more often:
 <div class="source-cli">