Restoring WHMCS - Revision history

SarahK at 18:47, 3 May 2022

2022-05-03T18:47:34Z

Show changes

SarahK: /* Perform Post Restoration Steps */

2022-04-25T20:43:49Z

‎Perform Post Restoration Steps

PeterM at 12:59, 8 December 2021

2021-12-08T12:59:26Z

AlexN: /* Restore the Database Backup */

2021-01-11T14:31:06Z

‎Restore the Database Backup

Nathan: /* Configuration File Template */

2019-03-11T17:42:33Z

‎Configuration File Template

Nathan at 13:49, 25 September 2018

2018-09-25T13:49:41Z

John: Created page with "Data loss is a catastrophic but not unheard of occurrence. Good backups will turn a potentially disastrous situation into regrettable downtime, but if complete backups are not..."

2015-03-09T10:23:17Z

Created page with "Data loss is a catastrophic but not unheard of occurrence. Good backups will turn a potentially disastrous situation into regrettable downtime, but if complete backups are not..."

New page

Data loss is a catastrophic but not unheard of occurrence. Good backups will turn a potentially disastrous situation into regrettable downtime, but if complete backups are not available for restoration, this guide shows how to restore a WHMCS installation from backups of its constituent parts.

The WHMCS is comprised of two main parts; the MySQL database which contains the settings and data, and the files which tell the software how to operate and control its appearance. Provided you have a backup of the database then most data can be salvaged, if you you also have a backup of the configuration.php file then all the data can be recovered.

#The first step is to restore the database backup to your server. Database backups can usually be restored to your hosting account via a web interface such as phpmyadmin. Instructions for doing so are published in our documentation; [[Maintenance#Restoring_a_Database_Backup|Restoring a Database Backup]]
##Your hosting provider will be able to assist in this process if you run into problems.
#Next you need to upload a fresh copy of the WHMCS full release files, these can be downloaded from http://download.whmcs.com or from your reseller.
#Upload the configuration.php file from your file backups.
#You should then be up and running with WHMCS once again. Proceed to step 11.
#If you do not have a backup of the configuration.php file then all password, security questions and credit card data will be scrambled. A new configuration.php file will need to be created using the template at the bottom of this guide.
#The license value should be filled with your full licence key.
#The database connection details (username, password and name) should be entered
##Your hosting provider will be able to advise the values if you're unsure.
#The cc_encryption_hash value should be a random 50 character string comprising lowercase letters and numbers.
#Save and upload the configuration.php file.
#You should then be up and running once again with most of your data in tact.
#Finally it will be necessary to re-create the [[Crons|cron job(s)]] and [[Email_Piping|email forwarders]].

==Sample Configuration.php File==
<source lang="php">
<?php
$license="";
$db_host = "localhost";
$db_username = "";
$db_password = "";
$db_name = "";
$cc_encryption_hash = "";
$templates_compiledir = "templates_c/";
?>
</source>

@@ Line 87: / Line 87: @@
 After restoring a WHMCS installation, it is a good idea to review all configuration sections of the Admin Area and to place a few test orders to ensure that everything is functioning as expected. Below is a short list of steps to take which will address this.
-# Log into the WHMCS Admin Area, and reset your Administrator User password as needed
+# Log in to the WHMCS Admin Area.
-# Review the [[Configuration|General Settings]]
+# If necessary, reset your admin user password.
-# Review the configuration of any existing [[Payment_Gateways|Gateway Modules]]
+# Review the following settings and configurations:
-# Review the configuration of any existing [[Servers|Server Modules]]
+## General settings at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
-# Review the configuration of any existing [[Domains_Configuration#Registrar_Configuration|Registar Modules]]
+## Payment gateways at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup  > Payment Gateways'''.
-# Recreate any needed [[Cron Jobs|Cron Jobs]] and [[Email_Piping|Email Forwarders]]
+## Servers at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup  > Products/Services > Servers'''.
-# Place some test orders on your website to check everything works as expected
+## Domain registrars at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup  > Products/Services > Domain Registrars'''.

@@ Line 25: / Line 25: @@
 #Log in to phpMyAdmin and select the database you want to restore.
 #Click the '''Import''' tab at the top: <br /><br />[[Image:maintenance1.png]] <br /><br />
 #Click the '''Browse''' button.

@@ Line 20: / Line 20: @@
 The first step towards recovering from catastrophic data loss is to restore the database backup to your server.
-Database backups can usually be restored to your hosting account via a web interface such as PHPMyAdmin. For instructions on how to restore a database backup using PHPMyAdmin specifically, please refer to the [[Maintenance#Restoring_a_Database_Backup|Restoring a Database Backup]] section of the documentation.
+Database backups can usually be restored to your hosting account via a web interface such as PHPMyAdmin. Should you run into problems while restoring your database backup, then your hosting provider will be able to assist in this process.
-−
-Should you run into problems while restoring your database backup, then your hosting provider will be able to assist in this process.
+To restore a database:
-−
 == Replace the WHMCS Files ==

@@ Line 66: / Line 66: @@
 <source lang="php">
 <?php
-$license="";
+$license = "";
 $db_host = "localhost";
 $db_username = "";
@@ Line 74: / Line 74: @@
 $templates_compiledir = "templates_c/";
 </source>
-−
 == Perform Post Restoration Steps ==

@@ Line 1: / Line 1: @@
-Data loss is a catastrophic but not unheard of occurrence. Good backups will turn a potentially disastrous situation into regrettable downtime, but if complete backups are not available for restoration, this guide shows how to restore a WHMCS installation from backups of its constituent parts.
+Data loss is a catastrophic, but not unheard of occurrence. This is often mitigated by good backup practices which can turn a potentially disastrous situation into manageable downtime.
-−
-The WHMCS is comprised of two main parts; the MySQL database which contains the settings and data, and the files which tell the software how to operate and control its appearance. Provided you have a backup of the database then most data can be salvaged, if you you also have a backup of the configuration.php file then all the data can be recovered.
+If a complete backup is not available for restoration, then it may be necessary to get WHMCS running again using only a database backup. This guide aims to cover the steps required to restore a WHMCS installation from backups of its constituent parts.
-−
-#The first step is to restore the database backup to your server. Database backups can usually be restored to your hosting account via a web interface such as phpmyadmin. Instructions for doing so are published in our documentation; [[Maintenance#Restoring_a_Database_Backup|Restoring a Database Backup]]
+== Overview ==
-##Your hosting provider will be able to assist in this process if you run into problems.
-#Next you need to upload a fresh copy of the WHMCS full release files, these can be downloaded from http://download.whmcs.com or from your reseller.
+WHMCS is effectively comprised of three key parts: the database, the files, and the configuration file; the database contains all of the settings and data used by WHMCS, the files tell the software how to operate and control its appearance, and the configuration file allows the files to communicate with the database.
-#Upload the configuration.php file from your file backups.
-#You should then be up and running with WHMCS once again. Proceed to step 11.
+Since the database itself contains all of the data, then this means that a WHMCS installation can be restored as long as you have a copy of that database. With that said, restoration can be performed via the following steps:
-#If you do not have a backup of the configuration.php file then all password, security questions and credit card data will be scrambled. A new configuration.php file will need to be created using the template at the bottom of this guide.
-#The license value should be filled with your full licence key.
+# Restore the Database Backup
-#The database connection details (username, password and name) should be entered
+# Replace the WHMCS Files
-##Your hosting provider will be able to advise the values if you're unsure.
+# Replace or Creating the Configuration File
-#The cc_encryption_hash value should be a random 50 character string comprising lowercase letters and numbers.
+# Perform Post Restoration Steps
-#Save and upload the configuration.php file.
-#You should then be up and running once again with most of your data in tact.
+It is recommended that all of these steps be reviewed in full before attempting to recover an installation.
-#Finally it will be necessary to re-create the [[Crons|cron job(s)]] and [[Email_Piping|email forwarders]].
+== Restore the Database Backup ==
-==Sample Configuration.php File==
 <source lang="php">
 <?php
@@ Line 27: / Line 73: @@
 $cc_encryption_hash = "";
 $templates_compiledir = "templates_c/";
 </source>