Personal tools
Namespaces

Variants
Actions

Plesk Extended For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About Plesk Extended For WHMCS)
(→‎About Plesk Extended For WHMCS)
 
(153 intermediate revisions by 7 users not shown)
Line 4: Line 4:
 
=About [https://www.modulesgarden.com/products/whmcs/plesk-extended Plesk Extended For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/plesk-extended Plesk Extended For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Plesk Extended For WHMCS''' is a module which allows your customers to manage their web hosting accounts directly from the client area.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''Plesk Extended For WHMCS''' is a module which empowers your customers to manage their web hosting accounts directly from the WHMCS client area.<br />
−
Our product increases your comfort of management and simplifies web hosting account handling for your customers.<br />
+
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.<br />
−
Let your web hosting users manage their Plesk accounts in your own WHMCS. Achieve all of these and set it up within a few minutes time!
+
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.<br />
 
|}
 
|}
 
<!-- fixed -->
 
<!-- fixed -->
Line 15: Line 15:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Change Package And Password Of Account
 
|style="padding: 0px 0px 0px 30px;"|✔ Change Package And Password Of Account
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Log In To Plesk User Panel On Click
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Products Configuration:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Service Plan Name
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Reseller Plan Name
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ IP Address Types To Use
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Toggle "Power User" Plesk Panel View
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Client Details Synchronization
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Create Subscriptions On Single Or Separate Plesk User Accounts
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Default PHP Version
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Enable Metric Billing
 
|}
 
|}
 
{|
 
{|
Line 20: Line 50:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Service Plan Name Per Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable And Configure Application Auto Installer To Use Per Product:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Reseller Plan Name Per Product
+
|style="padding: 0px 0px 0px 45px;"|✔ Default Plesk App Installer
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable And Configure Application Auto Installer To Use Per Product - Installatron Or Default Plesk App Installer
+
|style="padding: 0px 0px 0px 45px;"|✔ Installatron
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View All Plesk Extended Products In One Place
+
|style="padding: 0px 0px 0px 45px;"|✔ Softaculous
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Generate Auto Installer's Applications Configurable Options
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Configure Multiple Product Features And Settings At Once
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View All Plesk And Plesk Extended Products And Servers In One Place
 
|}
 
|}
 
{|
 
{|
Line 35: Line 74:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle 'Power User' Plesk Panel View
+
|style="padding: 0px 0px 0px 30px;"|✔ View All WHMCS Clients Linked With Plesk Customer Accounts In One Place
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Define Custom URL Of Panel And Webmail
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Server Custom URL Of Panel And Webmail
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Log In To Plesk Administrator Panel On Click
 +
|}
 +
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
Line 45: Line 88:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ FTP Access
+
|style="padding: 0px 0px 0px 45px;"|✔ Addon Domains
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Applications
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Backups (Up To Plesk 17.5)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Databases - MySQL And PostgreSQL Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Domain Aliases
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Backups
+
|style="padding: 0px 0px 0px 45px;"|✔ DNS Settings
 
|}
 
|}
 
{|
 
{|
Line 57: Line 112:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Spam Filter
+
|style="padding: 0px 0px 0px 45px;"|✔ FTP Access
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Databases
+
|style="padding: 0px 0px 0px 45px;"|✔ Git Repositories
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Subdomains
+
|style="padding: 0px 0px 0px 45px;"|✔ Log Rotation
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Addon Domains
+
|style="padding: 0px 0px 0px 45px;"|✔ Node.js
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Domain Aliases
+
|style="padding: 0px 0px 0px 45px;"|✔ PHP Settings
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ DNS Records - MySQL And PostgreSQL Databases Support
+
|style="padding: 0px 0px 0px 45px;"|✔ Spam Filter - SpamAssassin (Up To Plesk 17.5)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Applications
+
|style="padding: 0px 0px 0px 45px;"|✔ SSL Certificates
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Web Users
+
|style="padding: 0px 0px 0px 45px;"|✔ Subdomains
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ SSL Certificates
+
|style="padding: 0px 0px 0px 45px;"|✔ Web Users (Up To Plesk 17.5)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ [https://www.modulesgarden.com/products/whmcs/wordpress-manager WordPress Manager] - Separate Module Required
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ WordPress Toolkit
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To:
 
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Backup Manager
 
|}
 
|}
 
{|
 
{|
Line 93: Line 157:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Plesk Single Sign-On
+
|style="padding: 0px 0px 0px 45px;"|✔ WP Toolkit
 
|}
 
|}
 
{|
 
{|
Line 109: Line 173:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Area:
+
|style="padding: 0px 0px 0px 45px;"|✔ Allow Custom Settings Of Auto Installed Application - With Custom Fields
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Install New Applications With Installatron Or Default Plesk App Installer
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Area:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Installed Applications
+
|style="padding: 0px 0px 0px 45px;"|✔ Install New Applications With Installatron, Softaculous Or Default Plesk App Installer
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Manage Installed Applications
+
|style="padding: 0px 0px 0px 45px;"|✔ View And Manage Installed Applications
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 0px 45px;"|✔ Backup Installed Applications
 
|style="padding: 0px 0px 0px 45px;"|✔ Backup Installed Applications
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Perform Auto Backups Upon Application Updates By Installatron
 
|}
 
|}
 
{|
 
{|
Line 127: Line 194:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 45px;"|✔ Restore Applications From Backups
+
|style="padding: 0px 0px 0px 45px;"|✔ Restore Applications From Backups
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 45px;"|✔ Delete Applications Along With Their Backups
 
|}
 
|}
  
Line 138: Line 208:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Actual Server Resource Usage Billing [https://www.modulesgarden.com/products/whmcs/advanced-billing (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing For WHMCS] - Actual Server Resource Usage Billing
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Server Allocator For WHMCS</u> - Automatic Assignment Of Specified Servers To Products [https://www.modulesgarden.com/products/whmcs/server-allocator (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/ip-manager IP Manager For WHMCS] - Complete Control And Easy Assignment Of IP Subnets
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/server-allocator Server Allocator For WHMCS] - Automatic Assignment Of Most Suitable Servers To Products
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/wordpress-manager WordPress Manager For WHMCS] - Remote Installation And Management Of WordPress Instances
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Fully Integrated With [https://lagom.rsstudio.net/extensions/whmcs-modules-integration/plesk-extended-by-modulesgarden/ Lagom WHMCS Client Theme]
 
|}
 
|}
 
{|
 
{|
Line 147: Line 226:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports Windows & Linux
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports Windows And Linux
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports Plesk 9 up To Plesk Onyx
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports Plesk Onyx And Plesk Obsidian
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Metric Billing - Integration: Domains, Subdomains, Domain Aliases, Mailboxes, Databases, Additional FTP Accounts, Storage, Traffic
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Server Sync Tool
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/plesk-extended#open-source-version Open Source Version]
 
|}
 
|}
  
Line 165: Line 256:
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Plesk Extended For WHMCS.'''<br />
+
|style="padding: 10px 0px 150x 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/plesk-extended Plesk Extended For WHMCS.]'''<br />
 
We will guide you step by step through the whole installation and configuration process.
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
+
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
−
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
In the most recent versions of the module, you will find only one package that supports PHP 7.4 and later.<br/> <!--  If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP74_81.png]]
 
|}
 
|}
 +
<!--
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
−
The content of PHP version files should look like this.  
+
The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/>
 +
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PE_2_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]]
 +
|}-->
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.''' ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Plesk Extended For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory. <br/>
−
File is located in '' 'modules/servers/pleskExtended/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
The content of the package to upload should look like this.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3__2_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key you have to edit a previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Plesk Extended For WHMCS for the first time you have to rename the '' 'license_RENAME.php' '' file.'''<br />
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
+
The file is located in '' 'modules/servers/pleskExtended/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
 +
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'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step, set up the  '' 'storage' '' folder as recursively writable.'''<br />
 +
This folder is available at '''two''' locations:
 +
# '' your_whmcs/modules/addons/PleskExtended/ ''
 +
# '' your_whmcs/modules/servers/PleskExtended/ ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_5.png]]
 
|}
 
|}
  
 
==Activation of Addon==
 
==Activation of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''7. Now, you have to activate the module in your WHMCS system.'''<br />
−
Login to your WHMCS admin area. Click '' 'Setup' '' then choose '' 'Addon Modules'. ''<br />
+
Log in to your WHMCS admin area. Move to '' 'System Settings' '' and then choose '' 'Addon Modules'. ''<br />
−
Afterward, find '' 'Plesk Extended Center' '' and press the '' 'Activate' '' button.
+
Afterward, find '' 'Plesk Extended' '' and press the '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_6_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. In the next step you need to permit access to this module.'''<br />
−
To do so, press '' 'Configure'. '' Afterward, select required administrator roles and press '' 'Save Changes'. ''<br/>
+
To do so, press '' 'Configure'. '' Next, select the required administrator roles and press '' 'Save Changes' ''.  
−
''Note: Here you can also define which system template you are using, '5' or '6'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_6_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''8. You have just successfully installed Plesk Extended For WHMCS!<br/>
+
|style="padding: 0px 0px 30px 15px;"|'''9. Congratulations, you have just successfully installed Plesk Extended For WHMCS!<br/>
 
|}
 
|}
  
 
==Configuration of Server==
 
==Configuration of Server==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''9. Now, we will show you how to configure a new server.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''10. Now, we will show you how to configure a new server.'''<br />
−
To do so, log in into your WHMCS. Press '' 'Setup' → 'Products/Services' → 'Servers'.'' Afterward, press '' 'Add New Server'. ''
+
To do so, log in to your WHMCS. Go to '' 'System Settings' → 'Servers'.'' Afterward, press '' 'Add New Server'. ''
 
|}
 
|}
 
{|
 
{|
Line 233: Line 344:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''10. Next, enter your server name, IP address, username and password. Choose '' 'PleskExtended' '' from the dropdown menu and press '' 'Save Changes'. '''''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''11. Next, enter your server name, hostname/IP address, username and password. Choose '' 'PleskExtended' '' from the dropdown menu and press '' 'Save Changes'. '''''<br />
−
Here you can also provide other server details like nameservers or maximum number of accounts.
+
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.<br/>
 +
 
 +
'' '''Note:''' According to the [https://docs.plesk.com/en-US/onyx/partner-api-3.0/introduction-to-key-administrator-partner-api-30.77827 Plesk documentation], you '''cannot''' use the same account and password that you use to log in to the '''ka.plesk.com''' panel. Please use your special account with '''Partner API''' access.''<br/>
 +
 
 +
'' '''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.<br/>Otherwise, the "Could not resolve host" error may occur.''
 
|}
 
|}
 
{|
 
{|
Line 240: Line 355:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''11. After you configure your server correctly, you will see the following screen.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''12. After you have configured your server correctly, you will see the following screen.'''<br />
−
Now, you need to create a new group for your server. For that purpose press '' 'Create New Group'. ''
+
Now, you need to create a new group for your server. For that purpose, press '' 'Create New Group'. ''
 
|}
 
|}
 
{|
 
{|
Line 247: Line 362:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''12. Enter a name, click on your previously created server, press '' 'Add' '' then '' 'Save Changes'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''13. Enter a name, click on your previously created server, press '' 'Add' '', then '' 'Save Changes'. '''''
 
|}
 
|}
 
{|
 
{|
Line 255: Line 370:
 
==Configuration of Product==
 
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''13. In order to create and configure the product, click on '' 'Setup' → 'Products/Services' → 'Products/Services'. '''''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''14. In order to create and configure the product, move to '' 'System Settings' → 'Products/Services'. '''''<br />
−
If you do not have a product group, '' 'Create a New Group'. ''
+
If you do not have a product group, choose '' 'Create a New Group'. ''
 
|}
 
|}
 
{|
 
{|
Line 262: Line 377:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''14. Enter product group name and press '' 'Save Changes'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''15. Enter a product group name and press '' 'Save Changes'. '''''
 
|}
 
|}
 
{|
 
{|
Line 268: Line 383:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15. When you have a product group, you can create your product and assign it to Plesk Extended.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''16. Once you have a product group, you can create your product and assign it to Plesk Extended.'''<br />
−
To create a product press '' 'Create a New Product'. ''
+
To create a product, press '' 'Create a New Product'. ''
 
|}
 
|}
 
{|
 
{|
Line 275: Line 390:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''16. Afterward, choose your product type and a product group from the dropdown menus, enter your product name and press '' 'Save Changes'. '''''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''17. Afterward, choose your product type, product group and module, enter your product name and press '' 'Save Changes'. '''''<br/>
−
Please note that you may select only between '' 'Hosting Account' '' and '' 'Reseller Account' '' when choosing the product type as only those are supported by Pelsk module.
+
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.
 
|}
 
|}
 
{|
 
{|
Line 282: Line 397:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''17. Now, move to the '' 'Module Settings' '' section, choose both '' 'PleskExtended' '' and your previously created server group from the dropdown menus.'''<br />  
+
|style="padding: 0px 0px 15px 15px;"|'''18. Now, move to the '' 'Module Settings' '' section, choose your previously created server group from the dropdown menu.'''<br />  
 
Remember to add your '' 'Client Template Name' '' or '' 'Service Plan Name'. '' Plesk Extended will not work properly without a specified plan name.<br />
 
Remember to add your '' 'Client Template Name' '' or '' 'Service Plan Name'. '' Plesk Extended will not work properly without a specified plan name.<br />
−
Decide on the way Plesk will assign IP addresses in the accounts creation process, using the '' 'IP Address Types' '' dropdown list.<br />
+
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.<br />
−
Here you may also enable the '' 'Power User' '' view. Do not forget to '' 'Save Changes' ''.
+
Here you may also enable the '' 'Power User' '' view. Do not forget to press '' 'Save Changes'.''  
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_16.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_16.png]]
 
|}
 
|}
 +
<!-- CRON OD WERSJI 3.0.0 wyleciał
 
{|
 
{|
−
{|
+
|style="padding: 0px 0px 20px 15px;"|'''19. At the end of the product configuration process, make sure you add a cron job as presented below (10 minutes intervals are suggested).<br />
−
|style="padding: 0px 0px 20px 15px;"|'''18. At the end of the product configuration process, make sure you add a cron job as presented below (each 10 minutes suggested).<br />
+
Its purpose is to download requested backups from Plesk to your WHMCS server which can be subsequently downloaded by clients.
−
Its purpose is to download requested backups from Plesk to your WHMCS server which can be subsequently downloaded by the clients.
+
  php -q /your_whmcs/modules/addons/PleskExtended/cron/cron.php  
−
  php -q /your_whmcs/modules/servers/pleskExtended/cron.php  
+
 
Do not forget to replace '' 'your_whmcs' '' with your WHMCS root location.
 
Do not forget to replace '' 'your_whmcs' '' with your WHMCS root location.
−
The cron can be also run each few minutes in order to perform the action more often.
+
Cron can be also run every few minutes in order to perform the action more often.
 
|}
 
|}
 +
-->
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''19. Good job! You have just correctly created and customized your new product which will appear in Plesk Extended Center admin area.'''
+
|style="padding: 0px 0px 30px 15px;"|'''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==
 
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''19. You have just correctly created and customized a new product.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''20. After you have correctly created and customized a new product, it is time to configure it.'''<br />
−
Go to '' 'Addons' '' → '' 'Plesk Extended Center' '' in your WHMCS.<br />
+
Go to '' 'Addons' '' → '' 'Plesk Extended' '' in your WHMCS.<br />
−
You will find there dashboard with a short guide where you will find a few steps described to start your successful work with our module. <br/>
+
 
−
There are also precise data on available products and servers:
+
This section offers precise data on available products and servers:
−
*see the number of ''active/suspended/terminated'' products
+
*See the number of ''active/suspended/terminated'' accounts
−
*check the number of active accounts
+
*See the list of configured Plesk products and servers
−
*log in to panel
+
*Go directly to the product and server configuration
−
*upgrade your Plesk products
+
*Log in to Plesk panel from server configuration with one click
−
*press the '' 'Documentation' '' tab to be moved to this very site!
+
*Easily upgrade the already configured Plesk product to Plesk Extended
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''20. Proceed to the '' 'Features' '' section and find the product you are interested in.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''21. Proceed to the 'Features' section and find the product you are interested in. Press the 'Configuration' button next to the product.
−
Press the '' 'Configuration' '' button next to it to continue.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_18.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''21. You should find there a box dedicated to '' 'Features'.''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''22. You will find here boxes dedicated to '' 'Features' and 'Applications'. ''<br />
−
If you have already another product configured, you may copy its configuration now. Find one more box '' 'Copy Configuration From' '' and choose a product from the dropdown menu. <br/> To show you an example, we will set the configuration from the beginning, we will not use other product's configuration.<br/>  
+
To show you an example, we will set the configuration from the very beginning, without using other configuration options of the product.<br/>
 +
 
 
Select the features you would like to activate for your customers.
 
Select the features you would like to activate for your customers.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_19.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''22. Next toggle '' 'Install Application' '' that will be used to install applications by your clients.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''23. Next, toggle '' 'Install Application' '' that will be used to install applications by your clients.<br />
−
In '' 'Autoinstaller Type' '' you are free to choose between '' 'Installatron' '' and '' 'Default' '' autoinstallers. <br/>
+
In the '' 'Auto Installer Type' '' field you will be free to choose between '' 'Installatron' '',  '' 'Softaculous' '' and '' 'Default' '' auto installers. <br/>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_20.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''23. You may also introduce installing one of the selected applications automatically, once an order is created.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''24. You may also enable the option for automatic installation of selected applications once an order is created.<br />
−
Use '' 'Auto Install Chosen App on Create' '' switch and select the default option from the '' 'Apps / Configurable Options' '' list.<br />
+
Use the '' 'Auto Install On Creation' '' toggle and select the default option from the '' 'Apps / Configurable Options' '' list.<br />
 +
 
 +
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 [http://softaculous.com/docs/Scripts_Language_Codes  here].<br/>If the field is left blank, a default value, which is '' 'en' '' (English) will be used.<br />
 +
 
 +
Moreover, you can permit your clients to toggle automatic backups for application updates or enable them for the first application after the initial order.<br/>
 +
 
 +
'' '''Note:''' You can also create a configurable option with an app to be installed. You can find the instruction on how to do that [[#Applications Configuration|here]].''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_20_0.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_20_0.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''24. You are free to leave the application selection issue to your clients to be effected during ordering process by using the '' 'Use Configurable Options' '' switch and choosing the appropriate option from the list.  <br />
+
|style="padding: 0px 0px 20px 15px;"|'''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.   
−
Subsequently, you will notice a download button appearing next to the dropdown list. Its purpose is to download the available application list in a text format. <br />
+
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_20_02.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|By selecting this option, you will notice a download button next to the dropdown list on the product's features list. <br/>
 +
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 [[Plesk_Extended_For_WHMCS#Applications_Configuration|here]].
 
More information about the available configurable options and custom fields can be found [[Plesk_Extended_For_WHMCS#Applications_Configuration|here]].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_20_02.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_20_01.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''25. In the next step, move to '' 'Server Configuration' '' to set up a connection.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''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.'''<br/>
 +
Press it to quickly generate the configurable options for the product to allow selecting and installing application at the moment of ordering the product.<br/> Read more about generating configurable options [[#Applications Configuration|here]].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_20_1.5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''27. If you already have another product configured, you may copy its configuration. <br/>
 +
Find the '' 'Copy' '' button on the list with products or select multiple item at once. <br/>
 +
Then, choose the product configuration whose settings you wish to copy into the selected products.<br/>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_20_03.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''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.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_20_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''29. In the next step, move to '' 'Server Configuration' '' to set up a connection.'''<br />
 
Press the '' ' Configuration' '' button next to a desired server.  
 
Press the '' ' Configuration' '' button next to a desired server.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_20_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_20_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Enter proper domains or IP addresses to allow a connection with Plesk panel and Webmail accordingly.'''
+
|style="padding: 0px 0px 15px 15px;"|'''Enter the proper domain to allow a connection with Plesk panel.'''<br/>
−
Do not forget to '' 'Save' '' changes once it is ready!
+
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.<br/>For example: ''<nowiki>https://webmail.{$domain}</nowiki>''<br/>
 +
Do not forget to '' 'Save' '' changes once you are finished!
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_20_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_20_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''26. From now on, all your clients who ordered a previously created product will be able to manage their Plesk accounts via your WHMCS system.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'' '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.<br/>
−
Here is a view of the ordered product summary in admin area. Available actions:
+
Press '' 'More Information' '' icon to get more details.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_21_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Plesk client detailed information:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_21_2.png]]
 +
|}
 +
 
 +
===Upgrade Plesk to Plesk Extended Product===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Once you have already configured the standard ''Plesk'' products, you can easily upgrade them to the ''Plesk Extended'' products.<br/>
 +
'' '''Note:''' Before you start, make sure that you have already configured the Plesk Extended server.''<br/>
 +
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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_24_0.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|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.''<br/>
 +
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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_24_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''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.'''<br />
 +
Here is the summary of the ordered product in admin area. The available actions include:
 
*Log In To Control Panel
 
*Log In To Control Panel
−
*Use Module Commands: '' 'Create', 'Suspend', 'Unsuspend', 'Terminate' '' the product; '' 'Change Package' '' and '' 'Change Password'. ''
+
*Use Module Commands: '' 'Create', 'Suspend', 'Unsuspend', 'Terminate', 'Change Package' '' and '' 'Change Password'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_21.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_21.png]]
 
|}
 
|}
 
{|
 
{|
Line 381: Line 563:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PE2_23.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_23.png]]
 
|}
 
|}
  
Line 387: Line 569:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''Plesk Extended allows your customers to manage their accounts via client area in your WHMCS system.'''<br />
 
|style="padding: 10px 0px 15px 15px;"|'''Plesk Extended allows your customers to manage their accounts via client area in your WHMCS system.'''<br />
−
In this short guide we will present you the management possibilities of our module.
+
In this short guide we will present you with the management possibilities of our module.
 
|}
 
|}
 
==Client Area==
 
==Client Area==
  
−
===FTP Access===
+
===Addon Domains===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In the very first section you are given the possibility to manage your FTP access or create new FTP accounts.<br/>
+
|style="padding: 10px 0px 15px 15px;"|Addon domains section allows you to link the domain to a subdirectory of your account. <br/>You can view and manage addon domains, edit document root and make redirections.<br/>
−
FTP access management is dependent on the system your Plesk panel is set up on.<br/>
+
 
−
In case of Windows system used, you may add new accounts, change passwords and delete old accounts.<br/>
+
'' '''Note:''' Make sure this feature is enabled for your account before using''
−
However, in case of Linux system (see the screen below) only changing passwords is allowed.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_28.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Press the '' 'Create Addon Domain' '' button and enter the desired details.<br/> ''Please note that an FTP account '''will not''' be automatically created with the domain.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_28_1.png]]
 +
|}
 +
 
 +
===Applications===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Install your favorite applications in a few seconds without even accessing Plesk.<br />
 +
Use Plesk Extended For WHMCS to:
 +
*Install applications
 +
*Delete applications
 +
*Create and restore backups<br/>
 +
To start, simply proceed to '' 'Applications' '', and then find the '' 'Install New' '' section.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_31.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Afterwards, you will see an extensive menu with application categories. <br/>For presentation purposes we will install '' 'PrestaShop' '' located in the '' 'E-Commerce And Business' ''category. Find '' 'PrestaShop' '' and click on it.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_32.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Now, you have to enter necessary installation details and then press '' 'Install Application' '' to follow. Wait for the '' 'Success' '' notification.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_33.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|View the list of your installed applications by clicking on the '' 'Installed Applications' '' tab and manage the application.<br/>
 +
Here you will find the name of the application, its path, size and available actions ''(available only for Softaculous & Installatron)'':
 +
*Create backup
 +
*Delete application
 +
<!-- TEGO NA RAZIE NIE MA BO COS NIE WSPIERA
 +
*Edit application ''(available only if 'Installatron' is used; a pencil icon will appear)''
 +
-->
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_34.png]]
 +
|}
 +
 
 +
====Application Backups====
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|You can also create a backup of your installation. To do so, simply press the '' 'Create Backup' '' button next to the installed application.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_37.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Confirm the action and backup generation will start immediately.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_37_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|After a moment you should receive the '' 'The backup has been created successfully' '' message confirming that the operation has been performed successfully.<br/>
 +
Once you have created a backup of your application, proceed to the '' 'Backups' '' tab.<br/>There you will find a list of created application backups along with the date when they were created.<br/> Use action buttons marked on the screen to restore and delete a chosen backup.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_37_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|If you use the Installatron plugin, you can also let your customers create automatic backups for application updates. <br />
 +
To do this, go to '' 'Addons' '' → '' 'Plesk Extended' ''  → '' 'Features' ''  → '' 'Configuration' ''and enable '''Auto Update Backups'''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_37_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"| 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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_37_4.png]]
 
|}
 
|}
  
 
===Backups===
 
===Backups===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|All available backups are displayed under the '' 'Backups' '' section.<br />
+
|style="padding: 10px 0px 15px 15px;"|All available backups are displayed under the '' 'Backups' '' section. To add a new one, press the '' 'Create Backup' '' button.<br/>
−
To create a new backup add prefix, description, choose split size and backup types.''<br />
+
'''''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.''
−
To download the backup, the client creates a query which will prepare the backup first. The backup will be downloaded from Plesk to the WHMCS server on the next cron execution.<br />
+
|}
−
After preparation the backup will be marked in green and available for download by the client.
+
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_24_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|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.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_24_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|The backup creation might take a while. When ready, it can be downloaded by client or deleted from the server.<br/>
 +
'' '''Important:''' For large backup files we strongly recommend to increase the 'max_execution_time' setting in your server's 'php.ini' configuration.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_24_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|If you want to use the '' 'remote' '' backup type, you will also need to provide the '' 'FTP Storage Settings' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_24_6.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Provide your FTP server IP address or hostname, access credentials, mode, and the directory path to which the backup will be uploaded.<br/> Then, when you create the backup for a second time, select the remote type to upload it directly to your FTP server.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_24_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_24_7.png]]
 +
|}
 +
 
 +
===Databases===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|Owing to '' 'Databases' ''  management you can create/delete new databases and users. Press '' 'Create Database' '' to add a new database.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_26_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|To create a new database, type in its name into the appropriate field and select its type. <br/>Optionally, you can also create a user directly assigned to the database.<br/>
 +
'' '''Note:''' Only 'MySQL' and 'PostgreSQL' databases are currently supported and must be enabled in your Plesk panel first. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_26_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_26_3.png]]
 +
|}
 +
 
 +
===Domain Aliases===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Here you can add and manage your domain aliases.<br />
 +
This allows you to read content of one domain from another domain name.<br />
 +
To create a new redirection, press '' 'Create Domain Alias' ''.<br/>
 +
'' '''Note:''' Domains should be registered with a valid registrar and point to your DNS server.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_29.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Next, provide your alias domain, chose domain redirections as well as toggle the remaining options.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_29_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|After alias creation, you can also rename it, change its settings or delete it.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_29_3.png]]
 +
|}
 +
 
 +
===DNS Settings===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|Here you can add and manage DNS records to define the structure and content of the chosen domain name space.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_30.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Add records by selecting the type and providing their hostname and value.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_30_1.png]]
 
|}
 
|}
  
 
===Email Addresses===
 
===Email Addresses===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|You can manage all aspects related to e-mail accounts. Add new accounts, search through accounts and remove useless ones.  
+
|style="padding: 10px 0px 20px 15px;"|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. 
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_25.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Press '' 'Add Email Account' '' and select to which domain it shall be added, type or generate password and define limited or unlimited quota.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_25.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_25_1.png]]
 
|}
 
|}
  
 
===Email Forwarders===
 
===Email Forwarders===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Take any advantage of the '' 'Email Forwarders' '' functionality. Send a copy of all mails from one email address to another.  
+
|style="padding: 10px 0px 20px 15px;"|In this section, you can set up email forwarders and choose from several destination options to adjust mail forwarding perfectly to your needs.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_26.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_26.png]]
 
|}
 
|}
−
===Spam Filter===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|The '' 'Spam Filter' '' powered by SpamAssassin is designed to identify spam messages among emails sent to mailboxes hosted on your Plesk server.
+
|style="padding: 0px 0px 20px 15px;"|Press the '' 'Create Email Forwarder' '' button, specify the forwarded email and define the destination addresses.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_26_0_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_26_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|
+
|style="padding: 0px 0px 20px 15px;"|Use the mass action button to delete numerous email forwarders at once, or remove single items one by one.
−
Enable and configure the filter as desired for the selected mailbox. You can also adjust sensitivity which ranges from 2 to 12. <br />
+
|}
−
If mailboxes receive lots of spam messages with the current setting, to make the filter more sensitive, try setting a lesser value, for example, 6. <br />If they are missing emails because spam filter thinks they are junk, try reducing the filter's sensitivity by setting a higher value, for example, 8.
+
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_26_5.png]]
 
|}
 
|}
  
 +
===FTP Access===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 25px;"|[[File:PE2_26_0.png]]
+
|style="padding: 10px 0px 15px 15px;"|In the very first section you are given the possibility to manage your FTP access or create new FTP accounts.<br/>
 +
FTP access management is dependent on the system your Plesk panel is set up on.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_24.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Add and configure FTP Accounts in the easiest way possible.<br/> Just type in your login on a domain, provide or generate a secure password, define directory access and declare available quota.<br/>
 +
'' '''Note:''' If you have some other addon domains, creating an FTP account on the main domain will also add it to these domains.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_24_5.png]]
 
|}
 
|}
  
−
===Databases===
+
===Git Repositories===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Owing to '' 'Databases' '' management you can create/delete new databases and users. <br/> To create a new database, type in its name, into the appropriate field and select its type. <br/>
+
|style="padding: 10px 0px 15px 15px;"|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.<br/>
−
''Please note that 'MySQL' and 'PostgreSQL' databases are currently supported. ''
+
 
 +
'' '''Note:''' Curently, adding only local repositories is supported. Remote Git Repositories like GitHub or BitBucket are not supported yet.''<br/>
 +
 
 +
Start by pressing the '' 'Create Repository' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_26_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_43.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can also add users to particular databases. Remember that you may always use the secure password generator while creating a user. <br/>
+
|style="padding: 0px 0px 15px 15px;"|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' ''). <br/> Next, also choose the '' 'Deployment Mode' '' ('' 'Auto' '', '' 'Manual' '' or '' 'None' ''). <br/>
−
Use action buttons to delete useless users or change their password.
+
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: “>”.
 +
 
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_44.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Once the repository is created you can also manually deploy it  by pressing ''arrow up'' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_44_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Additionally, when pressing the '' 'Edit' '' button, besides the ability to change certain attributes, you can also preview the direct URL of the created repository.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_44_2.png]]
 +
|}
 +
 
 +
===Log Rotation===
 +
{|
 +
| style="padding: 10px 0px 15px 15px;" |The Log Rotation section allows managemnt of logs, turn on log rotation for a domain and configure its conditions.<br/>
 +
'' '''Note:''' Please keep in mind that custom logs cannot be rotated.''
 +
|}
 +
{|
 +
| style="padding: 0px 0px 20px 25px;" |[[File:PE3_45_0.png]]
 +
|}
 +
{|
 +
| style="padding: 0px 0px 15px 15px;" |Preess the '' 'Edit' '' button next to a single domain, and you will be moved to log rotation settings. <br/>
 +
Enable log rotaion and define its conditions.
 +
|}
 +
{|
 +
| style="padding: 0px 0px 20px 25px;" |[[File:PE3_45_1.png]]
 +
|}
 +
{|
 +
| style="padding: 0px 0px 20px 15px;" |Select numerous domains and define log rotaion settings in bulk.
 +
|}
 +
{|
 +
| style="padding: 0px 0px 20px 25px;" |[[File:PE3_45_2.png]]
 +
|}
 +
{|
 +
| style="padding: 0px 0px 30px 25px;" |[[File:PE3_45_3.png]]
 +
|}
 +
 
 +
===Node.js===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|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.<br/>
 +
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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_45.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Once you have installed Node.js extension and enabled it in the [[#Configuration_of_Addon|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. <br/>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_46.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Now, simply enable Node.js for the chosen domain and select which version you would like to use. <br/>You will also be able to switch version or disable Node.js any time by pressing the '' 'Edit' '' button again.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_47.png]]
 +
|}
 +
 
 +
=== PHP Settings ===
 +
{|
 +
| style="padding: 10px 0px 15px 15px;" |This section allows your clients to configure PHP settings of their domains.<br/>They are allowed to view and alter PHP version of each domain as well as select new settings by clicking the '' 'Edit' '' button.
 +
|}
 +
{|
 +
| style="padding: 0px 0px 20px 25px;" |[[File:PE3_47_0.png]]
 +
|}
 +
{|
 +
| style="padding: 0px 0px 15px 15px;" |Edit the PHP settings according to your needs. <br/> '' '''Note:''' Settings may vary depending on the currently selected PHP version.''
 +
|}
 +
{|
 +
| style="padding: 0px 0px 20px 25px;" |[[File:PE3_47_01.png]]
 +
|}
 +
{|
 +
| style="padding: 0px 0px 15px 15px;" |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:
 +
{yourWHMCS}/modules/servers/pleskExtended/lang/english.php
 +
 
 +
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';
 +
 
 +
|}
 +
{|
 +
| style="padding: 0px 0px 20px 15px;" |The result of these changes will be as following:
 +
|}
 +
{|
 +
| style="padding: 0px 0px 30px 25px;" |[[File:PE3_47_02.png]]
 +
|}
 +
 
 +
===Spam Filter===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|The '' 'Spam Filter' '' powered by ''[https://spamassassin.apache.org/ SpamAssassin]'' is designed to identify spam messages among emails sent to mailboxes hosted on your Plesk server.<br/>
 +
'''''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.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_26_0_2.png]]
 +
|}
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Enable and configure the filter as desired for the selected mailbox.<br/>
 +
 
 +
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.<br />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. <br />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.<br/>
 +
 
 +
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.<br/> Simply type domain names in appropriate fields (one domain name per line). Addresses can also contain ''' "*" ''' and ''' "?" ''' wildcard characters, for example, ''*@domain.com, user?@*.com''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_26_0.png]]
 +
|}
 +
 
 +
===SSL Certificates===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|This section will allow you to generate or paste ready SSL certificates and private keys.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_34_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|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.<br/>Once ready, you will see it on the list of ready certificates.<br/>
 +
'' '''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.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_34_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|If you already have a certificate, you can provide it by choosing '' 'Upload Certificate' ''.<br/> Next, provide the certificate and domain name, and paste the content of yours '' 'Private Key (*.key)' '', '' 'Certificate (*.crt)' '' and '' 'CA Certificate (*-ca.crt)' '' files.<br/>Once ready, you should see the provided certificate on the list.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PE2_26_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_34_5.png]]
 
|}
 
|}
  
 
===Subdomains===
 
===Subdomains===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Create subdomains to access different parts of your website. Choose a domain from your list of available and provide a document root.<br/>
+
|style="padding: 10px 0px 20px 15px;"|Create subdomains for different parts of your website by pressing the '' 'Create Subdomain' '' button.
−
You may always remove unused subdomain.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_27.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_27.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Choose a domain for your available subdomain from the list and provide a document root.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_27_1.png]]
 
|}
 
|}
  
−
===Addon Domains===
+
===Web Users===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|You can also add and manage addon domains.<br/> Choose a hosting type (with or without hosting) and press '' 'Add'. ''<br/>
+
|style="padding: 10px 0px 15px 15px;"|Add and manage the list of web users that have personal pages on your website.<br/>
−
''Make sure this feature is allowed for your account before using!''
+
'''''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.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_28.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_34_1.png]]
 
|}
 
|}
 +
{|
 +
|style="padding: 00px 0px 20px 15px;"|Provide login name and its password and decide whether to provide support for PHP and FastCGI.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_34_2.png]]
 +
|}
 +
===WordPress Manager===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|If you are an owner of the '''[https://www.modulesgarden.com/products/whmcs/wordpress-manager 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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_35_0.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|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 '''[https://www.docs.modulesgarden.com/WordPress_Manager_For_WHMCS#Client_Area here]'''.<br/>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:DAPE3_35_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|Keep in mind that the entire section can '''only''' be available if you have purchased and installed the [https://www.modulesgarden.com/products/whmcs/wordpress-manager WordPress Manager For WHMCS] module.
 +
|}
 +
===WordPress Toolkit===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|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.<br/>
 +
'''''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.''<br/>
  
−
===Domain Aliases===
+
'''''Note:''' Please bear in mind that WordPress Toolkit and WordPress Manager are two separate applications.<br/> 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.''
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Add and manage domain aliases to allow redirections of web contents display to other webpage.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE_40.png]]
−
Select available options and press '' 'Add'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_29.png]]
+
|style="padding: 0px 0px 15px 15px;"|Start your journey by adding the first installation of WordPress.<br/>
 +
Press the button 'New Installation' marked on the screen below and read the instruction to see how to install a pure new instance.
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE_41.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|A new window with four tabs will open. In the first '''Details''' tab, fill in the following fields:
  
−
===DNS Settings===
+
*'''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)''.
 +
<!--Note that this field will be displayed only for domains whose products have installation scripts configured in the Products Settings.
 +
If it is not displayed then the clean WordPress installation will be applied.-->
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Add records by providing their hostname and value, select the type of such a record. <br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE_42.png]]
−
Underneath you will find a full list of existing records.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_30.png]]
+
|style="padding: 0px 0px 15px 15px;"|
 +
*'''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.
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE_43.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|
 +
*'''Database Username'''
 +
*'''Database Name'''
 +
*'''Database Table Prefix'''
 +
*'''Database Password'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE_44.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|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
  
−
===Applications===
+
'''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
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Use Plesk Extended For WHMCS to install your favorite applications in a few seconds without even accessing Plesk panel! To start, simply proceed to '' 'Applications' '' <br/>then find the '' 'Install New' '' section.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE_45.png]]
−
'''Important:''' below we are presenting a sample flow of installing application with the '' 'Installatron' '' auto installer. <br/> The process itself differ slightly and some of options may not be available for '' 'Default' '' Plesk autoinstaller.<br/>
+
−
''For more info please refer to the features list [http://www.docs.modulesgarden.com/Plesk_Extended_For_WHMCS#About_Plesk_Extended_For_WHMCS here].''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_31.png]]
+
|style="padding: 0px 0px 15px 15px;"|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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterward, you will see an extensive list of all applications. For presentation purposes we will install '' 'osTicket'. ''<br />Find '' 'osTicket' '' and press it.
+
|style="padding: 0px 0px 30px 25px;"|[[File:PE_46.png]]
 
|}
 
|}
 +
 +
====Instance Management====
 +
=====Details=====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_32.png]]
+
|style="padding: 10px 0px 20px 15px;"|Instance details is the first section that you will be directed to once you move to single installation management.<br/>
 +
You will find there gathered details on WordPress, such as:  
 +
*URL, Domain, Owner Name, Version, Plugins & Themes Updates, Security Status, PHP version, SSL/TLS
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Now, you have to enter necessary installation details and then press '' 'Install Application' '' to follow. Wait for the '' 'Success' '' message.
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE_47.png]]
 
|}
 
|}
 +
=====Maintenance Mode=====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_33.png]]
+
|style="padding: 10px 0px 20px 15px;"|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<br/>
 +
 
 +
'''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)''<br/>
 +
 
 +
'''Timer''' - enable the timer to count down the remaining time
 +
*''Countdown Timer''
 +
*''Remaining time (days, hours, minutes)''<br/>
 +
 
 +
'''Social Network Links''' - Type in links to your social network pages. If left empty, the corresponding link will be hidden.
 +
*''Facebook''
 +
*''Twitter''
 +
*''Instagram''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|View the list of your installed applications by clicking the '' 'Installed Applications' '' tab. Please press the '' 'Refresh Table' '' button to see the latest installed application! <br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE_48.png]]
−
You will see there entered while installing '' 'Site Name', '' version of installed app and allowed actions.<br/>  '' 'Delete' '' (2) installed application or prepare a backup (1) of the application. More about '' 'Backups' '' below.
+
 
|}
 
|}
 +
 +
=====Credentials=====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_34.png]]
+
|style="padding: 10px 0px 20px 15px;"|Instance settings <br/>
 +
*Administrator Login Name
 +
*Administrator Password
 +
*Email Address
 +
*Language
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|This is how the list looks like when the '' 'Default' '' Plesk autoinstaller has been used.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE_49.png]]
−
Please note that there are no actions allowed on the installed application and there is no '' 'Backups' '' option.
+
 
|}
 
|}
 +
=====Plugins=====
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PE2_33_1.png]]
+
|style="padding: 10px 0px 20px 15px;"|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.
 +
 
 
|}
 
|}
−
====Backups====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|If the '' 'Installatron' '' autoinstaller type is used, then the '' 'Backups' '' option is available.<br/> To backup an application simply press the adequate action button next to it.
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE_50.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_37.png]]
+
|style="padding: 0px 0px 15px 15px;"|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.<br/> A list of related plugins will appear. You may now learn more about each plugin by pressing the '' 'Show Details' '' button. <br/> If the plugin meets your requirements, simply press the corresponding button to begin the installation process (which might take a short while).
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Confirm the action and wait a moment until your backup is ready.
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE_51.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_37_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE_52.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Move to the '' 'Backups' '' tab. There is a list of all created backups. <br/>
+
|style="padding: 0px 0px 20px 15px;"|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.
−
Use action buttons to restore (1) backup or to delete (2) it.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PE2_37_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PE_53.png]]
 
|}
 
|}
  
−
===Web Users===
+
=====Themes=====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Add and manage the list of web users that have personal pages on your website.
+
|style="padding: 10px 0px 20px 15px;"|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. <br/> You can also add new themes to your WordPress installation in the 'Add New' tab.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PE2_34_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE_54.png]]
 
|}
 
|}
−
===SSL Certificates===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|This section will allow you to generate or paste ready SSL certificates and private keys.<br/> Simply choose '' 'Generate' '' or '' 'Paste' '' and then fill out required fields. Once ready, you will see the list of ready certificates.
+
|style="padding: 0px 0px 15px 15px;"|Please start typing in the search field to see the available themes.<br/> Once a list of related themes appears, you will be allowed to first check their preview and details. <br/> If the theme satisfies your needs, simply press the corresponding button to begin the installation process (which might take a short while).
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PE2_34_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE_55.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Thanks to the '' 'Mass Action' '' functionality, you will be able to handle multiple themes more efficiently at the same time.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE_56.png]]
 
|}
 
|}
  
 
==One Click Login==
 
==One Click Login==
−
===Log In To Panel===
+
===Log In To Backup Manager===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|With a single click on the button '' 'Log In To Panel' '' you can be redirected to your Plesk Panel account.<br/>
+
|style="padding: 10px 0px 15px 15px;"|Just one click on the '' 'Backup Manager' '' button and you will be immediately redirected to the dedicated page.<br/>
 
''Note that you must have a proper IP address or domain entered in the admin area panel to use this button.''
 
''Note that you must have a proper IP address or domain entered in the admin area panel to use this button.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_35.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_36_0.png]]
 +
|}
 +
 
 +
===Log In To Plesk===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|With a single click on the '' 'Log In To Plesk' ''  button you can be redirected to your Plesk Panel account.<br/>
 +
''Note that you must have a proper IP address or domain entered in the admin area panel to use this button.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_35.png]]
 
|}
 
|}
  
 
===Log In To Webmail===
 
===Log In To Webmail===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|You can quickly access your webmail through pressing the '' 'Log In To Webmail' '' button.<br/>
+
|style="padding: 10px 0px 15px 15px;"|You can quickly access your webmail through pressing the '' 'Log In To Webmail' '' button.<br/>
 
''Note that you must have a proper IP address or domain entered in the admin area panel to use this button.''
 
''Note that you must have a proper IP address or domain entered in the admin area panel to use this button.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE2_36.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_36.png]]
 +
|}
 +
 
 +
===Log In To WP Toolkit===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|You can easily be redirected to the  WP Toolkit section in your Plek panel by clicking the '' 'Log In To WordPress Toolkit' '' button.<br/>
 +
''Note that you must have a proper IP address or domain entered in the admin area panel to use this button.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_36_1.png]]
 
|}
 
|}
  
 
==Applications Configuration==
 
==Applications Configuration==
 +
===Configurable Options For Application Auto Installation===
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Let your clients decide which application they would like to install on their new Plesk account.<br />
 +
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.<br />
 +
There is nothing else you need to do. The application will be instantly ready for use!<br />
 +
The module offers two ways in which you may generate applications' configurable options - automatically or manually.
 +
|}
 +
====Automatic Generation====
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|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.<br/>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_60_0.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Next, go back to the products list and press the ''' 'Generate Auto Installer's Applications Configurable Options' '' icon.<br/> Note that the button will remain inactive if the product already has the options generated and assigned or the Auto Installer is not selected.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_60_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|A list of available applications will appear. Keep in mind that it will differ depending on the selected Auto Installer. <br/>
 +
Decide which of the applications you wish to offer to your clients, to select all at once, use the '' 'Toggle All' '' option. <br/> Press '' 'Confirm' '' when ready.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_60_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|Once the options have been generated, they are visible at '' 'WHMCS' → 'System Settings' → 'Products/Services' → 'Configurable Options' '' and assigned to the product. <br/>
 +
In case you wish to generate the options again for that product, you must previuosy unassign those already generated or delete them.<br/> Otehrwise the ''' 'Generate Auto Installer's Applications Configurable Options' '' button will remain inactive.
 +
|}
  
−
===Configurable Options For Application Auto Install===
+
====Manual Generation====
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|
 +
As an alternative, you may generate the configurable options in a traditional way. <br/> 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' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_52_1.png]]
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let your clients decide which application they would like to install on their new Plesk account.<br />
+
|style="padding: 0px 0px 20px 15px;"|Next, go back to the features list and click on the download icon to view the list of applications.
−
While placing an order your customer chooses an application and along with account creation this very application will be installed on the account.<br />
+
−
There is nothing else you need to do. Application will be instantly ready to use!<br />
+
−
To set up this feature, come back to your product's configuration, find the '' 'Applications' '' section, activate '' 'Install Applications' '', choose '' 'Auto Installer' '' and activate '' 'Use Configurable Options' ''.<br />
+
−
Click on the download icon to view the list of applications.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE52.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_52.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|These are the names of values that you can enter in configurable options' fields, we will configure them in the next step.<br />
+
|style="padding: 0px 0px 15px 15px;"|These are the names of values that you can enter in configurable option fields. We will configure them in the next step.<br />
 
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. ''<br />
 
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. ''<br />
−
'''1. If you have made a mistake with the application name, the auto installer will not work.'''<br />
+
'''1. If you have made a mistake with the application name, the autoinstaller will not work.'''<br />
−
'''2. In the current version for variable you have to enter only application name (without application version number) and only the latest version available on the application list will be installed.'''<br />
+
'''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.'''<br />
−
Now, when you know what values should be entered in configurable options, we can proceed further.
+
Now that you know what values should be entered in configurable options, we can proceed further.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE53.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_53.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Go to your '' 'WHMCS' '' → '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Options' '' and press '' 'Create a New Group' ''.
+
|style="padding: 0px 0px 20px 15px;"|Go to your '' 'WHMCS' '' → '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Configurable Options' '' and press '' 'Create a New Group' ''.
 
|}
 
|}
 
{|
 
{|
Line 623: Line 1,279:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Now click on '' 'Add New Configurable Option' ''.
+
|style="padding: 0px 0px 20px 15px;"|Now, click on '' 'Add New Configurable Option' ''.
 
|}
 
|}
 
{|
 
{|
Line 629: Line 1,285:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|This moment is very important. As '' 'Option Name' '', you have to enter '' 'Installation App' ''. '''Otherwise the entire functionality will not work.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|This moment is very important. As '' 'Option Name' '', you have to enter '' 'Installation App' ''. '''Otherwise, the entire functionality will not work.'''<br />
−
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' ''.<br />
+
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' ''.<br />
 
Repeat this as many times as you need and do not forget to set '' 'Option Type' '' to '' 'Dropdown' ''.<br/><br />
 
Repeat this as many times as you need and do not forget to set '' 'Option Type' '' to '' 'Dropdown' ''.<br/><br />
−
Remember that you cannot type the application version number as variable! Only the latest version available will be installed.
+
Remember that you cannot type the application version number as a variable! Only the latest version available will be installed.
 
|}
 
|}
 
{|
 
{|
Line 638: Line 1,294:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|As you can see on the following screen we decided to offer our customers 5 applications.<br />
+
|style="padding: 0px 0px 15px 15px;"|As you can see on the following screen, we decided to offer our customers 5 applications.<br />
−
When you finish adding applications, press '' 'Save Changes' '' and '' 'Close Window'. ''
+
When you finish adding the applications, press '' 'Save Changes' '' and '' 'Close Window'. ''
 
|}
 
|}
 
{|
 
{|
Line 645: Line 1,301:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|From the module's version 3.1.0 you can also create a new configurable option '''Auto Backup On Update''' with the 'Yes/No' option type.<br />
+
|style="padding: 0px 0px 15px 15px;"|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.<br />
−
This option is used to enable the creation of auto update backups for a firstly chosen application after the initial order in WHMCS.<br />
+
This option is used to enable the creation of auto update backups for a first chosen application after the initial order in WHMCS.<br />
 
''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.''<br />
 
''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.''<br />
 
|}
 
|}
Line 653: Line 1,309:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterward, come back to '' 'Plesk Extended Features' '' → '' 'Configuration' '' → '' 'Applications' '', activate '' 'Use Configurable Options' '' and choose '' 'Apps/Configurable Options' '' from the dropdown menu.<br />
+
|style="padding: 0px 0px 15px 15px;"|Afterward, come back to '' 'Plesk Extended Features' '' → '' 'Configuration' '' → '' 'Applications' '', activate '' 'Use Configurable Options' '' and choose '' 'Apps / Configurable Options' '' from the dropdown menu.<br />
−
Please note that you can have more configurable options groups. Press '' 'Save' '' and that's it. You have just successfully assigned configurable options to the application autoinstall.
+
Please note that you can have more configurable options groups. Press '' 'Save' ''. You have just successfully assigned configurable options to the application auto installation.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PE59.png]]  
+
|style="padding: 0px 0px 20px 25px;"|[[File:PE3_59.png]]  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Let's check out what your customers are going to see in their client area while placing the order.<br/>
+
|style="padding: 0px 0px 15px 15px;"|Let us find out what your customers are going to see in your client area while placing the order.<br/>
−
As you can see, a dropdown menu with the previously configured applications has shown up.
+
As you can notice, a dropdown menu with the previously configured applications has appeared.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PE60.png]]  
+
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_60.png]]  
 
|}
 
|}
  
−
===Assignment of Custom Fields To Application Autoinstall===
+
===Assignment of Custom Fields To Application Auto Installation===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|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.<br />
+
|style="padding: 10px 0px 15px 15px;"|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.<br />
−
Until that moment applications had been installed with use of default details like e.g. directory names or database name.<br />
+
Until this moment applications have been installed with the use of default details like e.g. directory names or database name.<br />
 
Those details are sent to each customer's email.<br />
 
Those details are sent to each customer's email.<br />
−
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.<br />
+
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.<br />
−
In the beginning, go to '' 'Product/Services' '', find your product using'' 'Plesk Extended' '' module and enter '' 'Custom Fields' '' category.<br />
+
In the beginning, go to '' 'Product/Services' '', find your product using'' 'Plesk Extended' '' module and enter the '' 'Custom Fields' '' category.<br />
−
You will need to add 12 custom fields, the first 8 are:  
+
You will need to add 12 custom fields, the first 8 being:  
 
*'''Directory'''
 
*'''Directory'''
 
*'''Database Name'''
 
*'''Database Name'''
Line 690: Line 1,346:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|The next 3 fields are:  
+
|style="padding: 0px 0px 15px 15px;"|The next 3 fields are:  
 
*'''Admin Username'''
 
*'''Admin Username'''
 
*'''Admin Password'''
 
*'''Admin Password'''
Line 700: Line 1,356:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|The last field is:
+
|style="padding: 0px 0px 15px 15px;"|The last field is:
 
*'''Auto Update'''
 
*'''Auto Update'''
 
Set it as '' 'Drop Down' '', enter '' 'Yes, No' '' into '' 'Select Options' '', tick '' 'Required Field ' '' and '' 'Show on Order Form'. ''
 
Set it as '' 'Drop Down' '', enter '' 'Yes, No' '' into '' 'Select Options' '', tick '' 'Required Field ' '' and '' 'Show on Order Form'. ''
Line 708: Line 1,364:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Once you add all the custom fields they will appear while placing an order.<br />
+
|style="padding: 0px 0px 15px 15px;"|Once you add all the custom fields, they will appear while placing an order.<br />
 
Voila! Now your customers can personalize each application without the necessity of installing it later.
 
Voila! Now your customers can personalize each application without the necessity of installing it later.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PE62.png]]  
+
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_62.png]]  
 
|}
 
|}
  
Line 718: Line 1,374:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|We will show you how to quickly set a custom language for Installatron web applications.<br />
 
|style="padding: 10px 0px 15px 15px;"|We will show you how to quickly set a custom language for Installatron web applications.<br />
−
For this purpose you need to add a new custom field for your product. The field should be called '' 'Language' ''.
+
For this purpose, you need to add a new custom field for your product. The field should be called '' 'Language' ''.
 
|}
 
|}
 
{|
 
{|
Line 724: Line 1,380:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterward go to your '' 'Products/Services' '' and check whether the '' 'Language' '' field has appeared.<br />
+
|style="padding: 0px 0px 15px 15px;"|Afterward, go to your '' 'Products/Services' '' and check whether the '' 'Language' '' field has appeared.<br />
−
In order to change the default application language for a certain account enter here the appropriate value.
+
In order to change the default application language for a certain account, enter the appropriate value here.
 
|}
 
|}
 
{|
 
{|
Line 731: Line 1,387:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|From now on the new field will be visible for your customers as well. While installing a new application they can choose a desired language by entering its value into the field.<br />
+
|style="padding: 0px 0px 30px 15px;"|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.<br />
−
[http://softaculous.com/docs/Scripts_Language_Codes Here] you will find a complete list of language codes.
+
[https://softaculous.com/docs/Scripts_Language_Codes Here] you will find a complete list of language codes.
 
|}
 
|}
  
Line 738: Line 1,394:
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|'''You can easily use Plesk Extended module with your already configured Plesk products.<br />
 
|style="padding: 10px 0px 30px 15px;"|'''You can easily use Plesk Extended module with your already configured Plesk products.<br />
−
To do so change the type of servers and module names of products from '' 'Plesk' '' to '' 'PleskExtended'. ''<br />
+
To do so, change the type of servers and module names of products from '' 'Plesk' '' to '' 'PleskExtended'. ''<br />
 
Additional information about how to correctly configure your servers and products can be found at points 8-16 of the '' 'Installation and Configuration' '' section.
 
Additional information about how to correctly configure your servers and products can be found at points 8-16 of the '' 'Installation and Configuration' '' section.
 
|}
 
|}
Line 744: Line 1,400:
 
==Billing Management==
 
==Billing Management==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|When you combine Plesk Extended For WHMCS with [http://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br />
+
|style="padding: 10px 0px 20px 15px;"|When you combine Plesk Extended For WHMCS with [https://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br />
 
|}
 
|}
 
{|
 
{|
Line 756: Line 1,412:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display your customers the current server resource usage and their cost.
+
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display to your customers the current server resource usage and their cost.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PE42.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PE3_42.png]]
 +
|}
 +
 
 +
==Importing Existing Account==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|In this section, you can find short instruction on how to connect one of your clients to your already existing account in Plesk. <br/> Take the following steps to make sure that the process will be carried out properly. <br/>
 +
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' ''. <br/> '''What is important, do not perform the '' 'Create' '' action.''' The status has to remain as '' 'Pending' ''. <br/> More info about placing orders can be found [https://docs.whmcs.com/Order_Management#Placing_an_Order here]<br/>
 +
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. <br/> '''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. <br/> '''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. <br/>
 +
If you completed the required data, now change the status from '' 'Pending' '' to '' 'Active' '' and '' 'Save Changes' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Plesk_import.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|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. <br/> '''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. <br/>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|Another possibility to import already existing accounts in Plesk with your WHMCS is to use the ''' '' 'Server Sync Tool' '' '''  WHMCS tool. <br/> More info can be found  [https://docs.whmcs.com/Server_Sync_Tool here].
 +
After performing this action, do not forget to run the following cron command: <br/>
 +
<pre> php -q  yourModulePath/modules/servers/PleskExtended/cron/cron.php account:synchronize </pre>
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 0px 0px 5px 15px;"|1. To set up an existing customer's account in your Plesk Extended, create a new WHMCS order with the same username, password and email address.<br />
+
|style="padding: 0px 0px 5px 15px;"|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.<br />
−
Then set the account status to active.
+
Then, set the account status to active.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|2. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.
+
|style="padding: 0px 0px 5px 15px;"|2. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 5px 15px;"|3. If you want the already deleted accounts on the server to be removed from the WHMCS addon module list, <br/> proceed to '''yourWHMCS/modules/addons/PleskExtended/commands''' and use the following cron command.<br/>
 +
<pre> >  php -q run.php client:plesk:delete </pre>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 5px 15px;"|4. If the "Invalid secret key usage. Please check logs for details." error occurs, <br/> 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. <br/>
 +
<pre> yourModulePath/modules/servers/PleskExtended/cron/cron.php secretKeys:delete </pre>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|5. We recommend assigning only one server to '' 'Server Group' '' as servers may have different service plans. <br/> 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=
 
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
+
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
−
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
+
 
−
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
+
'''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.<br/> You also need to set '''recursively writable permissions''' for '''storage''' directories in these '''two''' locations:
 +
# your_whmcs/modules/addons/PleskExtended/
 +
# 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.<br/>
 +
In addition, remember to '''reissue''' your license due to changes in the folder names.<br/>
 +
 
 +
'' '''Note:''' from 3.0.0 version of the module the cron execution is also no longer required.
 
|}
 
|}
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> 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.<br/>
 +
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/plesk-extended#open-source-version Open Source version] of your Plesk Extended For WHMCS module to unlock these benefits.<br/> 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.<br/>
 +
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module 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=
 
=Common Problems=
 
{|
 
{|
Line 782: Line 1,487:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|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 product's 'Module Settings'.<br />
+
|style="padding: 0px 0px 15px 15px;"|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'.<br />
 
Once you enter the name, the problem will disappear.
 
Once you enter the name, the problem will disappear.
 
|}
 
|}
Line 789: Line 1,494:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|3. If you are unable to connect with your Plesk server or client area functionalities don't work properly, then make sure that you are connecting with your server on port 8443.<br />
+
|style="padding: 0px 0px 15px 15px;"|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.<br />
−
Here you can find more information on how to change default port in [http://kb.parallels.com/en/138 Linux] and [http://kb.parallels.com/en/115712 Windows]
+
Here you can find more information on how to change the default port in [https://kb.parallels.com/en/138 Linux] and [https://kb.parallels.com/en/115712 Windows]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|4. ''Unable to get the version number from the server. CURL Error: 7 - couldn't connect to host. Check server connection details.''<br />
+
|style="padding: 0px 0px 15px 15px;"|4. ''CURL Error: [6] Could not resolve host.''<br />
 +
Try entering your Plesk IP address into the ''Hostname'' field in the server configuration.
 +
|}
 +
 
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|5. ''Unable to get the version number from the server. CURL Error: 7 - couldn't connect to host. Check server connection details.''<br />
 
Check connection details and the connection itself between WHMCS and server.
 
Check connection details and the connection itself between WHMCS and server.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|5. ''Unable to get the version number from the server. Permission denied. You have to set admin account access details.''<br />
+
|style="padding: 0px 0px 15px 15px;"|6. ''Unable to get the version number from the server. Permission denied. You have to set admin account access details.''<br />
−
You need admin account access to use PPPE module, reseller account API is not supported.
+
You need admin account access to use PPPE module. Reseller account API is not supported.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|6. '''Blank page at '' 'Applications'. '''''<br />
+
|style="padding: 0px 0px 15px 15px;"|7. '''Blank page at '' 'Applications'. '''''<br />
 
''Reason'': Some libraries may be missing.<br />
 
''Reason'': Some libraries may be missing.<br />
 
''Solution'': Make sure you have installed php-xml library.
 
''Solution'': Make sure you have installed php-xml library.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|7. If you have problems with your license, please make sure that the content of the file is correct.<br/>
+
|style="padding: 0px 0px 15px 15px;"|8. If you have problems with your license, please make sure that the content of the file is correct.<br/>
−
Please note that for '''Plesk Extended For WHMCS V2.0.0''' and later the license key begins with:
+
Please note that for '''Plesk Extended For WHMCS V2.0.0''' and later, the license key begins with:
 
  $plesk_extended_licensekey="ModulesGarden_PleskEX_LicenseKey";
 
  $plesk_extended_licensekey="ModulesGarden_PleskEX_LicenseKey";
  
Line 814: Line 1,524:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|8. 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 the product, please verify your product type.<br/> Most probably it is set to '' 'Dedicated/VPS Server' '' or '' 'Other' '' which are not supported. See point 15 for more info.
+
|style="padding: 0px 0px 15px 15px;"|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.<br/> Most probably it is set to '' 'Dedicated/VPS Server' '' or '' 'Other' '' which are not supported. See point 17 of the installation for more info.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|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.<br/> Make sure that you have SSL 'Secure' ticked in your server configuration, depending on your Plesk settings.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|11. Plesk Extended For WHMCS functions only on the administrator account.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|12. For a large backup files we recommend to increase the '' 'max_execution_time' '' setting in your server's '' 'php.ini' '' configuration.<br/>Otherwise, fatal errors like '' 'Allowed memory size of 134217728 bytes exhausted (tried to allocate 100401152 bytes)' may occur when trying to download local backups.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|13. Getting the '' 'SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry (...)' '' error when creating a new Plesk account?<br/>
 +
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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|14. Due to [https://docs.plesk.com/en-US/onyx/api-rpc/about-xml-api.28709/ removed support for '' 'XML API'] '' by Plesk, Plesk Onyx from version ''' ''17.8'' ''' is only '''partly''' supported.<br/>
 +
This means the following functionalities:
 +
*Backups
 +
<!-- *FTP Access juz dziala w najnowszej wersji pleska -->
 +
*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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|9. 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 the product please verify your server configuration.<br/> Make sure that you have SSL 'Secure' ticked in your server configuration, depending on your Plesk settings.
+
|style="padding: 0px 0px 15px 15px;"|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' ''.<br/>
 +
You can set it up as described in [[#Configuration_of_Addon|Configuration of Addon]] section in '''step 29'''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|10. Plesk Extended For WHMCS functions only on the administrator account.  
+
|style="padding: 0px 0px 30px 15px;"|16. If you come across the ''' ''PleskAPIInvalidSecretKeyException : Invalid secret key usage. Please check logs for details.'' ''' error after migrating the system to another server, <br/> 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.<br/>
 +
<pre> php yourModulePath/modules/servers/PleskExtended/cron/cron.php secretKeys:delete </pre>
 
|}
 
|}

Latest revision as of 13:59, 26 April 2024

Contents

[edit] 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.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation and Configuration

[edit] Installation

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

[edit] 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!

[edit] 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 ka.plesk.com 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

[edit] 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.

[edit] 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

[edit] 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

[edit] Management

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.

[edit] Client Area

[edit] 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

[edit] Applications

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

[edit] 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

[edit] Backups

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

[edit] Databases

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

[edit] 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

[edit] 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

[edit] 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

[edit] 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

[edit] 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

[edit] 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

[edit] 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

[edit] Node.js

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

[edit] 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: 
{yourWHMCS}/modules/servers/pleskExtended/lang/english.php

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

[edit] 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, *@domain.com, user?@*.com.

PE3 26 0.png

[edit] 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

[edit] Subdomains

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

[edit] 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

[edit] 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.

[edit] 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

[edit] Instance Management

[edit] Details
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
[edit] 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
[edit] Credentials
Instance settings
  • Administrator Login Name
  • Administrator Password
  • Email Address
  • Language
PE 49.png
[edit] Plugins
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
[edit] Themes
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

[edit] One Click Login

[edit] 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

[edit] 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

[edit] 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

[edit] 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

[edit] Applications Configuration

[edit] 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.

[edit] 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.

[edit] 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' .
PE54.png
Enter 'Group Name' of your choice, select product you want to assign configurable options to, then press 'Save Changes' .
PE55.png
Now, click on 'Add New Configurable Option' .
PE56.png
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.

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

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

[edit] 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.

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

[edit] 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' .

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

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

[edit] 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.

[edit] Billing Management

When you combine Plesk Extended For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options.
PE40.png
The module allows you to charge your customers basing on the server resources used by them.
PE41.png
With Advanced Billing module, you can also display to your customers the current server resource usage and their cost.
PE3 42.png

[edit] 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

[edit] Tips

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.

[edit] 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.

[edit] 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.

[edit] 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.

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

$plesk_extended_licensekey="ModulesGarden_PleskEX_LicenseKey";

Not as it was for the previous versions: 

$parallels_plesk_panel_extended_licensekey="ModulesGarden_PleskEX_LicenseKey";
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
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Plesk_Extended_For_WHMCS&oldid=66728"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Plesk Extended For WHMCS