Personal tools
Namespaces

Variants
Actions

CPanel Manage2 For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About cPanel Manage2 For WHMCS)
(→‎Installation and Configuration)
Line 55: Line 55:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download cPanel Manage2.'''
+
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download cPanel Manage2 For WHMCS.'''
 
|}
 
|}
 
{|
 
{|
Line 62: Line 62:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
−
Files in your WHMCS directory should look like this.
+
Files in your WHMCS directory should look like these.
 
|}
 
|}
 
{|
 
{|
Line 69: Line 69:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''3. When you install cPanel Manage2 for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''3. When you install cPanel Manage2 for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
File is located in '' 'modules/servers/cpanelManagetwo/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' ''.
+
File is located in '' 'modules/servers/cpanelManagetwo/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
Line 76: Line 76:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a 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 at your client area → '' 'My Products' ''.
+
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → '' 'My Products'. ''
 
|}
 
|}
 
{|
 
{|
Line 82: Line 82:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. 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;"|'''5. 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' '' (or '' 'Setup' '' → '' 'Servers' '' in WHMCS v4.x).<br />
+
To do so, log in into your WHMCS. Now press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers'. ''<br />
−
Afterwards, press '' 'Add New Server' ''.
+
Afterwards, press '' 'Add New Server'. ''
 
|}
 
|}
 
{|
 
{|
Line 90: Line 90:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Next enter your server name in '' 'Name' '' field, cPanel NOC area details: cPanel Manage2 API username in '' 'Username' '' field and your API password in '' 'Password' '' field.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''6. Next enter your server '' 'Name', '' cPanel NOC area details: '' 'Username' '' and '' 'Password' '' '''<br />
−
Choose '' 'CpanelManagetwo' '' from a dropdown menu and press '' 'Save Changes' ''.<br />
+
Choose '' 'CpanelManagetwo' '' from a '' 'Type' '' dropdown menu and press '' 'Save Changes'. ''<br />
−
Here you can also provide other server details like nameservers or maximum number of accounts.
+
 
|}
 
|}
 
{|
 
{|
Line 99: Line 98:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''7. After you configure your server correctly, you will see a following screen.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''7. After you configure your server correctly, you will see a 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'. ''
 
|}
 
|}
 
{|
 
{|
Line 105: Line 104:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''8. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''8. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes'. '''''
 
|}
 
|}
 
{|
 
{|
Line 112: Line 111:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''9. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''9. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
−
If you don't have a product group, click on '' 'Create a New Group' ''. If you do, simply go to step 11.
+
If you do not have a product group, click on '' 'Create a New Group'. '' If you do, simply go to step 11.
 
|}
 
|}
 
{|
 
{|
Line 118: Line 117:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''10. Enter product group name and press '' 'Create Group' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''10. Enter product group name and press '' 'Create Group'. '''''
 
|}
 
|}
 
{|
 
{|
Line 124: Line 123:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''11. When you have a product group, you can create your product and assign it with cPanel Manage2. If you already have a product, go to step 13.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''11. When 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' ''.
 
|}
 
|}
Line 131: Line 130:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''12. Afterwards choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''12. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue'. '''''
 
|}
 
|}
 
{|
 
{|
Line 138: Line 137:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''13. 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;"|'''13. Now go to '' 'Module Settings' '' section, choose both '' 'CpanelManagetwo' '' and your previously created server group from dropdown menus.'''<br />
−
Next, tick '' 'Force License' '', enter your Package ID and Group ID, then press '' 'Save Changes' ''.
+
Next, select '' 'Force License', '' enter your Package ID and Group ID, then press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
Line 144: Line 143:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''14. After modifying module settings press '' 'Custom Fields' '' which is on the right of the '' 'Module Settings' '' button.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''14. After modifying module settings move to '' 'Custom Fields'. '''''<br />
−
In the '' 'Field Name' '' enter '' 'IP' '', choose '' 'Text Box' '' from a field type dropdown menu, enter description and set up validation as:<br />
+
In the '' 'Field Name' '' enter '' 'IP', '' choose '' 'Text Box' '' from a field type dropdown menu, enter 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]?)<br/ >\.(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/<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]?)<br/ >\.(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/<br />
−
Important! It is one line of command, do not split it into two lines.
+
Important! It is a one line command, do not split it into two lines.
 
|}
 
|}
 
{|
 
{|
Line 154: Line 153:
 
{|
 
{|
 
|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 />  
−
On the following screen you can see how the addon will look like for your customers.
+
This is how a correctly configured product looks like.
 
|}
 
|}
 
{|
 
{|

Revision as of 16:46, 9 November 2015

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 And Group ID
  • 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 WHMCS Templates Five and Six
✔ Supports WHMCS V5 and V6

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 your client area and download cPanel Manage2 For WHMCS.
CM1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like these.

CM2.png
3. When you install cPanel Manage2 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
4. 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 your client area → 'My Products'.

CM4.png
5. 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
6. Next enter your server 'Name', cPanel NOC area details: 'Username' and 'Password'

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

CM5.png
7. 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
8. Enter name, click on your previously created server, press 'Add' then press 'Save Changes'.
SO11.png
9. 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
10. Enter product group name and press 'Create Group'.
SO13.png
11. 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
12. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
SO15.png
13. Now go to 'Module Settings' section, choose both 'CpanelManagetwo' and your previously created server group from dropdown menus.

Next, select 'Force License', enter your Package ID and Group ID, then press 'Save Changes'.

CM6.png
14. After modifying module settings move to 'Custom Fields'.

In the '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/

Important! It is a one line command, do not split it into two lines.

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

Management

From admin area you can manage your clients cPanel Manage2 products as well as view licenses details and change licenses IP addresses.
CM9.png

Tips

1. You have to unlock your WHMCS System IP in the cPanel Manage2 to access the API.
2. Group ID — The ID of the group to which the new license will belong.
3. Package ID - The ID of the package that the new license will use.
4. Force License - Specifies whether the creation of the new account should be forced.

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 name is 'IP' . In other case, module will not work properly.
3. If after install, you will get an ionCube encoder problem (wrong version), please open a support ticket.

We will provide you with 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=20757"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
CPanel Manage2 For WHMCS