Difference between revisions of "Backups"
m (→Limitations) |
|||
| Line 1: | Line 1: | ||
| − | + | We strongly recommend that you back up your WHMCS database regularly, so that you always have a copy of your data if a server or system failure occurs. Backing up the database is a very simply task with the built-in backup tool, and you can automate it. | |
==Automated Database Backup== | ==Automated Database Backup== | ||
| − | <div class="docs-alert-info"><i class="fa fa-info"></i> | + | <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 | + | 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. |
| − | |||
| − | |||
==Enabling Automatic Backups== | ==Enabling Automatic Backups== | ||
| − | + | To modify your backup configuration, go to ''Setup > Other > Database Backups''. | |
| − | The available options are SFTP/FTP | + | The available options are '''SFTP/FTP Backup''', '''cPanel Backup''', and '''Daily Email Backups'''. |
===Testing Connection=== | ===Testing Connection=== | ||
| − | The SFTP/FTP and cPanel Backup options require a connection test | + | The '''SFTP/FTP Backup''' and '''cPanel Backup''' options require a successful connection test 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, incurring less chance of a failed connection. |
==SFTP/FTP Backup== | ==SFTP/FTP Backup== | ||
| − | This backup will place the WHMCS generated zipped | + | 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. | + | Checking the "'Use Secure FTP/SFTP (Recommended)'" box will ensure the backup upload is completed using an SFTP connection. |
===FTP Destination=== | ===FTP Destination=== | ||
| − | This value | + | This value is relative to the login folder for the FTP/SFTP account you are using. For example, if, when you log in using your FTP details, the folder is <tt>/home/user/</tt> and the backup will be in <tt>/home/user/backups</tt>, enter <tt>backups/</tt> as the '''FTP Destination'''. |
| − | |||
| − | |||
| − | + | If you intend to upload the backup file to the login folder, leave this field empty. | |
==cPanel Backup== | ==cPanel Backup== | ||
| − | The cPanel Backup option uses the [https:// | + | The '''cPanel Backup''' option uses the [https://docs.cpanel.net/cpanel/files/backup-wizard/ Full Backup] feature of cPanel's backup wizard. |
===cPanel Username=== | ===cPanel Username=== | ||
| − | <div class="docs-alert-info"><i class="fa fa-info"></i> The cPanel Username is the name of the account to | + | <div class="docs-alert-info"><i class="fa fa-info"></i> The '''cPanel Username''' is the name of the account to back up.</div> |
===Backup Destination=== | ===Backup Destination=== | ||
| − | * | + | * '''Remote FTP Server''' — Select this option to use FTP to store the backup file on a remote server. |
| − | + | * '''Remote FTP Server (Passive connection)''' — Select this option to use passive FTP to store the backup file on a remote server. | |
| − | * Remote FTP Server (Passive | + | * '''Secure Copy (SCP)''' — Select this option to use SCP 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. | + | * '''Home Directory''' — Select this option to save the backup file to the server. |
| − | <div class="docs-alert-warning"><i class="fa fa-exclamation-triangle"></i> Using Home Directory will generate the backup file in the home directory | + | <div class="docs-alert-warning"><i class="fa fa-exclamation-triangle"></i> Using '''Home Directory''' will generate the backup file in the cPanel user's home directory. This will count against any disk space limits, and you should manually move it to a better location after completion.</div> |
| − | The | + | The system cron job will only request the start of a full backup. Completion and relocation of the backup occurs within cPanel, and WHMCS will not notify you about the process. |
==Manual Database Backup== | ==Manual Database Backup== | ||
To manually download a backup of the WHMCS database at any time: | To manually download a backup of the WHMCS database at any time: | ||
| − | # | + | #Log in to your WHMCS Admin Area. |
| − | #Go to '''Utilities > System > Database Status''' | + | #Go to '''Utilities > System > Database Status'''. |
| − | #Click the Download | + | #Click the '''Download Database Backup''' button at the top of the page. The system will prompt you to download a file. |
| − | + | #Save the file to your computer. Depending on the database size, this may take a few moments. | |
| − | |||
==Configuration.php Backup== | ==Configuration.php Backup== | ||
| − | The configuration.php file in the main whmcs directory contains the encryption hash value unique to your particular installation, | + | The <tt>configuration.php</tt> file in the main <tt>whmcs</tt> directory. It contains the encryption hash value unique to your particular installation, which encrypts sensitive data. If you lose the encryption hash value, the system won't be able to decrypt your data. Because of this, it is important to keep a backup of this file in a secure location in case reinstallation is necessary. |
==Limitations== | ==Limitations== | ||
| − | As a | + | 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 | + | 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. |
==Optimise Tables== | ==Optimise Tables== | ||
| − | In normal operation | + | In normal operation, MySQL® tables can generate overhead. This is disk space that you have assigned to the table but aren't using. You can use MySQL's <tt>[http://dev.mysql.com/doc/refman/5.1/en/optimize-table.html optimise tables]</tt> function to reduce this. Usually this command is from the server's command line or phpMyAdmin, but it can also be run within WHMCS by clicking '''Optimise Tables''' at '''Utilities > System > Database Status'''. |
==Troubleshooting== | ==Troubleshooting== | ||
| − | A number of errors may occur | + | A number of errors may occur onscreen when you generate a manual database backup, or in the '''Utilities > Logs > Activity Log''' 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 | + | 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 /tmp working directory during the backup generation process. | + | 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. |
Revision as of 17:59, 12 May 2020
We strongly recommend that you back up your WHMCS database regularly, so that you always have a copy of your data if a server or system failure occurs. Backing up the database is a very simply task with the built-in backup tool, and you can automate it.
Contents
Automated Database Backup
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.
Enabling Automatic Backups
To modify your backup configuration, go to Setup > Other > Database Backups.
The available options are SFTP/FTP Backup, cPanel Backup, and Daily Email Backups.
Testing Connection
The SFTP/FTP Backup and cPanel Backup options require a successful connection test 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, incurring 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 is relative to the login folder for the FTP/SFTP account you are using. For example, if, when you log in using your FTP details, the folder is /home/user/ and the backup will be in /home/user/backups, enter backups/ as the FTP Destination.
If you intend to upload the backup file to the login folder, leave this field empty.
cPanel Backup
The cPanel Backup option uses the Full Backup feature of cPanel's backup wizard.
cPanel Username
Backup Destination
- Remote FTP Server — Select this option to use FTP to store the backup file on a remote server.
- Remote FTP Server (Passive connection) — Select this option to use passive FTP to store the backup file on a remote server.
- Secure Copy (SCP) — Select this option to use SCP to store the backup file on a remote server.
- Home Directory — Select this option to save the backup file to the server.
The system cron job will only request the start of a full backup. Completion and relocation of the backup occurs within cPanel, and WHMCS will not notify you about the process.
Manual Database Backup
To manually download a backup of the WHMCS database at any time:
- Log in to your WHMCS Admin Area.
- Go to Utilities > System > Database Status.
- Click the Download Database Backup button at the top of the page. The system will prompt you to download a file.
- Save the file to your computer. Depending on the database size, this may take a few moments.
Configuration.php Backup
The configuration.php file in the main whmcs directory. It contains the encryption hash value unique to your particular installation, which encrypts sensitive data. If you lose the encryption hash value, the system won't be able to decrypt your data. Because of this, it is important to keep a backup of this file in a secure location in case reinstallation is necessary.
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.
In this case, we recommend switching to the 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.
Optimise Tables
In normal operation, MySQL® tables can generate overhead. This is disk space that you have assigned to the table but aren't using. You can use MySQL's optimise tables function to reduce this. Usually this command is from the server's command line or phpMyAdmin, but it can also be run within WHMCS by clicking Optimise Tables at Utilities > System > Database Status.
Troubleshooting
A number of errors may occur onscreen when you generate a manual database backup, or in the Utilities > Logs > Activity Log when generating an automated database backup:
Table 'xxx' doesn't exist when using LOCK TABLES
This indicates that the named table xxx 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.
This indicates that you need to recompile PHP after enabling the ZipArchive PHP class, which WHMCS requires to compress the backup.
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. Make sure that the open_basedir value is Off in your PHP configuration, and that the PHP /tmp directory is writeable and is not full.