Personal tools
Namespaces

Variants
Actions

CPanel Extended For WHMCS

From ModulesGarden Wiki
Revision as of 14:13, 17 October 2012 by Peter (Talk | contribs)

Jump to: navigation, search

Contents

About cPanel Extended For WHMCS

ModulesGarden's cPanel Extended for WHMCS is a fully featured addon module created in order to facilitate management of cPanel.

It allows your customers to manage their hosting accounts without even accessing cPanel! Whole cPanel's functionality is relocated directly to the clientarea.
This is a fantastic time saving and convenience!

  • Client Area management includes:
✔ Apps Installation With Softaculous and Installatron
✔ BACKUPS MANAGEMENT for Apps - Softaculous and Installatron
✔ Application Auto Installer
✔ FTP Accounts
✔ Emails
✔ Databases
✔ Subdomains
✔ Parked Domains
✔ Addon Domains
✔ Email Forwarding
✔ CRON
✔ Login To Webmail
✔ Logon to cPanel/WHM
✔ Change Password Functionality
  • Additional functionality:
✔ Functions Manager Addon - Enable/Disable Functionality Per Each Product
✔ Language Support
✔ Supports WHMCS Version v4.5 and Later
✔ Ajax Loaded Pages - Similar To These From cPanel!

Installation

In this tutorial we will show you how to successfully install cPanel Extended For WHMCS.

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

1. Login to your clientarea and download cPanel Extended.
CP1.png
2. Upload and extract the module into the main whmcs directory.
Files in your WHMCS directory should look like this.
CP2.png
3. When you install cPanel Extended for the first time you have to rename 'license_RENAME.php' file.
File is located at 'modules/servers/cpanel_extended/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .
CP3.png
4. In order to configure your license key you have to edit a previously renamed 'license.php' file.
File is located at 'modules/servers/cpanel_extended/license.php' . Enter your licence key between quotation marks as presented on the following screen.
You can find your license key at your clientarea -> 'My Products'.
CP4.png
5. Now you have to activate the module in your WHMCS system.
Login to your WHMCS admin area. Click 'Setup' then choose 'Addon Modules' .
Afterwards find 'CPanel Extended Functions' and press Activate button.
CP5.png
6. In next step you need to permit access to this module.
To do so choose 'Full Administrator' and press 'Save Changes' .
CP6.png
7. Well done! You have just successfully installed cPanel Extended For WHMCS! Now in your WHMCS system press 'Addons' then press 'Cpanel Extended Functions' .
You will see a following screen. Let's proceed to configuration of your freshly installed module.
File:CP7.png
8. 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' (or 'Setup' -> 'Servers' in WHMCS v4.x).
Afterwards press 'Add New Server' .
CP8.png
9. Next, enter your server name, IP adress, username and password. Choose 'Cpanel_extended' from a dropdown menu and press 'Save Changes' .
Here you can also provide other server details like nameservers or maximum number of accounts.
CP9.png
10. 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' .
CP10.png
11. Enter name, click on your previously created server, press 'Add' then press 'Save Changes' .
CP11.png
12. In order to create and configure product click on 'Setup' -> 'Products/Services' -> 'Products/Services' .
If you don't have a product group, click on 'Create a New Group' . If you do, simply go to step 14.
CP12.png
13. Enter product group name and press 'Create Group' .
CP13.png
14. When you have a product group, you can create your product and assign it with cPanel Extended. If you already have a product, go to step 16.
To create a product click on 'Create a New Product' .
CP14.png
15. Afterwards choose your product type and product group from a dropdown menus, enter your product name and press 'Continue' .
CP15.png
16. Now go to 'Module Settings' section, choose both 'Cpanel_extended' and your previously created server group from a dropdown menus and press 'Save Changes' .
CP16.png
That's all. You have just correctly created and customized new product.
17. To verify whether everything is working as it should click on 'Addons' -> 'Cpanel Extended Functions' in your WHMCS.

For test purposes tick 'Install App' , 'Softaculous' , 'Install Button' and press 'Configure' .

File:CP7.1.png
18. In the newly opened window tick 'ALL' as shown on the screen below and press 'Save Changes' .
File:CP7.2.png
19. From now on all your clients who ordered previously created 'A Fine Product' will be able to manage their cPanel without entering it.
This is what your customers should see in their clientarea:
File:CP18.1.png

Management

cPanel Extended allows your customers to manage their cPanel account via clientarea in your WHMCS system.
In this short guide we will present you the possibilities of our addon module.

Management of FTP Accounts

1. You can manage your FTP accounts through creating, modifying and deleting.
File:CPC1b.png

Management of Emails

2. You can manage all aspects related to e-mail accounts.
File:CPC2b.png

Management of Emails Forwarders

3. Here you can manage all email forwarders and email domain forwarders.
File:CPC3b.png

Management of Databases

4. Owing to MySQL Databases Management you can create/delete new databases and users. You can also add users to particular databases and set up privileges.
File:CPC4b.png

Management of Cron

5. Management of Cron allows you to add and monitor your cron jobs.
File:CPC5c.png

Management of Subdomains

6. You can create and manage your subdomains.
File:CPC6b.png

Management of Addon Domains

7. You can add and manage your addon domains.
File:CPC7b.png

Management of Parked Domains

8. You can add and manage your parked domains.
File:CPC8b.png

Management of Domains Forwarders

9. Easy access to domain forwarders is very useful. Within a few seconds, you can redirect the page to point to another.
File:CPC10.png

Log In To cPanel

10. If necessary, you can easily log in to your cPanel by clicking 'Login to cPanel' .
File:CPC11b.png

Log In To Webmail

11. With a single click of a button 'Login to Webmail' you can log in to your Webmail.
File:CPC12b.png

Install Applications

12. Very interesting and time saving feature of cPanel Extended. In seconds you can install your favourite applications without even accessing cPanel!

To do so simply click on 'Install Applications!' then click on 'Install New' button.

File:CPC13.png
Afterwards you will see an extensive menu of application categories. For presentation purposes we will install 'Wordpress' located at 'Blogs' .

Please note that the following screen doesn't contain all applications categories.

File:CPC14.png
Let's enter 'Blogs' category and press the button 'Install Now!' next to 'Wordpress' .
File:CPC15.png
Now you can enter necessary installation details and press 'Install Application' when ready.
File:CPC16.png
If the installation process was successful you will see a message as shown on the screen below.
File:CPC17.png
From now on you can check the status of your application by clicking 'Install Applications!' on the left side menu.
File:CPC18.png

Backups Management For Apps

You can also create a backup of your installation. It's very easy! To do so click 'Create Backup' .
File:CPC19.png
After a few seconds you should see a 'Success' message as a confirmation of the operation performed.

To manage your backups simply press 'Backups' .

File:CPC20.png
Here you can quickly view your existing backups, delete them or restore.
File:CPC21.png

Management Of Application Auto Installer

text
File:CPC22.png
text
File:CPC23.png

Management Of Older Products

You can easily use cPanel Extended module with your already configured products.

To do so change the original 'cpanel' to 'cpanel_extended' in module configuration of servers and products.
Additional information about how to correctly configure your servers and products you can find at points 8-16 in 'Installation' section.

How To Update

1. Updating cPanel Extended to newer version is quite simple. Firstly download the newest version from your clientarea.
File:CPU1.png
2. Secondly upload and extract the module into the main whmcs directory.
Files in your whmcs directory should look like this.
File:CPU2.png
3. Afterwards rename 'license_RENAME.php' file which is located at 'modules/servers/cpanel_extended/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .
File:CPU3.png
4. Enter your license key to previously renamed 'license.php' file.
File is located at 'modules/servers/cpanel_extended/license.php' . Enter your licence key between quotation marks as presented on the following screen.
You can find your license key at your clientarea -> 'My Products'.
File:CPU4.png
5. Afterwards in your WHMCS system click on 'Setup' then 'Addon Modules' .
Now deactivate cPanel Extended by pressing 'Deactivate' button as shown on the screen below.
File:CPU5.png
6. Next activate your module once again by pressing 'Activate' button.
File:CPU6.png
7. Don't forget to set the access control. To do so tick 'Full Administrator' and press 'Save Changes' .
File:CPU7.png
8. In the last step go to 'Addons' -> 'Cpanel Extended Functions' and set up your products functions.
File:CPU8.png
Your module and products have been just sucessfully updated, good job!

Tips

1. How to create multiple products and assign them separate options? Nothing easier!

Let's say you want to offer FTP only for the first product, email and email forwarders for the second product and databases only for the third product.
To do so create three products and at 'Module Settings' of each product choose 'Cpanel_extended' as a module name.
Now go to 'Addons' -> 'Cpanel Extended Functions' and set up functionality of your previously created products as presented on the screen below.
Don't forget to save your changes.

File:CPC9.png
Keep in mind that you can configure any number of products with any combination of functionality.

Common Problems

1. If after install, you get IonCube encoder problem (wrong version), please open a support ticket. We will provide you different version of the module encyrpted with the old version of IonCube.
2. 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' ".
If so please deactivate and activate your module and try once again. If it still doesn't solve your problem, please download your addon module from your clintarea and re install it.

3. If you have problems with connection make sure that both ports 2082 and 2083 are open.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
CPanel Extended For WHMCS