CPanel Manage2 For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
(→Installation and Configuration) |
|||
| Line 46: | Line 46: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: | + | |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. | |
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 55: | Line 53: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: | + | |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 at '' 'modules/servers/cpanelManagetwo/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' ''. | |
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 64: | Line 60: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: | + | |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 licence key between quotation marks as presented on the following screen. You can find your license key at your client area → '' 'My Products' ''. | |
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 73: | Line 67: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: | + | |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 /> | |
| − | + | Afterwards press '' 'Add New Server' ''. | |
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 82: | Line 75: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |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 /> |
Choose '' 'CpanelManagetwo' '' from a dropdown menu and press '' 'Save Changes' ''.'''<br /> | Choose '' 'CpanelManagetwo' '' from a dropdown menu and press '' 'Save Changes' ''.'''<br /> | ||
Here you can also provide other server details like nameservers or maximum number of accounts. | Here you can also provide other server details like nameservers or maximum number of accounts. | ||
| Line 90: | Line 83: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: | + | |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' ''. | |
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 105: | Line 96: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: | + | |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. | |
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 120: | Line 109: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: | + | |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 > |
| − | + | To create a product click on '' 'Create a New Product' ''. | |
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 135: | Line 122: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''13. Now go to '' 'Module Settings' '' section, choose both '' 'CpanelManagetwo' '' and your previously created server group from a dropdown menus.'''<br /> |
Next tick '' 'Force License' '', enter your Package ID and Group ID, then press '' 'Save Changes' ''. | Next tick '' 'Force License' '', enter your Package ID and Group ID, then press '' 'Save Changes' ''. | ||
|} | |} | ||
| Line 151: | Line 138: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 25px;"|'''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. | On the following screen you can see how the addon will look like for your customers. | ||
|} | |} | ||
Revision as of 16:43, 10 January 2014
Contents |
About cPanel Manage2 For WHMCS
| ModulesGarden cPanel Manage2 For WHMCS is an addon module which was created to handle the cPanel Licenses provisioning for the WHMCS system. It will help you to automatically provide licenses to your customers. Module is easy to setup, compatible with older WHMCS versions and provides complex functionality for your clients. |
- cPanel Manage2 Functionality:
| ✔ Buy License (Create) |
| ✔ Terminate License |
| ✔ Suspend/Unsuspend License |
| ✔ Change IP Address |
| ✔ Get License Details |
- Requirements:
| ✔ ionCube Loaders |
| ✔ WHMCS V4.4 or Later |
| ✔ You have to be cPanel Partner NOC |
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. |
|
| 2. Upload and extract the module into the main WHMCS directory.</br >
Files in your WHMCS directory should look like this. |
|
| 3. When you install cPanel Manage2 for the first time you have to rename 'license_RENAME.php' file.</br >
File is located at 'modules/servers/cpanelManagetwo/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' . |
|
| 4. In order to configure your license key you have to edit a previously renamed 'license.php' file.</br >
Enter your licence key between quotation marks as presented on the following screen. You can find your license key at your client area → 'My Products' . |
|
| 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). |
|
| 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. Choose 'CpanelManagetwo' from a dropdown menu and press 'Save Changes' . |
|
| 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' . |
|
| 8. Enter name, click on your previously created server, press 'Add' then press 'Save Changes' . |
|
| 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. |
|
| 10. Enter product group name and press 'Create Group' . |
|
| 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 >
To create a product click on 'Create a New Product' . |
|
| 12. Afterwards choose your product type and product group from a dropdown menus, enter your product name and press 'Continue' . |
|
| 13. Now go to 'Module Settings' section, choose both 'CpanelManagetwo' and your previously created server group from a dropdown menus. Next tick 'Force License' , enter your Package ID and Group ID, then press 'Save Changes' . |
|
| 14. After modifying module settings press 'Custom Fields' which is on the right of the 'Module Settings' button. 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]?) Important! It is one line of command, do not split it into two lines. |
|
| That's it. You have just successfully installed and configured cPanel Manage 2 For WHMCS! On the following screen you can see how the addon will look like for your customers. |
|
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. 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. |
| 2. Make sure that your custom field name is 'IP' . In other case, module won't work properly. |
| 3. When you have problems with connection, check whether your SELinux or firewall is not blocking ports. |