CPanel Extended For WHMCS

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!

• Clientarea 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

✔ Stats: Latest Visitors, Webalizer, Analog Stats, AWStats

✔ SSL Certificates Management

✔ Log In To phpMyAdmin

✔ Login To Webmail

✔ Login to cPanel/WHM

✔ Change Password Functionality

• Additional Functionality:

✔ Functions Manager Addon - Enable/Disable Functionality Per Each Product

✔ Multi-Language Support

✔ Supports WHMCS Version V4.5 and Later

✔ Ajax Loaded Pages - Similar To These From cPanel!

Installation and Configuration

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. Log in to your clientarea and download cPanel Extended For WHMCS.

2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

3. When you install cPanel Extended for the first time you have to rename 'license_RENAME.php' file.

File is located at 'modules/servers/cpanelExtended/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.

Enter your licence key between quotation marks as presented on the following screen. You can find your license key at your clientarea → 'My Products' .

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.

6. In next step you need to permit access to this module.

To do so click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes' .

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

9. Next, enter your server name, IP address, username and password. Choose 'CpanelExtended' from a dropdown menu and press 'Save Changes' . Keep in mind that values of clientarea buttons 'Login to Webmail' and 'Login to cPanel' are taken from a 'Hostname' field. If field is empty, they are taken from an 'IP Address' field. Here you can also provide other server details like nameservers or maximum number of accounts.

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

11. Enter name, click on your previously created server, press 'Add' then press 'Save Changes' .

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.

13. Enter product group name and press 'Create Group' .

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

15. Afterwards choose your product type and product group from a dropdown menus, enter your product name and press 'Continue' .

16. Now go to 'Module Settings' section, choose both 'CpanelExtended' and your previously created server group from a dropdown menus and press 'Save Changes' . You can also configure your WHM Package here.

17. That's all. You have just correctly created and customized new product which will appear in cPanel Extended admin area. To verify whether everything is working as it should click on 'Addons' → 'Cpanel Extended Functions' in your WHMCS. Afterwards click on 'Configure' button.

File:CP7.1.png

18. In the newly opened window tick 'ALL' as shown on the screen below and press 'Save Changes' . Keep in mind that at least one of the functionalities needs to be active in order to enable Application Installer.

File:CP7.2.png

19. Now tick 'Install App' , choose your Auto Installer and App from a dropdown menus. Afterwards tick 'Install Button' and 'Backup Button' . You can also choose desired language of the application by entering value into the 'Language' field. Complete list of language codes you will find here. If the field is left blank, the default value 'en' (english) will be used.

File:CP7.3.png

20. 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. You can easily log in to your cPanel by clicking 'Login to cPanel' . You don't need to even enter your username and password!

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 available 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, delete or restore your existing backups.

File:CPC21.png

Management of Application Auto Installer

With this feature you can set up which application will be installed for newly created cPanel accounts. To do so go to your 'WHMCS' → 'Addons' → 'Cpanel Extended Functions' . Next tick 'Install App' , choose your auto installer and your application from dropdown menus. Don't forget to save changes.

File:CPC22.png

If you don't want to install any application to your customer's accounts just set this field as blank and press 'Save Changes' .

File:CPC23.png

Assignment of Configurable Options To Application Autoinstall

Your customers will definitely love this functionality! With it's help you can let them decide which application they would like to install on their new cPanel account. And that's very easy. While placing an order your customer chooses application and along with account creation this very application will be installed on the account. There is nothing else you need to do. Application will be instantly ready to use! Ok, lets setup this feature. Go to 'cPanel Extended Functions' , tick 'Assign To Configurable Options' and hover the cursor over blue question mark field as shown on the screen below.

File:CPC27.png

Click on 'Click here' field. As you can see the window with all the applications appeared. Please note that following screen doesn't contain all available applications. These are the names of values that you can enter in configurable options fields which we will configure in the next step. For example, if you would like to set up MediaWiki in your applications list, you will need to enter value 'MediaWiki 1.20.2' . If you will make a mistake with the name, the autoinstall won't work. Now, when you know what values should be entered in configurable options for particular applications, we can proceed further.

File:CPC28.png

Go to your WHMCS → 'Setup' → 'Products/Services' → 'Configurable Options' . Now press 'Create a New Group' .

File:CPC24.png

Enter Group Name by your choice then press 'Save Changes' .

File:CPC25.png

Now click on 'Add New Configurable Option' .

File:CPC26.png

This moment is very important. As an Option Name you have to enter 'Installation App' . In other case entire functionality won't work. Here you can set up as many applications as you want. To do so enter the name of value e.g. 'Wordpress 3.5.1' and press 'Save Changes' . Repeat this as many times as you need and don't forget to set the Option Type to 'Dropdown' .

File:CPC29.png

As you can see on the following screen we decided to offer our customers 5 applications. When you finish adding applications press 'Save Changes' and 'Close Window' .

File:CPC30.png

Afterwards go to 'cPanel Extended Functions' , tick 'Assign To Configurable Options' and choose 'Applications' from a dropdown menu. Please note that you can have more configurable options groups. Press 'Save Changes' and that's it. You have just successfully assigned configurable options to application autoinstall. Lets check out what your customers are going to see in their clientarea while placing the order.

File:CPC31.png

As you can see a dropdown menu with our previously set up applications has shown up.

File:CPC32.png

Assignment of Custom Fields To Application Autoinstall

Now when you know how to allow your customers to choose which application they would like to install on their account, we can proceed one step further. Until that momemt applications would have been installed with use of default details like e.g. directory names or database name. Those details are sent to each customer's email. There's nothing wrong with that but you can allow your customers to choose their own installation paths, usernames etc. Lets see how can we do that. At the beginning go to 'Product/Services' , find your product connected with cPanel Extended and enter 'Custom Fields' category. You will need to add several fields here. There are 7 custom fields that need to be added: 'Directory' , 'Database Name' , 'Database Username' , 'Database Password' , 'Table Prefix' , 'Site Name' and 'Site Description' . Remember to set the field type as 'Text Box' , tick 'Required Field ' and 'Show on Order Form' . Everything is shown on the screen below.

File:CPC33.png

Once you added all the custom fields they will appear while placing an order. Voila! Now your customers can personalize each application without necessity of installing it.

File:CPC34.png

Custom Softaculous Application Language

We will show you how to quickly set custom language for Softaculous web applications. For this purpose you need to add new custom field for your product. Field should be called 'Language' .

File:CPC36.png

Afterwards go to your 'Products/Services' and check whether the 'Language' field appeared. In order to change default applications language for certain account enter here an appropriate value.

File:CPC35.png

From now on new field will appear for your customers as well. While installing new application they can choose desired language by entering value into the field. Complete list of language codes you will find here.

File:CPC37.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 'CpanelExtended' 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.

2. Secondly upload and extract the module into the main whmcs directory.

Files in your whmcs directory should look like this.

3. Afterwards rename 'license_RENAME.php' file which is located at 'modules/servers/cpanelExtended/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

4. Enter your license key to previously renamed 'license.php' file.

File is located at 'modules/servers/cpanelExtended/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.

7. Don't forget to set the access control. To do so tick 'Full Administrator' and press 'Save Changes' .

8. In the last step go to 'Addons' → 'Cpanel Extended Functions' , set up your products functions and save the changes.

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! To do so create as many cPanel Extended products as you need. Go to 'Addons' → 'Cpanel Extended Functions' and set up functionality of your previously created products by clicking on 'Configure' button. 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.

2. You can also use cPanel Extended with reseller accounts. It gives you new opportunities! To do so simply go to your cPanel Extended product → 'Details' and choose 'Reseller Account' from a dropdown menu as shown on the following screen.

File:CP19t.png

3. In order to make the reseller account to own itself you need to check the 'Set the reseller to own their own account' field located in 'Module Settings' .

File:CP20t.png

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

4. After you change language of the module, your Ajax notifications might not work correctly. Solution to this is encoding language file in UTF-8 (without BOM).

5. No results to display: Connection problem: This problem occurs when connection to the cPanel server is not configured properly.

Reason: Hostname, IP address, username, password, type and/or access hash is/are incorrect. Solution: Verify provided details and test connection through pressing 'WHM' button.

6. No results to display: User or domain not found.

Reason: Account with the specified domain name doesn't exist on the server. Solution: Make sure that customer's details in your WHMCS system contain specified domain name or create a new account.

7. No results to display: Wrong username value

Reason: Account with the specified username doesn't exist on the server. Solution: Make sure that customer's details in your WHMCS system contain specified username or create a new account.

8. No results to display: Access denied

Reason: Account already exists on the server but access to the server has been lost due to changed server group, changed server details or block by e.g firewall. Solution: Make sure that connection to your server is working properly and it's not being blocked. Additionally make sure that your server group is set up correctly.

9. User parameter is invalid or was not supplied

Reason: Account exists on the server but username is incorrect. Solution: Make sure that customer's account username is same in both your WHMCS system and your WHM.

10. When you have problems with connection, check whether your SELinux is not blocking ports.