Difference between revisions of "Uninstall WHMCS"

From WHMCS Documentation

(Disable Email Piping and Importing)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
There are times when a user has the need to remove WHMCS from their system.
+
==Overview==
  
This can be achieved by following 5 small steps:
+
Should you need to uninstall WHMCS from your web server, then this can be accomplished by removing the files, data, and cron jobs that make up the installation. We have put together a short guide below which can aide in accomplishing this.
  
#'''Take a backup of the database and configuration.php file. You may need these at a later date should you want to start using WHMCS again.'''
+
<div class="docs-alert-danger">
#'''Remove all the related files and folders of WHMCS from your server. Below you will find a list of relevant folders/files to remove should you be unsure.'''
+
<span class="title">Note:</span> Before removing WHMCS entirely, we recommend first backing up the configuration.php file and database as per the [[Backups#Manual_Database_Backup|Manual Database Backup]] guide. These backups can be used to restore WHMCS should you wish to continue using it in the future. More information about this can be found on the [[Restoring_WHMCS|Restoring WHMCS]] documentation page.
#'''Remove the database tables relating to your WHMCS information.'''
+
</div>
#'''Ensure all Cron Jobs have been cancelled.'''
 
#'''Ensure all email piping is disabled.'''
 
  
==Folders==
+
==Removing WHMCS==
  
*Admin folder
+
Removing a WHMCS installation can be broken down into the 4 following steps:
*Attachments folder
 
*Crons folder
 
*Downloads folder
 
*Feeds folder
 
*Images folder
 
*Includes folder
 
*Lang folder
 
*Modules folder
 
*Pipe folder
 
*Status folder
 
*Templates folder
 
*Templates_c folder
 
  
==Files==
+
# Delete the WHMCS Files and Folders
 +
# Delete the Database
 +
# Delete Existing Cron Jobs
 +
# Disable Email Piping
  
*aff.php
+
Each of the four steps is addressed in detail in the following sections of this guide. Once all of the steps have been completed, the installation will have been successfully removed.
*affiliates.php
+
 
*announcements.php
+
===Delete the WHMCS Files and Folders===
*announcementsrss.php
+
 
*banned.php
+
The first step to removing WHMCS would be to remove all files and folders that make up the WHMCS installation. This would typically be every file and folder found within your WHMCS directory, however if there are a number of non-WHMCS files located there as well, then differentiating whether a file is associated with WHMCS or not could prove difficult.
*cart.php
+
 
*clientarea.php
+
To this end we have put together a list of the WHMCS files and folders that we would expect to see in a WHMCS directory. This list can be found below in the [[Uninstall_WHMCS#Files_and_Folders|Files and Folders]] section.
*configuressl.php
+
 
*contact.php
+
===Delete the Database===
*creditcard.php
+
 
*dbconnect.php
+
The database is the second most integral part of a WHMCS installation. As such, the next step would be to delete the database from the web server.
*dl.php
+
 
*dologin.php
+
This could be accomplish via a variety of methods such as via PHPMyAdmin, the mysql cli, or with the aid of a control panel such as cPanel or Plesk.
*domainchecker.php
+
 
*downloads.php
+
<div class="docs-alert-warning">
*index.php
+
<span class="title">External Resources</span>
*knowledgebase.php
+
* [https://documentation.cpanel.net/display/74Docs/MySQL+Databases Managing Databases with cPanel]
*link.php
+
* [https://docs.plesk.com/en-US/onyx/customer-guide/advanced-website-databases.69535/ Managing Databases with Plesk]
*login.php
+
</div>
*logout.php
+
 
*networkissues.php
+
===Delete Existing Cron Jobs===
*networkissuesrss.php
+
 
*pwreset.php
+
A few cron jobs may have been configured to handle automated processes for the WHMCS installation. You will want to identify any configured cron jobs, and then delete these from the server.
*register.php
+
 
*serverstatus.php
+
The following are the most common files to have cron jobs configured to run:
*submitticket.php
+
 
*supporttickets.php
+
* cron.php
*upgrade.php
+
* domainsync.php
*viewemail.php
+
* pop.php
*viewinvoice.php
+
 
*viewquote.php
+
For more information on cron jobs in WHMCS please refer to the [[Crons|Crons]] documentation page.
*viewticket.php
+
 
*whois.php
+
<div class="docs-alert-warning">
 +
<span class="title">External Resources</span>
 +
* [https://documentation.cpanel.net/display/74Docs/Cron+Jobs Managing Cron Jobs with cPanel]
 +
* [https://docs.plesk.com/en-US/onyx/customer-guide/scheduling-tasks.65207/ Managing Scheduled Tasks with Plesk]
 +
</div>
 +
 
 +
===Disable Email Piping and Importing===
 +
 +
If WHMCS was configured to automatically pipe or import emails into the ticket system, make sure to disable piping or importing.
 +
 +
* For email piping, delete any forwarders that currently pipe mail to <tt>pipe.php</tt>.
 +
* For email importing, delete the <tt>/crons/pop.php</tt> file.
 +
 +
For more information, see [[Email_Piping|Email Piping]] and [[Email Importing]].
 +
 
 +
==Files and Folders==
 +
 
 +
===Files===
 +
 
 +
<source>
 +
aff.php
 +
affiliates.php
 +
announcements.php
 +
announcementsrss.php
 +
banned.php
 +
cart.php
 +
clientarea.php
 +
configuration.php
 +
configuressl.php
 +
contact.php
 +
creditcard.php
 +
dist.loghandler.php
 +
dl.php
 +
dologin.php
 +
domainchecker.php
 +
downloads.php
 +
index.php
 +
init.php
 +
knowledgebase.php
 +
link.php
 +
login.php
 +
logout.php
 +
networkissues.php
 +
networkissuesrss.php
 +
pwreset.php
 +
register.php
 +
serverstatus.php
 +
submitticket.php
 +
supporttickets.php
 +
unsubscribe.php
 +
upgrade.php
 +
viewemail.php
 +
viewinvoice.php
 +
viewquote.php
 +
viewticket.php
 +
whois.php
 +
</source>
 +
 
 +
===Folders===
 +
 
 +
<source>
 +
admin
 +
assets
 +
attachments
 +
crons
 +
downloads
 +
feeds
 +
includes
 +
lang
 +
modules
 +
oauth
 +
pipe
 +
resources
 +
status
 +
templates
 +
templates_c
 +
vendor
 +
</source>

Latest revision as of 15:34, 29 December 2020

Overview

Should you need to uninstall WHMCS from your web server, then this can be accomplished by removing the files, data, and cron jobs that make up the installation. We have put together a short guide below which can aide in accomplishing this.

Note: Before removing WHMCS entirely, we recommend first backing up the configuration.php file and database as per the Manual Database Backup guide. These backups can be used to restore WHMCS should you wish to continue using it in the future. More information about this can be found on the Restoring WHMCS documentation page.

Removing WHMCS

Removing a WHMCS installation can be broken down into the 4 following steps:

  1. Delete the WHMCS Files and Folders
  2. Delete the Database
  3. Delete Existing Cron Jobs
  4. Disable Email Piping

Each of the four steps is addressed in detail in the following sections of this guide. Once all of the steps have been completed, the installation will have been successfully removed.

Delete the WHMCS Files and Folders

The first step to removing WHMCS would be to remove all files and folders that make up the WHMCS installation. This would typically be every file and folder found within your WHMCS directory, however if there are a number of non-WHMCS files located there as well, then differentiating whether a file is associated with WHMCS or not could prove difficult.

To this end we have put together a list of the WHMCS files and folders that we would expect to see in a WHMCS directory. This list can be found below in the Files and Folders section.

Delete the Database

The database is the second most integral part of a WHMCS installation. As such, the next step would be to delete the database from the web server.

This could be accomplish via a variety of methods such as via PHPMyAdmin, the mysql cli, or with the aid of a control panel such as cPanel or Plesk.

Delete Existing Cron Jobs

A few cron jobs may have been configured to handle automated processes for the WHMCS installation. You will want to identify any configured cron jobs, and then delete these from the server.

The following are the most common files to have cron jobs configured to run:

  • cron.php
  • domainsync.php
  • pop.php

For more information on cron jobs in WHMCS please refer to the Crons documentation page.

Disable Email Piping and Importing

If WHMCS was configured to automatically pipe or import emails into the ticket system, make sure to disable piping or importing.

  • For email piping, delete any forwarders that currently pipe mail to pipe.php.
  • For email importing, delete the /crons/pop.php file.

For more information, see Email Piping and Email Importing.

Files and Folders

Files

aff.php
affiliates.php
announcements.php
announcementsrss.php
banned.php
cart.php
clientarea.php
configuration.php
configuressl.php
contact.php
creditcard.php
dist.loghandler.php
dl.php
dologin.php
domainchecker.php
downloads.php
index.php
init.php
knowledgebase.php
link.php
login.php
logout.php
networkissues.php
networkissuesrss.php
pwreset.php
register.php
serverstatus.php
submitticket.php
supporttickets.php
unsubscribe.php
upgrade.php
viewemail.php
viewinvoice.php
viewquote.php
viewticket.php
whois.php

Folders

admin
assets
attachments
crons
downloads
feeds
includes
lang
modules
oauth
pipe
resources
status
templates
templates_c
vendor