Personal tools


Plesk Extended For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


About Plesk Extended For WHMCS

Plesk Extended For WHMCS is a module which empowers your customers to manage their web hosting accounts directly from the WHMCS client area.

They will be able to manage their FTP accounts, backups, databases, mailboxes, spam filters, DNS settings and other key aspects in a fully remote manner.
The module also offers the choice of three Auto Installers - Softaculous, Installatron and Plesk Application to allow clients add their favorite applications in just a few clicks.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Account
✔ Change Package And Password Of Account
✔ Log In To Plesk User Panel On Click
✔ Define Products Configuration:
✔ Service Plan Name
✔ Reseller Plan Name
✔ IP Address Types To Use
✔ Toggle "Power User" Plesk Panel View
✔ Toggle Client Details Synchronization
✔ Create Subscriptions On Single Or Separate Plesk User Accounts
✔ Define Default PHP Version
✔ Enable Metric Billing
✔ Configure Client Area Features Per Product
✔ Enable And Configure Application Auto Installer To Use Per Product:
✔ Default Plesk App Installer
✔ Installatron
✔ Softaculous
✔ Generate Auto Installer's Applications Configurable Options
✔ Configure Multiple Product Features And Settings At Once
✔ View All Plesk And Plesk Extended Products And Servers In One Place
✔ View All Plesk Extended Server Configurations In One Place
✔ View All WHMCS Clients Linked With Plesk Customer Accounts In One Place
✔ Define Server Custom URL Of Panel And Webmail
✔ Log In To Plesk Administrator Panel On Click
  • Client Area Features:
✔ Remote Access And Management Of:
✔ Addon Domains
✔ Applications
✔ Backups (Up To Plesk 17.5)
✔ Databases - MySQL And PostgreSQL Support
✔ Domain Aliases
✔ DNS Settings
✔ Email Addresses
✔ Email Forwarders
✔ FTP Access
✔ Git Repositories
✔ Log Rotation
✔ Node.js
✔ PHP Settings
✔ Spam Filter - SpamAssassin (Up To Plesk 17.5)
✔ SSL Certificates
✔ Subdomains
✔ Web Users (Up To Plesk 17.5)
WordPress Manager - Separate Module Required
✔ WordPress Toolkit
✔ One Click Login To:
✔ Backup Manager
✔ Plesk
✔ Webmail
✔ WP Toolkit
✔ Change Account Password
  • Application Auto Installer Features:
✔ Ordering Process:
✔ Auto Install Chosen Application After Account Creation
✔ Auto Install Application Chosen By Client During Order - With Configurable Options
✔ Allow Custom Settings Of Auto Installed Application - With Custom Fields
✔ Client Area:
✔ Install New Applications With Installatron, Softaculous Or Default Plesk App Installer
✔ View And Manage Installed Applications
✔ Backup Installed Applications
✔ Perform Auto Backups Upon Application Updates By Installatron
✔ View And Manage Created Backups
✔ Restore Applications From Backups
✔ Delete Applications Along With Their Backups
  • General Info:
✔ Utilizes Ajax Loaded Pages
✔ Supports SSO Into Panel And Webmail
✔ Integrated With Advanced Billing For WHMCS - Actual Server Resource Usage Billing
✔ Integrated With IP Manager For WHMCS - Complete Control And Easy Assignment Of IP Subnets
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products
✔ Integrated With WordPress Manager For WHMCS - Remote Installation And Management Of WordPress Instances
✔ Fully Integrated With Lagom WHMCS Client Theme
✔ Multi-Language Support
✔ Supports Windows And Linux
✔ Supports Plesk Onyx And Plesk Obsidian
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Metric Billing - Integration: Domains, Subdomains, Domain Aliases, Mailboxes, Databases, Additional FTP Accounts, Storage, Traffic
✔ Supports WHMCS Server Sync Tool
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.10 Back To WHMCS V8.8
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

Installation and Configuration


This tutorial will show you how to successfully install and configure Plesk Extended For WHMCS.

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

1. Log in to our client area and download the module.
PE3 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.4 and later.

PHP74 81.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

PE3 2 3.png
4. When you install Plesk Extended For WHMCS for the first time you have to rename the 'license_RENAME.php' file.

The file is located in 'modules/servers/pleskExtended/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

PE3 3.png
5. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

PE3 4.png
6. In the next step, set up the 'storage' folder as recursively writable.

This folder is available at two locations:

  1. your_whmcs/modules/addons/PleskExtended/
  2. your_whmcs/modules/servers/PleskExtended/
PE3 5.png

Activation of Addon

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

Log in to your WHMCS admin area. Move to 'System Settings' and then choose 'Addon Modules'.
Afterward, find 'Plesk Extended' and press the 'Activate' button.

PE3 6 1.png
8. In the next step you need to permit access to this module.

To do so, press 'Configure'. Next, select the required administrator roles and press 'Save Changes' .

PE3 6 2.png
9. Congratulations, you have just successfully installed Plesk Extended For WHMCS!

Configuration of Server

10. Now, we will show you how to configure a new server.

To do so, log in to your WHMCS. Go to 'System Settings' → 'Servers'. Afterward, press 'Add New Server'.

PE2 8.png
11. Next, enter your server name, hostname/IP address, username and password. Choose 'PleskExtended' from the dropdown menu and press 'Save Changes'.

Here you can also provide other server details like nameservers or maximum number of accounts. Finally, click 'Test Connection' to check if the provided credentials are valid.

Note: According to the Plesk documentation, you cannot use the same account and password that you use to log in to the panel. Please use your special account with Partner API access.

Important: Due to changes in the original WHMCS Plesk module, it may be required to additionally enter the IP address into the Hostname field even if you have already provided it in the IP Address field below.
Otherwise, the "Could not resolve host" error may occur.

PE2 9.png
12. After you have configured your server correctly, you will see the following screen.

Now, you need to create a new group for your server. For that purpose, press 'Create New Group'.

PE2 10.png
13. Enter a name, click on your previously created server, press 'Add' , then 'Save Changes'.
PE2 11.png

Configuration of Product

14. In order to create and configure the product, move to 'System Settings' → 'Products/Services'.

If you do not have a product group, choose 'Create a New Group'.

PE2 12.png
15. Enter a product group name and press 'Save Changes'.
PE2 13.png
16. Once you have a product group, you can create your product and assign it to Plesk Extended.

To create a product, press 'Create a New Product'.

PE2 14.png
17. Afterward, choose your product type, product group and module, enter your product name and press 'Save Changes'.

Please note that you may choose only between 'Shared Hosting' and 'Reseller Account' as the product type since only those are supported by the Plesk module.

PE2 15.png
18. Now, move to the 'Module Settings' section, choose your previously created server group from the dropdown menu.

Remember to add your 'Client Template Name' or 'Service Plan Name'. Plesk Extended will not work properly without a specified plan name.
Decide in what way Plesk will assign IP addresses during the accounts creation process, by choosing the appropriate method from the 'Which IP address to use?' dropdown list.
Here you may also enable the 'Power User' view. Do not forget to press 'Save Changes'.

PE2 16.png
19. Good job! You have just correctly created and customized your new product. It will now appear in Plesk Extended Center admin area.

Configuration of Addon

20. After you have correctly created and customized a new product, it is time to configure it.

Go to 'Addons' 'Plesk Extended' in your WHMCS.

This section offers precise data on available products and servers:

  • See the number of active/suspended/terminated accounts
  • See the list of configured Plesk products and servers
  • Go directly to the product and server configuration
  • Log in to Plesk panel from server configuration with one click
  • Easily upgrade the already configured Plesk product to Plesk Extended
PE3 17.png
21. Proceed to the 'Features' section and find the product you are interested in. Press the 'Configuration' button next to the product.
PE3 18.png
22. You will find here boxes dedicated to 'Features' and 'Applications'.

To show you an example, we will set the configuration from the very beginning, without using other configuration options of the product.

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

PE3 19.png
23. Next, toggle 'Install Application' that will be used to install applications by your clients.

In the 'Auto Installer Type' field you will be free to choose between 'Installatron' , 'Softaculous' and 'Default' auto installers.

PE3 20.png
24. You may also enable the option for automatic installation of selected applications once an order is created.

Use the 'Auto Install On Creation' toggle and select the default option from the 'Apps / Configurable Options' list.

You can also choose the desired language of applications by typing in its two-letter code in 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.

Moreover, you can permit your clients to toggle automatic backups for application updates or enable them for the first application after the initial order.

Note: You can also create a configurable option with an app to be installed. You can find the instruction on how to do that here.

PE3 20 0.png
25. You can let your clients decide about the automatic application installation during ordering process by using the 'Use Configurable Options' switch and choosing the appropriate option from the list.
PE3 20 02.png
By selecting this option, you will notice a download button next to the dropdown list on the product's features list.

Its purpose is to download the available application list in the text format that can be then used for configurable options.

More information about the available configurable options and custom fields can be found here.

PE3 20 01.png
26. If you have selected the Auto Installer for the product, and that product does not have any configurable options assigned yet, a button to 'Generate Configurable Options' becomes active.

Press it to quickly generate the configurable options for the product to allow selecting and installing application at the moment of ordering the product.
Read more about generating configurable options here.

PE3 20 1.5.png
27. If you already have another product configured, you may copy its configuration.

Find the 'Copy' button on the list with products or select multiple item at once.
Then, choose the product configuration whose settings you wish to copy into the selected products.

PE3 20 03.png
28. In situation you wish to edit the features of more than one product at once, simply mark the required products and use the mass action button.
PE3 20 4.png
29. In the next step, move to 'Server Configuration' to set up a connection.

Press the ' Configuration' button next to a desired server.

PE3 20 1.png
Enter the proper domain to allow a connection with Plesk panel.

In order to connect to Webmail you may either type in an adequate IP address or provide a webmail URL with a {$domain} variable which will be replaced with a client's domain.
For example: https://webmail.{$domain}
Do not forget to 'Save' changes once you are finished!

PE3 20 2.png
'Clients' section includes a list of your clients who own any Plesk type product. Apart from the client name you may find there the client's Plesk customer ID and server.

Press 'More Information' icon to get more details.

PE3 21 1.png
Plesk client detailed information:
PE3 21 2.png

Upgrade Plesk to Plesk Extended Product

Once you have already configured the standard Plesk products, you can easily upgrade them to the Plesk Extended products.

Note: Before you start, make sure that you have already configured the Plesk Extended server.
To start, proceed to the 'Dashboard' in the Plesk Extended addon. Next, find your standard Plesk product on the list and press the 'Upgrade Product' button.

PE3 24 0.png
Now, select the new server group configured for the Plesk Extended module.

Note: Make sure that this server configuration is exactly the same as the standard cPanel server configuration.
Press 'Confirm' to proceed with the product upgrade. After completion, the product will switch its module settings to the ones from the Plesk Extended module and server.

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

Here is the summary of the ordered product in admin area. The available actions include:

  • Log In To Control Panel
  • Use Module Commands: 'Create', 'Suspend', 'Unsuspend', 'Terminate', 'Change Package' and 'Change Password'.
PE3 21.png
Client area view:
PE3 23.png


Plesk Extended allows your customers to manage their accounts via client area in your WHMCS system.

In this short guide we will present you with the management possibilities of our module.

Client Area

Addon Domains

Addon domains section allows you to link the domain to a subdirectory of your account.
You can view and manage addon domains, edit document root and make redirections.

Note: Make sure this feature is enabled for your account before using

PE3 28.png
Press the 'Create Addon Domain' button and enter the desired details.
Please note that an FTP account will not be automatically created with the domain.
PE3 28 1.png


Install your favorite applications in a few seconds without even accessing Plesk.

Use Plesk Extended For WHMCS to:

  • Install applications
  • Delete applications
  • Create and restore backups

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

PE3 31.png
Afterwards, you will see an extensive menu with application categories.
For presentation purposes we will install 'PrestaShop' located in the 'E-Commerce And Business' category. Find 'PrestaShop' and click on it.
PE3 32.png
Now, you have to enter necessary installation details and then press 'Install Application' to follow. Wait for the 'Success' notification.
PE3 33.png
View the list of your installed applications by clicking on the 'Installed Applications' tab and manage the application.

Here you will find the name of the application, its path, size and available actions (available only for Softaculous & Installatron):

  • Create backup
  • Delete application
PE3 34.png

Application Backups

You can also create a backup of your installation. To do so, simply press the 'Create Backup' button next to the installed application.
PE3 37.png
Confirm the action and backup generation will start immediately.
PE3 37 1.png
After a moment you should receive the 'The backup has been created successfully' message confirming that the operation has been performed successfully.

Once you have created a backup of your application, proceed to the 'Backups' tab.
There you will find a list 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.

PE3 37 2.png
If you use the Installatron plugin, you can also let your customers create automatic backups for application updates.

To do this, go to 'Addons' 'Plesk Extended' 'Features' 'Configuration' and enable Auto Update Backups.

PE3 37 3.png
Then, when a client installs a new application, it will be possible to toggle the option for automatic update backups and restore them if the application update fails.
PE3 37 4.png


All available backups are displayed under the 'Backups' section. To add a new one, press the 'Create Backup' button.

Important: Backups option is available only for users of Plesk up to version 17.5. If you are using a newer version of Plesk, this option will not work correctly.

PE3 24 2.png
Next, add prefix and backup description, choose split size, backup content type and decide whether to make backup 'locally' on Plesk server or on your 'remote' FTP storage.
PE3 24 3.png
The backup creation might take a while. When ready, it can be downloaded by client or deleted from the server.

Important: For large backup files we strongly recommend to increase the 'max_execution_time' setting in your server's 'php.ini' configuration.

PE3 24 4.png
If you want to use the 'remote' backup type, you will also need to provide the 'FTP Storage Settings' .
PE3 24 6.png
Provide your FTP server IP address or hostname, access credentials, mode, and the directory path to which the backup will be uploaded.
Then, when you create the backup for a second time, select the remote type to upload it directly to your FTP server.
PE3 24 7.png


Owing to 'Databases' management you can create/delete new databases and users. Press 'Create Database' to add a new database.
PE3 26 1.png
To create a new database, type in its name into the appropriate field and select its type.
Optionally, you can also create a user directly assigned to the database.

Note: Only 'MySQL' and 'PostgreSQL' databases are currently supported and must be enabled in your Plesk panel first.

PE3 26 2.png
You can also delete already assigned users as well as add new ones to particular databases by choosing 'Create Database User' in the 'Users' tab.
PE3 26 3.png

Domain Aliases

Here you can add and manage your domain aliases.

This allows you to read content of one domain from another domain name.
To create a new redirection, press 'Create Domain Alias' .
Note: Domains should be registered with a valid registrar and point to your DNS server.

PE3 29.png
Next, provide your alias domain, chose domain redirections as well as toggle the remaining options.
PE3 29 2.png
After alias creation, you can also rename it, change its settings or delete it.
PE3 29 3.png

DNS Settings

Here you can add and manage DNS records to define the structure and content of the chosen domain name space.
PE3 30.png
Add records by selecting the type and providing their hostname and value.
PE3 30 1.png

Email Addresses

View and edit email accounts that are associated with your domains. Use filter to find required email addresses, preview its selected quota or delete manage the account.
PE3 25.png
Press 'Add Email Account' and select to which domain it shall be added, type or generate password and define limited or unlimited quota.
PE3 25 1.png

Email Forwarders

In this section, you can set up email forwarders and choose from several destination options to adjust mail forwarding perfectly to your needs.
PE3 26.png
Press the 'Create Email Forwarder' button, specify the forwarded email and define the destination addresses.
PE3 26 4.png
Use the mass action button to delete numerous email forwarders at once, or remove single items one by one.
PE3 26 5.png

FTP Access

In the very first section you are given the possibility to manage your FTP access or create new FTP accounts.

FTP access management is dependent on the system your Plesk panel is set up on.

PE3 24.png
Add and configure FTP Accounts in the easiest way possible.
Just type in your login on a domain, provide or generate a secure password, define directory access and declare available quota.

Note: If you have some other addon domains, creating an FTP account on the main domain will also add it to these domains.

PE3 24 5.png

Git Repositories

The 'Git Repositories' section allows you to create and manage your local Git Repositories and automatically or manualy deploy web sites from such repositories to a target public directory.

Note: Curently, adding only local repositories is supported. Remote Git Repositories like GitHub or BitBucket are not supported yet.

Start by pressing the 'Create Repository' button.

PE3 43.png
In the opened window, chose which 'Domain' you want to use, provide 'Repository Name' (only latin characters, numbers, dashes, underscores, and dots are allowed) and 'Deployment Path' (by default is set to 'httpdocs' ).
Next, also choose the 'Deployment Mode' ( 'Auto' , 'Manual' or 'None' ).

Optionally, specify a list of additional actions which can be carried out each time the files are deployed to the website - use shell commands delimited by “;” symbol that should be applied with an escape character: “>”.

PE3 44.png
Once the repository is created you can also manually deploy it by pressing arrow up button.
PE3 44 1.png
Additionally, when pressing the 'Edit' button, besides the ability to change certain attributes, you can also preview the direct URL of the created repository.
PE3 44 2.png

Log Rotation

The Log Rotation section allows managemnt of logs, turn on log rotation for a domain and configure its conditions.

Note: Please keep in mind that custom logs cannot be rotated.

PE3 45 0.png
Preess the 'Edit' button next to a single domain, and you will be moved to log rotation settings.

Enable log rotaion and define its conditions.

PE3 45 1.png
Select numerous domains and define log rotaion settings in bulk.
PE3 45 2.png
PE3 45 3.png


To use Node.js with our module you have to first get that extension from the Plesk catalog.

Please, log in to you Plesk administrator panel and go to the 'Extensions' section.
Next, find 'Node.js' from the search bar and press the 'Get It Free' button. Now, wait a few minutes until the installation is ready.

PE3 45.png
Once you have installed Node.js extension and enabled it in the features configuration you can enable and adjust the Node.js version to your domains, by pressing the 'Edit' button in the 'Node.js' section of the client area.
PE3 46.png
Now, simply enable Node.js for the chosen domain and select which version you would like to use.
You will also be able to switch version or disable Node.js any time by pressing the 'Edit' button again.
PE3 47.png

PHP Settings

This section allows your clients to configure PHP settings of their domains.
They are allowed to view and alter PHP version of each domain as well as select new settings by clicking the 'Edit' button.
PE3 47 0.png
Edit the PHP settings according to your needs.
Note: Settings may vary depending on the currently selected PHP version.
PE3 47 01.png
If you would like to change the display of the default PHP names in the system to a more user-friendly variant, you may esily edit the language file that is located in:

Add records into the file according to the system names of PHP versions that you want to change, e.g.:

$_LANG['addonCA']['phpSettings'][PHP]['PHP 7.2.34 (CGI application)'] = 'PHP 7.2';
$_LANG['addonCA']['phpSettings'][PHP]['PHP 7.1.33 (CGI application)'] = 'PHP 7.1';
$_LANG['addonCA']['phpSettings'][PHP]['PHP 7.4.15 (FastCGI application)'] = 'PHP 7.4';
$_LANG['addonCA']['phpSettings'][PHP]['PHP 7.2.34 (CGI application)'] = 'Some Custom Name';
The result of these changes will be as following:
PE3 47 02.png

Spam Filter

The 'Spam Filter' powered by SpamAssassin is designed to identify spam messages among emails sent to mailboxes hosted on your Plesk server.

Important: Spam Filter option is available only for users of Plesk up to version 17.5. If you are using a newer version of Plesk, this option will not work correctly.

PE3 26 0 2.png
Enable and configure the filter as desired for the selected mailbox.

You can also adjust sensitivity - by default it might be set to 7 so that all messages with that score or more points will be classified as spam.
If mailboxes receive lots of spam messages with the current setting, to make the filter more sensitive, try setting a lower value, for example, 6.
If any emails are missing because spam filter considers them as spam, try reducing the filter's sensitivity by setting a higher value, for example, 8.

You can also add email messages to a white list that will not be checked by the spam filter, and black list that will block all emails coming from a particular sender.
Simply type domain names in appropriate fields (one domain name per line). Addresses can also contain "*" and "?" wildcard characters, for example, *, user?@*.com.

PE3 26 0.png

SSL Certificates

This section will allow you to generate or paste ready SSL certificates and private keys.
PE3 34 3.png
Choose 'Generate Certificate' and fill out the required fields. You can also decide whether you want the private key to be automatically generated or provide your own key.
Once ready, you will see it on the list of ready certificates.

Note: Current Plesk API does not give the possibility to preview the automatically generated private key. To do this, you need to log directly into the Plesk panel.

PE3 34 4.png
If you already have a certificate, you can provide it by choosing 'Upload Certificate' .
Next, provide the certificate and domain name, and paste the content of yours 'Private Key (*.key)' , 'Certificate (*.crt)' and 'CA Certificate (*-ca.crt)' files.
Once ready, you should see the provided certificate on the list.
PE3 34 5.png


Create subdomains for different parts of your website by pressing the 'Create Subdomain' button.
PE3 27.png
Choose a domain for your available subdomain from the list and provide a document root.
PE3 27 1.png

Web Users

Add and manage the list of web users that have personal pages on your website.

Important: Web Users option is available only for users of Plesk up to version 17.5. If you are using a newer version of Plesk, this option will not work correctly.

PE3 34 1.png
Provide login name and its password and decide whether to provide support for PHP and FastCGI.
PE3 34 2.png

WordPress Manager

If you are an owner of the WordPress Manager For WHMCS module and you have it installed in your WHMCS, your customers can now fully benefit from its seamless integration with the Plesk Extended For WHMCS module.
PE3 35 0.png
This integration will allow your customers to install and manage WordPress instances in detail without the need to leave the Plesk Extended panel in your WHMCS client area.

Precise instructions of the 'WordPress Manager' itself is located here.

DAPE3 35 1.png
Keep in mind that the entire section can only be available if you have purchased and installed the WordPress Manager For WHMCS module.

WordPress Toolkit

WordPress Toolkit is an independent tool used to manage WordPress instances. You may add, configure and freely manage your WordPress installations directly from the level of the WHMCS client area.

Important: Kindly note that the option to delete instances is currently exclusively accessible through the control panel. Removing an installation from the WHMCS client area is not supported.

Note: Please bear in mind that WordPress Toolkit and WordPress Manager are two separate applications.
A single instance cannot be managed from either app, an instance created via the WP Toolkit can be managed in this app only, it cannot be fetched by the WordPress Manager module and the other way around.

PE 40.png
Start your journey by adding the first installation of WordPress.

Press the button 'New Installation' marked on the screen below and read the instruction to see how to install a pure new instance.

PE 41.png
A new window with four tabs will open. In the first Details tab, fill in the following fields:
  • Protocol - select protocol between 'https://' and 'http://'
  • Domain - provide a domain the software will be installed on (your domain is entered by default)
  • Site Name - your custom name of the installation
  • Plugin/Theme Package - you may optionally select a ready plugin or theme set to install on WordPress
  • Language - choose a language for the installation
  • Version - select the version from the list of available
  • Installation Path - here you can select any custom installation script that you want to install (this field is required).
PE 42.png
  • Administrator Username - enter the administrator account username for this installation.
  • Administrator Password - generate an administrator password for this new installation of WordPress.
  • Administrator Email Address - enter the administrator account email address for this installation.
PE 43.png
  • Database Username
  • Database Name
  • Database Table Prefix
  • Database Password
PE 44.png
WP Toolkit can automatically install WordPress core, plugin, and theme updates as soon as they become available. Updates related data:

WordPress Update - Update WordPress automatically:

  • No
  • Yes, but only minor (security) updates
  • Yes, all (minor and major) updates

Plugins Update - Update plugins automatically

  • Defined individually
    • Enable autoupdates by default for new plugins installed via WP Toolkit
  • Defined individually, but security updates are autoinstalled
    • Enable autoupdates by default for new plugins installed via WP Toolkit
    • Deactivate vulnerable plugins instead of updating them
  • Forced
    • Deactivate vulnerable plugins instead of updating them

Themes Update - Update themes automatically

  • Defined individually
    • Enable autoupdates by default for new plugins installed via WP Toolkit
  • Defined individually, but security updates are autoinstalled
    • Enable autoupdates by default for new plugins installed via WP Toolkit
  • Forced - All themes will be forcefully autoupdated regardless of their individual autoupdate settings
PE 45.png
Now wait a moment until a ready WordPress installation is complete and appears on the list on the main page of the WP Toolkit app.

You will find there a list with basic information regarding every installation, including the URL, site name, and version. From this point, you may also manage the installation (1) and delete (2) it at any time.

PE 46.png

Instance Management

Instance details is the first section that you will be directed to once you move to single installation management.

You will find there gathered details on WordPress, such as:

  • URL, Domain, Owner Name, Version, Plugins & Themes Updates, Security Status, PHP version, SSL/TLS
PE 47.png
Maintenance Mode
This section allows setting up the options of website maintenance time. Start by enabling/disabling the mode and then move to more specific features:
  • Restrict Access to WordPress Admin Panel - Restricting access to the WordPress admin dashboard will prevent the site admin from logging in to WordPress when maintenance mode is enabled

Screen Text section allows changing the text displayed on the maintenance screen. You can use HTML tags to format the text's appearance. You may adjust the texts of:

  • Browser Page Title
  • Text Block 1 (large font size)
  • Text Block 2 (small font size)

Timer - enable the timer to count down the remaining time

  • Countdown Timer
  • Remaining time (days, hours, minutes)

Social Network Links - Type in links to your social network pages. If left empty, the corresponding link will be hidden.

  • Facebook
  • Twitter
  • Instagram
PE 48.png
Instance settings
  • Administrator Login Name
  • Administrator Password
  • Email Address
  • Language
PE 49.png
Here you are enabled to activate, deactivate, delete, and update the already installed plugins. You can also add new plugins to your WordPress installation in the 'Add New' tab.
PE 50.png
To add a new plugin, you are required to type in at least three of the initial letters of the desired plugin's name into the search field to see the actual results.
A list of related plugins will appear. You may now learn more about each plugin by pressing the 'Show Details' button.
If the plugin meets your requirements, simply press the corresponding button to begin the installation process (which might take a short while).
PE 51.png
PE 52.png
The 'Mass Action' feature is also present in this section, so you will be able to handle multiple plugins more efficiently and at the same time.
PE 53.png
This section allows quick and easy management of themes installed on your WordPress instance. Enable/disable the theme, update the already installed theme, and delete useless ones.
You can also add new themes to your WordPress installation in the 'Add New' tab.
PE 54.png
Please start typing in the search field to see the available themes.
Once a list of related themes appears, you will be allowed to first check their preview and details.
If the theme satisfies your needs, simply press the corresponding button to begin the installation process (which might take a short while).
PE 55.png
Thanks to the 'Mass Action' functionality, you will be able to handle multiple themes more efficiently at the same time.
PE 56.png

One Click Login

Log In To Backup Manager

Just one click on the 'Backup Manager' button and you will be immediately redirected to the dedicated page.

Note that you must have a proper IP address or domain entered in the admin area panel to use this button.

PE3 36 0.png

Log In To Plesk

With a single click on the 'Log In To Plesk' button you can be redirected to your Plesk Panel account.

Note that you must have a proper IP address or domain entered in the admin area panel to use this button.

PE3 35.png

Log In To Webmail

You can quickly access your webmail through pressing the 'Log In To Webmail' button.

Note that you must have a proper IP address or domain entered in the admin area panel to use this button.

PE3 36.png

Log In To WP Toolkit

You can easily be redirected to the WP Toolkit section in your Plek panel by clicking the 'Log In To WordPress Toolkit' button.

Note that you must have a proper IP address or domain entered in the admin area panel to use this button.

PE3 36 1.png

Applications Configuration

Configurable Options For Application Auto Installation

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

While placing an order, your customer will choose an application and along with the account creation, this very application will be installed on the account.
There is nothing else you need to do. The application will be instantly ready for use!
The module offers two ways in which you may generate applications' configurable options - automatically or manually.

Automatic Generation

Move to your product's configuration 'Addon' → 'Features' → 'Settings', find the 'Applications' section and make sure you have selected the Auto Installer for the product.
PE3 60 0.png
Next, go back to the products list and press the ' 'Generate Auto Installer's Applications Configurable Options' icon.
Note that the button will remain inactive if the product already has the options generated and assigned or the Auto Installer is not selected.
PE3 60 1.png
A list of available applications will appear. Keep in mind that it will differ depending on the selected Auto Installer.

Decide which of the applications you wish to offer to your clients, to select all at once, use the 'Toggle All' option.
Press 'Confirm' when ready.

PE3 60 2.png
Once the options have been generated, they are visible at 'WHMCS' → 'System Settings' → 'Products/Services' → 'Configurable Options' and assigned to the product.

In case you wish to generate the options again for that product, you must previuosy unassign those already generated or delete them.
Otehrwise the ' 'Generate Auto Installer's Applications Configurable Options' button will remain inactive.

Manual Generation

As an alternative, you may generate the configurable options in a traditional way.
To do so, come back to your product's configuration, find the 'Applications' section, activate 'Install Applications' , choose 'Auto Installer Type' and activate 'Auto Install On Creation' with 'Use Configurable Options' .

PE3 52 1.png
Next, go back to the features list and click on the download icon to view the list of applications.
PE3 52.png
These are the names of values that you can enter in configurable option fields. We will configure them in the next step.

For example, if you would like to set up 'Drupal 8.3.2' in your applications list, you will need to enter 'Drupal' or 'Drupal|Drupal 8.3.2' into the value field.
1. If you have made a mistake with the application name, the autoinstaller will not work.
2. In the current version, for a variable you have to enter only the application name (without application version number) and only the latest version available on the application list will be installed.
Now that you know what values should be entered in configurable options, we can proceed further.

PE3 53.png
Go to your 'WHMCS' 'System Settings' 'Products/Services' 'Configurable Options' and press 'Create a New Group' .
Enter 'Group Name' of 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 'Option Name' , you have to enter 'Installation App' . Otherwise, 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 |WordPress 4.7.5' 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 cannot type the application version number as a variable! Only the latest version available will be installed.

As you can see on the following screen, we decided to offer our customers 5 applications.

When you finish adding the applications, press 'Save Changes' and 'Close Window'.

From the module's 3.1.0 version you can also create a new configurable option - Auto Backup On Update with the 'Yes/No' option type.

This option is used to enable the creation of auto update backups for a first chosen application after the initial order in WHMCS.
Please note that this option works only with the Installatron plugin and Auto Update Backup Enabled By Default On Order setting in the module addon features has to be disabled to make this configurable option work properly.

PE58 2.png
Afterward, come back to 'Plesk Extended Features' 'Configuration' 'Applications' , activate 'Use Configurable Options' and choose 'Apps / Configurable Options' from the dropdown menu.

Please note that you can have more configurable options groups. Press 'Save' . You have just successfully assigned configurable options to the application auto installation.

PE3 59.png
Let us find out what your customers are going to see in your client area while placing the order.

As you can notice, a dropdown menu with the previously configured applications has appeared.

PE3 60.png

Assignment of Custom Fields To Application Auto Installation

Now that 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 this moment applications have been installed with the 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 us see how to do that.
In the beginning, go to 'Product/Services' , find your product using 'Plesk Extended' module and enter the 'Custom Fields' category.
You will need to add 12 custom fields, the first 8 being:

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

The next 3 fields are:
  • Admin Username
  • Admin Password
  • Admin Email

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

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

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

PE3 62.png

Custom Installatron Application Language

We will show you how to quickly set a custom language for Installatron web applications.

For this purpose, you need to add a new custom field for your product. The field should be called 'Language' .

Afterward, go to your 'Products/Services' and check whether the 'Language' field has appeared.

In order to change the default application language for a certain account, enter the appropriate value here.

From now on the new field will be visible to your customers as well. While installing a new application, they will be able to choose a desired language by entering its value into the field.

Here you will find a complete list of language codes.

Management of Existing Products

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

To do so, change the type of servers and module names of products from 'Plesk' to 'PleskExtended'.
Additional information about how to correctly configure your servers and products can be found at points 8-16 of the 'Installation and Configuration' section.

Billing Management

When you combine Plesk 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.
With Advanced Billing module, you can also display to your customers the current server resource usage and their cost.
PE3 42.png

Importing Existing Account

In this section, you can find short instruction on how to connect one of your clients to your already existing account in Plesk.
Take the following steps to make sure that the process will be carried out properly.

1. Firstly, manually create an order for your customer in WHMCS. Choose a client and in the summary view, click on the ' Add New Order' button. Next, select a 'Product/Service' and press 'Submit Order' .
What is important, do not perform the 'Create' action. The status has to remain as 'Pending' .
More info about placing orders can be found here
2. Proceed to the newly created product's card in your admin area. Find the following empty fields:

  • Domain
  • Username
  • Password

The above-mentioned information has to be consistent with the data from your cPanel account. Now, complete these fields as presented below.
Important! Remember to make sure that the format of the provided data is compatible with the format supported by the module. You can preview it for another product of the module you have already created and enter it in a similar way.
Note: You need to enter a password to your Plesk account. If for some reason, you do not remember your password, there has to be the possibility to reset your password and create a new one in your panel.
If you completed the required data, now change the status from 'Pending' to 'Active' and 'Save Changes' .

Plesk import.png
3. If the completed data is correct, you can log in to the account by pressing the 'Go To Webmail' button. Moreover, to make sure that everything works as expected, you can check if the newly-created account can be managed in the client area.
Important! Remember to manually add other missing parameters of the product in configurable options, custom fields, billing cycle, etc. so they match the parameters of the connected account from your Plesk panel.
Another possibility to import already existing accounts in Plesk with your WHMCS is to use the 'Server Sync Tool' WHMCS tool.
More info can be found here.

After performing this action, do not forget to run the following cron command:

 php -q  yourModulePath/modules/servers/PleskExtended/cron/cron.php account:synchronize 


1. To set up an account for an existing customer in your Plesk Extended, create a new WHMCS order with the exact same username, password and email address.

Then, set the account status to active.

2. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.
3. If you want the already deleted accounts on the server to be removed from the WHMCS addon module list,
proceed to yourWHMCS/modules/addons/PleskExtended/commands and use the following cron command.
 >  php -q run.php client:plesk:delete 
4. If the "Invalid secret key usage. Please check logs for details." error occurs,
then you need to use the following cron command that will delete all keys from the Plesk panel as well as 'PleskExtended_Accounts' database table to allow each account to create a new key.
 yourModulePath/modules/servers/PleskExtended/cron/cron.php secretKeys:delete 
5. We recommend assigning only one server to 'Server Group' as servers may have different service plans.
Otherwise, API may return the following message 'There is no such a service plan' if WHMCS chooses a server from ' Server Group' that has no existing service plan.

Update Instructions

Essential guidance through the process of updating the module is offered here.

Important: If you are upgrading from Plesk Extended 2.X to 3.X version of the module, you have to delete the old /modules/servers/pleskExtended/ folder (started with a lower case letter) before you start using a new version.
You also need to set recursively writable permissions for storage directories in these two locations:

  1. your_whmcs/modules/addons/PleskExtended/
  2. your_whmcs/modules/servers/PleskExtended/

Then, after activation of the new addon version, all data from the old version of the addon and the product configurations will be automatically migrated to the new version.
In addition, remember to reissue your license due to changes in the folder names.

Note: from 3.0.0 version of the module the cron execution is also no longer required.

Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Plesk Extended For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If you see an error as shown on the screen below, it means that you haven't provided your service plan name or reseller plan name in the product's 'Module Settings'.

Once you enter the name, the problem will disappear.

3. If you are unable to connect with your Plesk server or client area functionalities do not work properly, then make sure that you are connecting with your server on port 8443.

Here you can find more information on how to change the default port in Linux and Windows

4. CURL Error: [6] Could not resolve host.

Try entering your Plesk IP address into the Hostname field in the server configuration.

5. Unable to get the version number from the server. CURL Error: 7 - couldn't connect to host. Check server connection details.

Check connection details and the connection itself between WHMCS and server.

6. Unable to get the version number from the server. Permission denied. You have to set admin account access details.

You need admin account access to use PPPE module. Reseller account API is not supported.

7. Blank page at 'Applications'.

Reason: Some libraries may be missing.
Solution: Make sure you have installed php-xml library.

8. If you have problems with your license, please make sure that the content of the file is correct.

Please note that for Plesk Extended For WHMCS V2.0.0 and later, the license key begins with:


Not as it was for the previous versions:

9. In case you see an error: 'Request Is Invalid: Error In Line 5: Element 'owner-id' is not a valid value of the atomic type 'int'.' while creating a product, please verify your product type.
Most probably it is set to 'Dedicated/VPS Server' or 'Other' which are not supported. See point 17 of the installation for more info.
10. If you see an error similar to: 'Unable to find appropriate manager for this version of Panel. Plesk should be at least 8.0 version.' while creating a product, please verify your server configuration.
Make sure that you have SSL 'Secure' ticked in your server configuration, depending on your Plesk settings.
11. Plesk Extended For WHMCS functions only on the administrator account.
12. For a large backup files we recommend to increase the 'max_execution_time' setting in your server's 'php.ini' configuration.
Otherwise, fatal errors like 'Allowed memory size of 134217728 bytes exhausted (tried to allocate 100401152 bytes)' may occur when trying to download local backups.
13. Getting the 'SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry (...)' error when creating a new Plesk account?

This might occur when a client has both normal and reseller hosting accounts. In this case, we recommended to try the 'Separate Plesk User' option for the product's configuration.

14. Due to removed support for 'XML API' by Plesk, Plesk Onyx from version 17.8 is only partly supported.

This means the following functionalities:

  • Backups
  • Spam Filter (SpamAssassin)
  • Web Users

will not work anymore and even more features may become incompatible with further versions of Plesk. If you need full compatibility, please use the last compatible Plesk 17.5 version.

15. If your clients encounter problems with auto-login to Plesk control panel, please check if you provided the proper 'Log In To Panel' URL in the addon's 'Server Settings' .

You can set it up as described in Configuration of Addon section in step 29.

16. If you come across the PleskAPIInvalidSecretKeyException : Invalid secret key usage. Please check logs for details. error after migrating the system to another server,
then use the following cron command. It will delete all keys from the Plesk panel as well as 'PleskExtended_Accounts' database table to allow each account to create a new key.
 php yourModulePath/modules/servers/PleskExtended/cron/cron.php secretKeys:delete 
WHMCS Modules
WHMCS Widgets
cPanel Modules
Plesk Extended For WHMCS