Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Update Instructions)
Line 2: Line 2:
 
<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>
 
<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>
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Read the below article carefully as it contains crucial information on how to update any of ModuelsGarden modules For WHMCS. <br/>
+
|style="padding: 10px 0px 30px 15px;"|This article will help you go through the process of updating any WHMCS module.<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/>
+
Follow the steps presented below to complete a basic module's update.<br />
−
 
+
Additionally, you can view the list of additional actions that might be required to conduct the update mechanism properly.
−
Please read the whole article first and then go on with a safe update.
+
 
|}
 
|}
 
==Update Instructions==
 
==Update Instructions==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''1. Start with making a backup copy of your WHMCS files and database.'''<br/>
+
|style="padding: 10px 0px 20px 15px;"|'''1. In the beginning, please make a backup 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.
+
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|2. '''Addon Modules Only:''' Log in to your WHMCS 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 are going to update.<br />
+
Go to '' 'Settings' '' → '' 'Addon Modules' '' and deactivate the module you wish to update.<br />
−
'' '''Note:''' This step is recommended but you may skip it if you want to keep the settings of the module.''
+
'' '''Note:''' This step is recommended but skip it if you want to keep your current module's settings.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|3. Download the latest version of the module from your client area.
+
|style="padding: 0px 0px 20px 15px;"|3. Download the latest version of the module from our website.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|4. Remove all the files of the previous module's version from the WHMCS root directory '''(except the license.php file)'''.<br/>
+
|style="padding: 0px 0px 20px 15px;"|4. Remove all files of the previous module's version (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.<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 into your WHMCS root directory.
+
|style="padding: 0px 0px 20px 15px;"|5. Upload and extract the new files into your WHMCS root directory. They will overwrite the old files.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|6. '''This step is mandatory only in a few cases due to the changes in the packaging system.'''
+
|style="padding: 0px 0px 15px 15px;"|6. Proceed to the module's location and remove the '' 'license.php' '' file.<br />
−
Proceed to the module's location and remove the '' 'license.php' '' file.<br />
+
Now, rename '' 'license_RENAME.php' '' to '' 'license.php' '' file and edit it by providing your module's license.<br />
−
Now, rename '' 'license_RENAME.php' '' to '' 'license.php' '' file and edit it by providing your module's license.
+
'' '''Note:''' This step is mandatory only in a few cases, due to the changes in the packaging system.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|7. Next, move to '' '\your_whmcs\template_c\' '' directory and delete all the files that are inside it except the '' index.php'' file.<br/>
+
|style="padding: 0px 0px 15px 15px;"|7. Remove all files from the '' '\your_whmcs\template_c\' '' directory.<br/>
−
'' '''Note:''' This action will remove cache, which will prevent WHMCS from storing obsolete parts of the module and read the new version correctly.''
+
'' '''Note:''' This will remove cache, which will prevent WHMCS from storing obsolete parts of the module and read the new version.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|8. It is adviced to move to the module's [https://www.docs.modulesgarden.com/Main_Page documentation] and confirm that there are no additional steps required in the Update Instruction section.
+
|style="padding: 0px 0px 15px 15px;"|8. '''Addon Modules Only:''' Log in to your WHMCS admin area.<br />
 +
Go to '' 'Settings' '' → '' 'Addon Modules' '' and activate the recently updated module.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|9. '''Addon Modules Only:''' Log in to your WHMCS admin area.<br />
+
|style="padding: 0px 0px 30px 15px;"|Once these instructions are carried out, your module should be updated correctly.<br />
−
Go to '' "Settings" '' → '' "Addon Modules" '' and activate the just updated module.
+
Otherwise, please refer to the additional steps described below.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|Once the instructions are carried out, the module update is ready and correct.<br />
+
 
|}
 
|}
  
−
==Additional Instructions==
+
==Additional Guidance==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In case of some modules, for example SMS Center For WHMCS, additional steps are required.  
+
|style="padding: 10px 0px 15px 15px;"|It may happen that after the update of a module, additional steps still have to be taken in order to ensure its proper functioning.<br />
−
 
+
If so, we advise you to check the module's documentation and see whether some specific actions are needed.<br /><br />
−
Please move to the module's documentation page and check whether there are any specific actions required. <br />
+
In particular, search for the following elements:<br />
−
Review  the following sections: '' "Installation", "Update Instructions" ''  and '' "Common Problems" '' sections:<br />
+
1. Folders which need specific write permissions (chmods).<br />
−
 
+
−
Search for information on:<br/>
+
−
1. Folders which need specific writing permissions (chmods).<br />
+
 
2. Previous settings of chmods which were overwritten.<br />
 
2. Previous settings of chmods which were overwritten.<br />
 
3. Either a new cron job added or an old one removed.<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 />
+
4. The use of the migration tool needed to import the settings from a previous version.<br />
 
5. Settings removed during the update.<br />
 
5. Settings removed during the update.<br />
 
6. Integration codes that need to be changed after the update.<br/>
 
6. Integration codes that need to be changed after the update.<br/>

Revision as of 12:41, 30 August 2018

This article will help you go through the process of updating any WHMCS module.

Follow the steps presented below to complete a basic module's update.
Additionally, you can view the list of additional actions that might be required to conduct the update mechanism properly.

Update Instructions

1. In the beginning, please make a backup of your WHMCS files and database.
2. Addon Modules Only: Log in to your WHMCS admin area.

Go to 'Settings' → 'Addon Modules' and deactivate the module you wish to update.
Note: This step is recommended but skip it if you want to keep your current module's settings.

3. Download the latest version of the module from our website.
4. Remove all files of the previous module's version (except the license.php file).
5. Upload and extract the new files into your WHMCS root directory. They will overwrite the old files.
6. 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.
Note: This step is mandatory only in a few cases, due to the changes in the packaging system.

7. Remove all files from the '\your_whmcs\template_c\' directory.

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

8. Addon Modules Only: Log in to your WHMCS admin area.

Go to 'Settings' → 'Addon Modules' and activate the recently updated module.

Once these instructions are carried out, your module should be updated correctly.

Otherwise, please refer to the additional steps described below.

Additional Guidance

It may happen that after the update of a module, additional steps still have to be taken in order to ensure its proper functioning.

If so, we advise you to check the module's documentation and see whether some specific actions are needed.

In particular, search for the following elements:
1. Folders which need specific write 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 a 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=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=40921"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community