CPanel Extended For WHMCS
(→About cPanel Extended For WHMCS) |
(→Tips) |
||
(40 intermediate revisions by 2 users not shown) | |||
Line 32: | Line 32: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 30px;"|✔ Configure Email Accounts Initial Settings And Resource Limits | |style="padding: 0px 0px 0px 30px;"|✔ Configure Email Accounts Initial Settings And Resource Limits | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ View All cPanel And cPanel Extended Products And Servers In One Place | ||
|} | |} | ||
{| | {| | ||
Line 40: | Line 43: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ View | + | |style="padding: 0px 0px 0px 30px;"|✔ View And Manage Queue Tasks |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Customize Module Language Files With "Translations" Tool | ||
|} | |} | ||
{| | {| | ||
Line 108: | Line 114: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 45px;"|✔ IP Blocker | |style="padding: 0px 0px 0px 45px;"|✔ IP Blocker | ||
− | |||
− | |||
− | |||
|} | |} | ||
{| | {| | ||
Line 153: | Line 156: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 45px;"|✔ [https://www.modulesgarden.com/products/whmcs/wordpress-manager WordPress Manager] - Separate Module Required | |style="padding: 0px 0px 0px 45px;"|✔ [https://www.modulesgarden.com/products/whmcs/wordpress-manager WordPress Manager] - Separate Module Required | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 60px;"|✔ In Module Version 4.0.0 Native Support Was Temporarily Withdrawn Until Further Update | ||
|} | |} | ||
{| | {| | ||
Line 256: | Line 262: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support | + | |style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support With Custom Translations Tool |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8. | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.2 Back To PHP 8.1 |
|} | |} | ||
{| | {| | ||
Line 268: | Line 274: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8. | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.11 Back To WHMCS V8.8 |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader | + | |style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V13 Or Later |
|} | |} | ||
{| | {| | ||
Line 290: | Line 296: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''2 | + | |style="padding: 0px 0px 15px 15px;"|'''2. Extract the package and upload its content into the main WHMCS directory. |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
The content of the package to upload should look like this. | The content of the package to upload should look like this. | ||
|} | |} | ||
Line 315: | Line 303: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''3. When you install cPanel Extended For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br /> |
− | The file is located in '' 'modules/servers/ | + | The file is located in '' 'modules/servers/CpanelExtended/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' ''. |
|} | |} | ||
{| | {| | ||
Line 322: | Line 310: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br /> |
Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products' ''. | Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products' ''. | ||
|} | |} | ||
Line 329: | Line 317: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''5. In the next step, set up the '' 'storage' '' folder as recursively writable.'''<br /> |
This folder is available at '''two''' locations: | This folder is available at '''two''' locations: | ||
# '' your_whmcs/modules/addons/CpanelExtended/ '' | # '' your_whmcs/modules/addons/CpanelExtended/ '' | ||
− | # '' your_whmcs/modules/servers/ | + | # '' your_whmcs/modules/servers/CpanelExtended/ '' |
|} | |} | ||
{| | {| | ||
Line 338: | Line 326: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 15px; color: #ff0000;"|''' If you are updating your module from version | + | |style="padding: 0px 0px 30px 15px; color: #ff0000;"|''' If you are updating your module from version to 4.0.0, you have to perform additional steps described in the [[#Update_Instructions|Update Instructions.]]'''<br /> |
|} | |} | ||
==Activation of Addon== | ==Activation of Addon== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|''' | + | |style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br /> |
− | Log in to your WHMCS admin area. | + | Log in to your WHMCS admin area. Find '' 'System Settings' '' and open the '' 'Addon Modules'. ''<br/> |
Afterwards, find '' 'cPanel Extended Center' '' and press the '' 'Activate' '' button. | Afterwards, find '' 'cPanel Extended Center' '' and press the '' 'Activate' '' button. | ||
|} | |} | ||
Line 351: | Line 339: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''7. In the next step, you need to permit access to this module.'''<br /> |
To do so, click on the '' 'Configure' '' button, tick the desired admin roles and press '' 'Save Changes'. ''<br /> | To do so, click on the '' 'Configure' '' button, tick the desired admin roles and press '' 'Save Changes'. ''<br /> | ||
|} | |} | ||
Line 358: | Line 346: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 15px;"|''' | + | |style="padding: 0px 0px 30px 15px;"|'''8. Optionally, add a cron job as shown below (5-minute intervals are recommended).''' |
− | + | php -q /your_whmcs/modules/addons/CpanelExtended/cron/cron.php queue | |
+ | This cron will automatically queue and handle the IP unbanning function.<br/> | ||
+ | In the '' 'Queue' '' section of the addon, you will find a personalized command for the cron on your server.<br/> | ||
+ | The cron can also be executed every single minute to perform the action more often, but this increases the WHMCS server load.<br/> | ||
+ | You may access the addon under '' 'Addons' '' → '' 'cPanel Extended'. '' | ||
|} | |} | ||
==Configuration of Server== | ==Configuration of Server== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|''' | + | |style="padding: 10px 0px 15px 15px;"|'''9. To begin, you must add a new server.'''<br /> |
− | Go to '' ' | + | Go to '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server'. '' |
|} | |} | ||
{| | {| | ||
Line 371: | Line 363: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''10. Enter your server name, IP address, username and password. Choose '' 'cPanelExtended' '' from the dropdown menu and press '' 'Save Changes'. '''''<br /> |
− | If you connect with your cPanel server via SSL, then make sure that you | + | If you connect with your cPanel server via SSL, then make sure that you check the '' 'Secure' '' field located at the bottom of the page.<br /> |
'''''Note:''' Keep in mind that the URLs of the 'Login to Webmail' and 'Login to cPanel' buttons located in the client area derive from the 'Hostname' or 'IP Address' fields.'' | '''''Note:''' Keep in mind that the URLs of the 'Login to Webmail' and 'Login to cPanel' buttons located in the client area derive from the 'Hostname' or 'IP Address' fields.'' | ||
|} | |} | ||
Line 379: | Line 371: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''11. Once your server has been configured correctly, you will see the following screen.'''<br /> |
Create a new group for your server. Press '' 'Create New Group' '' to proceed. | Create a new group for your server. Press '' 'Create New Group' '' to proceed. | ||
|} | |} | ||
Line 386: | Line 378: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|''' | + | |style="padding: 0px 0px 20px 15px;"|'''12. Enter the group name, select your previously created server, press '' 'Add', '' and then '' 'Save Changes'.'' ''' |
|} | |} | ||
{| | {| | ||
Line 394: | Line 386: | ||
==Configuration of Product== | ==Configuration of Product== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|''' | + | |style="padding: 10px 0px 15px 15px;"|'''13. In order to create a product, go to '' 'System Settings' '' → '' 'Products/Services' ''.'''<br /> |
If you do not have a product group, click on '' 'Create a New Group' ''. If you do, simply skip step 13. | If you do not have a product group, click on '' 'Create a New Group' ''. If you do, simply skip step 13. | ||
|} | |} | ||
Line 401: | Line 393: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|''' | + | |style="padding: 0px 0px 20px 15px;"|'''14. Fill in a product group name and press '' 'Save Changes'. '' ''' |
|} | |} | ||
{| | {| | ||
Line 407: | Line 399: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|''' | + | |style="padding: 0px 0px 20px 15px;"|'''15. When you have a product group added, you can start creating a new product. |
|} | |} | ||
{| | {| | ||
Line 413: | Line 405: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''16. Choose your product type and product group from dropdown menus, then enter your product name and select the used module: '' 'cPanel Extended'. ''<br/> |
Press '' 'Continue' '' to go on. | Press '' 'Continue' '' to go on. | ||
|} | |} | ||
Line 420: | Line 412: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''17. Now, go to the '' 'Module Settings' '' section, choose the previously created server group from dropdown menu and press'' 'Save Changes' ''.'''<br /> |
'''Important:''' Setting cPanel theme is required for some features to work properly.<br /> | '''Important:''' Setting cPanel theme is required for some features to work properly.<br /> | ||
Configure your WHM Package here if you wish. | Configure your WHM Package here if you wish. | ||
Line 428: | Line 420: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''18. If you want to enable CloudLinux features for your product, simply select this option. '''<br /> |
Now, you can put limits for your clients' resources regarding: | Now, you can put limits for your clients' resources regarding: | ||
*CPU Usage | *CPU Usage | ||
Line 454: | Line 446: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''19. You may set up several options that will be applied to the product when creating one:''' |
*Configure the '' "Mail Node", "Mailbox Format" '' and the '' "Contact Email" '' options | *Configure the '' "Mail Node", "Mailbox Format" '' and the '' "Contact Email" '' options | ||
*Define the limits of the '' "Deferred/Failed Emails", "Emails Per Hour" '' and the '' "Email Account Quota" '' | *Define the limits of the '' "Deferred/Failed Emails", "Emails Per Hour" '' and the '' "Email Account Quota" '' | ||
Line 504: | Line 496: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''24 | + | |style="padding: 0px 0px 15px 15px;"|'''24. Finally, decide whether to allow your clients to create email accounts with an unlimited quota.<br/> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
If you disable this option here, you may then set the quota limit per created account.<br/> | If you disable this option here, you may then set the quota limit per created account.<br/> | ||
'''Do not forget to '' 'Save' '' the changes once the product configuration is ready!''' | '''Do not forget to '' 'Save' '' the changes once the product configuration is ready!''' | ||
Line 520: | Line 504: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''25. If you already have another product configured, you may copy its configuration. <br/> |
Find the '' 'Copy' '' button on the list with products or select multiple item at once. <br/> | Find the '' 'Copy' '' button on the list with products or select multiple item at once. <br/> | ||
Then choose the product configuration that settings you wish to copy into the selected products.<br/> | Then choose the product configuration that settings you wish to copy into the selected products.<br/> | ||
Line 528: | Line 512: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''26. From now on, all your clients who ordered a previously created product will be able to manage their cPanel accounts via your WHMCS system.'''<br /> |
The screen below presents a summary view of the ordered product in admin area. Among the available actions you will find: | The screen below presents a summary view of the ordered product in admin area. Among the available actions you will find: | ||
*'' 'Log In To Control Panel' '' | *'' 'Log In To Control Panel' '' | ||
Line 540: | Line 524: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px | + | |style="padding: 0px 0px 20px 30px;"|[[File:CP21.png]] |
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
+ | |||
===Upgrade cPanel to cPanel Extended Product=== | ===Upgrade cPanel to cPanel Extended Product=== | ||
{| | {| | ||
Line 561: | Line 543: | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:CP73.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:CP73.png]] | ||
+ | |} | ||
+ | ===Queue=== | ||
+ | {| | ||
+ | |style="padding: 10px 0px 15px 15px;"|'''The '' 'Queue' '' section is where the '' 'Unban IP' '' actions are queued and automatically run by an optional cron job.'''<br/> | ||
+ | You will find the information on the cron itself at the top of this section. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:CP_Q1.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 15px;"|The list of the queued requests can be viewed, inspected, and managed manually. Use the action buttons to see each request's details, manually run it, or delete it. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:CP_Q2.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 15px;"|Multiple tasks can be deleted at once via the mass selection feature. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:CP_Q3.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 15px 15px;"|The auto prune system can be set up to automatically delete tasks after a specified time.<br/> | ||
+ | This feature can be found under additional actions. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 25px;"|[[File:CP_Q4.png]] | ||
+ | |} | ||
+ | |||
+ | ===[https://www.docs.modulesgarden.com/Translations_Tool Translations]=== | ||
+ | {| | ||
+ | |style="padding: 10px 0px 15px 15px;"|Customizing language files is now extremely easy with the '' "Translations" '' tool that is now available directly in the addon.<br.> Its user-friendly design makes managing various language file tweaks a smooth and efficient process. <br/> | ||
+ | Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it [https://www.docs.modulesgarden.com/Translations_Tool here]. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 25px;"|[[File:CP_T.png]] | ||
|} | |} | ||
Line 587: | Line 605: | ||
|style="padding: 0px 0px 15px 15px;"|These are the names of values that you can enter in the fields of configurable options. We will configure them in the next step.<br /> | |style="padding: 0px 0px 15px 15px;"|These are the names of values that you can enter in the fields of configurable options. We will configure them in the next step.<br /> | ||
For example, if you would like to set up '' 'Drupal' '' in your applications list, you will need to enter the '' 'Drupal 8.6.2' '' or '' 'Drupal' '' value.<br /> | For example, if you would like to set up '' 'Drupal' '' in your applications list, you will need to enter the '' 'Drupal 8.6.2' '' or '' 'Drupal' '' value.<br /> | ||
− | '''1. If you have made a mistake with the application name, the auto installer will not work.'''<br /> | + | '''1. If you have made a mistake with the application name, the auto-installer will not work.'''<br /> |
− | '''2. If you do not enter the version number, the auto installer will install the latest version of the application.'''<br /> | + | '''2. If you do not enter the version number, the auto-installer will install the latest version of the application.'''<br /> |
Now that you know what values should be entered in configurable options for particular applications, we can proceed further. | Now that you know what values should be entered in configurable options for particular applications, we can proceed further. | ||
|} | |} | ||
Line 595: | Line 613: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Go to your | + | |style="padding: 0px 0px 20px 15px;"|Go to your WHMCS: '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Configurable Options' '' and press '' 'Create a New Group'.'' |
|} | |} | ||
{| | {| | ||
Line 601: | Line 619: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Enter the group name of your choice, select the product to which you want to assign configurable, then press '' 'Save Changes' '' | + | |style="padding: 0px 0px 20px 15px;"|Enter the group name of your choice, select the product to which you want to assign configurable options, then press '' 'Save Changes'.'' |
|} | |} | ||
{| | {| | ||
Line 607: | Line 625: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Now click on '' 'Add New Configurable Option' '' | + | |style="padding: 0px 0px 20px 15px;"|Now click on '' 'Add New Configurable Option'.'' |
|} | |} | ||
{| | {| | ||
Line 757: | Line 775: | ||
|style="padding: 0px 0px 20px 25px;"|[[File:CP42.png]] | |style="padding: 0px 0px 20px 25px;"|[[File:CP42.png]] | ||
|} | |} | ||
+ | <!-- | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|Use the '' 'Search' '' box to find the application you need and install it.<br/> For presentation purposes we will install '' 'PrestaShop' '' located in the '' 'eCommerce' category. '' | |style="padding: 0px 0px 15px 15px;"|Use the '' 'Search' '' box to find the application you need and install it.<br/> For presentation purposes we will install '' 'PrestaShop' '' located in the '' 'eCommerce' category. '' | ||
Line 763: | Line 782: | ||
|style="padding: 0px 0px 20px 25px;"|[[File:CP42_1.png]] | |style="padding: 0px 0px 20px 25px;"|[[File:CP42_1.png]] | ||
|} | |} | ||
+ | --> | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Now, you have to enter necessary installation details, login details and other required data. Then press '' 'Create' '' button to follow. Wait for the '' 'Success' '' notification. | + | |style="padding: 0px 0px 20px 15px;"|Now, you have to enter the necessary installation details, login details and other required data. Then press '' 'Create' '' button to follow. Wait for the '' 'Success' '' notification. |
|} | |} | ||
{| | {| | ||
Line 776: | Line 796: | ||
*Clone application - clone existing website installations to modify or use them on different domains ''('Softaculous' only)'' | *Clone application - clone existing website installations to modify or use them on different domains ''('Softaculous' only)'' | ||
*Delete application | *Delete application | ||
− | *Edit application ''('Installatron' only | + | *Edit application ''('Installatron' only)''<br/> |
'''''Note 1:''' Please be aware that creating staging applications, generating backups and cloning may take even up to a few minutes and the results are not visible instantly.<br/> Please wait until they appear on the list.''<br/> | '''''Note 1:''' Please be aware that creating staging applications, generating backups and cloning may take even up to a few minutes and the results are not visible instantly.<br/> Please wait until they appear on the list.''<br/> | ||
Line 1,094: | Line 1,114: | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:CP22_11.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:CP22_11.png]] | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
Line 1,167: | Line 1,164: | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:CP31_2.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:CP31_2.png]] | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
Line 1,195: | Line 1,181: | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:CP36_1_2.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:CP36_1_2.png]] | ||
+ | |} | ||
+ | |||
+ | ===MySQL Databases=== | ||
+ | {| | ||
+ | |style="padding: 10px 0px 15px 15px;"|MySQL databases are required to run web-based applications such us CMS systems, bulletin boards, online stores etc. There are three subsections available:<br/> | ||
+ | *'''Databases'''- rename your database or delete when no longer needed, | ||
+ | *'''Users'''- change your password, rename a user or delete when necessary, | ||
+ | *'''Manage Privileges'''- connect users with particular databases and manage their permissions. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 25px;"|[[File:CP25.png]] | ||
|} | |} | ||
Line 1,297: | Line 1,294: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|Unban IP addresses banned by the system.<br /> | |style="padding: 10px 0px 15px 15px;"|Unban IP addresses banned by the system.<br /> | ||
− | In order for the process of unbanning IP addresses to work properly, you need to run the following cron command ( | + | In order for the process of unbanning IP addresses to work properly, you need to run the following cron command (5-minute interval suggested). |
<pre> php -q {whmcs_path}/modules/servers/cpanelExtended/cron/cron.php queue </pre> | <pre> php -q {whmcs_path}/modules/servers/cpanelExtended/cron/cron.php queue </pre> | ||
Line 1,323: | Line 1,320: | ||
===WordPress Manager=== | ===WordPress Manager=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|If you have '''[https://www.modulesgarden.com/products/whmcs/wordpress-manager WordPress Manager For WHMCS]''' module installed, your customers will fully benefit from its seamless integration with the cPanel Extended For WHMCS module. | + | |style="padding: 10px 0px 5px 15px;"|'''''Important:''' The WordPress Manager For WHMCS integration is '''not supported in the newest version (4.0.0)''' of the module yet.''<br/> |
+ | ''We are sorry for the inconvenience caused.'' | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 15px;"|If you have '''[https://www.modulesgarden.com/products/whmcs/wordpress-manager WordPress Manager For WHMCS]''' module installed, your customers will fully benefit from its seamless integration with the cPanel Extended For WHMCS module. | ||
|} | |} | ||
{| | {| | ||
Line 1,340: | Line 1,341: | ||
|style="padding: 0px 0px 30px 15px;"|Please note that this entire section can '''only''' be available if you have purchased and installed the [https://www.modulesgarden.com/products/whmcs/wordpress-manager WordPress Manager For WHMCS] module. | |style="padding: 0px 0px 30px 15px;"|Please note that this entire section can '''only''' be available if you have purchased and installed the [https://www.modulesgarden.com/products/whmcs/wordpress-manager WordPress Manager For WHMCS] module. | ||
|} | |} | ||
+ | |||
===WordPress Toolkit=== | ===WordPress Toolkit=== | ||
{| | {| | ||
Line 1,418: | Line 1,420: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|Now wait a moment until a ready WordPress installation is complete and appears on the list on the main page of the WP Toolkit app. | |style="padding: 0px 0px 15px 15px;"|Now wait a moment until a ready WordPress installation is complete and appears on the list on the main page of the WP Toolkit app. | ||
− | You will find there a list with basic information regarding every installation, including the URL, site name, and version. From this point, you may also manage the installation | + | You will find there a list with basic information regarding every installation, including the URL, site name, and version. From this point, you may also manage the installation and delete it at any time. |
|} | |} | ||
{| | {| | ||
Line 1,428: | Line 1,430: | ||
{| | {| | ||
|style="padding: 10px 0px 20px 15px;"|Instance details is the first section that you will be directed to once you move to single installation management.</br> | |style="padding: 10px 0px 20px 15px;"|Instance details is the first section that you will be directed to once you move to single installation management.</br> | ||
− | You will find | + | You will find the gathered details on WordPress and database, such as: |
*URL, Domain, Owner Name, Version, Plugins & Themes Updates, Security Status, PHP version, SSL/TLS | *URL, Domain, Owner Name, Version, Plugins & Themes Updates, Security Status, PHP version, SSL/TLS | ||
*Database Name, host, List URL, User Name, Table prefix | *Database Name, host, List URL, User Name, Table prefix | ||
Line 1,435: | Line 1,437: | ||
|style="padding: 0px 0px 20px 25px;"|[[File:CPT_8.png]] | |style="padding: 0px 0px 20px 25px;"|[[File:CPT_8.png]] | ||
|} | |} | ||
− | =====Maintenance | + | =====Maintenance===== |
{| | {| | ||
|style="padding: 10px 0px 20px 15px;"|This section allows setting up the options of website maintenance time. Start by enabling/disabling the mode and then move to more specific features: | |style="padding: 10px 0px 20px 15px;"|This section allows setting up the options of website maintenance time. Start by enabling/disabling the mode and then move to more specific features: | ||
Line 1,505: | Line 1,507: | ||
{| | {| | ||
|style="padding: 0px 0px 20px 25px;"|[[File:CPT_16.png]] | |style="padding: 0px 0px 20px 25px;"|[[File:CPT_16.png]] | ||
− | |||
− | |||
− | |||
|} | |} | ||
{| | {| | ||
Line 1,571: | Line 1,570: | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:CP39.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:CP39.png]] | ||
+ | |} | ||
+ | ===Log In To WordPress Toolkit=== | ||
+ | {| | ||
+ | |style="padding: 10px 0px 20px 15px;"|By simply clicking on "WordPress Toolkit," you can easily access the WordPress Toolkit in cPanel. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 25px;"|[[File:CP39_1.png]] | ||
|} | |} | ||
Line 1,620: | Line 1,626: | ||
|style="padding: 0px 0px 15px 15px;"|3. If the completed data is correct, you can log in to the account by pressing the '' 'Login to Control Panel' '' button. <br/> Moreover, to make sure that everything works as expected, you can check if the newly-created account can be managed in the client area. <br/> '''Important!''' Remember to manually add other missing parameters of the product in configurable options, custom fields, billing cycle, etc. so they match the parameters of the connected account from your cPanel. <br/> | |style="padding: 0px 0px 15px 15px;"|3. If the completed data is correct, you can log in to the account by pressing the '' 'Login to Control Panel' '' button. <br/> Moreover, to make sure that everything works as expected, you can check if the newly-created account can be managed in the client area. <br/> '''Important!''' Remember to manually add other missing parameters of the product in configurable options, custom fields, billing cycle, etc. so they match the parameters of the connected account from your cPanel. <br/> | ||
4. If you have [https://www.modulesgarden.com/products/whmcs/account-synchronization Account Synchronization For WHMCS] installed, you can use it to quickly and automatically import and synchronize your cPanel account with WHMCS. <br/>The detailed instruction can be found [https://www.docs.modulesgarden.com/Account_Synchronization_For_WHMCS here]. | 4. If you have [https://www.modulesgarden.com/products/whmcs/account-synchronization Account Synchronization For WHMCS] installed, you can use it to quickly and automatically import and synchronize your cPanel account with WHMCS. <br/>The detailed instruction can be found [https://www.docs.modulesgarden.com/Account_Synchronization_For_WHMCS here]. | ||
+ | |} | ||
+ | |||
+ | =Use Cases= | ||
+ | {| | ||
+ | |style="padding: 10px 0px 30px 15px;"|'''In this section, you'll find sample scenarios that demonstrate common use cases, along with details on how the module's features can be practically applied.'''<br/> | ||
+ | Check out the following examples for real-world applications of the module. | ||
+ | |} | ||
+ | ==Automatic App Installation With Service Order== | ||
+ | {| | ||
+ | |style="padding: 10px 0px 15px 15px;"|When using the cPanel Extended For WHMCS, you have the option to automatically install applications with the product.<br/> To begin, access the '' 'cPanel Extended' '' addon, go to '' 'Features' '' → '' 'Settings' '' and locate the '' 'Applications' '' section. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:CP80.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 15px 15px;"|First, activate the '' 'Install Applications' '' feature.<br/> You can set up an application to install automatically for new cPanel accounts by selecting the '' 'Auto Installer' '' option and then choosing your desired application.<br/> Be sure to enable the '' 'Auto Install On Create' '' option to facilitate this process. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:CP81.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 15px 15px;"|Alternatively, you can let your customers choose their applications during the ordering phase.<br/> Simply toggle on the '' 'Use Configurable Options' '' option and select from the available dropdown choices.<br/> For detailed instructions on how to configure these options, please refer to the '' '[[#Configurable_Options_For_Application_Auto_Install|Management]]' '' section. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 15px 25px;"|[[File:CP82.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 15px;"|Once a client places an order and the '' 'Create' '' action is executed.<br/> The new cPanel account will automatically include the selected application (for instance, a WordPress installation). | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 25px;"|[[File:CP83.png]] | ||
|} | |} | ||
Line 1,665: | Line 1,702: | ||
=Update Instructions= | =Update Instructions= | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|1. The essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/> | + | |style="padding: 10px 0px 15px 15px;"|1. The essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/> |
− | + | ||
'''Important:''' If you update the module from any version prior to '''3.2.0''', you have to '''activate a new addon''' and then '''deactivate the old one'''.<br/>Note that all settings configured in the previous version of cPanel Extended addon will be migrated to the new one.<br/> | '''Important:''' If you update the module from any version prior to '''3.2.0''', you have to '''activate a new addon''' and then '''deactivate the old one'''.<br/>Note that all settings configured in the previous version of cPanel Extended addon will be migrated to the new one.<br/> | ||
You also need to set '''recursively writable permissions''' for '''storage''' directories in these '''two''' locations: | You also need to set '''recursively writable permissions''' for '''storage''' directories in these '''two''' locations: | ||
# your_whmcs/modules/addons/CpanelExtended/ | # your_whmcs/modules/addons/CpanelExtended/ | ||
# your_whmcs/modules/servers/cpanelExtended/ | # your_whmcs/modules/servers/cpanelExtended/ | ||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|2. When updating from version '''3.14 to 3.15,''' you have to manually delete the following files from the '''Templates''' folder at: <br/> |
''yourWHMCS/modules/servers/cpanelExtended/app/UI/WordPressToolkit/Templates/pages'' | ''yourWHMCS/modules/servers/cpanelExtended/app/UI/WordPressToolkit/Templates/pages'' | ||
Line 1,689: | Line 1,721: | ||
* '''wordPressMaintenanceMain.tpl''' | * '''wordPressMaintenanceMain.tpl''' | ||
* '''wordPressSubEdit.tpl''' | * '''wordPressSubEdit.tpl''' | ||
+ | |} | ||
+ | |||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 15px;"| | ||
+ | 3. '''Update instructions for module migration from version 3.x to the 4.x:''' | ||
+ | # '''Delete the directories:''' '' '/modules/servers/cpanelExtended' '' and '' '/modules/addons/cpanelExtended' '' along with the contents of the previous version of the module. | ||
+ | # '''Upload the new module files''' to the respective directories: '' '/modules/servers/' '' and '' '/modules/addons/'.'' | ||
+ | # '''Enter the license key''' in the appropriate file ''(see 'Installation' instructions, step 4).'' | ||
+ | # Log into your client area and '''reissue the product license'''. | ||
+ | # Open the cPanel Extended For WHMCS module addon.<br/> | ||
+ | The migration of product configuration data from the previous version should occur at this point. | ||
+ | |} | ||
+ | |||
+ | =Upgrade Guide= | ||
+ | {| | ||
+ | |style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/> | ||
+ | |||
+ | Opt for the [https://www.modulesgarden.com/products/whmcs/cpanel-extended#open-source-version Open Source version] of your cPanel Extended For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/> | ||
+ | |||
+ | Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized. | ||
|} | |} | ||
Line 1,797: | Line 1,849: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 15px;"|''Solution'': Review your server configuration, and make sure you used a correct token with sufficient ''(full)'' privileges. More about API tokens can be found [https://docs.cpanel.net/whm/development/manage-api-tokens-in-whm/ here]. |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 15px;"|21. '''In some cases, you may need to increase the connection timeout due to the extended time required for the cPanel server to create an account.'''<br/> To adjust this setting, follow these steps: | ||
+ | * Locate the '' '/app/Config/configuration.yml' '' file. | ||
+ | * Open the file and find the '' 'cpanelApiConnectionTimeout' '' parameter.<br/> | ||
+ | By default, this parameter is set to an empty value, which means it does not alter the WHMCS module's behavior: | ||
+ | cpanelApiConnectionTimeout: '' | ||
+ | To change the timeout, specify a value in seconds. For example, setting it to 4, will override the default timeout duration. | ||
+ | cpanelApiConnectionTimeout: '4' | ||
|} | |} |
Latest revision as of 10:13, 2 October 2024
[edit] About cPanel Extended For WHMCS
cPanel Extended For WHMCS allows you to automate accounts provisioning and lets your clients manage their web hosting accounts in the WHMCS client area. The module authorizes your customers to not only manage FTP accounts, domains, databases or backups but also install and manage various web applications. |
- Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Account |
✔ Change Package And Account Password |
✔ Log In To Each cPanel Account On Click |
✔ Log In To WHM Panel On Click |
✔ Automatically Unban Client IP Address Upon Logging In |
✔ Configure Account Initial Settings And Resource Limits |
✔ Configure Email Accounts Initial Settings And Resource Limits |
✔ View All cPanel And cPanel Extended Products And Servers In One Place |
✔ Configure Client Area Features And Template Per Product |
✔ Enable And Configure Application Auto Installer To Use Per Product - Softaculous Or Installatron |
✔ View And Manage Queue Tasks |
✔ Customize Module Language Files With "Translations" Tool |
✔ Define CloudLinux Configuration Per Product: |
✔ Operations Per Second |
✔ PHP Version |
✔ Resource Limits |
✔ Virtual Memory |
- Client Area Features:
✔ Remote Access And Management Of: |
✔ Addon Domains |
✔ Applications And Their Backups |
✔ Autoresponders |
✔ Backups - Manual And Automatic |
✔ Cron Jobs |
✔ Disk Usage |
✔ DNS Zone Editor |
✔ Domain Aliases |
✔ Domain Redirects |
✔ Email Accounts |
✔ Email Deliverability |
✔ Email Forwarders |
✔ Files Manager |
✔ FTP Accounts |
✔ Git Version Control |
✔ IP Blocker |
✔ Mailing Lists |
✔ Metrics: Latest Visitors, Webalizer, Analog Stats, AWStats |
✔ ModSecurity |
✔ MX Entries |
✔ MySQL Databases |
✔ PHP Version |
✔ PostgreSQL Databases |
✔ Remote MySQL |
✔ Subdomains |
✔ SSL/TLS Management |
✔ SSH Access |
✔ Unban IP Addresses |
✔ User Manager |
✔ WordPress Manager - Separate Module Required |
✔ In Module Version 4.0.0 Native Support Was Temporarily Withdrawn Until Further Update |
✔ WordPress Toolkit |
✔ One Click Login To: |
✔ cPanel |
✔ File Manager |
✔ phpMyAdmin |
✔ RVSiteBuilder |
✔ Webmail |
✔ WP Toolkit |
✔ Change Account Password |
✔ Perform Bulk Actions |
- Application Auto Installer Features:
✔ Ordering Process: |
✔ Auto Install Chosen Application After Account Creation |
✔ Auto Install Application Chosen By Client During Order - With Configurable Options |
✔ Allow Custom Settings Of Auto Installed Application - With Custom Fields |
✔ Client Area: |
✔ Install New Applications With Softaculous Or Installatron |
✔ View And Manage Installed Applications |
✔ Create Clones Of Installed Applications - Softaculous Auto Installer |
✔ Create And Push To Live Staging Instances Of Installed Applications - Softaculous Auto Installer |
✔ Backup Installed Applications |
✔ Perform Auto Backups On Application Updates By Softaculous Or Installatron |
✔ View And Manage Created Backups |
✔ Restore Applications From Backups |
✔ Delete Applications Along With Their Backups |
- General Info:
✔ Supports CloudLinux on WHM |
✔ Works With Root And Reseller Account (Single Features Require Root Access) |
✔ Utilizes Ajax Loaded Pages - Similar To Those From cPanel |
✔ Integrated With Advanced Billing For WHMCS - Actual Server Resource Usage Billing |
✔ Integrated With DNS Manager For WHMCS - Supports cPanel & cPanel DNSOnly |
✔ Integrated With IP Manager For WHMCS - Complete Control And Easy Assignment Of IP Subnets |
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products |
✔ Integrated With WordPress Manager For WHMCS - Remote Installation And Management Of WordPress Instances |
✔ Fully Integrated With Lagom WHMCS Client Theme |
✔ Multi-Language Support With Custom Translations Tool |
✔ Supports PHP 8.2 Back To PHP 8.1 |
✔ Supports WHMCS Server Sync Tool |
✔ Supports WHMCS Themes "Six" And "Twenty-One" |
✔ Supports WHMCS V8.11 Back To WHMCS V8.8 |
✔ Requires ionCube Loader V13 Or Later |
✔ Easy Module Upgrade To Open Source Version |
[edit] Installation and Configuration
Read the below instructions to learn how to install and then configure cPanel Extended For WHMCS properly. We will guide you step by step through all installation procedures. |
[edit] Installation
1. Log in to our client area and download the module. |
2. Extract the package and upload its content into the main WHMCS directory.
The content of the package to upload should look like this. |
3. When you install cPanel Extended For WHMCS for the first time, you have to rename the 'license_RENAME.php' file. The file is located in 'modules/servers/CpanelExtended/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' . |
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file. Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products' . |
5. In the next step, set up the 'storage' folder as recursively writable. This folder is available at two locations:
|
If you are updating your module from version to 4.0.0, you have to perform additional steps described in the Update Instructions. |
[edit] Activation of Addon
6. Now you have to activate the module in your WHMCS system. Log in to your WHMCS admin area. Find 'System Settings' and open the 'Addon Modules'. |
7. In the next step, you need to permit access to this module. To do so, click on the 'Configure' button, tick the desired admin roles and press 'Save Changes'. |
8. Optionally, add a cron job as shown below (5-minute intervals are recommended).
php -q /your_whmcs/modules/addons/CpanelExtended/cron/cron.php queue This cron will automatically queue and handle the IP unbanning function. |
[edit] Configuration of Server
9. To begin, you must add a new server. Go to 'System Settings' → 'Products/Services' → 'Servers' and press 'Add New Server'. |
10. Enter your server name, IP address, username and password. Choose 'cPanelExtended' from the dropdown menu and press 'Save Changes'. If you connect with your cPanel server via SSL, then make sure that you check the 'Secure' field located at the bottom of the page. |
11. Once your server has been configured correctly, you will see the following screen. Create a new group for your server. Press 'Create New Group' to proceed. |
12. Enter the group name, select your previously created server, press 'Add', and then 'Save Changes'. |
[edit] Configuration of Product
13. In order to create a product, go to 'System Settings' → 'Products/Services' . If you do not have a product group, click on 'Create a New Group' . If you do, simply skip step 13. |
14. Fill in a product group name and press 'Save Changes'. |
15. When you have a product group added, you can start creating a new product. |
16. Choose your product type and product group from dropdown menus, then enter your product name and select the used module: 'cPanel Extended'. Press 'Continue' to go on. |
17. Now, go to the 'Module Settings' section, choose the previously created server group from dropdown menu and press 'Save Changes' . Important: Setting cPanel theme is required for some features to work properly. |
18. If you want to enable CloudLinux features for your product, simply select this option. Now, you can put limits for your clients' resources regarding:
|
If you want to use the above cPanel entries as configurable options, please follow the guide available at this article. Additionally, you can use the records for CloudLinux from the list below: speed|CPU Speed pmem|Physical Memory io|I/O Limit maxentryprocs|Concurrent Connections nproc|Number of Processes vmem|Virtual Memory iops|Operations Per Second |
19. You may set up several options that will be applied to the product when creating one:
|
[edit] Configuration of Addon
20. You have just correctly created and customized a new product. Go to 'Addons' → 'cPanel Extended' in your WHMCS. You will find there a dashboard with the possibility to:
|
21. Proceed to the 'Features' section and find the product you are interested in and press the 'Configuration' button next to it. |
22. You should find here boxes dedicated to 'Features', 'Applications', 'Client Area Template'. To show you an example, we will set the configuration from the beginning, without using other configuration options of the product. |
23. Choose whether to activate the 'Install Applications' option. In case you wish to activate this option, you will have to select 'Auto Installer' from the dropdown menu. Afterwards, enable 'Install Tab' and 'Backup Tab'. |
24. Finally, decide whether to allow your clients to create email accounts with an unlimited quota. If you disable this option here, you may then set the quota limit per created account. |
25. If you already have another product configured, you may copy its configuration. Find the 'Copy' button on the list with products or select multiple item at once. |
26. From now on, all your clients who ordered a previously created product will be able to manage their cPanel accounts via your WHMCS system. The screen below presents a summary view of the ordered product in admin area. Among the available actions you will find:
|
This is what your customers should see in their client area: |
[edit] Upgrade cPanel to cPanel Extended Product
Once you have already configured the standard cPanel products, you can easily upgrade them to the cPanel Extended products. Note: Before you start, make sure that you have already configured the cPanel Extended server. |
Now, select the new server group configured for the cPanel Extended module.
Note: Make sure that this server configuration is exactly the same as the standard cPanel server configuration. |
[edit] Queue
The 'Queue' section is where the 'Unban IP' actions are queued and automatically run by an optional cron job. You will find the information on the cron itself at the top of this section. |
The list of the queued requests can be viewed, inspected, and managed manually. Use the action buttons to see each request's details, manually run it, or delete it. |
Multiple tasks can be deleted at once via the mass selection feature. |
The auto prune system can be set up to automatically delete tasks after a specified time. This feature can be found under additional actions. |
[edit] Translations
Customizing language files is now extremely easy with the "Translations" tool that is now available directly in the addon. Its user-friendly design makes managing various language file tweaks a smooth and efficient process. Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it here. |
[edit] Management
cPanel Extended For WHMCS allows your customers to manage their cPanel accounts without being logged into the cPanel server. Read the below descriptions to get familiar with all of the cPanel Extended For WHMCS functionalities. |
[edit] Configurable Options For Application Auto Install
Let your clients decide which application they would like to install on their new cPanel account. While placing an order, your customer can choose an application which will be installed upon account creation. |
Go back to the list of products and click on a download icon to view the applications list. |
These are the names of values that you can enter in the fields of configurable options. We will configure them in the next step. For example, if you would like to set up 'Drupal' in your applications list, you will need to enter the 'Drupal 8.6.2' or 'Drupal' value. |
Go to your WHMCS: 'System Settings' → 'Products/Services' → 'Configurable Options' and press 'Create a New Group'. |
Enter the group name of your choice, select the product to which you want to assign configurable options, then press 'Save Changes'. |
Now click on 'Add New Configurable Option'. |
This moment is very important. As 'Option Name' , you have to enter 'Installation App' . Otherwise the entire functionality will not work. Here you can set up as many applications as you want. To do so, enter a value name, e.g. 'WordPress 3.7.1' and press 'Save Changes' . |
As you can see on the following screen, we decided to offer our customers five applications. When you finish adding applications, press 'Save Changes' and 'Close Window'. |
Using the module's version above 3.1.0, you can also create a new configurable option - Auto Backup On Update with the 'Yes/No' type. This option is used to enable the creation of auto update backups for the first chosen application after the initial order in WHMCS. |
Afterwards, come back to 'cPanel Extended Features' → 'Configuration' → 'Applications' , activate 'Use Configurable Options' and choose 'Apps/Configurable Options' from a dropdown menu. Please note that you can have more configurable options groups at your disposal. Press 'Save' . You have just successfully assigned configurable options to the application autoinstall. |
Let us find out what your customers are going to see in your client area while placing an order. As you can see, a dropdown menu with the previously configured applications has shown up. |
[edit] Assignment of Custom Fields To Application Autoinstall
Now that you know how to allow your customers to choose which application they would like to install on their account, we can proceed one step further. Until now all applications have been installed with the use of default details like e.g. directory names or a database name.
Remember to set each field type as 'Text Box', tick 'Required Field ' and 'Show on Order Form'. |
The next 3 fields are:
Set them as 'Text Box' and tick 'Show on Order Form'. |
The last field is:
Set it as 'Drop Down', enter 'Yes, No' into 'Select Options', tick 'Required Field ' and 'Show on Order Form'. |
Once you add all custom fields, they will appear while placing an order. Voila! Now your customers can personalize each application without the necessity of installing it later. |
[edit] Custom Softaculous Application Language
We will show you how to quickly set custom language for Softaculous web applications. For this purpose you need to add a new custom field for your product. The field should be called 'Language' . |
Afterwards, go to your 'Products/Services' and check whether the 'Language' field has appeared. In order to change the default language of the application for an account, enter here an appropriate value. |
From now on the just added language field will be visible to your customers as well. While installing a new application, they will be enabled to set a desired language by entering the appropriate value into the field. Here you will find a complete list of all language codes. |
[edit] Client Area
In the following section, features available in the client area will be thoroughly discussed. |
[edit] Addon Domains
Addon domains allow you to link the domain to a subdirectory of your account. You can view and manage addon domains, edit document root and make redirections. |
Press the 'Create Addon Domain' button and enter the desired details. Please note that an FTP account will not be automatically created with the domain. |
[edit] Applications Configuration
[edit] Applications
Install your favorite applications in a few seconds without even accessing cPanel. Use cPanel Extended For WHMCS to:
To start, simply proceed to 'Applications' , and then find the 'Install New' section. |
Afterwards, you will see an extensive menu with application categories. |
Now, you have to enter the necessary installation details, login details and other required data. Then press 'Create' button to follow. Wait for the 'Success' notification. |
View the list of your installed applications by clicking on the 'Installed Applications' tab and manage the application. Here you will find the name of the application, its path, size and available actions:
Note 1: Please be aware that creating staging applications, generating backups and cloning may take even up to a few minutes and the results are not visible instantly. Note 2: There are few applications available in Softaculous, which cannot be cloned nor staging instances created. These two options are not available on the list in case of such apps. |
For staging applications, there is an extra option available to push such application instance to the live environment. Simply press the marked button. Please keep in mind that it might last a short while before the application appears on the list. |
[edit] Application Backups
You can also create a backup of your installation. To do so, simply press the 'Create Backup' button next to the installed application. |
Confirm the action and backup generation will start immediately. |
After a moment you should receive a message confirming that the operation has just started and will be completed in a short while. Once you have created a backup of your application, proceed to the 'Backups' tab. |
You can also let your customers create automatic backups for application updates. To do this, go to 'Addons' → 'cPanel Extended Center' → 'Features' → 'Configuration' and enable Auto Update Backups. |
Then, when a client installs a new application, it will be possible to toggle the option for automatic update backups and restore them if the application update fails. |
[edit] Autoresponders
In this section you may compose and add extremely useful default messages. They will be automatically sent as a response message when you have no access to your mailbox. |
Fill out all the required information. Define whether to start the autoresponder immediately or introduce custom starting time. In the same way, define when to stop using this particular autoresponder. |
[edit] Backups
All backups generated automatically are displayed in the page under 'Restore Points' and 'History' tabs. To restore a backup, choose the desired elements and press 'Restore' . |
You can make backups and download your entire cPanel settings or only a part of them. To generate a full backup, press 'Generate Full Backup' . |
Afterwards, choose 'Backup Destination' from a dropdown menu. Optionally, you can also fill in an email address to which a notification about the backup will be sent. |
To download a backup, simply press the 'Download' button. The process should start immediately. Partial backups are generated during the download process. |
Note that if you have created any MySQL databases or email forwarders, you can also download their backups from the corresponding tabs. |
[edit] Cron Jobs
Configure cron jobs settings to fully automate commands and scripts on your site. Press 'Add Cron Job' to create a command. |
You may create a custom command, yet make sure it is correct, or slecet one of the defined settings. In the second case, simply select need time configuration and type in the command. |
[edit] Disk Usage
Disk Usage section allows clients to monitor their account's available space. Please note that all presented figures are relative to the largest directory and may not reflect recent changes to the client account’s disk usage. Moreover, email account storage may occupy less space on the disk if compression or hard-link optimizations are used to save space. If you need to see usage data for individual files use File Manager tool. |
[edit] DNS Zone Editor
This section gives you the possibility to manage the 'DNS Zones' of your domain easily. Press ' Edit' icon next to a single domain and you will be moved to DNS records section. |
As presented below, there is a list of your existing 'DNS Zones' . You can edit them or delete if they are no longer needed. If you wish to add a new 'DNS Zone' , simply click on the appropriate button. |
Now, choose the type of your 'DNS Zone' and provide its name and any other required values depending on the zone type. |
[edit] Domain Aliases
You can add and manage your domain aliases. This option allows you to read content of one domain from another domain name. |
After alias creation, you can edit it to enable and add redirection. |
[edit] Domain Redirects
Easy access to domain redirection options is very useful. This option allows you to redirect a specific web page to another one and display the contents of that page. |
For example, if your main domain is mytestdomain.com, you can make such the following forward: mytestdomain.com/redirect → adomainwithlongname-averylongname.com Choose the type: Permanent or Temporary; decide whether to use 'www' redirection or not; select 'Wild Card Redirect' if you need. |
[edit] Email Accounts
View and edit email accounts that are associated with your domains. Use filter to find required email addresses, preview its selected quota and manage the account. |
Press 'Create Email Account' and select to which domain it should be added, type or generate password and define limited or unlimited quota. In case 'Unlimited Quota' has been disabled for the product by the administrator the visible on the screen below option will not be available here. |
You may also preview the email account settings on pressing the information icon. Any details on the email account, necessary to configure an external email client, are included in that place. |
[edit] Email Deliverability
Email Deliverability interface allows clients to reduce the number of emails sent from their server that end up in spam folders by installing recommended DKIM, SPF and PTR DNS records. There are two options available:
|
After choosing the domain, the client can preview and install the suggested names and values of the records. Please note that it is recommended to evaluate beforehand whether your system is properly configured. |
In this section you can set up email forwarders and choose from several destination options to adjust mail forwarding perfectly to your needs. |
Press the 'Create Forwarder' button, specify the forwarded email, select forward option type and define the destination |
In the next tab you can also add email domain forwarders to forward email from one domain to another. Note: Forwarding a domain's email will override the default address for that domain! |
[edit] File Manager
File manager allows you to manage files and folders on your cPanel account. View the list of files with their specific data: name, size, date of last modification and established permissions. |
You can create a new file by pressing a corresponding button as well as upload new files and create directory by pressing additional actions. |
You can also perform such actions as compression, extraction, moving or coping to other location, permission change and removal on single or multiple files or directories. |
[edit] FTP Accounts
Manage the accounts to be able to access your website files through an FTP protocol. |
Add and configure FTP Accounts in the easiest possible way. Just type in your login on a selected domain, provide or generate a secure password, define directory and declare available quota. |
[edit] Git Version Control
The 'Git Version Control' section provides you with the possibility to create as well as manage your Git repositories. Git is a fast and modern implementation of version control. It not only allows you to check the history of content changes but also facilitates collaborative changes to files. To do so, simply click on the 'Create Repository' button. |
Complete the 'Repository Root' and 'Repository Name' fields. If you wish to clone from your already existing repository, you need to enable 'Clone From Existing Repository' and provide the source of the repository. |
You may 'Add Deployment' , 'Modify' , or 'Delete' a single repository. There are also the mass action buttons as presented below. |
[edit] IP Blocker
The 'IP Blocker' option grants you the possibility to block access to your site for one or more IP addresses. What is more, you can quickly unblock IP addresses by removing them from the list of blocked IP addresses. Click on the 'Block IP Address' button. |
All you need to do is provide the IP address or IP range. |
If you wish to remove all blocked IP addresses, you can simply do it by clicking on the 'Remove IP Addresses' button. |
[edit] Mailing Lists
Mailing lists allow you to use a single address to send message to multiple email addresses. This feature is very useful when you need to send a newsletter or another update to a group of people. Allowed actions on a mailing list:
|
Press the 'Create Mailing List' button and then define a name, password, and a domain name. Next, choose the access type:
|
After creating a list, you can delegate its administrative privileges to the users of your choice. Press the 'Edit' button and 'Create Delegate' in the next section. |
Once you have delegated administrative privileges to an email user from a list, this user will be able to log in to administrative console of the list from webmail. |
[edit] Metrics
Be always up to date with information about your websites. Use 'Webalizer', 'AWstats', 'Analog Stats' and 'Visitors' to analyze and interpret the presented data on each domain. |
[edit] ModSecurity
In this section, you can enable and disable the ModSecurity protection for your domains. Please remember that we recommend to enable ModSecurity for all of your domains as it is used for intrusion detection and prevention. Disable ModSecurity only while you troubleshoot ModSecurity-related problems. |
[edit] MX Entry
This page enables you to manage your MX records for each of your domains. First, you need to choose the desired domain. |
Then, press 'Create MX Record' and define its priority and destination. After creating an MX record, you can add more records or edit and remove the existing ones. |
[edit] MySQL Databases
MySQL databases are required to run web-based applications such us CMS systems, bulletin boards, online stores etc. There are three subsections available:
|
[edit] PHP Version
In this section your clients can manage PHP versions of their domains. They are allowed to view a current PHP version of each domain as well as select a new one by clicking the 'Edit' button. Please note that EasyApache 4 is required to permit your clients to handle PHP versions. |
If you would like to change the display of the default PHP names in the system to a more user-friendly variant, please locate the language file in:
{yourWHMCS}/modules/servers/cpanelExtended/lang/english.php An add records according to the system names of PHP versions you want to change. E.g.: $_LANG['phpVersion']['ea-php54'] = 'PHP 5.4'; $_LANG['phpVersion']['ea-php55'] = 'PHP 5.5'; $_LANG['phpVersion']['ea-php56'] = 'PHP 5.6'; $_LANG['phpVersion']['ea-php70'] = 'PHP 7.0'; $_LANG['phpVersion']['ea-php71'] = 'PHP 7.1'; $_LANG['phpVersion']['ea-php72'] = 'PHP 7.2'; |
The result of those changes will be as following: |
[edit] PostgreSQL Databases
PostgreSQL databases are required to run web-based applications such as CMS systems, bulletin boards, online stores etc. Here you can create and rename databases, add new users as well as connect them with particular databases. |
When you create a new user, please be aware that currently there is NO possibility to remove such a user due to cPanel API limitations. You can only change their passwords or modify their usernames. |
Add the user to the database, the same moment all the privileges will be granted. You can revoke the privileges by removing the user from the database. |
[edit] Remote MySQL
The 'Remote MySQL' section allows you to add specific domain names to allow visitors to connect to the MySQL databases. It may be used, for example, when you want to enable shopping cart or guestbook apps on other servers to access your databases. |
[edit] Subdomains
Create subdomains for different parts of your website by pressing the 'Create Subdomain' button. |
Choose the domain for your available subdomain from the list and provide document root. |
You can redirect or delete the once created subdomains if you wish so. |
[edit] SSL/TLS Management
This feature moves the management of your Private Keys, CSR Keys and SSL Certificates into your WHMCS client area. Generate, upload and install certificates and keys without the necessity of logging in to your cPanel. |
[edit] SSH Access
Configure your SSH keys. Create new keys or import your existing keys. Available actions: view, authorize, download or delete key. |
[edit] Unban IP Address
Unban IP addresses banned by the system. In order for the process of unbanning IP addresses to work properly, you need to run the following cron command (5-minute interval suggested). php -q {whmcs_path}/modules/servers/cpanelExtended/cron/cron.php queue Please do not forget to replace {whmcs_path} with your WHMCS root location. |
[edit] User Manager
The 'User Manager' section grants you the possibility to manage your subaccounts that use the same login and password details for email, FTP, and Web Disk services. |
Add a new user by clicking 'Add User' and complete the details. Note: Please keep in mind that the 'Unlimited Quota' is set for 'FTP Subaccount' by default. If you wish to modify it, please proceed to your panel and change it manually in the 'User Manager' section. |
[edit] WordPress Manager
Important: The WordPress Manager For WHMCS integration is not supported in the newest version (4.0.0) of the module yet. We are sorry for the inconvenience caused. |
If you have WordPress Manager For WHMCS module installed, your customers will fully benefit from its seamless integration with the cPanel Extended For WHMCS module. |
Thanks to this integration, your customers will have the capability to install and manage WordPress instances in detail without the bother of leaving the cPanel Extended panel in your WHMCS client area.
Full and detailed instructions on the 'WordPress Manager' itself is located here. Important: cPanel integration with WordPress Manager does not offer support for reseller's accounts. Such accounts will not be visible nor managed in the cPanel view. |
Please note that this entire section can only be available if you have purchased and installed the WordPress Manager For WHMCS module. |
[edit] WordPress Toolkit
WordPress Toolkit is an independent tool used to manage WordPress instances. You may add, configure and freely manage your WordPress installations directly from the level of the WHMCS client area. Note: Please bear in mind that WordPress Toolkit and WordPress Manager are two separate applications. |
Start your journey by adding the first installation of WordPress. Press the button 'New Installation' marked on the screen below and read the instruction to see how to install a pure new instance. |
A new window with four tabs will open. In the first Details tab, fill in the following fields:
|
|
|
WP Toolkit can automatically install WordPress core, plugin, and theme updates as soon as they become available. Updates related data:
WordPress Update - Update WordPress automatically:
Plugins Update - Update plugins automatically
Themes Update - Update themes automatically
|
Now wait a moment until a ready WordPress installation is complete and appears on the list on the main page of the WP Toolkit app.
You will find there a list with basic information regarding every installation, including the URL, site name, and version. From this point, you may also manage the installation and delete it at any time. |
[edit] Instance Management
[edit] Details
Instance details is the first section that you will be directed to once you move to single installation management.</br>
You will find the gathered details on WordPress and database, such as:
|
[edit] Maintenance
This section allows setting up the options of website maintenance time. Start by enabling/disabling the mode and then move to more specific features:
Screen Text section allows changing the text displayed on the maintenance screen. You can use HTML tags to format the text's appearance. You may adjust the texts of:
Timer - enable the timer to count down the remaining time
Social Network Links - Type in links to your social network pages. If left empty, the corresponding link will be hidden. |
[edit] Credentials
Instance settings
|
[edit] Plugins
Here you are enabled to activate, deactivate, delete, and update the already installed plugins. You can also add new plugins to your WordPress installation in the 'Add New' tab. |
To add a new plugin, you are required to type in at least three of the initial letters of the desired plugin's name into the search field to see the actual results. A list of related plugins will appear. You may now learn more about each plugin by pressing the 'Show Details' button. If the plugin meets your requirements, simply press the corresponding button to begin the installation process (which might take a short while). |
The 'Mass Action' feature is also present in this section, so you will be able to handle multiple plugins more efficiently and at the same time. |
[edit] Themes
This section allows quick and easy management of themes installed on your WordPress instance. Enable/disable the theme, update the already installed theme, and delete useless ones. You can also add new themes to your WordPress installation in the 'Add New' tab. |
Please start typing in the search field to see the available themes. Once a list of related themes appears, you will be allowed to first check their preview and details - pressing the 'Information' button to learn more. If the theme satisfies your needs, simply press the corresponding button to begin the installation process (which might take a short while). |
Thanks to the 'Mass Action' functionality, you will be able to handle multiple themes more efficiently at the same time. |
[edit] Backups
As the name suggests, this section provides you with the ability to create backups. You are allowed to download, restore and delete a particular backup. |
[edit] Logs
The 'Logs' section contains a list of recorded events. Check the list of actions, which can also be downloaded as a .txt file. |
[edit] Log In To cPanel
You can easily log in to your cPanel by clicking 'Log In To cPanel'. You do not even need to fill in your username and password! |
[edit] Log In To File Manager
Takes you to File Manager in your cPanel account instantly. |
[edit] Log In To phpMyAdmin
Get quick access to your phpMyAdmin with just one click. Here, similarly to cPanel login, you do not even need to enter your access details! |
[edit] Log In To RVSiteBuilder
One click of the button will also move you immediately to RVSiteBuilder. |
[edit] Log In To Webmail
With a single click of 'Log In To Webmail' you can access your Webmail. Please note that Webmail redirection does not automatically log in to the panel. You will have to provide your credentials manually. |
[edit] Log In To WordPress Toolkit
By simply clicking on "WordPress Toolkit," you can easily access the WordPress Toolkit in cPanel. |
[edit] Change Password
You can change the password to both your cPanel and FTP account at the same time. |
[edit] Management of Existing Products
You can easily use cPanel Extended For WHMCS module with your already configured cPanel products. To do so, change the type of servers and module names of products from 'cPanel' to 'cPanelExtended' . |
[edit] Management of Billing
When you combine cPanel Extended For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options. The module allows you to charge your customers basing on the located server resources. More information concerning the usage can be found in the Advanced Billing documentation. |
With Advanced Billing module you can also display the current server resource usage, its total cost, and usage records history, as well as set resource reminders. |
[edit] Importing Existing Account
In this section, you can find short instruction on how to connect one of your clients to your already existing account in cPanel. Take the following steps to make sure that the process will be carried out properly. 1. Firstly, manually create an order for your customer in WHMCS. Choose a client and in the summary, view click on the ' Add New Order' button. Next, select a 'Product/Service' and press 'Submit Order' .
The above-mentioned information has to be consistent with the data from your cPanel account. Now, complete these fields as presented below. |
3. If the completed data is correct, you can log in to the account by pressing the 'Login to Control Panel' button. Moreover, to make sure that everything works as expected, you can check if the newly-created account can be managed in the client area. Important! Remember to manually add other missing parameters of the product in configurable options, custom fields, billing cycle, etc. so they match the parameters of the connected account from your cPanel. 4. If you have Account Synchronization For WHMCS installed, you can use it to quickly and automatically import and synchronize your cPanel account with WHMCS. |
[edit] Use Cases
In this section, you'll find sample scenarios that demonstrate common use cases, along with details on how the module's features can be practically applied. Check out the following examples for real-world applications of the module. |
[edit] Automatic App Installation With Service Order
When using the cPanel Extended For WHMCS, you have the option to automatically install applications with the product. To begin, access the 'cPanel Extended' addon, go to 'Features' → 'Settings' and locate the 'Applications' section. |
First, activate the 'Install Applications' feature. You can set up an application to install automatically for new cPanel accounts by selecting the 'Auto Installer' option and then choosing your desired application. Be sure to enable the 'Auto Install On Create' option to facilitate this process. |
Alternatively, you can let your customers choose their applications during the ordering phase. Simply toggle on the 'Use Configurable Options' option and select from the available dropdown choices. For detailed instructions on how to configure these options, please refer to the 'Management' section. |
Once a client places an order and the 'Create' action is executed. The new cPanel account will automatically include the selected application (for instance, a WordPress installation). |
[edit] Tips
1. cPanel Extended For WHMCS shall be used with a root account on regular basics, however, it is also possible to use a reseller account. Bear in mind that you might encounter some issues while using the reseller account. If you need to switch accounts, simply go to your cPanel Extended product → 'Details' and choose 'Reseller Hosting' from a dropdown menu as shown on the following screen. |
2. In order to make the reseller own their account, you need to check 'Set the reseller to own their own account' field located in 'Module Settings'. |
3. If you would like to use cPanel/WHM Import Utility with cPanel Extended products, you will need to switch the products type to 'cPanel'. Afterwards, you can successfully use the import script. After finishing the import, simply switch back the product type to 'cPanelExtended'. |
4. If your users have problems with seeing applications available for installation, you need to log in to WHM and proceed to Softaculous general settings. Choose: Top Scripts (Default) for Default page for End user Panel. |
5. As this module supports templates system, any changes made to the module's templates files will be saved after the upgrade process. |
6. Alternatve method of server connection. You can connect with your cPanel server by providing 'API Token' and your username. Firstly, you need to generate 'API Token' in your WHM panel. To do so, log in to your panel and choose 'Development' from the side menu. Then, navigate to the 'Manage API Tokens' section. To add a new 'API Token' , you need to click 'Generate Token' . Enter the name of your new token as well as set the preferred privileges. Once ready, press 'Save' at the bottom of the page. |
Copy your API Token to a safe place. |
Finally, you can provide it during the server configuration as presented below. |
[edit] Update Instructions
1. The essential guidance through the process of updating the module is offered here. Important: If you update the module from any version prior to 3.2.0, you have to activate a new addon and then deactivate the old one.
|
2. When updating from version 3.14 to 3.15, you have to manually delete the following files from the Templates folder at: yourWHMCS/modules/servers/cpanelExtended/app/UI/WordPressToolkit/Templates/pages List of files to delete:
|
3. Update instructions for module migration from version 3.x to the 4.x:
The migration of product configuration data from the previous version should occur at this point. |
[edit] Upgrade Guide
Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability? There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment. Opt for the Open Source version of your cPanel Extended For WHMCS module to unlock these benefits. Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized. |
[edit] Common Problems
1. In case of connection problems, please check whether your SELinux or firewall does not block ports. |
2. If you get an ionCube encoder problem (wrong version) after installation, please open a support ticket. We will provide you with a different version of the module encrypted with the older version of ionCube. |
3. SQL Issue: When you move your WHMCS system to another domain and you import your SQL database, you may get an error with missing tables or fields. An example of such an error can be: "Unknown column 's.change_password' in 'field list' ". |
4. If you have problems with connection, make sure that both ports 2082 and 2083 are open. |
5. After you change the language of the module, your Ajax notifications may work incorrectly. Encode language file in UTF-8 (without BOM) to solve this issue. |
6. No results to display: Connection problem: This problem occurs when connection to the cPanel server is not configured properly. |
Reason: Values inside the field/s 'Hostname' , 'IP Address' , 'Username' , 'Password' , 'Type' and/or 'Access Hash' is/are incorrect. Solution: Verify provided details and test connection through pressing the 'WHM' button. |
7. No results to display: Wrong hostname or IP value: This problem occurs when connection to the cPanel server is not configured properly. |
Reason: Values inside the field/s 'Hostname' or 'IP Address' is/are are in the wrong format. Solution: Verify provided details and test connection through pressing the 'WHM' button. |
8. No results to display: User or domain not found. |
Reason: Account with the specified domain name does not exist on the server. Solution: Make sure that customer's details in your WHMCS system contain specified domain name or create a new account. |
9. No results to display: Wrong username value |
Reason: Account with the specified username does not exist on the server. Solution: Make sure that customer's details in your WHMCS system contain specified username or create a new account. |
10. No results to display: Access denied |
Reason: Account already exists on the server but access to the server has been lost due to changed server group, changed server details or is blocked by e.g firewall. Solution 1: Make sure that connection to your server is working properly and it is not being blocked. Additionally, make sure that your server group is set up correctly. |
11. User parameter is invalid or was not supplied |
Reason: Account exists on the server but the username is incorrect. Solution: Make sure that customer's account username is the same in both your WHMCS system and your WHM. |
12. When you get 'cURL Error : Maximum (20) redirects followed' while trying to install a new application, this indicates the problem with your cPanel theme. To solve the problem, log in to your WHMCS, go to 'Module Settings' of your product, find the 'cPanel Theme' field and make sure that the entered name is correct. |
13. Blank page while logging into phpMyAdmin or any functionality in the 'Stats' page. |
Reason: Logging in requires SSL connection. Solution: Check 'Secure' in your server settings for cPanel (step 11th of Installation and Configuration). |
14. Running 'Create' on cPanel Extended product does not create application ordered along with product. Reason: Some applications require additional fields during installation (other than those available in the product custom fields). |
15. In case you encounter a problem with notification: 'Something goes wrong, check logs, contact admin.' please clear your cache first before taking any other steps as it might solve the problem. |
16. cPanel Extended For WHMCS does not support Application Links. |
17. If you see any missing language entries e.g. for applications installer, you can add them manually in the language file. Simply open the '{yourWHMCS}/modules/servers/cpanelExtended/lang/english.php' file, insert the missing entry to it and add your own translation, following the example of the other records. |
18. 'Domain is invalid' - displayed while trying to create a new addon domain. |
Reason: Used TLD is not supported. Solution: Please check whether the used TLD is present on the list of supported TLDs in the file: '/modules/servers/cpanelExtended/core/Config/tldList/tld.list' |
19. 'Unexpected Module Error(Token 'f80e57b1be9752d7d4344672d55aafa2'). Please Contact Administrator.' - error displayed in the client area. |
Solution: Reissue your license in our client area, if that does not help, please contact our support department. |
20. Failure Reason: 'Permission Denied' encountered in the module queue. |
Solution: Review your server configuration, and make sure you used a correct token with sufficient (full) privileges. More about API tokens can be found here. |
21. In some cases, you may need to increase the connection timeout due to the extended time required for the cPanel server to create an account. To adjust this setting, follow these steps:
By default, this parameter is set to an empty value, which means it does not alter the WHMCS module's behavior: cpanelApiConnectionTimeout: To change the timeout, specify a value in seconds. For example, setting it to 4, will override the default timeout duration. cpanelApiConnectionTimeout: '4' |