How To Update WHMCS Module
From ModulesGarden Wiki
(Difference between revisions)
(→Update Instructions) |
|||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <meta name="keywords" content="modulesgarden whmcs modules update, whmcs products update, whmcs modules, whmcs modules download, whmcs modules version, whmcs modules upload, update instructions, update guide"></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=" | + | <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;"| | + | |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/> |
| − | Follow the steps | + | 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/> |
| − | + | ||
| + | Please read the whole article first and then go on with a safe update. | ||
|} | |} | ||
==Update Instructions== | ==Update Instructions== | ||
{| | {| | ||
| − | |style="padding: 10px 0px | + | |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 admin area.<br /> | |style="padding: 0px 0px 15px 15px;"|2. '''Addon Modules Only:''' Log in to your WHMCS admin area.<br /> | ||
| − | Go to '' | + | 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 | + | '' '''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;"| | + | |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 | + | |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;"| | + | |style="padding: 0px 0px 20px 15px;"|4. Upload and extract the new files into your WHMCS root directory. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"| | + | |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's license. | + | 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. | |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"| | + | |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 | + | |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. |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 15px;"|Once | + | |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 /> |
| − | + | <!-- to już nieaktualne | |
| + | Go to '' "Settings" '' → '' "Addon Modules" '' and activate the just updated module. | ||
| + | --> | ||
| + | '' '''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.'' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 15px;"|Once the instructions are carried out, the module update is ready and correct.<br /> | ||
|} | |} | ||
| − | ==Additional | + | ==Additional Instructions== |
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|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. <br /> | |
| − | 1. Folders which need specific | + | Review the following sections: '' "Installation", "Update Instructions" '' and '' "Common Problems" '' sections:<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 | + | 4. The use of the migration tool needed to import the settings from the 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/> | ||
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. 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. |
| 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. |
| 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.
|
| 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. |
| 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. Search for information on: |
| In case of failure, return to the previous version of the module and contact us. |