Personal tools
Namespaces

Variants
Actions

CPanel Manage2 For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Upgrade Guide)
 
(90 intermediate revisions by 7 users not shown)
Line 5: Line 5:
 
=About [https://www.modulesgarden.com/products/whmcs/cpanel-manage2 cPanel Manage2 For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/cpanel-manage2 cPanel Manage2 For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''cPanel Manage2 For WHMCS''' is a module created to introduce and automate provisioning of cPanel licenses in your WHMCS.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''cPanel Manage2 For WHMCS''' is a module created to introduce and automate the provisioning of cPanel licenses in your WHMCS.<br />
−
The module will enable your clients to view detailed information about their licenses in your WHMCS client area as well as assign IP addresses to their licenses.
+
The module will enable your clients to view detailed information about their licenses in your WHMCS client area as well as assign IP addresses to their licenses.<br/><br/>
 +
Check out also our [https://www.modulesgarden.com/products/cpanel/inactive-account-manager '''Inactive Account Manager For cPanel'''] module and '''reduce your running cPanel costs!'''
 
|}
 
|}
 
<!--a comment maybe? -->
 
<!--a comment maybe? -->
Line 12: Line 13:
 
{|
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate License
 
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate License
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Change License Package
 
|}
 
|}
 
{|
 
{|
Line 23: Line 27:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Define Package ID And Group ID
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Package, Group And Expiration Reason
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Choose Billing Type:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Default - Bill Client Only For License Regardless Of Accounts Number
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Flexible - Bill Client For Exact Number Of Accounts Assigned To License
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Bill Client For Closest Number Of Accounts Assigned To License
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Day Of Month To Synchronize Accounts Number For Billing
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Adjust Number Of Accounts To Start Billing
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Allow Creating Multiple Licenses For Single IP Address
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Sell Licenses As Products Or Product Addons
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Run API Connection Test
 +
|}
 +
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
Line 31: Line 63:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ View License Details
 
|style="padding: 0px 0px 0px 30px;"|✔ View License Details
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Number Of Accounts Assigned To License
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 10px 30px;"|✔ Change IP Address Assigned To License
 
|style="padding: 0px 0px 10px 30px;"|✔ Change IP Address Assigned To License
 
|}
 
|}
 +
 +
*'''Configurable Options:'''
 +
{|
 +
|style="padding: 10px 0px 10px 30px;"|✔ Billing For The Number Of Accounts
 +
|}
 +
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With <u>Product Linker For WHMCS</u> - Resell Licenses In Product Bundles [http://www.modulesgarden.com/products/whmcs/product_linker/features (read more)]
+
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/product_linker Product Linker For WHMCS] - Resell Licenses In Product Bundles
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/server-allocator Server Allocator For WHMCS] - Automatic Assignment Of Most Suitable Servers To Products
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Product Addons
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.8 Back To WHMCS V8.6
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
+
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/cpanel-manage2#open-source-version Open Source Version]
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''In this tutorial we will show you how to quickly install and configure cPanel Manage2 For WHMCS.'''<br />
+
|style="padding: 10px 0px 0px 0px;"|'''In this tutorial we will show you how to quickly install and configure [https://www.modulesgarden.com/products/whmcs/cpanel-manage2 cPanel Manage2 For WHMCS.]'''<br />
 
We will guide you step by step through the whole installation process.
 
We will guide you step by step through the whole installation process.
 
|}
 
|}
Line 64: Line 114:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 20px 15px;"|'''2. In the downloaded file you will find a package with specified PHP versions, that is PHP 7.4 and later.'''
−
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP74_81.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory. <br/>
−
The content of PHP version files should look like this.  
+
The content of the package to upload should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:dsrter.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install cPanel Manage2 For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install cPanel Manage2 For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
−
File is located in '' 'modules/servers/cpanelManagetwo/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
The file is located in '' 'modules/servers/cpanelManagetwo/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CM3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
+
Enter your license key in between the quotation marks as presented on the screen below. You can find your license key in our client area → '' 'My Products'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CM4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM_4.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''6. Good job! You have just successfully installed cPanel Manage2 For WHMCS! Now, we will show you how to configure a new product.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''6. Good job! You have just successfully installed cPanel Manage2 For WHMCS! Now, we will show you how to configure a new product.'''<br />
−
To do so, log in into your WHMCS. Now press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers'. ''<br />
+
To do so, log in to your WHMCS. Now, press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers'. ''<br />
−
Afterwards, press '' 'Add New Server'. ''
+
Afterward, press '' 'Add New Server'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SO8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM_4_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. Next enter your server '' 'Name', 'Username' '' and '' 'Password'. '' '''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. Next, enter your server '' 'Name' '' and  '' 'Hostname' '' or '' 'IP Address'.'' '''<br/>
−
Choose '' 'CpanelManagetwo' '' from a '' 'Type' '' dropdown menu and press '' 'Save Changes'. ''<br />
+
Choose '' 'CpanelManagetwo' '' from the '' 'Type' '' dropdown menu, enter your '' 'Access Key ID' '' and '' 'Secret Access Key','' finally test the connection, and, if successful, press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
Line 107: Line 156:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. After you configure your server correctly, you will see a following screen.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. If you configure your server correctly, you will see the following screen.'''<br />
 
Now you need to create a new group for your server. For that purpose press '' 'Create New Group'. ''
 
Now you need to create a new group for your server. For that purpose press '' 'Create New Group'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CM5.5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM5.6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''9. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''9. Enter your group name, click on your previously created server, press '' 'Add' '' and then '' 'Save Changes'. '''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SO11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CM_7.png]]
 
|}
 
|}
 +
==Configuration Of Product==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''10. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''10. In order to create and configure a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
−
If you do not have a product group, click on '' 'Create a New Group'. '' If you do, simply go to step 11.
+
Click on '' 'Create a New Group'. '' Otherwise, simply move on to step 11.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SO12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM_8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. Enter product group name and press '' 'Create Group'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''11. Enter your product group name and press '' 'Create Group'. '''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SO13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''12. When you have a product group, create a new product. If you already have a product, go to step 13.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''12. Once you have a product group, create a new product. If you already have a product, go to step 13.'''<br />
 
To create a product click on '' 'Create a New Product' ''.
 
To create a product click on '' 'Create a New Product' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SO14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''13. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''13. Afterwards, choose your product type and product group from the dropdown menus, enter your product name and press '' 'Continue'. '''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SO15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM_11.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''14. Now go to '' 'Module Settings' '' section, choose both '' 'CpanelManagetwo' '' and your previously created server group from dropdown menus.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''14. Now, go to the '' 'Module Settings' '' section, choose both '' 'CpanelManagetwo' '' and your previously created server group from the dropdown menus.'''<br />
−
Next, select '' 'Force License' ''- force adding license to a specified IP address.<br/>
+
* ''' Force License '''- allows you to force adding the license to the specified IP address.
−
Enter '' 'Package ID' '' - the ID of the package that the new license will use.<br/>
+
* ''' Package ''' - it is the package that the new license will use. In previous versions of the module you have to provide its ID.
−
Enter '' 'Group ID' '' — the ID of the group which the new license will belong to.<br/>
+
* ''' Group ''' - it is the group which the new license will belong to. In previous versions of the module you have to provide its ID.
−
'' 'Save Changes'! ''
+
* ''' Expiration Reason ''' -  a parameter required for distributors.
 +
* ''' Billing Type ''' - specifies how you can bill your clients for the number of accounts assigned to a single license.
 +
** ''' Default ''' - you will bill your WHMCS clients only for the purchased license regardless of accounts number assigned to it. <br/>E.g. if a client bought a license and created '' '5 accounts' '' that use this license, the amount of your charge will not change.
 +
** ''' Flexible ''' - you will additionally bill your WHMCS clients for the exact number of accounts assigned to the license. <br/> E.g. if a client uses '' '5 accounts' '', there must exist a configurable option corresponding to that exact number of accounts that client can be billed for.
 +
** ''' Tiered ''' - you will additionally bill your WHMCS clients for the closest tier number of accounts assigned to the license. <br/> E.g. if a client uses '' '5 accounts' '', but you set up your configurable options to bill your clients only for '' '1', '3', '7' '' or '' '10' '' accounts, then your client will be billed for ''7 accounts'', because that is the closest highest number to the already used '' '5 accounts' ''.
 +
* ''' Accounts Number Update ''' -  if you chose the '' 'Flexible' '' or '' 'Tiered' '' billing type, enter here the day of the month in which you want to synchronize the configurable options in your WHMCS with the number of accounts assigned to the license. <br/>This synchronization will take place on the provided day during the execution of the main WHMCS cron.
 +
* ''' Adjust Accounts Number ''' - here you can provide the number of license accounts after exceeding which you will start billing your clients. Leave this field empty if you want accounts billing to work as normal.<br/> E.g. if you provide '' '100' '' there, and your client has 101 accounts, then he will be charged for only 1 new account, while the first 100 will be ignored. If there are 105 license accounts, the client will be billed as if he had only 5 accounts and so on. This number also affects the value you set for a configurable option. It can be particularly useful when using the '' 'quantity' '' type, where you provide pricing based on the specified range. E.g. if you want to charge your clients from 101 to 110 new accounts, in our case, you can set quantity pricing as it would be from 1 to 10 for each new account.<br/>  
 +
 
 +
'' '''Note:''' To use 'Billing Type' and other related options you will have to create an additional ''' 'accounts' ''' configurable option, which you can read about in '''point 16''' of this setup guide.''
 +
 
 +
Save Changes when you are ready.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CM6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM_12.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15. Once module settings are ready move to '' 'Custom Fields'. '''''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''15. Once the module settings are ready, move to '' 'Custom Fields'. '''''<br />
−
In '' 'Field Name' '' enter '' 'IP', '' choose '' 'Text Box' '' from a field type dropdown menu, enter description and set up validation as:<br />
+
In '' 'Field Name' '' enter '' 'IP', '' choose '' 'Text Box' '' from the field type dropdown menu, enter a description and set up validation as:<br />
 
  /\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/
 
  /\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CM7.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:CM7.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''16. Finally, if you want to use the '' 'Billing Type'' ' option, you will have to create a new configurable option. '''''<br />
 +
First, go to '' 'Setup' → 'Products/Services' → 'Configurable Options' '' and '' 'Create a New Group' '' with any custom name. <br/>
 +
Next, press the '' 'Add New Configurable Option' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:CM_13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|A new window will open. Now, you have to create a new configurable option with the '''accounts''' variable name.<br />
 +
It is important to use that exact name, but you can put any friendly name you want next to it.<br/>
 +
Now, provide the number of accounts assigned to the license and their pricing you want to bill your clients. <br/>
 +
You may use the '' '''Dropdown''' '' or '' '''Quantity''' '' configurable option type.<br/> Save changes when ready.<br/>
 +
 +
'' '''Important: ''' Remember that using the 'Adjust Accounts Number' product setting will affect the values of configurable options set during synchronization with the number of accounts assigned to the license.<br/>
 +
 +
Please also refer to [https://docs.whmcs.com/Addons_and_Configurable_Options#Configurable_Options this article] to find more information about using configurable options in WHMCS.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:CM_14.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|After the creation of a new configurable option is done, remember to assign it to your cPanel Manage2 license product.<br/>
 +
You may also hide this billing option from your clients. Do not forget to save the changes.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:CM_15.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''That's it. You have just successfully installed and configured cPanel Manage 2 For WHMCS!'''<br />  
 
|style="padding: 0px 0px 15px 15px;"|'''That's it. You have just successfully installed and configured cPanel Manage 2 For WHMCS!'''<br />  
−
This is how a correctly configured product looks like.
+
This is how a correctly configured product looks in the client area.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:CM_15_0.png]]
 +
|}
 +
 
 +
==Configuration Of Addon==
 +
{|
 +
|style="padding: 10px 0px 15px 0px;"|'''This module can be also alternatively configured as to become a 'Product Addon' that can be bought additionally next to a given product.'''<br />
 +
More information concerning 'Product Addons' in WHMCS can be found [https://docs.whmcs.com/Product_Addons here].
 +
In order to configure your addon follow the steps explained below.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''1. Proceed to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Product Addons' '' → '' 'Add New' '' . '''''<br />
 +
Enter a name and desired description. Then move to the '' 'Module Settings' '' tab.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:CM_16.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''2. Now, as your '' 'Module Name' ''choose '' 'CpanelManagetwo' '' and select your previously created server group from the '' 'Server Group' '' dropdown menu. '''<br />
 +
Then configure the addon in the similar way as the product.<br/>
 +
 
 +
'' '''Important:''' For now billing options for an additional number accounts for licenses are only available for products, not for product addons!''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:CM _17.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''3. In the next step of configuration, move to '' 'Custom Fields'. '' '''<br />
 +
In '' 'Field Name' '' enter '' 'IP' '', choose '' 'Text Box' '' from the '' 'Field Type' '' dropdown menu, enter a description and set up the following validation:<br />
 +
 
 +
<nowiki>/\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/</nowiki>
 +
The validation is necessary to prevent users from providing IP addresses in the wrong format. <br/>
 +
'''Important!''' It is a single line command, do not split it into two lines.<br />
 +
Mark the '' 'Show on Order Form' '' checkbox and press the '' 'Save Changes' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:CM _18.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''You have just successfully configured a new cPanel Manage2 For WHMCS addon. It can be assigned to other products of your choice.''' <br/>
 +
That is how an assigned and active cPanel Manage2 addon product might look in the client area.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CM8.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CM_21.png]]
 
|}
 
|}
  
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|From admin area you can manage your clients cPanel Manage2 products as well as view license's details.<br/>
+
|style="padding: 10px 0px 15px 15px;"|From the admin area you can manage your clients' cPanel Manage2 products as well as view license details.<br/>
−
Actions:
+
Additionally, you can view the number of currently used accounts as well as the corresponding billing plan from the configurable option.<br/>Moreover, you can also change the license's IP address.
−
*Change IP - enter new IP address to change it.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CM9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM_19.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If you move to the client are page, you will see the same data on the license.  
+
|style="padding: 0px 0px 15px 15px;"|If you move to the client area page, you will see the same data on the license.  
−
License IP address can be changed here as well.
+
The license IP address can be changed here as well.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CM8.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CM_20.png]]
 
|}
 
|}
 +
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|1. You have to unlock your WHMCS System IP in the cPanel Manage2 to access the API.'''
+
|style="padding: 10px 0px 10px 15px;"|'''1. You have to unlock your WHMCS System IP in the cPanel Manage2 to access the API.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|2. If you already have licenses in cPanel Manage2 and you would like to import them to WHMCS, you can match them with your products. <br/>
 +
 
 +
All you have to do is add/order a new WHMCS product to your customer without processing the '' 'Create' '' module command. <br/> Then, find the added product in the '' 'Product/Services' '' tab of your customer profile and look for the custom IP field which you created in ''point 15.'' of this manual. <br/> Next, enter the IP of the license you want to link, change the product status to '' 'active' '' and save settings.
 +
 
 +
'' '''Note:''' Be aware that the product's module settings in your WHMCS (point 14. of this manual) should correspond to the specifications of the linked license.
 
|}
 
|}
  
 
=Update Instructions=
 
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
+
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
−
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
+
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
−
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
+
 
|}
 
|}
 +
=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-manage2#open-source-version Open Source version] of your cPanel Manage2 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.
 +
|}
 +
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 10px 15px;"|'''1. If you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}
 
{|
 
{|
Line 206: Line 351:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|3. If after installation you get an ionCube encoder problem (wrong version), please open a support ticket.<br />
+
|style="padding: 0px 0px 30px 15px;"|3. If you encounter the ionCube encoder problem (wrong version) after the installation process, please open a support ticket.<br />
 
We will provide you with a different version of the module encrypted with the older version of ionCube.
 
We will provide you with a different version of the module encrypted with the older version of ionCube.
 
|}
 
|}

Latest revision as of 12:50, 19 April 2024

Contents

[edit] About cPanel Manage2 For WHMCS

cPanel Manage2 For WHMCS is a module created to introduce and automate the provisioning of cPanel licenses in your WHMCS.

The module will enable your clients to view detailed information about their licenses in your WHMCS client area as well as assign IP addresses to their licenses.

Check out also our Inactive Account Manager For cPanel module and reduce your running cPanel costs!

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate License
✔ Change License Package
✔ Change IP Address Assigned To License
✔ View License Details
✔ Toggle Automatic License Assignment To Specified IP Address
✔ Define Package, Group And Expiration Reason
✔ Choose Billing Type:
✔ Default - Bill Client Only For License Regardless Of Accounts Number
✔ Flexible - Bill Client For Exact Number Of Accounts Assigned To License
✔ Tiered - Bill Client For Closest Number Of Accounts Assigned To License
✔ Define Day Of Month To Synchronize Accounts Number For Billing
✔ Adjust Number Of Accounts To Start Billing
✔ Allow Creating Multiple Licenses For Single IP Address
✔ Sell Licenses As Products Or Product Addons
✔ Run API Connection Test
  • Client Area Features:
✔ Order License
✔ View License Details
✔ View Number Of Accounts Assigned To License
✔ Change IP Address Assigned To License
  • Configurable Options:
✔ Billing For The Number Of Accounts
  • General Info:
✔ Integrated With Product Linker For WHMCS - Resell Licenses In Product Bundles
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Product Addons
✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.8 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation and Configuration

In this tutorial we will show you how to quickly install and configure cPanel Manage2 For WHMCS.

We will guide you step by step through the whole installation process.

1. Log in to our client area and download the module.
CM1.png
2. In the downloaded file you will find a package with specified PHP versions, that is PHP 7.4 and later.
PHP74 81.png
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

CM 2.png
4. When you install cPanel Manage2 For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in 'modules/servers/cpanelManagetwo/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

CM 3.png
5. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key in between the quotation marks as presented on the screen below. You can find your license key in our client area → 'My Products'.

CM 4.png
6. Good job! You have just successfully installed cPanel Manage2 For WHMCS! Now, we will show you how to configure a new product.

To do so, log in to your WHMCS. Now, press 'Setup' → 'Products/Services' → 'Servers'.
Afterward, press 'Add New Server'.

CM 4 1.png
7. Next, enter your server 'Name' and 'Hostname' or 'IP Address'.

Choose 'CpanelManagetwo' from the 'Type' dropdown menu, enter your 'Access Key ID' and 'Secret Access Key', finally test the connection, and, if successful, press 'Save Changes'.

CM5.png
8. If you configure your server correctly, you will see the following screen.

Now you need to create a new group for your server. For that purpose press 'Create New Group'.

CM5.6.png
9. Enter your group name, click on your previously created server, press 'Add' and then 'Save Changes'.
CM 7.png

[edit] Configuration Of Product

10. In order to create and configure a product, go to 'Setup' → 'Products/Services' → 'Products/Services' .

Click on 'Create a New Group'. Otherwise, simply move on to step 11.

CM 8.png
11. Enter your product group name and press 'Create Group'.
CM 9.png
12. Once you have a product group, create a new product. If you already have a product, go to step 13.

To create a product click on 'Create a New Product' .

CM 10.png
13. Afterwards, choose your product type and product group from the dropdown menus, enter your product name and press 'Continue'.
CM 11.png
14. Now, go to the 'Module Settings' section, choose both 'CpanelManagetwo' and your previously created server group from the dropdown menus.
  • Force License - allows you to force adding the license to the specified IP address.
  • Package - it is the package that the new license will use. In previous versions of the module you have to provide its ID.
  • Group - it is the group which the new license will belong to. In previous versions of the module you have to provide its ID.
  • Expiration Reason - a parameter required for distributors.
  • Billing Type - specifies how you can bill your clients for the number of accounts assigned to a single license.
    • Default - you will bill your WHMCS clients only for the purchased license regardless of accounts number assigned to it.
      E.g. if a client bought a license and created '5 accounts' that use this license, the amount of your charge will not change.
    • Flexible - you will additionally bill your WHMCS clients for the exact number of accounts assigned to the license.
      E.g. if a client uses '5 accounts' , there must exist a configurable option corresponding to that exact number of accounts that client can be billed for.
    • Tiered - you will additionally bill your WHMCS clients for the closest tier number of accounts assigned to the license.
      E.g. if a client uses '5 accounts' , but you set up your configurable options to bill your clients only for '1', '3', '7' or '10' accounts, then your client will be billed for 7 accounts, because that is the closest highest number to the already used '5 accounts' .
  • Accounts Number Update - if you chose the 'Flexible' or 'Tiered' billing type, enter here the day of the month in which you want to synchronize the configurable options in your WHMCS with the number of accounts assigned to the license.
    This synchronization will take place on the provided day during the execution of the main WHMCS cron.
  • Adjust Accounts Number - here you can provide the number of license accounts after exceeding which you will start billing your clients. Leave this field empty if you want accounts billing to work as normal.
    E.g. if you provide '100' there, and your client has 101 accounts, then he will be charged for only 1 new account, while the first 100 will be ignored. If there are 105 license accounts, the client will be billed as if he had only 5 accounts and so on. This number also affects the value you set for a configurable option. It can be particularly useful when using the 'quantity' type, where you provide pricing based on the specified range. E.g. if you want to charge your clients from 101 to 110 new accounts, in our case, you can set quantity pricing as it would be from 1 to 10 for each new account.

Note: To use 'Billing Type' and other related options you will have to create an additional 'accounts' configurable option, which you can read about in point 16 of this setup guide.

Save Changes when you are ready.

CM 12.png
15. Once the module settings are ready, move to 'Custom Fields'.

In 'Field Name' enter 'IP', choose 'Text Box' from the field type dropdown menu, enter a description and set up validation as:

/\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/
CM7.png
16. Finally, if you want to use the 'Billing Type ' option, you will have to create a new configurable option.

First, go to 'Setup' → 'Products/Services' → 'Configurable Options' and 'Create a New Group' with any custom name.
Next, press the 'Add New Configurable Option' button.

CM 13.png
A new window will open. Now, you have to create a new configurable option with the accounts variable name.

It is important to use that exact name, but you can put any friendly name you want next to it.
Now, provide the number of accounts assigned to the license and their pricing you want to bill your clients.
You may use the Dropdown or Quantity configurable option type.
Save changes when ready.

Important: Remember that using the 'Adjust Accounts Number' product setting will affect the values of configurable options set during synchronization with the number of accounts assigned to the license.

Please also refer to this article to find more information about using configurable options in WHMCS.

CM 14.png
After the creation of a new configurable option is done, remember to assign it to your cPanel Manage2 license product.

You may also hide this billing option from your clients. Do not forget to save the changes.

CM 15.png
That's it. You have just successfully installed and configured cPanel Manage 2 For WHMCS!

This is how a correctly configured product looks in the client area.

CM 15 0.png

[edit] Configuration Of Addon

This module can be also alternatively configured as to become a 'Product Addon' that can be bought additionally next to a given product.

More information concerning 'Product Addons' in WHMCS can be found here. In order to configure your addon follow the steps explained below.

1. Proceed to 'Setup' → 'Products/Services' → 'Product Addons' → 'Add New' .

Enter a name and desired description. Then move to the 'Module Settings' tab.

CM 16.png
2. Now, as your 'Module Name' choose 'CpanelManagetwo' and select your previously created server group from the 'Server Group' dropdown menu.

Then configure the addon in the similar way as the product.

Important: For now billing options for an additional number accounts for licenses are only available for products, not for product addons!

CM 17.png
3. In the next step of configuration, move to 'Custom Fields'.

In 'Field Name' enter 'IP' , choose 'Text Box' from the 'Field Type' dropdown menu, enter a description and set up the following validation:

/\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/

The validation is necessary to prevent users from providing IP addresses in the wrong format.
Important! It is a single line command, do not split it into two lines.
Mark the 'Show on Order Form' checkbox and press the 'Save Changes' button.

CM 18.png
You have just successfully configured a new cPanel Manage2 For WHMCS addon. It can be assigned to other products of your choice.

That is how an assigned and active cPanel Manage2 addon product might look in the client area.

CM 21.png

[edit] Management

From the admin area you can manage your clients' cPanel Manage2 products as well as view license details.

Additionally, you can view the number of currently used accounts as well as the corresponding billing plan from the configurable option.
Moreover, you can also change the license's IP address.

CM 19.png
If you move to the client area page, you will see the same data on the license.

The license IP address can be changed here as well.

CM 20.png

[edit] Tips

1. You have to unlock your WHMCS System IP in the cPanel Manage2 to access the API.
2. If you already have licenses in cPanel Manage2 and you would like to import them to WHMCS, you can match them with your products.

All you have to do is add/order a new WHMCS product to your customer without processing the 'Create' module command.
Then, find the added product in the 'Product/Services' tab of your customer profile and look for the custom IP field which you created in point 15. of this manual.
Next, enter the IP of the license you want to link, change the product status to 'active' and save settings.

Note: Be aware that the product's module settings in your WHMCS (point 14. of this manual) should correspond to the specifications of the linked license.

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[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 Manage2 For WHMCS module to unlock these benefits.
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.

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. If you have problems with connection, check whether your SELinux or firewall does not block ports.
2. Make sure that your custom field is named 'IP'. In any other case, the module will not work properly.
3. If you encounter the ionCube encoder problem (wrong version) after the installation process, please open a support ticket.

We will provide you with a different version of the module encrypted with the older version of ionCube.

Retrieved from "https://www.docs.modulesgarden.com/index.php?title=CPanel_Manage2_For_WHMCS&oldid=66360"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
CPanel Manage2 For WHMCS