CPanel Extended For WHMCS

About cPanel Extended For WHMCS

ModulesGarden 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 web hosting accounts without even accessing cPanel! Whole cPanel's functionality is relocated directly to the client area. 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

✔ Assignment Of Configurable Options To Application Autoinstall

✔ Assignment Of Custom Fields To Application Autoinstall

✔ FTP Accounts

✔ Emails

✔ Databases

✔ Subdomains

✔ Parked Domains

✔ Addon Domains

✔ Email Forwarding

✔ Email Domain Forwarders

✔ Cron

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

✔ Backups Management

✔ SSL Certificates Management

✔ Unban IP Addresses

✔ Log In To phpMyAdmin

✔ Log In To RVSiteBuilder

✔ Log In To Webmail

✔ Log In To cPanel/WHM

✔ Change Password Functionality

• Additional Functionality:

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

✔ Multi-Language Support

✔ Ajax Loaded Pages - Similar To These From cPanel!

✔ Integrated With DNS Manager For WHMCS - Supports cPanel & cPanel DNSOnly (read more)

✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more)

✔ Supports WHMCS V4.5 and Later

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.

Installation

1. Log in to your client area 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 client area → 'My Products' .

Activation of Addon

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

Configuration of Server

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 client area 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. If you connect with your cPanel server via SSL then make sure that you checked 'Tick to use SSL Mode for Connections' located at the bottom of the page. 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' .

Configuration of Product

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.

Configuration of Addon

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

18. In the newly opened window, tick the features you would like to activate for your customers and press on 'Save Changes' button.

19. Now, press on 'Install Apps' button.

20. Tick 'Install App' , choose your Auto Installer from a dropdown menu. 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. Note: You can also assign configurable options with app to install, you can find instruction for it here.

21. From now on all your clients who ordered previously created 'cPanel Extended' will be able to manage their cPanel without entering it. This is what your customers should see in their client area:

Management

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

Management of FTP Accounts

You can manage your FTP accounts through creating, modifying and deleting.

Management of Emails

You can manage all aspects related to e-mail accounts.

Management of Emails Forwarders

Here you can manage all email forwarders and email domain forwarders.

Management of Databases

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.

Management of Cron

Management of Cron allows you to add and monitor your cron jobs.

Management of Subdomains

You can create and manage your subdomains.

Management of Addon Domains

You can add and manage your addon domains.

Management of Parked Domains

You can add and manage your parked domains.

Management of Domains Forwarders

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

Management of Stats

Owing to Webalizer, AWstats, Analog Stats and Latest Visitors, you can always be up to date with information about your websites.

Management of Backups

You can backup and download your whole cPanel settings or only part of it. To generate full backup, press on 'Download or Generate Full Website Backup' .

Afterwards, choose 'Backup Destination' from a dropdown menu, choose wheter send or not email notification and enter email if so. Fill aditionall fields, if backup destination is not 'Home Directory' and confirm through pressing 'Generate Backup' .

To download backup simply press on it, download should start immediately. You do not need to generate partial backup, they are generated when you are trying to download them.

Management of SSL Certificates

This feature moves completely the managament of your Private Keys, CSR Keys and SSL Certificates into your WHMCS client area. Here you can conveniently manage all the aspects of your SSL Certificates without necessity to log in to your cPanel.

Management of Unban IP

At 'Unban IP' page you can unban IP addresses banned by your system. To unban IP, simply enter it into 'IP ' textbox and press 'Unban' button.

Log In To phpMyAdmin

Get quick access to your phpMyAdmin with just one click. You don't need to even enter your username and password!

Log In To cPanel

You can easily log in to your cPanel by clicking 'Log In To cPanel' . Here you also don't need to enter your username and password!

Log In To Webmail

With a single click of a button 'Log In To Webmail' you can log in to your Webmail.

Log In To RVSiteBuilder

Moves you to 'RVSiteBuilder' immediately.

Install Applications

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.

Afterwards you will see an extensive menu of application categories. For presentation purposes we will install 'Wordpress' located at 'Content Management' . Please note that the following screen doesn't contain all available applications.

Let's enter 'Content Management' category and press the button 'Install Now!' next to 'Wordpress' .

File:CP43.png

Now you can enter necessary installation details and press 'Install Application' when ready.

If the installation process was successful you will see a message as shown on the screen below.

File:CP45.png

From now on you can check the status of your application by clicking 'Install Applications!' on the left side menu.

Backups Management For Apps

You can also create a backup of your installation. It's very easy! To do so click 'Manage' button.

Afterwards, go to 'Backup' tab. Backup creation will start immediately.

After a few seconds progress bar will fill, you should see a 'Creating Backup: Completed' message as a confirmation of the operation performed. To manage your backups simply go to 'Backups' .

Here you can quickly view, delete or restore your existing backups.

Assignment of Configurable Options To Application Autoinstall

Your customers will definitely love this functionality! With its 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' , press on 'Install Apps' , tick 'Install App' and 'Assign To Configurable Options' and choose 'Auto Installer' . Click on floppy disk icon to download list of app.

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 4images in your applications list, you will need to enter value '4images 1.7.11' . If you will make a mistake with the name, the autoinstall will not work. Now, when you know what values should be entered in configurable options for particular applications, we can proceed further.

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

Enter 'Group Name' by your choice, select product you want to assign configurable options to, then press 'Save Changes' .

Now click on 'Add New Configurable Option' .

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

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

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 client area while placing the order.

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

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. Recommended and safer solution is allowing 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 9 custom fields. First 8 are: 'Directory' , 'Database Name' , 'Database Username' , 'Database Password' , 'Table Prefix' , 'Site Name' , 'Site Description' and 'Language' . Remember to set the field type as 'Text Box' , tick 'Required Field ' and 'Show on Order Form' . Everything is shown on the screen below.

Last field is 'Auto Update' , set it as 'Drop Down' , enter 'Yes, No' into 'Select Options' and tick 'Required Field ' and 'Show on Order Form' .

File:CP61.1.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.

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

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.

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:CP65.png

Management of Existing Products

You can easily use cPanel Extended module with your already configured cPanel products. To do so change type of servers and module names of products from 'Cpanel' to 'CpanelExtended' . Additional information about how to correctly configure your servers and products you can find at points 8-16 in 'Installation and Configuration' section.

Management of Billing

When you combine cPanel Extended For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options. Module allows you to charge your customers based on the server resources used by them.

With Advanced Billing module, you can also display your customers the current server resource usage and their cost.

How To Update

1. Updating cPanel Extended to newer version is quite simple. Firstly download the newest version from your client area.

2. Secondly upload and extract the module into the main whmcs directory. Files in your whmcs directory should look like this.

2.5. If you are updating from cPanel Extended 1.6.6 or older you have to make additional changes. Remove folder 'cpanel_extended' from 'your_whmcs/modules/servers' . Set server type as 'CpanelExtended' (Configuration of Server, step 9) Set module name as 'CpanelExtended' (Configuration of Product, step 16)

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 client area → 'My Products'.

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.

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.

Your module and products have been just sucessfully updated, good job!

Tips

1. You can 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.

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

3. If you would like to use the cPanel/WHM Import Utility with cPanel Extended products, you will need to switch products type to 'Cpanel'. Afterwards you can successfully use the import script. After finishing the import, simply switch back the products type to 'CpanelExtended'.

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: Values inside the field/s '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: Wrong hostname or ip value: This problem occurs when connection to the cPanel server is not configured properly.

Reason: Values inside the field/s 'Hostname' or 'IP Address' is/are are in the wrong format. Solution: Verify provided details and test connection through pressing 'WHM' button.

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

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

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

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

11. When you get 'cURL Error : Maximum (20) redirects followed' while trying to install new application, this indicates the problem with your cPanel theme. To solve the problem log in to your WHMCS, go to 'Module Setttings' of your product, find the field 'cPanel Theme' and make sure that the entered name is correct.

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