Personal tools
Namespaces

Variants
Actions

cPanel Manage2 For WHMCS

From ModulesGarden Wiki
Revision as of 11:57, 4 March 2019 by Karolina (Talk | contribs)

Jump to: navigation, search

Contents

About cPanel Manage2 For WHMCS

cPanel Manage2 For WHMCS is a module created to introduce and automate 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.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate License
✔ Change IP Address Assigned To License
✔ View License Details
✔ Toggle Automatic License Assignment To Specified IP Address
✔ Define Package ID, Group ID And Expiration Reason
  • Client Area Features:
✔ Order License
✔ View License Details
✔ Change IP Address Assigned To License
  • General Info:
✔ Integrated With Product Linker For WHMCS - Resell Licenses In Product Bundles (read more)
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7
✔ Easy Module Upgrade To Open Source Version

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 two packages that support different PHP versions.
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.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' › 'System' › 'PHP Info'.

PHP56 72.png
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.

The content of PHP version files should look like this.

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

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

CM3.png
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

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'.

CM4.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 into your WHMCS. Now press 'Setup' 'Products/Services' 'Servers'.
Afterwards, press 'Add New Server'.

SO8.png
7. Next enter your server 'Name', 'Username' and 'Password'.

Choose 'CpanelManagetwo' from a 'Type' dropdown menu and press 'Save Changes'.

CM5.png
8. After you configure your server correctly, you will see a following screen.

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

CM5.5.png
9. Enter name, click on your previously created server, press 'Add' then press 'Save Changes'.
SO11.png

Configuration Of Product

10. In order to create and configure product, click on 'Setup' 'Products/Services' 'Products/Services' .

If you do not have a product group, click on 'Create a New Group'. If you do, simply go to step 11.

SO12.png
11. Enter product group name and press 'Create Group'.
SO13.png
12. When 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' .

SO14.png
13. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
SO15.png
14. Now go to 'Module Settings' section, choose both 'CpanelManagetwo' and your previously created server group from dropdown menus.

Next, select 'Force License' - force adding license to a specified IP address.
Enter 'Package ID' - the ID of the package that the new license will use.
Enter 'Group ID' — the ID of the group which the new license will belong to.
Select 'Expiration Reason' — a parameter required for distributors
'Save Changes'!

CM6.png
15. Once module settings are ready move to 'Custom Fields'.

In 'Field Name' enter 'IP', choose 'Text Box' from a field type dropdown menu, enter 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
That's it. You have just successfully installed and configured cPanel Manage 2 For WHMCS!

This is how a correctly configured product looks like.

CM8.png

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.

CM10.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.

CM11.png
3. In the next step of settings 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/


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.

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

Management

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

Actions:

  • Change IP - enter new IP address to change it.
CM9.png
If you move to the client are page, you will see the same data on the license.

License IP address can be changed here as well.

CM8.png

Tips

1. You have to unlock your WHMCS System IP in the cPanel Manage2 to access the API.

Update Instructions

Essential guidance through the process of updating the module is offered here.

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!
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.

Common Problems

1. When 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 after installation you get an ionCube encoder problem (wrong version), please open a support ticket.

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

Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
CPanel Manage2 For WHMCS