Personal tools
Namespaces

Variants
Actions

How To Update WHMCS Module

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎DNS Manager For WHMCS Update)
(→‎Update Instructions)
 
(43 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="modulesgarden whmcs modules update, whmcs 5.2 addon modules, whmcs 5.2.2 addon modules, whmcs v.5.2 addon modules, whmcs v.5.2.2 addon modules, whmcs v5.2 addon modules, whmcs v5.2.2 addon modules"></meta>
+
<meta name="keywords" content="modulesgarden whmcs modules update, whmcs products update, whmcs modules update, whmcs modules download, whmcs modules version, whmcs modules upload, update instructions, update guide, whmcs modules upgrade"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About Addons And Modules Update In WHMCS V5.2.2"></meta>
+
<meta name="description" content="We Will Guide You Step By Step And Show You How To Successfully Update Any WHMCS Module Designed By ModulesGarden."></meta>
−
 
+
−
=How To Update WHMCS Module=
+
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|This article will help you go through the process of updating a WHMCS module.<br />
+
|style="padding: 10px 0px 30px 15px;"|Read the below article carefully as it contains crucial information on how to update any of [https://www.modulesgarden.com/products/whmcs ModuelsGarden modules for WHMCS]. <br/>
−
Proceed with steps shown below to complete a basic update.<br />
+
Follow the steps one by one to complete successfully the module update and avoid losing data or any other unexpected issues.<br />You will also find here a current list of additional actions that might be required to perform the update properly.<br/>
−
We will also list additional steps which may be needed.
+
 
 +
Please read the whole article first and then go on with a safe update.
 
|}
 
|}
−
==Basic Update==
+
==Update Instructions==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. In the beginning, please make a backup of your server.'''
+
|style="padding: 10px 0px 15px 15px;"|'''1. Start with making a backup copy of your WHMCS files and database.'''<br/>
 +
This step is crucial as it will let you avoid losing any data in case of unexpected update failure or other issues.
 
|}
 
|}
 +
<!-- TEN KROK JEST JUŻ NIEKATUALNY I W ZASADZIE NIE ZALECAMY DEAKTYWACJI ADDONÓW PRZED WGRANIEM STARYCH
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|2. '''Addon Modules Only:''' Log in to your WHMCS system admin area.<br />
+
|style="padding: 0px 0px 15px 15px;"|2. '''Addon Modules Only:''' Log in to your WHMCS admin area.<br />
−
Go to '' 'Settings' '' → '' 'Addon Modules' '' and deactivate the module you wish to update.<br />
+
Go to '' "Settings" → "Addon Modules" '' and deactivate the module you are going to update.<br />
−
''Note: This step is recommended but skip it if you want to keep your module's settings.''
+
'' '''Note:''' This step is recommended but you may skip it if you want to keep the settings of the module.''
 
|}
 
|}
 +
-->
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|3. Download the latest version of the module from our website.
+
|style="padding: 0px 0px 20px 15px;"|2. Download the latest version of the module from our [https://www.modulesgarden.com/client-area/products client area].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|4. Remove all files of the old module version (except license.php file).
+
|style="padding: 0px 0px 15px 15px;"|3. Remove all the files of the previous module's version from the WHMCS root directory '''(except the license.php file)'''.<br/>
 +
Only in this way all the old and useless hooks will be properly deleted but the module current configuration settings will remain untouched as they are stored in the base.<br/>
 +
'''''Note:''' If you have some attachments or other files uploaded into the module and you do not want to lose them with the update, please do not delete them.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|5. Upload and extract the new files to your WHMCS root directory. They will overwrite the old files.
+
|style="padding: 0px 0px 20px 15px;"|4. Upload and extract the new files into your WHMCS root directory.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|6. Proceed to the module location and remove the '' 'license.php' '' file.<br />
+
|style="padding: 0px 0px 15px 15px;"|5. '''This step is mandatory only in a few cases due to the changes in the packaging system.'''
−
Now, rename '' 'license_RENAME.php' '' to '' 'license.php' '' file and edit it by providing your module license.<br />
+
Proceed to the module's location and remove the '' 'license.php' '' file.<br />
−
''Note: This step is mandatory only in some part of cases, due to changes in the packaging system.''
+
Now, rename '' 'license_RENAME.php' '' to '' 'license.php' '' file and edit it by providing your module's license.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|7. Remove all files from '' '\your_whmcs\template_c\' '' directory.
+
|style="padding: 0px 0px 15px 15px;"|6. Next, move to '' '/your_whmcs/template_c/' '' directory and delete all the files that are inside it except the '' index.php'' file.<br/>
 +
This action will remove cache, which will prevent WHMCS from storing obsolete parts of the module and read the new version correctly.<br/><br/>
 +
'''''Important:''' It is strongly advised to refresh your browser's cache. Visit the target page of the module and press any of the following key combinations simultaneously.<br/> The key combinations may vary depending on the browser or system you are using:''
 +
*''Ctrl + F5''
 +
*''Shift + F5''
 +
*''Ctrl + Shift + R''
 +
*''Command ⌘ + Shift + R (for Mac)''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|8. (Addon Modules Only) Log in to your WHMCS system admin area.<br />
+
|style="padding: 0px 0px 20px 15px;"|7. It is adviced to move to the module's [https://www.docs.modulesgarden.com documentation] and confirm that there are no additional steps required in the '' '''Update Instruction''' '' section.
−
Go to '' 'Settings' '' → '' 'Addon Modules' '' and activate the recently updated module.
+
 
|}
 
|}
−
 
−
==Optional Actions Needed==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|It may happen, that after the update of a module, it still causes a lot of errors.<br />
+
|style="padding: 0px 0px 15px 15px;"|8. '''Addon Modules Only:''' Log in to your WHMCS admin area and proceed to the updated module addon.<br />
−
If so, we advice to check the module's wiki article and check whether additional actions are needed.<br />
+
<!-- to już nieaktualne
−
Especially look for:<br />
+
Go to '' "Settings" '' → '' "Addon Modules" '' and activate the just updated module.
−
1. Folders which need specific chmods.<br />
+
-->
−
2. Earlier settings of chmods which got overwritten.<br />
+
'' '''Important:''' We do '''not''' recommend deactivating the old version of the module addon before updating the new one.<br/>Such action is '''no''' longer required for the module addon to be successfully updated.''
−
3. New cron job added or old cron job removed.<br />
+
−
4. Use of migration tool needed to import settings from earlier version.<br />
+
−
5. Settings removed during the update.<br />
+
−
6. Integration codes that need to be changed after the upgrade. <br/>
+
−
7. Additional steps listed in the installation instruction.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''In case of failure, return to the previous version of the module and [https://www.modulesgarden.com/customers/support  report a problem].'''
+
|style="padding: 0px 0px 30px 15px;"|Once the instructions are carried out, the module update is ready and correct.<br />
 
|}
 
|}
  
−
=How To Update Provisioning Modules For WHMCS V5.2.2=
+
==Additional Instructions==
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|<span style="color: #ff0000">'''If you downloaded our provisioning module/modules before 19.03.2013 and updated your WHMCS to V5.2.2, you need to also update module/modules.''' </span><br />
+
|style="padding: 10px 0px 15px 15px;"|In case of some modules, for example ''SMS Center For WHMCS'', additional steps are required.  
−
<span style="color: #ff0000">'''If you downloaded our provisioning module/modules for the first time on 19.03.2013 or later, you don't need to update anything.''' </span><br />
+
−
'''Please note that since WHMCS V5.2.1, server types nor modules names can not contain the underscore ( <span style="color: #ff0000">_</span> ). '''<br /><br />
+
−
'''Here is the list of modules which require your special attention:'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ cPanel Extended For WHMCS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ DirectAdmin Extended For WHMCS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Plesk Extended For WHMCS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Rackspace Email For WHMCS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Rackspace Email Extended For WHMCS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Zimbra Email For WHMCS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ cPanel Manage2 For WHMCS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Google Apps For WHMCS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ WWD GoDaddy Domaind For WHMCS '''(more details in the following sections)'''
+
−
|}
+
−
{|
+
−
|style="padding: 20px 0px 10px 0px;"|'''Follow these instructions:'''
+
−
|}
+
−
{|
+
−
|style="padding: 10px 0px 10px 15px;"|1. Create backup of your WHMCS system.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|2. Remove old module files from your system.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|3. Download the latest module version from your clientarea.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|4. Upload all the module files into your main WHMCS directory.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|5. Update server/servers type through choosing new module name e.g. '' 'CpanelExtended' '' from a dropdown menu.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:MU1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|6. Update product/products module settings through choosing new module name e.g. '' 'CpanelExtended' '' from a dropdown menu.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:MU2.png]]
+
−
|}
+
  
−
==WWD GoDaddy Domains For WHMCS Update==
+
Please move to the module's documentation page and check whether there are any specific actions required. <br />
−
{|
+
Review  the following sections: '' "Installation", "Update Instructions" '' and '' "Common Problems" '' sections:<br />
−
|style="padding: 10px 0px 10px 0px;"|'''Follow these instructions:'''
+
 
−
|}
+
Search for information on:<br/>
−
{|
+
1. Folders which need specific writing permissions (chmods).<br />
−
|style="padding: 10px 0px 10px 15px;"|1. Create backup of your WHMCS system.
+
2. Previous settings of chmods which were overwritten.<br />
−
|}
+
3. Either a new cron job added or an old one removed.<br />
−
{|
+
4. The use of the migration tool needed to import the settings from the previous version.<br />
−
|style="padding: 0px 0px 10px 15px;"|2. Remove old module files from your system.
+
5. Settings removed during the update.<br />
−
|}
+
6. Integration codes that need to be changed after the update.<br/>
−
{|
+
7. Additional steps listed in the installation instruction.<br/>
−
|style="padding: 0px 0px 10px 15px;"|3. Download the latest module version from your clientarea.
+
8. If you upgraded your WHMCS server from the PHP 5.x to PHP 7.x version, make sure that the uploaded module's package supports the correct PHP version as well.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|4. Upload all the module files into your main WHMCS directory.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|5. Update registrar settings through choosing registrar module '' 'WwdGoDaddy' '' from a dropdown menu. Then enter your Go Daddy API User login and password.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:MU3.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|6. Update domain pricing through choosing '' 'WwdGoDaddy' '' from an 'Auto Registration' '' dropdown menu.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:MU4.png]]
+
−
|}
+
−
==DNS Manager For WHMCS Update==
+
−
{|
+
−
|style="padding: 10px 0px 10px 0px;"|'''While updating DNS Manager to 1.9.10 version - compatible with the latest WHMCS V6.0.x remember to follow the below steps:'''
+
−
|}
+
−
{|
+
−
|style="padding: 10px 0px 10px 15px;"|1. Follow basic update instructions.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|'''IMPORTANT!'''<br/>
+
−
2. Replace your old integration codes from ''clientareahome.tpl'' with the one adequate to your WHMCS version.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|3. Find a very detailed information on the integration codes for each WHMCS and template version [http://www.docs.modulesgarden.com/DNS_Manager_For_WHMCS#Installation HERE,] look at point 5.
+
|style="padding: 0px 0px 30px 15px;"|'''In case of failure, return to the previous version of the module and [https://www.modulesgarden.com/support/ticket/general-support contact us.]'''
 
|}
 
|}

Latest revision as of 16:12, 28 January 2019

Read the below article carefully as it contains crucial information on how to update any of ModuelsGarden modules for WHMCS.

Follow the steps one by one to complete successfully the module update and avoid losing data or any other unexpected issues.
You will also find here a current list of additional actions that might be required to perform the update properly.

Please read the whole article first and then go on with a safe update.

[edit] Update Instructions

1. Start with making a backup copy of your WHMCS files and database.

This step is crucial as it will let you avoid losing any data in case of unexpected update failure or other issues.

2. Download the latest version of the module from our client area.
3. Remove all the files of the previous module's version from the WHMCS root directory (except the license.php file).

Only in this way all the old and useless hooks will be properly deleted but the module current configuration settings will remain untouched as they are stored in the base.
Note: If you have some attachments or other files uploaded into the module and you do not want to lose them with the update, please do not delete them.

4. Upload and extract the new files into your WHMCS root directory.
5. This step is mandatory only in a few cases due to the changes in the packaging system.

Proceed to the module's location and remove the 'license.php' file.
Now, rename 'license_RENAME.php' to 'license.php' file and edit it by providing your module's license.

6. Next, move to '/your_whmcs/template_c/' directory and delete all the files that are inside it except the index.php file.

This action will remove cache, which will prevent WHMCS from storing obsolete parts of the module and read the new version correctly.

Important: It is strongly advised to refresh your browser's cache. Visit the target page of the module and press any of the following key combinations simultaneously.
The key combinations may vary depending on the browser or system you are using:

  • Ctrl + F5
  • Shift + F5
  • Ctrl + Shift + R
  • Command ⌘ + Shift + R (for Mac)
7. It is adviced to move to the module's documentation and confirm that there are no additional steps required in the Update Instruction section.
8. Addon Modules Only: Log in to your WHMCS admin area and proceed to the updated module addon.

Important: We do not recommend deactivating the old version of the module addon before updating the new one.
Such action is no longer required for the module addon to be successfully updated.

Once the instructions are carried out, the module update is ready and correct.

[edit] Additional Instructions

In case of some modules, for example SMS Center For WHMCS, additional steps are required.

Please move to the module's documentation page and check whether there are any specific actions required.
Review the following sections: "Installation", "Update Instructions" and "Common Problems" sections:

Search for information on:
1. Folders which need specific writing permissions (chmods).
2. Previous settings of chmods which were overwritten.
3. Either a new cron job added or an old one removed.
4. The use of the migration tool needed to import the settings from the previous version.
5. Settings removed during the update.
6. Integration codes that need to be changed after the update.
7. Additional steps listed in the installation instruction.
8. If you upgraded your WHMCS server from the PHP 5.x to PHP 7.x version, make sure that the uploaded module's package supports the correct PHP version as well.

In case of failure, return to the previous version of the module and contact us.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=How_To_Update_WHMCS_Module&oldid=43344"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community