cPanel Extended For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About cPanel Extended For WHMCS

cPanel Extended For WHMCS allows to automate accounts provisioning and lets your clients manage their web hosting accounts in the WHMCS client area.

The module permits your customers not only to manage aspects like FTP accounts, domains, databases or backups but also install and manage various web applications.
Inbuilt admin panel will let you adjust each product individually and decide which functionalities shall be available to your clients. It will definitely prove to be a convenient and time saving solution!

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Account
✔ Change Package And Password Of Account
✔ Log In To Each cPanel Account On Click
✔ Automatically Unban Client IP Address Upon Logging In
✔ Configure Client Area Features And Template Per Product
✔ Configure Resource Limits Per Product
✔ Choose And Configure Application Auto Installer To Use Per Product - Softaculous Or Installatron
✔ View All cPanel And cPanel Extended Products And Servers In One Place
✔ Define CloudLinux Configuration Per Product:
✔ Resource Limits
✔ PHP Version
  • Client Area Features:
✔ Remote Access And Management Of:
✔ Applications And Their Backups
✔ FTP Accounts
✔ Email Accounts
✔ Email Forwarders
✔ MySQL Databases
✔ Cron Jobs
✔ Subdomains
✔ Addon Domains
✔ Domain Redirects
✔ Domain Aliases
✔ Metrics: Latest Visitors, Webalizer, Analog Stats, AWStats
✔ SSL/TSL Management
✔ Backups - Manual And Automatic
✔ Unban IP Addresses
✔ MX Entries
✔ Files Manager
✔ SSH Access
✔ One Click Login To:
✔ cPanel
✔ Webmail
✔ phpMyAdmin
✔ RVSiteBuilder
✔ File Manager
✔ cPanel Single Sign-On - WHMCS V6 Only
✔ Change Account Password
  • Application Auto Installer Features:
✔ Ordering Process:
✔ Auto Install Chosen Application After Account Creation
✔ Auto Install Application Chosen By Client During Order - Owing To Configurable Options
✔ Allow Custom Settings Of Auto Installed Application - Owing To Custom Fields
✔ Client Area:
✔ Install New Applications With Softaculous And Installatron
✔ View And Manage Installed Applications
✔ Backup Installed Applications
✔ View And Manage Created Backups
✔ Restore Applications From Backups
✔ Delete Applications Along With Their Backups
  • General Info:
✔ Utilizes Ajax Loaded Pages - Similar To Those 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)
✔ Integrated With IP Manager For WHMCS - Complete Management of IP Subnets (read more)
✔ Multi-Language Support
✔ Supports PHP 5.3 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation and Configuration

Read the below instructions to learn how to install and then configure cPanel Extended For WHMCS properly.

We will guide you step by step through the installation procedures.

Installation

1. Log in to your client area and download cPanel Extended For WHMCS.
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 in 'modules/servers/cpanelExtended/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.

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

CP4.png
5. Set files installatron_script.txt and softaculous_scripts.txt located in 'whmcs_root/modules/addons/cpanel_extended_center' as writable.

Activation of Addon

6. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Click 'Setup' and find 'Addon Modules'.
Afterwards, find 'cPanel Extended Center' and press 'Activate' button.

CP5.png
7. In the next step, you need to permit access to this module.

To do so, click on 'Configure' button, tick desired admin roles and press 'Save Changes'.
Note: Here you can also define which client area template are you using, based on Six or Five.

CP6.png
8. cPanel Extended For WHMCS is now successfully installed!

Access the addon under 'Addons' 'cPanel Extended Center'.

Configuration of Server

9 To begin, you must add a new server.

Go to 'Setup' 'Products/Services' 'Servers' and press 'Add New Server'.

CP8.png
10. Enter your server name, IP address, username and a password. Choose 'cpanelExtended' from a dropdown menu and press 'Save Changes'.

If you connect with your cPanel server via SSL, then make sure that you checked 'Secure' located at the bottom of the page.
Note: Keep in mind that 'Login to Webmail' and 'Login to cPanel' buttons' URLs, located in the client area, derive from 'Hostname' or 'IP Address' fields input.

CP9.png
11. Once your server has been configured correctly, you will see a following screen.

Create a new group for your server. Press 'Create New Group' to follow.

CP10.png
12. Enter name, click on your previously created server, press 'Add' then 'Save Changes'.
CP11.png

Configuration of Product

13. In order to create a product, go to 'Setup' 'Products/Services' 'Products/Services' .

If you do not have a product group, click on 'Create a New Group' . If you do, simply skip step 13.

CP12.png
14. Fill in a product group name and press 'Create Group'.
CP13.png
15. When you have a product group added, you can create your product and assign it to cPanel Extended module.
CP14.png
16. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue' .
CP15.png
17. Now, go to 'Module Settings' section, choose both 'CpanelExtended' and a previously created server group from dropdown menus and press 'Save Changes' .

Important: Setting cPanel theme is required for some features to work properly.
Configure your WHM Package here if you wish.

CP16.png
18. If you want to enable CloudLinux features for your product, then simply select this option.

When you save the changes, fields underneath become active. Now, you can put limits on your clients' resources within:

  • CPU Usage
  • Physical Memory
  • I/O Limit
  • Concurrent Connections
  • Number of Processes
  • PHP Version
CP16 1.png

Configuration of Addon

19. You have just correctly created and customized a new product.

Go to 'Addons' 'cPanel Extended Center' in your WHMCS. You will find there dashboard with precise data on products and servers:

  • see the number of active/suspended/terminated products
  • check the number of active accounts
  • connect with WHM here (if configured in 'Module Settings')
  • press 'Documentation' tab to be moved to this very site!
CP17.png
20. Proceed to 'Features' section and find the product you are interested in and press 'Configuration' button next to it.
CP17 1.png
21. You should find there boxes dedicated to 'Features', 'Applications', 'Client Area Template'.

If you have already another product configured, you may copy its configuration now. Find one more box 'Copy Configuration' and choose product from dropdown menu.
To show you an example, we will set the configuration from the beginning, we will not use other product's configuration.

Select the features you would like to activate for your customers.

CP18.png
22. Choose whether to activate 'Install Applications' option.

In case you wish to activate this option, you will have to select 'Auto Installer' from a dropdown menu. Afterwards activate 'Install Button' and 'Backup Button'.
You can also choose desired language of the applications by typing in its two letter code into the 'Language' field. A complete list of language codes can be found here.
If the field is left blank, a default value, which is 'en' (english) will be used.
Note: You can also create a configurable option with app to be installed, you can find the instruction to do that here.

CP20.png
23. Finally, select from the available which client area template shall be used for this product.

Note that by default only one template is available. If you have more templates prepared, they will also appear here to choose from.
Do not forget to 'Save' changes once product configuration is ready!

CP19.png
24. From now on, all your clients who ordered a previously created product will be able to manage their cPanel accounts via your WHMCS system.

Here a view of the ordered product summary in admin area. Available actions:

  • Log In To Control Panel
  • Use Module Commands: 'Create', 'Suspend', 'Unsuspend', 'Terminate' the product; 'Change Package' and 'Change Password'
CP00.png
This is what your customers should see in their client area in WHMCS V5:
CP21.png
Client area view in WHMCS V6:
CP21 1.png

Management

cPanel Extended allows your customers to manage their cPanel accounts without being logged into the server.

Read the below descriptions to become familiarized with all of the cPanel Extended functionalities.

Client Area

In the following section, features available in the client area will be thoroughly discussed.

Applications

Install your favorite applications in a few seconds without even accessing cPanel!

Use cPanel Extended For WHMCS to:

  • Install applications
  • Edit/delete applications
  • Create and restore Backups

To start, simply proceed to 'Applications' then find 'Install New' section.

CP41.png
Afterwards, you will see an extensive menu of application categories. For presentation purposes we will install 'PrestaShop' located in 'eCommerce'.
Find 'PrestaShop' and press it.
CP42.png
Now, you have to enter necessary installation details and then press 'Install Application' to follow. Wait for 'Success' message.
CP44.png
View the list of your installed applications by clicking 'Installed Applications' tab and manage the application.

You will find there the name of the application, its path, size and available actions:

  • create backup
  • delete application
  • edit application (available if 'installatron' is used, a pencil icon will appear)
CP46.png

Backups

You can also create a backup of your installation. It's very easy! To do so, press 'Create Backup' button next to an installed application.
CP47.png
Confirm the action and backup creation will start immediately.
CP48.png
After a moment you should see 'Backup created successfully' message as a confirmation of the operation performed.
CP49.png
When you have created a backup of your application, proceed to 'Backups' tab.
There is a lit of created application backups along with the date when they were created.
Use action buttons marked on the screen to restore and delete a chosen backup.
CP49.1.png

FTP Accounts

Add and configure FTP Accounts in the easiest way possible. Just type in login, generate a totally secure password, provide directory and declare Quota.
Manage the accounts to be able to access your website files through an FTP protocol.
CP22.png

Email Accounts

Create and edit email accounts that are associated with your domains. Use filter to find required email address, preview its selected quota and manage the account.
CP23.png

Email Forwarders

Set up email forwarders, choose from several destination options to adjust mail forwarding perfectly to your needs.
Add email domain forwarders to forward email form one domain to another.
CP24.png

MySQL Databases

MySQL Databases and Users allow easy and fast management of online applications, systems, shopping carts etc.
Create database, add new users and then combine the users with particular databases.
CP25.png

Cron Jobs

Select cron jobs settings to fully automate commands and scripts on your site.
Choose its specific timing and type in the command to be executed.
CP26.png

Subdomains

Create subdomains for different parts of your website. Choose domain from your list of available, provide document root.

Once created, redirect or delete the subdomain if needed.

CP27.png

Addon Domains

Addon domains allow you to link the domain to a subdirectory of your account.
Manage addon domains, create subdomains, use password generator to enjoy full security. Redirect and assign users to crated addon domains.
Please note, that FTP account associated with the domain will be automatically created.
CP28.png

Domain Redirects

Easy access to domain redirection options is very useful.

This option allows you to redirect a specific web page to another one and display the contents of that page.
For example, if your main domain is mytestingdomain.com, you can make such forward:
mytestingdomain.com/redirectadomainwithlongname-averylongname.com
Choose type: permanent or temporary; decide whether to use 'www' redirection or not; select 'Wild Card Redirect' if you need.

CP30.png

Domain Aliases

You can add and manage your domains' aliases.

This option allows you to read content of one domain from another domain name.
Note: domains must be registered with a valid registrar and point to your DNS server.

CP29.png

Metrics

Be always up to date with information about your websites, use 'Webalizer', 'AWstats', 'Analog Stats' and 'Visitors' to analyze and interpret the presented data on each domain.
CP31.png

SSL/TLS MAnagement

This feature moves the management of your Private Keys, CSR Keys and SSL Certificates into your WHMCS client area.

Generate, upload and install certificates and keys without the necessity of logging in to your cPanel.

CP35.png

Backups

All backups made automatically are displayed on this page under 'Available Restore Points' section.

To restore from a backup, choose elements to backup and press 'Restore' .
Note: Automatic backup has to be enabled from your WHM panel.

CP31 1.png
You can make backups and download your whole cPanel settings or only a part of them.

To generate a full backup, press 'Generate A Full Backup' .

CP32.png
Afterwards, choose 'Backup Destination' from a dropdown menu.

Optionally, you can fill in an email address, where a notification about the backup will be sent.
Choose backup destination from a dropdown menu.
Confirm backup creation through pressing 'Generate Backup' .

CP33.png
To download a backup, simply press 'Download' button. The process should start immediately.

Partial backups are generated during the download process.

CP34.png

Unban IP Address

Unban IP addresses banned by the system.

Your IP is automatically filled in in the field to unban.

CP36.png

MX Entry

This page enables you to manage your MX records for each of your domains.

Choose the domain, then select priority of the new record and its destination.
When added, edit or remove records.

CP36 1.png

File Manager

Manage files and folders of your cPanel account. Upload files, create folder to categorize the files, compress, extract etc.

View the list of files with specific data on them: name, file size, last modification date and given permissions.

CP36 2.png

SSHAccess

Configure your SSH keys. Create new keys or import your existing keys.

Available actions: view, authorize, download or delete key.
Afterwards, you can connect to your cPanel, for example via PuTTY, with your private SSH key.

CP36 3.png

Log In To phpMyAdmin

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

Log In To RVSiteBuilder

One click of the button moves you immediately to RVSiteBuilder.
CP40.png

Log In To cPanel

You can easily log in to your cPanel by clicking 'Log In To cPanel'.

Here, similarly to phpMyAdmin, you don't need to enter your access details!

CP38.png

Log In To Webmail

With a single click of 'Log In To Webmail' you can access your Webmail.
CP39.png

Log In To File Manager

Forwards you to File Manager in your cPanel account instantly.
CP40 1.png

Change Password

Through changing the password you can change both, your cPanel account and FTP account passwords at the same time.
CP49 2.png

Applications Configuration

Configurable Options For Application Auto Install

Let your clients decide which application they would like to install on their new cPanel account.

While placing an order your customer chooses an 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!
To set up this feature, come back to your product's configuration, find 'Applications' section, activate 'Install Applications' , choose 'Auto Installer' and activate 'Use Configurable Options' .
Click on a download icon to view the list of applications.

CP52.png
These are the names of values that you can enter in configurable options' fields, we will configure them in the next step.

For example, if you would like to set up 'Drupal' in your applications list, you will need to enter value 'Drupal 7.38' or 'Drupal'.
1. If you have made a mistake with the application name, the auto installer will not work.
2. If you do not enter version number, the auto installer will install the latest version of the application.
Now, when you know what values should be entered in configurable options for particular applications, we can proceed further.

CP53.png
Go to your 'WHMCS' 'Setup' 'Products/Services' 'Configurable Options' and press 'Create a New Group' .
CP54.png
Enter 'Group Name' of your choice, select product you want to assign configurable options to, then press 'Save Changes' .
CP55.png
Now click on 'Add New Configurable Option' .
CP56.png
This moment is very important. As 'Option Name' , you have to enter 'Installation App' . In other case the entire functionality will not work.

Here you can set up as many applications as you want. To do so, enter a value name e.g. 'Wordpress 3.7.1' and press 'Save Changes' .
Repeat this as many times as you need and do not forget to set 'Option Type' to 'Dropdown' .

Remember that you are not obliged to type in the application version number! If not provided, the latest version will be installed.

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

CP58.png
Afterwards, come back to 'cPanel Extended Features' 'Configuration' 'Applications' , activate 'Use Configurable Options' and choose 'Apps/Configurable Options' from a dropdown menu.

Please note that you can have more configurable options groups. Press 'Save' and that's it. You have just successfully assigned configurable options to application autoinstall.

CP59.png
Let's 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 previously configured applications has shown up.

CP60.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 moment applications had been installed with use of default details like e.g. directory names or database name.
Those details are sent to each customer's email.
Allowing your customers to choose their own installation paths, usernames and others is a safer and recommended solution.. Let's see how can we do that.
In the beginning, go to 'Product/Services' , find your product using 'cPanel Extended' module and enter 'Custom Fields' category.
You will need to add 12 custom fields, the first 8 are:

  • Directory
  • Database Name
  • Database Username
  • Database Password
  • Table Prefix
  • Site Name
  • Site Description
  • Language

Remember to set each field type as 'Text Box' , tick 'Required Field ' and 'Show on Order Form'.
Everything is shown on the screen below.

CP61.png
The next 3 fields are:
  • Admin Username
  • Admin Password
  • Admin Email

Set them as 'Text Box' and tick 'Show on Order Form'.

CP61 1.png
The last field is:
  • Auto Update

Set it as 'Drop Down' , enter 'Yes, No' into 'Select Options' , tick 'Required Field ' and 'Show on Order Form'.

CP61 2.png
Once you add all the custom fields they will appear while placing an order.

Voila! Now your customers can personalize each application without the necessity of installing it later.

CP62.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 a new custom field for your product. The field should be called 'Language' .

CP63.png
Afterwards go to your 'Products/Services' and check whether 'Language' field has appeared.

In order to change default applications language for certain account enter here an appropriate value.

CP64.png
From now on the new field will be visible for your customers as well. While installing a new application they can choose desired language by entering value into the field.

Here you will find a complete list of language codes.

Management of Existing Products

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

To do so, change the type of servers and module names of products from 'Cpanel' to 'CpanelExtended' .
Additional information about how to correctly configure your servers and products can be found in 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.

The module allows you to charge your customers basing on the server resources used by them.

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

How To Update

1. Updating cPanel Extended goes alike updating any other MG product, for more information visit Modules Update page.

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.

CP70.png
2. In order to make the reseller account own itself you need to check 'Set the reseller to own their own account' field located in 'Module Settings'.
CP71.png
3. If you would like to use 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'.

4. If your users have problems with applications not showing to install, you need to log into WHM and proceed to Softacullous general settings.
Choose: Top Scripts (Default) for Default page for Enduser Panel.
5. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If after installation, you 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.

3. 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 client area and re install it.

4. If you have problems with connection make sure that both ports 2082 and 2083 are open.
5. After you change language of the module, your Ajax notifications might not work correctly. Encode language file in UTF-8 (without BOM) to solve this issue.
6. 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.

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

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

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

10. 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 1: 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.
Solution 2 (cPanel Extended V1.7.0 and previous): open file modules/servers/cpanelExtended/classes/cPanel API/curl_options.ini and set CURLOPT_FOLLOWLOCATION to 0.

11. 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 the same in both your WHMCS system and your WHM.

12. 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 Settings' of your product, find the field 'cPanel Theme' and make sure that the entered name is correct.

13. Blank page while logging into phpMyAdmin or any functionality in 'Stats' page.
Reason: Logging in requires SSL connection.

Solution: Check 'Secure' in your server settings for cPanel (step 10th of Installation and Configuration).

14. Running 'Create' on cPanel Extended product does not create application ordered along with product.

Reason: Some applications require additional fields during installation (other than those available in the product custom fields).
Due to limitations in the Softaculous API these applications will not be installed when a new product is created.
Solution: Application has to be installed manually via cPanel Extended For WHMCS. Walk around will be added in a further version.

15. In case you encounter a problem with notification: 'Something goes wrong, check logs, contact admin.'
Please firstly clear your cache, before taking any other steps as it might solve the problem.
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
CPanel Extended For WHMCS