WordPress Manager For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
(→About WordPress Manager For WHMCS) |
(→About WordPress Manager For WHMCS) |
||
| (168 intermediate revisions by 7 users not shown) | |||
| Line 5: | Line 5: | ||
{| | {| | ||
|style="padding: 10px 0px 10px 0px;"|'''WordPress Manager For WHMCS''' is a module that enables your customers to control and freely alter their WordPress instances right inside your WHMCS. <br /> | |style="padding: 10px 0px 10px 0px;"|'''WordPress Manager For WHMCS''' is a module that enables your customers to control and freely alter their WordPress instances right inside your WHMCS. <br /> | ||
| − | Your clients will be able to add WordPress installations using instance images and custom scripts, perform WordPress updates, install themes and plugins, create staging instances and then push them live.<br/> All of that just next to the basic upgrade options. You will easily handle the list of services | + | Your clients will be able to add WordPress installations using instance images and custom scripts, perform WordPress updates, install themes and plugins, create staging instances and then push them live.<br/> All of that just next to the basic upgrade options. You will easily handle the list of services with WordPress management features. |
|} | |} | ||
*'''Admin Area:''' | *'''Admin Area:''' | ||
| Line 16: | Line 16: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 30px;"|✔ Choose Supported Products: | |style="padding: 0px 0px 0px 30px;"|✔ Choose Supported Products: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Select API To Use: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ Softaculous Auto Installer | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ WP Toolkit | ||
|} | |} | ||
{| | {| | ||
| Line 27: | Line 36: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ Automatically Install: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Automatic Deletion Of Blocked Plugins | + | |style="padding: 0px 0px 0px 60px;"|✔ WordPress After Service Creation: |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 75px;"|✔ Based On Installation Script | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 75px;"|✔ Based On Instance Image | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ Plugin Packages | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ Theme Packages | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Blocked Plugins And Themes | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Automatic Deletion Of Blocked Plugins And Themes | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Set Scan Interval For Blacklists Cleaner | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Define Default Theme To Be Enabled After Installation | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Choose Custom Plugins And Themes Available To Clients | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Choose Instance Images Available To Clients | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Permission To Delete WordPress Auto-Installation | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Define Protocol For WordPress Auto-Installation | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Select Welcome Email Template | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Define Installation Limit Per Hosting Account | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Define Update WordPress Notification Mail Interval | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Select Update WordPress Email Template | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Debug Logs | ||
|} | |} | ||
{| | {| | ||
| Line 42: | Line 102: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Add/Remove Selected Themes From Blacklist: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 60px;"|✔ Prevent Blacklisted Themes From Being Installed By Clients |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ Remove Blacklisted Themes From Current Installations | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Define Client Area Features: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ Management Options | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ Action Options | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Plugins: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Create Plugin Packages: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ Enter Package Name And Description | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ Choose Available Plugins | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Add Custom Plugins | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Themes: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Create Theme Packages: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ Enter Package Name And Description |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ Choose Available Themes |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ Add Custom Themes |
|} | |} | ||
{| | {| | ||
| Line 66: | Line 159: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Access Module Tasks List And Logs |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Provide Google API Token For PageSpeed Insights | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Define Allowed Protocols For WordPress Instances To Be Used In Client Area | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 10px 30px;"|✔ Enable Extended View Of Instances List | ||
|} | |} | ||
| Line 74: | Line 176: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Using Simple List Of Instances |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Using Extended View With Instances Preview Screenshots |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Create WordPress | + | |style="padding: 0px 0px 0px 30px;"|✔ View/Create/Edit/Delete WordPress Installations On Your Resellers Accounts: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ cPanel |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ DirectAdmin |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Update Selected WordPress Installations To Newest Version In One Batch |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Import WordPress Installation From Remote Server |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Create WordPress Installation Based On Instance Image |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Log In To Admin Panel Of WordPress Instances | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Receive Email Notifications And Get Visual Alerts When WordPress Update Is Available | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ View Installation Details: | ||
|} | |} | ||
{| | {| | ||
| Line 102: | Line 213: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 45px;"|✔ Product On Which Is Installed | |style="padding: 0px 0px 0px 45px;"|✔ Product On Which Is Installed | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ WordPress Version | ||
|} | |} | ||
{| | {| | ||
| Line 120: | Line 234: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 45px;"|✔ Instance Status | |style="padding: 0px 0px 0px 45px;"|✔ Instance Status | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ SSL Certificate Expiration Date | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ View Website Details Based On Google "PageSpeed Insights": | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Desktop And Mobile Screengrab Thumbnails Of Website | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ General Performance Information | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Page Statistics | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Opportunities | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Audit Passed Successfully | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Diagnostics | ||
|} | |} | ||
{| | {| | ||
| Line 162: | Line 300: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 45px;"|✔ View/Create/Edit/Delete WP Config Records | |style="padding: 0px 0px 0px 45px;"|✔ View/Create/Edit/Delete WP Config Records | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ View/Create/Edit/Delete WordPress User Accounts With Specified Privileges | ||
|} | |} | ||
{| | {| | ||
| Line 168: | Line 309: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 45px;"|✔ Log In To Control Panel | |style="padding: 0px 0px 0px 45px;"|✔ Log In To Control Panel | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Access Credentials Setup | ||
|} | |} | ||
{| | {| | ||
| Line 201: | Line 345: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 45px;"|✔ Enable/Disable SSL | |style="padding: 0px 0px 0px 45px;"|✔ Enable/Disable SSL | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Enable/Disable Debug Mode | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Enable/Disable Maintenance Mode | ||
|} | |} | ||
{| | {| | ||
| Line 206: | Line 356: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Delete |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 10px 30px;"|✔ Single Sign-On Into WordPress Panel From Product View | ||
|} | |} | ||
*'''Supported Modules:''' | *'''Supported Modules:''' | ||
{| | {| | ||
| − | |style="padding: 10px 0px 0px 30px;"|✔ cPanel | + | |style="padding: 10px 0px 0px 30px;"|✔ cPanel (Root Access Required) |
|} | |} | ||
{| | {| | ||
| Line 217: | Line 370: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ DirectAdmin | + | |style="padding: 0px 0px 0px 30px;"|✔ DirectAdmin (Admin Account Required) |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ [https://www.modulesgarden.com/products/whmcs/directadmin-extended DirectAdmin Extended] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Plesk (Root Access Required) | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 10px 30px;"|✔ [https://www.modulesgarden.com/products/whmcs/plesk-extended Plesk Extended] | ||
| + | |} | ||
| + | |||
| + | *'''Supported Integrations:''' | ||
| + | {| | ||
| + | |style="padding: 10px 0px 0px 30px;"|✔ Softaculous Auto Installer - Premium (cPanel, Plesk, DirectAdmin) | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 10px 30px;"|✔ | + | |style="padding: 0px 0px 10px 30px;"|✔ WP Toolkit (cPanel, Plesk) - View [[#WP_Toolkit_Integration|Wiki]] To See Differences In Support |
|} | |} | ||
*'''General Info:''' | *'''General Info:''' | ||
{| | {| | ||
| − | |style="padding: 10px 0px 0px 30px;"|✔ | + | |style="padding: 10px 0px 0px 30px;"|✔ Automatic Let's Encrypt SSL Installation (DirectAdmin Only) |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Fully Integrated With [https://lagom.rsstudio.net/extensions/whmcs-modules-integration/wordpress-manager-by-modulesgarden Lagom WHMCS Client Theme] |
|} | |} | ||
{| | {| | ||
| Line 234: | Line 401: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4 |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One" |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6 |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/wordpress-manager#open-source-version Open Source Version] | + | |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/wordpress-manager#open-source-version Open Source Version] | ||
|} | |} | ||
| Line 255: | Line 425: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:WM1.png]] |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP 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/> | ||
| − | In the most recent versions of the module, you will find only one package that supports PHP 7. | + | In the most recent versions of the module, you will find only one package that supports PHP 7.2 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: | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]] |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/> | |style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/> | ||
| − | The first one that supports PHP 5.6 up to PHP 7. | + | 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. | + | '''''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 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 10px 15px;"|'' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/wordpress-manager#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.''' | + | |style="padding: 0px 0px 10px 15px;"| <!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/wordpress-manager#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''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;"|'''3. | + | |style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory.<br/> |
| − | The content of the | + | The content of the package to upload should look like this. |
|} | |} | ||
{| | {| | ||
| Line 284: | Line 454: | ||
==cPanel (WHM) Installation== | ==cPanel (WHM) Installation== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|'''1. Upload and extract the '' 'UploadToWHM' '' folder into the '''/root''' cPanel directory.'''<br /> | + | |style="padding: 10px 0px 20px 15px; color: #ff0000;"|'''''Important: Root access''' is required to perform the installation successfully!'' |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|'''1. Upload and extract the '' 'UploadToWHM' '' folder into the '''/root''' cPanel directory.'''<br /> | ||
Files in your cPanel ''/root/uploadToWHM/'' directory should look like these on the following screen. | Files in your cPanel ''/root/uploadToWHM/'' directory should look like these on the following screen. | ||
|} | |} | ||
| Line 298: | Line 471: | ||
|style="padding: 0px 0px 30px 25px;"|[[File:WM_3.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:WM_3.png]] | ||
|} | |} | ||
| + | |||
==DirectAdmin Installation== | ==DirectAdmin Installation== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|'''1. In the '' 'uploadToDirectAdmin' '' folder find the '' 'wordpress_cli.tar.gz' '' package.'''<br /> | + | |style="padding: 10px 0px 20px 15px; color: #ff0000;"|'''''Important: Admin account''' is required to perform the installation successfully!'' |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|'''1. In the '' 'uploadToDirectAdmin' '' folder find the '' 'wordpress_cli.tar.gz' '' package.'''<br /> | ||
Next, log in to your DirectAdmin panel as an administrator and go to '' 'Plugin Manager' ''. | Next, log in to your DirectAdmin panel as an administrator and go to '' 'Plugin Manager' ''. | ||
|} | |} | ||
| Line 317: | Line 494: | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:WM_2_3.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:WM_2_3.png]] | ||
| + | |} | ||
| + | |||
| + | ==Plesk Installation== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|''' Note: ''' The current version of the module requires your Plesk server configured in WHMCS to use '''username''' and '''password''' as authentication to the Plesk API. <br/>We also recommended using Plesk version 17.8.11 at least. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px; color: #ff0000;"|'''''Important: Root access''' is required to perform the installation successfully!'' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|'''1. In the '' 'uploadToPlesk' '' folder find the '' 'wordpress-manager-cli-X.X-X.zip' '' package.'''<br /> | ||
| + | Next, log in to your Plesk panel as an administrator and go to the '' 'Extensions' '' section. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM_3_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|'''2. Once you are in the '' 'Extensions' '' section, go to the '' 'My Extensions' '' tab and select the '' 'Upload Extension' '' option.'''<br/> In the opened window choose the '' 'wordpress-manager-cli-X.X-X.zip' '' package to upload and press the '' 'OK' '' button. | ||
| + | '''Important:''' If for some reason the '' 'Upload Extension' '' button is disabled, you will need to install the free panel.ini editor extension. <br/> Next, search for 'extensionUpload' and copy it. Then, go to the editor tab and paste that setting.<br/> Finally, scroll down to the last line and set it from false to true. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM_3_2.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|'''3. Once the plugin is uploaded and successfully installed, you will see it on the plugins' list. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM_3_3.png]] | ||
|} | |} | ||
| Line 349: | Line 554: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''5. Now you have to activate the module in your WHMCS system.'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''5. Now you have to activate the module in your WHMCS system.'''<br /> | ||
| − | Log in to your WHMCS admin area. Click '' ' | + | Log in to your WHMCS admin area. Click '' 'System Settings' '', then choose '' 'Addon Modules'. ''<br /> |
Afterwards, find '' 'WordPress Manager' '' and press the '' 'Activate' '' button. | Afterwards, find '' 'WordPress Manager' '' and press the '' 'Activate' '' button. | ||
|} | |} | ||
| Line 369: | Line 574: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|'''8. Good job! You have just successfully installed WordPress Manager For WHMCS! Now in your WHMCS press '' 'Addons' '' and then '' 'WordPress Manager'. '' ''' | + | |style="padding: 0px 0px 20px 15px;"|'''8. Good job! You have just successfully installed WordPress Manager For WHMCS! Now, in your WHMCS, press '' 'Addons' '' and then '' 'WordPress Manager'. '' ''' |
|} | |} | ||
{| | {| | ||
| Line 386: | Line 591: | ||
===Home=== | ===Home=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|'' 'Home' '' section is the first open when entering the addon. <br/> | + | |style="padding: 10px 0px 15px 15px;"|The '' 'Home' '' section is the first open when entering the addon. <br/> |
You will see here a quick summary of the WordPress connected elements and a list of all active WordPress installations with any details on their installation. | You will see here a quick summary of the WordPress connected elements and a list of all active WordPress installations with any details on their installation. | ||
|} | |} | ||
| Line 403: | Line 608: | ||
====General==== | ====General==== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|In '' 'General' '' section you set up some specific options concerning the plugins installation. Take a look at the below notes to learn about all the possibilities.<br/> | + | |style="padding: 10px 0px 15px 15px;"|In the '' 'General' '' section you will need to set up some specific options concerning the plugins installation. Take a look at the below notes to learn about all of the possibilities.<br/> |
| + | *'''API''' - select the desired integration method for WordPress Manager. | ||
| + | ** "Softaculous" - choose to utilize Softaculous for WordPress installations | ||
| + | ** "WP Toolkit" - seamless integration with cPanel's WP Toolkit ''(available for cPanel only)''<br/> Please refer to the [[#WP_Toolkit_Integration|WP Toolkit Integration]] section to see the list of supported features | ||
*'''Debug Mode''' - if enabled, the module's activity details will be gathered in the '' 'Logs' '' subsection. | *'''Debug Mode''' - if enabled, the module's activity details will be gathered in the '' 'Logs' '' subsection. | ||
*'''Installation Scripts''' - allow your clients to install your pre-configured WordPress instances instead of performing a clean installation only.<br/>This feature can be useful if you already have a few WordPress installations ready, such as custom theme with a demo content or other plugins.<br/>If you leave this field empty, then a clean WordPress instance will be installed by default.<br/>'' '''Important:''' The dropdown will display a bunch of other installation scrips from Softaculous, not only those from WordPress.<br/>Remember to only select your WordPress-based installations. Otherwise, unpredictable errors might occur.''<br/> | *'''Installation Scripts''' - allow your clients to install your pre-configured WordPress instances instead of performing a clean installation only.<br/>This feature can be useful if you already have a few WordPress installations ready, such as custom theme with a demo content or other plugins.<br/>If you leave this field empty, then a clean WordPress instance will be installed by default.<br/>'' '''Important:''' The dropdown will display a bunch of other installation scrips from Softaculous, not only those from WordPress.<br/>Remember to only select your WordPress-based installations. Otherwise, unpredictable errors might occur.''<br/> | ||
| − | *'''Test Installation''' - in order to get the list of applications in the [[#Plugins Blacklist|Plugins Blacklist]] search, you must have at least one active WordPress instance, otherwise, API will show no results. | + | *'''Test Installation''' - in order to get the list of e.g. applications in the [[#Plugins Blacklist|Plugins Blacklist]] search or other possible items search, you must have at least one active WordPress instance, otherwise, API will show no results. <br/>'''Important!''' You need to start typing to see the results in the drop-down menu. <br/> <span style="color: red;">'''Note:''' Please see the [[#Test Installation|Test Installation]] section for more information.</span> <br/> |
*'''Blocked Plugins''' - enable if you do not wish your clients to install certain plugins due to security, safety or any other reason.<br/> Define the plugins that will not be allowed for installation in the [[#Plugins Blacklist|Plugins Blacklist]] section. | *'''Blocked Plugins''' - enable if you do not wish your clients to install certain plugins due to security, safety or any other reason.<br/> Define the plugins that will not be allowed for installation in the [[#Plugins Blacklist|Plugins Blacklist]] section. | ||
*'''Delete Blocked Plugins''' - enable if you wish to automatically delete plugins that have been added to the blacklist.<br/>Remember that the pointed here plugins will also be removed from the already existing WordPress instances. | *'''Delete Blocked Plugins''' - enable if you wish to automatically delete plugins that have been added to the blacklist.<br/>Remember that the pointed here plugins will also be removed from the already existing WordPress instances. | ||
| − | *'''Scan Interval [Hours]''' - the products will be scanned using a cron job in the provided time intervals, suggested time interval - every 3 hours.<br/> Please do not set it more often as the server may be overloaded during the scan. It works only if the Delete Blocked Plugins option has been enabled. | + | *'''Blocked Themes''' - enable if you do not want your clients to install particular themes due to security, safety, or any other reason. <br/> Define the themes that will not be allowed for installation in the '' 'Themes Blacklist' ''section. |
| − | *'''Plugin Packages''' - select any packages containing a bunch of preselected plugins that can be later quickly installed, read more about them in section [[#Plugin Packages|Plugin Packages]]. | + | *'''Delete Blocked Themes''' - enable if you wish to automatically remove themes that have been added to the blacklist. |
| − | *'''Instance Images''' - select which of the existing images clients will be allowed to use to add new installation, read more about them in section [[#Instance Images|Instance Images]]. | + | *'''Scan Interval [Hours]''' - the products will be scanned using a cron job in the provided time intervals, suggested time interval - every 3 hours.<br/> Please do not set it more often as the server may be overloaded during the scan. It works only if the '' 'Delete Blocked Plugins' '' / '' 'Delete Blocked Themes' '' option has been enabled. |
| + | *'''Plugin Packages''' - select any packages containing a bunch of preselected plugins that can be later quickly installed, read more about them in the section [[#Plugin Packages|Plugin Packages]]. | ||
| + | *'''Auto Install Plugin Packages''' - choose which plugin packages will be installed automatically when a new WordPress instance is created by a client. Read more about them in the section [[#Plugin Packages|Plugin Packages]]. | ||
| + | *'''Custom Plugins''' - if you previously prepared '' 'Custom Plugins' '', here you may define which ones will be available to your clients. | ||
| + | *'''Auto Install Theme Packages''' - choose which themes packages will be installed automatically when a new WordPress instance is created by a client. Read more about them in section [[#Theme Packages|Theme Packages]]. | ||
| + | *'''Default Theme''' - you may select a theme that will be automatically activated once the process of installing the WordPress installation is complete. | ||
| + | *'''Custom Themes''' - select which of the previously created '' 'Custom Themes' '' should be accessible to your clients. | ||
| + | *'''Instance Images''' - select which of the existing images clients will be allowed to use to add new installation, read more about them in the section [[#Instance Images|Instance Images]]. | ||
| + | *'''Auto Install WordPress After Service Creation''' - you may here decide whether the WordPress instance should be automatically installed once the client's service is created: | ||
| + | **'''Disabled''' - select if you do not want the WordPress instance to be automatically installed after provisioning the product. | ||
| + | **'''Based On Instance Image''' - if chosen, the new dropdown will appear where you can choose the instance image based on which the WordPress will be automatically installed. | ||
| + | **'''Based On Installation Script''' - if selected, then you can choose in the new dropdown, which of the installation scripts will handle the installation of the WordPress instance after the service is created. | ||
| + | *'''Auto Install Instance Image''' - select an instance image that will be used for WordPress auto installation when the client service is created. | ||
| + | *'''Delete Auto Installed WordPress Installations''' - enable this option to allow the client to delete those WordPress installations that have been installed automatically. | ||
| + | *'''Protocol''' - select protocol that will be used for WordPress auto installation when the client service is created. | ||
| + | *'''Welcome Email'' - select an email template that will be delivered to the customer when the WordPress installation is complete. | ||
| + | *'''Installation Limit per Hosting Account''' - define the number of max installations per hosting account. | ||
| + | *'''Send Update WordPress Notification Mail''' - enable to allow customers to receive emails informing that there is a new update available for their WordPress installation. | ||
| + | *'''Send Update WordPress Notification Mail Interval [Hours]''' - determine the time interval to send notification emails about an available update for the client WordPress installation. | ||
| + | *'''Update WordPress Email Template''' - select an email template that will be sent to the customer with WordPress installation details when auto-installation is done. <br/>By default, the module will also create the '' '[[#Email_Templates|New WordPress Information]]' '' sample template which you can use or familiarize yourself with the available merge fields variables. | ||
|} | |} | ||
{| | {| | ||
| Line 418: | Line 645: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 15px;"|'' '''Note:''' By default, installation script names in the client area will be displayed without their IDs. If you want to | + | |style="padding: 0px 0px 30px 15px;"|'' '''Note:''' By default, installation script names in the client area will be displayed without their IDs. If you still want to change their names to more client-friendly, you can do it in a language file. <br/>Go to the [[#Tips|Tips]] section and look for more details in the second point.'' |
| + | |} | ||
| + | |||
| + | ====Test Installation (up to 1.7.1 version)==== | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"| | ||
| + | '''''Important:''' If the module version you are using is '''1.8.0 or later, test installation is no longer required''' to perform the below described actions!''<br/> | ||
| + | |||
| + | |||
| + | '''To fully take advantage of what the module offers, it is necessary to set up the '' 'Test Installation' '' firstly before you start completing the rest of module configuration.''' <br/> | ||
| + | In order to make the module start using WordPress API requests, it is required to have at least one WordPress instance installed. <br/> Otherwise, the features like searching '' 'Plugins' '' or '' 'Themes' '' in the admin area will not work. Thanks to the '' 'Test Installation' '' option, the module will use the WordPress instance as a gateway to WordPress API to make such requests possible. <br/> If you already have such WordPress instances in your system, you can skip this step and go back to the [[#Product Settings|Product Settings]] section where you can choose the existing instance from your system. <br/> If you do not have any instance you need to either install it on your own directly from the '' 'Softaculous' '' auto-installer (and then choose it from [[#Product Settings|Product Settings]]) or you need to install it by using the module itself as presented below. | ||
| + | |||
| + | '''Note: The below steps should be possible if you have already made the basic [[#Product Settings|Product Settings]] configuration. ''' <br/> | ||
| + | |||
| + | So, to start, proceed to the '' 'WordPress Management' '' section of the product in the [[#Client Area|Client Area]] on any of your test accounts. Next, click on the '' 'New Installation' '' button.<br/> | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_8_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|There are two sections to complete. Firstly, provide the details of your installation. <br/> Remember to enter your domain properly. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_8_2.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"| Now, go to the '' 'Other' '' section of your installation and fill in the details. You may also decide which options should be enabled for your installation. <br/> Remember to click '' 'Create' '' and wait until the '' 'New Installation' '' is ready. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_8_3.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"| Finally, you can come back to '' 'WordPress Manager' ''. Go to '' 'Product Settings' '' and click on the '' 'Edit' '' icon next to the preferred product. <br/> You will find the '' 'Test Installation' '' option here. <br/> As presented below, start typing your domain name that was provided in the previous step of creating '' 'New Installation' ''. <br/> Choose your '' 'Test Installation' '' and save changes. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_8_4.png]] | ||
|} | |} | ||
| Line 432: | Line 694: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|Add selected plugin to the blacklist.<br/> It will no longer be available for clients to install if '' "Blocked Plugins" '' option has been enabled in the ''General'' section. | + | |style="padding: 0px 0px 15px 15px;"|Add the selected plugin to the blacklist.<br/> It will no longer be available for clients to install if the '' "Blocked Plugins" '' option has been enabled in the ''General'' section. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:WM2_13.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_13.png]] | ||
| + | |} | ||
| + | ====Themes Blacklist==== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 10px 15px;"|This section of the Product Settings includes a list of blocked themes - those that your clients will not be able to install. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|If you want to add a theme to the list, simply start typing its name in the search field and press enter to see the results.<br/> Add the selected themes to the blacklist.<br/> Remember that you must have previously set any '' "Test Installation" '' to be allowed to add any themes to the list. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_13_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|Your clients will not be able to install the previously added themes if the '' "Blocked Themes" '' option has been enabled in the ''General'' section. <br/> | ||
| + | If you decide to remove the preferred themes from the '' 'Blocked' '' section, you may easily do this by clicking the appropriate button. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_13_2.png]] | ||
| + | |} | ||
| + | |||
| + | ====Client Area Features==== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|In this section, you can define which options should be enabled for clients. <br/> To make it easier, the available options are divided into two parts, the '' 'Management Options' '' and '' 'Action Options' ''. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_13_3.png]] | ||
|} | |} | ||
| − | === | + | ===Plugins=== |
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|In the '' ' | + | |style="padding: 10px 0px 15px 15px;"|In the '' 'Plugins' '' section you may prepare ready-made packages with selected by you plugins or prepare custom plugins and then offer them to install to your clients. <br/> |
| − | In this quick and convenient way, your clients will be given an offer with perfectly adjusted and suitable plugins to shorten the time of searching and verification. <br/> Prepare packages, enable when ready or disable when you want to withdraw them from the offer temporarily or edit their content and surely delete when no longer needed.<br/> | + | In this quick and convenient way, your clients will be given an offer with perfectly adjusted and suitable plugins to shorten the time of searching and verification. <br/> You may also use this package to automatically preinstall given plugins when a client creates a new WordPress instance. <br/>Prepare packages, enable when ready or disable when you want to withdraw them from the offer temporarily or edit their content and surely delete when no longer needed.<br/> |
| − | + | Choose '' 'Plugin Packages' '' and press '' 'Create Package' '' to compose the bundle.<br/> | |
'''''Note:''' Plugins included in the packages are always installed in their newest version available in the WordPress base.'' | '''''Note:''' Plugins included in the packages are always installed in their newest version available in the WordPress base.'' | ||
|} | |} | ||
| Line 449: | Line 736: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|In '' 'General' '' part, enter the package name, select the directory of the test installation, describe the package in short. Save the changes and then move to the '' 'Plugins' '' tab.<br/> In this part you will also need to enable the package once it is prepared. | + | |style="padding: 0px 0px 15px 15px;"|In the '' 'General' '' part, enter the package name, select the directory of the test installation, describe the package in short. Save the changes and then move to the '' 'Plugins' '' tab.<br/> In this part you will also need to enable the package once it is prepared. |
|} | |} | ||
{| | {| | ||
| Line 467: | Line 754: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|Once you have the packages ready, move again to the [[#General|General]] configuration of a product and select which of the packages | + | |style="padding: 0px 0px 15px 15px;"|Once you have the packages ready, move again to the [[#General|General]] configuration of a product and select which of the packages will be available to choose from by clients or be automatically preinstalled for a single product.<br/> Surely, you may assign a different set of packages to each product. |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_17_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|There is also the possibility to add '' 'Custom Plugins' ''. Press the following button to do so. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_17_2.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|Now, provide a name and description of your '' 'Custom Plugin' ''. Then, complete the '' 'URL' '' and finally define a version. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_17_3.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|If you wish to modify your '' 'Custom Plugins' '', you can easily do this by pressing the '' 'Edit' '' button. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_17_4.png]] | ||
| + | |} | ||
| + | |||
| + | ===Themes=== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|In the '' 'Themes' '' section you may prepare ready-made packages with selected by you themes or create your '' 'Custom Themes' '' and automatically install them along with the WordPress instance. <br/> | ||
| + | In this quick and convenient way, your clients will have quick access to preinstalled themes on their WordPress without the need of searching them on their own. <br/> Prepare packages, enable when ready or disable when you want to withdraw them from the installation temporarily or edit their content and surely delete when no longer needed.<br/> | ||
| + | Choose '' 'Theme Packages' '' and press '' 'Create Package' '' to compose the bundle.<br/> | ||
| + | '''''Note:''' Themes included in the packages are always installed in their newest version available in the WordPress base.'' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_2_14.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|In the '' 'General' '' part, enter the package name, select the directory of the test installation, describe the package in short. Save the changes and then move to the '' 'Themes' '' tab.<br/> In this part you will also need to enable the package once it is prepared. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_2_15.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|Add themes by searching through the existing ones, start typing the theme name, press ''enter'' and the results will appear.<br/> Add a single theme or use mass action button to add themes in bulk. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_2_16.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|Added themes will appear on the list of included immediately. You may always delete any unwanted themes when editing the package by pressing the bin icon. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_2_17.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|Once you have the packages ready, move again to the [[#General|General]] configuration of a product and select which of the packages will be installed automatically for a single product.<br/> Surely, you may assign a different set of packages to each product. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_2_17_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|There is also the possibility to add '' 'Custom Themes' ''. Press the following button to do so. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_17_5.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|Now, provide a name and description of your '' 'Custom Theme' ''. Then, complete the '' 'URL' '' and finally define a version. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_17_6.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|If you wish to modify your '' 'Custom Themes' '', you can easily do this by pressing the '' 'Edit' '' button. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_17_7.png]] |
|} | |} | ||
===Instance Images=== | ===Instance Images=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|This section is dedicated to WordPress images that are used to allow clients to add WordPress installations using this very images of WordPress.<br/> To create such an image, simply press '' 'Add | + | |style="padding: 10px 0px 15px 15px;"|This section is dedicated to WordPress images that are used to allow clients to add WordPress installations using this very images of WordPress.<br/> To create such an image, simply press the '' 'Add Image' '' button and then follow the steps described below. |
|} | |} | ||
{| | {| | ||
| Line 481: | Line 839: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|In order to properly configure a new instance image you will need to | + | |style="padding: 0px 0px 15px 15px;"|In order to properly configure a new instance image you will need to set up the below options. <br/> |
| − | Please be aware that to create such instance image you will need to deliver full access data to a server with WordPress installations that will be used to create an image.<br/> Once a client decides to use an image to add an installation, he will be connected with the server, WordPress instance downloaded and installed. <br/>The whole process may take from a few up to a dozen or so minutes, depending on the instance complexity. | + | Please be aware that to create such an instance image you will need to deliver full access data to a server with WordPress installations that will be used to create an image.<br/> Once a client decides to use an image to add an installation, he will be connected with the server, WordPress instance downloaded and installed. <br/>The whole process may take from a few up to a dozen or so minutes, depending on the instance complexity. |
| − | *'''Enable''' - enable the image when it is ready to allow for clients to use | + | *'''Enable''' - enable the image when it is ready to allow for clients to use. |
| − | *'''Custom''' - if you | + | *'''Custom''' - if you switch on the custom images, you will need to provide a custom name of the installation and domain that will be used. |
| − | *'''Installation''' - select existing installation of WordPress to configure instance | + | *'''Installation''' - select existing installation of WordPress to configure instance images. |
| − | *'''Private''' - if disabled, the instance will be visible to all clients who own a product with assigned instance (more details [[#General|here]]). <br/> '' 'Private' '' flag is assigned to an instance image created by a client, which is visible to the client who has created it. | + | *'''Private''' - if disabled, the instance will be visible to all clients who own a product with an assigned instance (more details [[#General|here]]). <br/> '' 'Private' '' flag is assigned to an instance image created by a client, which is visible to the client who has created it. |
| − | *'''Name''' - give the instance image a unique name | + | *'''Name''' - give the instance image a unique name. |
| − | *'''Protocol''' - select protocol form: '' 'FTP', 'FTPS' '' and '' 'SFTP' '' to connect | + | *'''Protocol''' - select protocol form: '' 'FTP', 'FTPS' '' and '' 'SFTP' '' to connect. |
| − | *'''FTP Path''' - define the path to the directory that is relative to the home directory of the users | + | *'''FTP Path''' - define the path to the directory that is relative to the home directory of the users. |
| − | *'''Server Host''' - host used to connect via FTP | + | *'''Server Host''' - host used to connect via FTP. |
| − | *'''Server Port''' - port number to connect to the FTP server | + | *'''Server Port''' - port number to connect to the FTP server. |
| − | *'''FTP User''' - user to connect to the FTP server | + | *'''FTP User''' - user to connect to the FTP server. |
| − | *'''FTP Password''' - password for user to connect to the FTP server | + | *'''FTP Password''' - password for user to connect to the FTP server. |
|} | |} | ||
{| | {| | ||
| Line 500: | Line 858: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|Once you have the images ready, move again to the [[#General|General]] configuration of a product and select which of the images | + | |style="padding: 0px 0px 15px 15px;"|Once you have the images ready, move again to the [[#General|General]] configuration of a product and select which of the images will be available for a single product.<br/> Surely, you may assign different sets of images to each product. |
|} | |} | ||
{| | {| | ||
| Line 525: | Line 883: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|Press the '' ' | + | |style="padding: 0px 0px 20px 15px;"|Press the '' 'Information' '' button to get a quick view on the basic information on the task and log details. |
|} | |} | ||
{| | {| | ||
| Line 531: | Line 889: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|Logs section will include information on errors only. If a task is completed | + | |style="padding: 0px 0px 20px 15px;"|Logs section will include information on errors only. If a task is completed successfully, no information will be included here. |
|} | |} | ||
{| | {| | ||
| Line 541: | Line 899: | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:WM2_25_1.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_25_1.png]] | ||
| + | |} | ||
| + | ====Settings==== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|Provide '' 'Google API Token For PageSpeed Insights' '' and define the cron interval to run the speed test.<br/> The API token is required to successfully enter and use the '' 'Website Details' '' section of the WordPress instance in the client area. The section underneath explains how and where you can find the required API Key.<br/> | ||
| + | |||
| + | There is also a list of protocols. Select the ones that you want to enable to use for clients in the client area. <br/> Finally, here you can switch between modes, enable the '' 'Extended View' '' to use the brand new view with the site screen thumbnails and action tools.<br/> Leave it disabled to use the standard list mode. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_25_0.png]] | ||
| + | |} | ||
| + | =====Google API Token===== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|In order to get your Google API token necessary for the Website Details section to work, open the following site: ''https://developers.google.com/speed/docs/insights/v5/get-started''<br/> Scroll down to '' 'Acquiring and using an API key' '' section. There, press '' 'Get a Key' '' button: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_25_03.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|'' 'Enable PageSpeed Insights API' '' modal will appear. Select your project or create a new one, and then press '' 'Next'.'' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_25_02.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|That's all! Your Google API key is ready, copy it and paste in the '' 'Google API Token' '' field in the WordPress For WHMCS module Settings as described in the above section. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_25_01.png]] | ||
| + | |} | ||
| + | |||
| + | ===Email Templates=== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|By default, the module creates the '' 'New WordPress Information' '' email template You can find it in your WHMCS '' 'Setup' '' → '' '[https://docs.whmcs.com/Email_Templates Email Templates]' '' section.<br/> | ||
| + | |||
| + | This template can be used to send WordPress details to the customer when the automatic installation is enabled after the service creation. <br/>You can also modify that template, create your own and assign it to the service it in the [[#General|product general settings]]. <br/> | ||
| + | |||
| + | Additionally, you may use the merge fields variables, which will be replaced to the corresponding WordPress installation details when are sent to the customer: | ||
| + | * '''{$installation.domain}''' - WordPress installation domain | ||
| + | * '''{$installation.url}''' - WordPress installation URL | ||
| + | * '''{$installation.version}''' - WordPress version | ||
| + | * '''{$installation.path}''' - WordPress installation path | ||
| + | * '''{$admin_username}''' - generated WordPress username | ||
| + | * '''{$admin_pass}''' - generated WordPress password | ||
| + | * '''{$installation.id'''} - ID of the WordPress instance in your WHMCS. It can be used to prepare URL that will redirect customer directly to the instance in their client area. <br/>E.g. ''{$whmcs_url}/index.php?m=WordpressManager&mg-page=home&mg-action=detail&wpid={$installation.id}'' | ||
| + | * '''{$adminurl}''' - directory path to the WordPress admin control panel. It should be used with the ''{$installation.url}'' veriable. E.g. ''{$installation.url}/{$adminurl}'' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_25_2.png]] | ||
|} | |} | ||
==Client Area== | ==Client Area== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|Now that you already have the module configured, you may see the process of adding and managing the WordPress installations by your clients.<br/> | + | |style="padding: 10px 0px 15px 15px;"|Now that you already have the module configured, you may see the process of adding and managing the WordPress installations by your clients.<br/> In the client area, find and choose your product with WordPress management support and then move directly to the relative section. |
|} | |} | ||
{| | {| | ||
| Line 552: | Line 958: | ||
===WordPress Installations=== | ===WordPress Installations=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|Extended view, toggled by the admin in the module addon, read more [[#Settings|here]]. |
| − | The former one | + | At the top of the page, you will find all WordPress installations located in dedicated segments. Every installation has its own section with screen grabs, installation details and instant access to action tools.<br/> The '' 'Reseller Accounts' '' section is visible only in case such accounts are detected in the client's cPanel, DirectAdmin or Plesk panels, otherwise, it is hidden. |
| − | '' 'Reseller Accounts' '' section is visible only in case such accounts are detected in the client's cPanel or DirectAdmin panels, otherwise, it is hidden. | + | |} |
| − | + | {| | |
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_27_0.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|The standard view of the WordPress Management page includes the very same information as the extended view, yet they are placed in a simple list form. Underneath the list there is also section dedicated to '' 'Reseller Accounts'. ''<br/> | ||
| + | The former one contains a list with basic information regarding every installation, including the domain, related product, URL etc. <br/> | ||
| + | The '' 'Reseller Accounts' '' section again is visible only in case such accounts are detected in the client's cPanel or DirectAdmin panels, otherwise, it is hidden. They are displayed in a standard manner only. | ||
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 20px 25px;"|[[File:WM2_27.png]] | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_27.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|Use action buttons marked on the screen to perform actions on a single installation: | ||
| + | *View/Edit installation details (1) | ||
| + | *Log into the Control Panel (2) | ||
| + | *Clear cache (3) | ||
| + | *Clone the installation (4) | ||
| + | *Update (5) | ||
| + | *Change domain (6) | ||
| + | *Manage auto upgrade (7) | ||
| + | *Create staging instance (8) | ||
| + | *Push to live the staging instance(9) | ||
| + | *Manage SSL status (10) | ||
| + | *Maintenance mode status (11) | ||
| + | *Create instance image (12) | ||
| + | *Delete installation (13) | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_27_1.png]] | ||
|} | |} | ||
{| | {| | ||
| Line 567: | Line 998: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_28.png]] |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|You may also delete or update multiple WordPress instances to the newest version at once, use mass actions to do so ''(standard view only).'' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_28_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|If you wish, you may create a backup of the instances before processing the update. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_28_2.png]] | ||
|} | |} | ||
| Line 579: | Line 1,022: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"| A new window | + | |style="padding: 0px 0px 15px 15px;"| A new window with two tabs will open.<br/> |
| − | In the first '' '''Details''' '' tab, fill in the following fields: | + | In the first '' '''Details''' '' tab, fill in the following fields: |
| − | *'''Product/Service''' - select hosting to install WordPress on it | + | *'''Product/Service''' - select hosting to install WordPress on it. |
*'''Protocol''' - select protocol from among: '' <nowiki>'https://', 'http://', 'http://www'</nowiki> '' and '' <nowiki>'https://www'</nowiki> '' | *'''Protocol''' - select protocol from among: '' <nowiki>'https://', 'http://', 'http://www'</nowiki> '' and '' <nowiki>'https://www'</nowiki> '' | ||
*'''Domain''' - provide a domain the software will be installed on. | *'''Domain''' - provide a domain the software will be installed on. | ||
| − | *'''Installation Script''' - here you can select any custom installation script that you want to install.<br/>Note that this field will be displayed only for domains | + | *'''Installation Script''' - here you can select any custom installation script that you want to install.<br/>Note that this field will be displayed only for domains which products have installation scripts configured in the [[#Product Settings|Products Settings]].<br/>If it is not displayed then the clean WordPress installation will be applied. |
| − | *'''Plugin Packages''' - select plugin packages to install on WordPress, more about their configuration can be | + | *'''Plugin Packages''' - select plugin packages to install on WordPress, more about their configuration can be found [[#Plugin Packages|here]]. |
| − | *'''Administrator Password''' - generate an administrator password for this new installation of WordPress | + | *'''Administrator Password''' - generate an administrator password for this new installation of WordPress. |
*'''Site Name''' - the name of a site created for the installation. | *'''Site Name''' - the name of a site created for the installation. | ||
*'''Language''' - choose a language for the installation. | *'''Language''' - choose a language for the installation. | ||
| − | *'''Administrator Username''' - enter the administrator account username for this installation | + | *'''Administrator Username''' - enter the administrator account username for this installation. |
| − | *'''Administrator Email''' - enter the administrator account email address for this installation | + | *'''Administrator Email''' - enter the administrator account email address for this installation. |
'' '''Note''' that only those fields marked with '''*''' (e.g. 'Site Name') are required to complete the creation.'' | '' '''Note''' that only those fields marked with '''*''' (e.g. 'Site Name') are required to complete the creation.'' | ||
|} | |} | ||
| Line 625: | Line 1,068: | ||
*'''Server Host''' - used as a host to connect via FTP | *'''Server Host''' - used as a host to connect via FTP | ||
*'''Protocol''' - protocol used for connection to the domain | *'''Protocol''' - protocol used for connection to the domain | ||
| − | *'''Server Port''' port number to connect to the FTP server | + | *'''Server Port''' - port number to connect to the FTP server |
*'''FTP User''' - user used to connect to the FTP server | *'''FTP User''' - user used to connect to the FTP server | ||
*'''FTP Password''' - user password to connect to the FTP server | *'''FTP Password''' - user password to connect to the FTP server | ||
| Line 637: | Line 1,080: | ||
|style="padding: 0px 0px 15px 15px;"|Then move to the other tab, to provide any data on the destination. | |style="padding: 0px 0px 15px 15px;"|Then move to the other tab, to provide any data on the destination. | ||
*'''Product/Service''' - choose a hosting to install WordPress on it | *'''Product/Service''' - choose a hosting to install WordPress on it | ||
| − | *'''Protocol''' - select protocol that | + | *'''Protocol''' - select protocol that will be used |
*'''Domain''' - destination domain where the script will be imported | *'''Domain''' - destination domain where the script will be imported | ||
*'''Directory''' - directory under the domain where the script will be imported. Leave blank to import to the root directory of your domain | *'''Directory''' - directory under the domain where the script will be imported. Leave blank to import to the root directory of your domain | ||
*'''Database''' - database name for the script <br/> | *'''Database''' - database name for the script <br/> | ||
| − | Press '' 'Import' '' button to finalize the process.<br/> | + | Press the '' 'Import' '' button to finalize the process.<br/> |
'''''Note:''' the process may take from a few up to a dozen or so minutes for the instance to appear on the list, depending on the instance size or external server connection speed.'' | '''''Note:''' the process may take from a few up to a dozen or so minutes for the instance to appear on the list, depending on the instance size or external server connection speed.'' | ||
|} | |} | ||
| Line 659: | Line 1,102: | ||
*'''Product/Service''' - choose hosting to install WordPress on | *'''Product/Service''' - choose hosting to install WordPress on | ||
*'''Instance Image''' - select WordPress instance image from client ''[[#Instance Image|private instances]]'' and ''[[#Instance Images|public images]]'' created by the admin | *'''Instance Image''' - select WordPress instance image from client ''[[#Instance Image|private instances]]'' and ''[[#Instance Images|public images]]'' created by the admin | ||
| − | *'''Protocol''' - select protocol that | + | *'''Protocol''' - select protocol that will be used |
*'''Domain''' - destination domain of on which the new instance will be imported to | *'''Domain''' - destination domain of on which the new instance will be imported to | ||
*'''Directory''' - directory under the domain, leave blank if you want to install WordPress instance in the root directory | *'''Directory''' - directory under the domain, leave blank if you want to install WordPress instance in the root directory | ||
| Line 671: | Line 1,114: | ||
====Installation Management==== | ====Installation Management==== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|Once you have successfully created a new installation, you can edit its advanced options or simply remove it in case you no longer need it.<br/> Let us view the management options and available actions now. | + | |style="padding: 10px 0px 15px 15px;"|Once you have successfully created a new installation, you can edit its advanced options or simply remove it in case you no longer need it.<br/> Let us view the management options and available actions now.<br/> |
| + | |||
| + | '''''Note:''' Please be aware that deleting installations "(3)" is not possible from this section for the '''WP Toolkit for Plesk API'''. To delete an instance, you need to log into the Plesk panel.<br/> Once deleted there, please wait until the next cron execution for the instance to be removed from this management section. For more information, refer to the [[#WP_Toolkit_Integration|WP Toolkit integration]] section.'' | ||
|} | |} | ||
{| | {| | ||
| Line 678: | Line 1,123: | ||
=====Installation Details===== | =====Installation Details===== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|On the very first page, when you enter the edit section, there is an exemplary configuration of your installation in the '' 'Management' '' section. <br/>You will find there all the basic information, such as domain and database details, available at hand. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:WM2_38.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_38.png]] | ||
|} | |} | ||
| + | |||
| + | =====Website Details===== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|Desktop and mobile website details based on Google "PageSpeed Insights" statistics. This section requires to previously generate and provide the '' 'Google API Token'.''<br/> Follow [[#Settings|this instructions]] to learn how to do that. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_38_1.png]] | ||
| + | |} | ||
| + | |||
=====Backups===== | =====Backups===== | ||
{| | {| | ||
| Line 691: | Line 1,145: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|Surely you can delete multiple backups at once. | + | |style="padding: 0px 0px 20px 15px;"|Surely you can delete multiple backups at once. Take a look at the screenshot below. |
|} | |} | ||
{| | {| | ||
| Line 722: | Line 1,176: | ||
{| | {| | ||
|style="padding: 0px 0px 20px 25px;"|[[File:WM2_44.png]] | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_44.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|If there are any '' 'Custom Themes' '' accessible for adding, they will be located here. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_44_1.png]] | ||
|} | |} | ||
{| | {| | ||
| Line 743: | Line 1,203: | ||
{| | {| | ||
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S_1811.png]] | |style="padding: 0px 0px 20px 25px;"|[[File:WM_S_1811.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM_S_1812.png]] | ||
|} | |} | ||
{| | {| | ||
| Line 751: | Line 1,214: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 15px;"|In case the plugin seems interesting, just press the '' 'Install' '' button. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S_1811_1.png]] | |style="padding: 0px 0px 20px 25px;"|[[File:WM_S_1811_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|There is also an option to add your custom plugins, simply press adequate icon and confirm the action. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM_S_1811_3.png]] | ||
|} | |} | ||
{| | {| | ||
| Line 776: | Line 1,245: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|In this section you can directly alter the records from the '' '''wp-config.php''' '' file.<br/>This file is located in the root of your WordPress file directory and contains your website's configuration details such as database connection information.<br/>You are allowed to edit or delete already existing config records as well as create new ones.<br/> | |style="padding: 10px 0px 15px 15px;"|In this section you can directly alter the records from the '' '''wp-config.php''' '' file.<br/>This file is located in the root of your WordPress file directory and contains your website's configuration details such as database connection information.<br/>You are allowed to edit or delete already existing config records as well as create new ones.<br/> | ||
| − | '' '''Important:''' Be particularly careful when editing these config records! You can find more information about | + | '' '''Important:''' Be particularly careful when editing these config records! You can find more information about editing the 'wp-config.php' file [https://wordpress.org/support/article/editing-wp-config-php/ here].'' |
|} | |} | ||
{| | {| | ||
| Line 782: | Line 1,251: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|When creating a new config record, enter its proper name, value and | + | |style="padding: 0px 0px 20px 15px;"|When creating a new config record, enter its proper name, value and choose one of the two available types ''('Constant' or 'Variable')''. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:WM_21.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:WM_21.png]] | ||
| + | |} | ||
| + | |||
| + | ====Users==== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|Enter this section to manage existing users and create new ones. You are allowed to perform following actions on a single user: | ||
| + | *edit the existing user details (1) ''(change role, change display name, change the email address)'' | ||
| + | *change its password (2) | ||
| + | *delete the user(3) | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_21_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|When creating a new user, you will have to provide the following data to complete: | ||
| + | *enter the username | ||
| + | *provide its email address for communication | ||
| + | *type in the display name | ||
| + | *enter the user password | ||
| + | *select the role from the dropdown menu | ||
| + | *decide whether to send a notification email about creating the account | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_21_2.png]] | ||
|} | |} | ||
| Line 793: | Line 1,285: | ||
*'''Control Panel''' - log in to your WordPress panel directly any time you like. | *'''Control Panel''' - log in to your WordPress panel directly any time you like. | ||
*'''Clear Cache''' - remove the cache of your installation. | *'''Clear Cache''' - remove the cache of your installation. | ||
| − | *'''Update''' - after selecting this option, your WordPress will be updated to the latest version if any is available | + | *'''Update''' - after selecting this option, your WordPress will be updated to the latest version if any is available. |
| − | *'''Delete''' - immediately remove the complete installation along with its settings or selected parts of it<br/> | + | *'''Delete''' - immediately remove the complete installation along with its settings or selected parts of it<be/> |
| − | Underneath you can find detailed description of all the remaining actions. Please take a look. | + | '''''Important:''' Please refer to the [[#WP_Toolkit_Integration|WP Toolkit Integration]] section for the list of troublesome features and make sure they are supported by the API you are using.''<br/> |
| + | |||
| + | Underneath you can find a detailed description of all the remaining actions. Please take a look. | ||
|} | |} | ||
{| | {| | ||
| Line 820: | Line 1,314: | ||
=====Change Domain===== | =====Change Domain===== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|If you want to change the domain of your WordPress installation, simply provide here a new one.<br/> Decide whether to create backup at the same time and enable/disable SSL for the new domain. | + | |style="padding: 10px 0px 15px 15px;"|If you want to change the domain of your WordPress installation, simply provide here a new one.<br/> Decide whether to create a backup at the same time and enable/disable SSL for the new domain. |
|} | |} | ||
{| | {| | ||
| Line 866: | Line 1,360: | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:WM2_61.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_61.png]] | ||
| + | |} | ||
| + | =====Debug Mode===== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 20px 15px;"|Check whether the debug mode is currently enabled or disabled. Change the mode by pressing the '' 'Change' '' button. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_61_2.png]] | ||
| + | |} | ||
| + | |||
| + | =====Maintenance Mode===== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 20px 15px;"|Check the current status of the website, turn off/on maintenance mode according to your needs by pressing the '' 'Change' '' button. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_61_1.png]] | ||
|} | |} | ||
=====Instance Image===== | =====Instance Image===== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|Turn on instance image on the WordPress installation. Simply, toggle '' 'Mark As Image' '' option and then fill in the below options.<br/> | + | |style="padding: 10px 0px 15px 15px;"|Turn on instance image on the WordPress installation. Simply, toggle the '' 'Mark As Image' '' option and then fill in the below options.<br/> |
'''''Note:''' The 'FTP Password' input is encoded in the database, which makes is completely safe and secure.'' | '''''Note:''' The 'FTP Password' input is encoded in the database, which makes is completely safe and secure.'' | ||
|} | |} | ||
| Line 880: | Line 1,389: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|Existing Reseller's Accounts with the number of WordPress installations. Keep in mind that this section is visible only when such accounts exist in the client's cPanel or DirectAdmin panels.<br/> In case no such accounts have been detected, this section is hidden.<br/> | |style="padding: 10px 0px 15px 15px;"|Existing Reseller's Accounts with the number of WordPress installations. Keep in mind that this section is visible only when such accounts exist in the client's cPanel or DirectAdmin panels.<br/> In case no such accounts have been detected, this section is hidden.<br/> | ||
| + | '' '''Note:''' Plesk resellers accounts are not yet currently supported.''<br/> | ||
| + | |||
The table includes the name of the product, reseller's account name on which the instances are installed as well as their number. | The table includes the name of the product, reseller's account name on which the instances are installed as well as their number. | ||
|} | |} | ||
| Line 895: | Line 1,406: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|The only difference is the need to select a customer when adding new installation.<br/> If there is no username available here to choose, the reseller must create an extra account in the cPanel or DirectAdmin panels. <br/> | + | |style="padding: 0px 0px 15px 15px;"|The only difference is the need to select a customer when adding a new installation.<br/> If there is no username available here to choose, the reseller must create an extra account in the cPanel or DirectAdmin panels. <br/> |
All the remaining options are exactly the same as in case of standard WordPress installations described in the above sections. | All the remaining options are exactly the same as in case of standard WordPress installations described in the above sections. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:WM2_66.png]] |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|Using mass actions you may also update multiple WordPress instances to the newest version at once or delete them. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:WM2_66_1.png]] | ||
| + | |} | ||
| + | ===WP Toolkit Integration=== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 5px 15px;"|As an alternative to the Softaculous auto-installer, you have the option to benefit from the WP Toolkit integration available for cPanel/WHM or Plesk.<br/> | ||
| + | Please note that if you are using the '''free version of WP Toolkit''', certain features may '''not be accessible or fully functional''' within the WordPress Manager module.<br/> For a detailed comparison of features '''not supported''' by Softaculous and the WP Toolkit API, please refer to the table below. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 10px 15px;"|'''Important!''' <br/> | ||
| + | By default, all the API support all features enumerated on the product [[#About_WordPress_Manager_For_WHMCS|features list]], available at the top of this documentation.<br/> Yet there are some options that are limited to Softaculous or WP Toolkit API, or are only partially supported by any of them. <br/ | ||
| + | >If you do not see a feature you are interested in here it means that '''all three available APIs support it.''' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|'''List of troublesome features with API compatibility status:''' | ||
| + | |} | ||
| + | {|class="wikitable" style="margin-left: 15px; margin-bottom: 20px; margin-top: 0px;" | ||
| + | |- text-align:center; | ||
| + | ! | ||
| + | ! style="text-align:left;" |'''Feature Name''' | ||
| + | ! '''Softaculous''' | ||
| + | ! '''WP Toolkit for Plesk''' | ||
| + | ! '''WP Toolkit for cPanel/WHM''' | ||
| + | |- style="text-align:center;" | ||
| + | | style="text-align:left;" | 1. | ||
| + | | style="text-align:left;" | Clone an instance | ||
| + | | ✔️ | ||
| + | | ✔️ | ||
| + | | ❌ | ||
| + | |- style="text-align:center;" | ||
| + | | style="text-align:left;" | 2. | ||
| + | | style="text-align:left;" | Delete an instance | ||
| + | | ✔️ | ||
| + | | ❌ | ||
| + | | ✔️ | ||
| + | |- style="text-align:center;" | ||
| + | | style="text-align:left;" | 3. | ||
| + | | style="text-align:left;" | Download backups | ||
| + | | ✔️ | ||
| + | | ❌ | ||
| + | | ✔️ | ||
| + | |- style="text-align:center;" | ||
| + | | style="text-align:left;" | 4. | ||
| + | | style="text-align:left;" | Push staging to live environment | ||
| + | | ✔️ | ||
| + | | ❌ | ||
| + | | ❌ | ||
| + | |- style="text-align:center;" | ||
| + | | style="text-align:left;" | 5. | ||
| + | | style="text-align:left;" | Create staging | ||
| + | | ✔️ | ||
| + | | ❌ | ||
| + | | ❌ | ||
| + | |- style="text-align:center;" | ||
| + | | style="text-align:left;" | 6. | ||
| + | | style="text-align:left;" | Use instance image | ||
| + | | ✔️ | ||
| + | | ❌ | ||
| + | | ❌ | ||
| + | |- style="text-align:center;" | ||
| + | | style="text-align:left;" | 7. | ||
| + | | style="text-align:left;" | Access setup section<br/> ''(Installation Details → Actions → Setup)'' | ||
| + | | ❌ | ||
| + | | ✔️ | ||
| + | | ✔️ | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 15px;"|Depending on your API selection, be sure to customize the [[#Client_Area_Features|Client Area Features]] in your product configuration.<br/> This ensures that your clients have access only to the supported functionalities while disabling any unsupported ones.<br/> | ||
|} | |} | ||
| Line 909: | Line 1,492: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 5px 15px;"|2. If you wish to change the names of your WordPress installations scripts to more friendly in the client area, you can do this in [https://www.docs.modulesgarden.com/General#How_To_Change_WHMCS_Module_Language language file].<br/>Simply open your default '' 'english.php'' ' file located in '' '/yourWHMCS/modules/addons/WordpressManager/langs' '' directory and add a new language record in the following format: | + | |style="padding: 0px 0px 5px 15px;"|2. If you wish to change the names of your WordPress installations scripts to more friendly in the client area, you can do this in a [https://www.docs.modulesgarden.com/General#How_To_Change_WHMCS_Module_Language language file].<br/>Simply open your default '' 'english.php'' ' file located in '' '/yourWHMCS/modules/addons/WordpressManager/langs' '' directory and add a new language record in the following format: |
$_LANG['WordPress Script Name']="WordPress Friendly Name"; | $_LANG['WordPress Script Name']="WordPress Friendly Name"; | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 5px 15px;"|3. When using WordPress Manager module with cPanel, you will also need to whitelist '' 'phar' '' support in your ''php.ini'' on the WHM server.<br/> You can do this by adding or editing the below record: |
suhosin.executor.include.whitelist = phar | suhosin.executor.include.whitelist = phar | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 5px 15px;"|4. It is possible to set language for WordPress auto-installation. In the Product Custom Fields section you should complete: | ||
| + | *Field Name - '''wpmanager_language|Language''' | ||
| + | *Field Type - choose '' 'Drop Down' '' | ||
| + | *Select Options -decide which languages should be available to choose from the dropdown menu.<br/> If your language is not on the following list (but is supported by WordPress) then use the same formula by providing the two-letter country code as shown below: | ||
| + | <pre>en|English,ar|Arabic,zh_CN|Chinese,fr_FR|French,de_DE|German,el|Greek,it_IT|Italian,ja|Japanese,ko_KR|Korean,pl_PL|Polish,ru_RU|Russian, | ||
| + | sl_SI|Slovenian,sk_SK|Slovak,es_ES|Spanish,tr_TR|Turkish,uk|Ukrainian,vi|Vietnamese </pre> | ||
| + | *Do not forget to mark the '' 'Show on Order Form' '' option. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|5. You can set a username and password for the administrator panel in WordPress using the following product custom fields. <br/> Remember that this method works only when the '' 'Auto Install WordPress After Service Creation' '' option is set to '' 'Based on Installation Script' ''. <br/> '' Please note that these product custom fields work only for a clean installation, and '''do not work''' with instance images. '' | ||
| + | <pre> wp_username|Username </pre> | ||
| + | <pre> wp_password|Password </pre> <br/> | ||
| + | If a client completes the username and password, then the account will be created on the basis of the provided data. <br/> If left empty, then '' 'admin' '' will be set as '' 'Username' '', and a new password will be automatically generated. <br/> Do not forget to mark the '' 'Show on Order Form' '' option. | ||
| + | |} | ||
| + | ==Language Overrides== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 30px 15px;"|'''Incorporating language customizations - the module readily accommodates language overrides, allowing you to tailor the language files to your preferences.'''<br/> The language file english.php remains unencoded and can be modified to suit your needs. However, it's recommended to avoid altering the core file itself, and instead, leverage the capability of using overrides.<br/> | ||
| + | |||
| + | Here's how to apply language overrides: | ||
| + | * Navigate to the ''~/langs/'' directory located within the following ''yourWHMCS/modules/servers/moduleName/langs/'' path. | ||
| + | * Within this directory, create a new file or duplicate the language file you intend to modify. For instance, if you wish to create an override for the English language, establish the following directory structure: | ||
| + | ''~/langs/overrides/english.php''. | ||
| + | * Open the newly created override file to edit its contents. | ||
| + | * At the beginning of the file, indicate the used code, for instance, you can use: '''<?php''' for PHP code. | ||
| + | * Adapt the file content according to your requirements. You can either selectively modify specific variables or opt to revise the entire content of the language file. | ||
| + | |||
| + | For example: | ||
| + | |||
| + | '''Original yourWHMCS/modules/servers/moduleName/langs/english.php:''' | ||
| + | |||
| + | $_LANG['Search'] = 'Search'; | ||
| + | |||
| + | '''Override yourWHMCS/modules/servers/moduleName/langs/overrides/english.php:''' | ||
| + | |||
| + | $_LANG['Search'] = 'Look for'; | ||
| + | |||
| + | By following these steps, you can seamlessly implement language customizations without altering the core language file, ensuring your changes will not be lost after every module update.<br/> | ||
| + | |||
| + | Remember that some of the modules have more than one language file, located under ''/addons'' and ''/servers'' paths. You may create the override files for both of them.<br/> Note that you do not need to paste all the original content of the lang file into the override file. Enter there only the lines that you wish to change, every other line will be fetched from the original module lang file.<br/> Consequently, the override lang file might include only one or just a few lines. | ||
|} | |} | ||
=Update Instructions= | =Update Instructions= | ||
{| | {| | ||
| − | |style="padding: 10px 0px 30px 15px;"| | + | |style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/> |
| + | |||
| + | '''Important:''' If you are performing an update from a previous version of WordPress Manager with cPanel, you have to also update the files and run again the installation script on your WHM server.<br/>Simply go [https://www.docs.modulesgarden.com/WordPress_Manager_For_WHMCS#cPanel_.28WHM.29_Installation here] and repeat the following instructions. <br/> | ||
| + | If you are updating WordPress Manager For WHMCS, '''it is highly recommended''' to perform an update of the plugins that are used. | ||
| + | |} | ||
| + | =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/wordpress-manager#open-source-version Open Source version] of your WordPress Manager 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. | |
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
| Line 938: | Line 1,568: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 5px 15px;"|4. Native integration with [https://www.docs.modulesgarden.com/CPanel_Extended_For_WHMCS#WordPress_Manager cPanel Extended] module works seamlessly except for one aspect, specifically access via '' 'Manage Account → WordPress Manager','' where an issue is encountered.<br/> You may smoothly enter the WordPress Manager via: '' 'Actions → WordPress Management'.'' |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|5. The module supports two APIs: Softaculus and WP Toolkit.<br/> | ||
| + | If you are changing the API '''from WP Toolkit to Softaculous''', when there are already existing installations, you must remember to synchronize the instances.<br/> Otherwise, errors will occur when trying to manage the instance from the WHMCS client area. <br/> | ||
| + | |||
| + | '''Solution:''' Proceed to cPanel → Softaculous and press the ''"Scan"'' button. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM_66_2.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|When changing the API '''from Softaculous to WP Toolkit''', trigger the scanning in cPanel → WP Toolkit: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:WM_66_3.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|After the scan is successfully complete, wait until the data is synchronized in the module by running the following cron command: | ||
| + | |||
| + | php -q /yourWHMCS/modules/addons/WordpressManager/cron/cron.php Synchronize | ||
| + | |||
| + | That is all, the installations can now be managed via target API. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 15px;"|6. If you experience issues with the proper functionality of a Plesk-based module, one potential cause might be difficulties in retrieving the accurate external WHMCS IP address.<br/> | ||
| + | To eliminate this as a factor, we recommend configuring the variable '''ipServerWhmcs''' with a specific IP address in the configuration file located at: '''''app/config/configuration.yml'''''. <br/>The assigned IP address will overwrite the WHMCS-provided IP address: | ||
| + | |||
| + | ipServerWhmcs: '123.456.78.910' | ||
| + | |} | ||
| + | |||
| + | |||
| + | <!-- Na razie tego niet | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 15px;"|5. The current version of the module does not support authentication with Plesk using '' 'API Key' ('Access Hash')''.<br/> | ||
| + | If you want to connect your WHMCS with Plesk API we recommended to use '' 'Username' '' and '' 'Password' ''as authentication method in the configuration of WHMCS server. | ||
|} | |} | ||
| + | --> | ||
Latest revision as of 14:08, 26 April 2024
Contents
|
[edit] About WordPress Manager For WHMCS
| WordPress Manager For WHMCS is a module that enables your customers to control and freely alter their WordPress instances right inside your WHMCS. Your clients will be able to add WordPress installations using instance images and custom scripts, perform WordPress updates, install themes and plugins, create staging instances and then push them live. |
- Admin Area:
| ✔ View Active WordPress Installations, Clients And Products Summary |
| ✔ View WordPress Installations List |
| ✔ Choose Supported Products: |
| ✔ Select API To Use: |
| ✔ Softaculous Auto Installer |
| ✔ WP Toolkit |
| ✔ Select Available Installation Scripts |
| ✔ Select Available Plugin Packages |
| ✔ Select Available Instance Images |
| ✔ Automatically Install: |
| ✔ WordPress After Service Creation: |
| ✔ Based On Installation Script |
| ✔ Based On Instance Image |
| ✔ Plugin Packages |
| ✔ Theme Packages |
| ✔ Toggle Blocked Plugins And Themes |
| ✔ Toggle Automatic Deletion Of Blocked Plugins And Themes |
| ✔ Set Scan Interval For Blacklists Cleaner |
| ✔ Define Default Theme To Be Enabled After Installation |
| ✔ Choose Custom Plugins And Themes Available To Clients |
| ✔ Choose Instance Images Available To Clients |
| ✔ Toggle Permission To Delete WordPress Auto-Installation |
| ✔ Define Protocol For WordPress Auto-Installation |
| ✔ Select Welcome Email Template |
| ✔ Define Installation Limit Per Hosting Account |
| ✔ Define Update WordPress Notification Mail Interval |
| ✔ Select Update WordPress Email Template |
| ✔ Toggle Debug Logs |
| ✔ Add/Remove Selected Plugins From Blacklist: |
| ✔ Prevent Blacklisted Plugins From Being Installed By Clients |
| ✔ Remove Blacklisted Plugins From Current Installations |
| ✔ Add/Remove Selected Themes From Blacklist: |
| ✔ Prevent Blacklisted Themes From Being Installed By Clients |
| ✔ Remove Blacklisted Themes From Current Installations |
| ✔ Define Client Area Features: |
| ✔ Management Options |
| ✔ Action Options |
| ✔ Plugins: |
| ✔ Create Plugin Packages: |
| ✔ Enter Package Name And Description |
| ✔ Choose Available Plugins |
| ✔ Add Custom Plugins |
| ✔ Themes: |
| ✔ Create Theme Packages: |
| ✔ Enter Package Name And Description |
| ✔ Choose Available Themes |
| ✔ Add Custom Themes |
| ✔ Create Instance Images: |
| ✔ From Local Or External Installation Source |
| ✔ Public Or Private |
| ✔ Access Module Tasks List And Logs |
| ✔ Provide Google API Token For PageSpeed Insights |
| ✔ Define Allowed Protocols For WordPress Instances To Be Used In Client Area |
| ✔ Enable Extended View Of Instances List |
- Client Area:
| ✔ View/Create/Edit/Delete WordPress Installations |
| ✔ Using Simple List Of Instances |
| ✔ Using Extended View With Instances Preview Screenshots |
| ✔ View/Create/Edit/Delete WordPress Installations On Your Resellers Accounts: |
| ✔ cPanel |
| ✔ DirectAdmin |
| ✔ Update Selected WordPress Installations To Newest Version In One Batch |
| ✔ Import WordPress Installation From Remote Server |
| ✔ Create WordPress Installation Based On Instance Image |
| ✔ Log In To Admin Panel Of WordPress Instances |
| ✔ Receive Email Notifications And Get Visual Alerts When WordPress Update Is Available |
| ✔ View Installation Details: |
| ✔ Domain And URL |
| ✔ Product On Which Is Installed |
| ✔ WordPress Version |
| ✔ Site Name |
| ✔ Creation Date |
| ✔ Directory Path |
| ✔ Database Access Details |
| ✔ Debug Status |
| ✔ Instance Status |
| ✔ SSL Certificate Expiration Date |
| ✔ View Website Details Based On Google "PageSpeed Insights": |
| ✔ Desktop And Mobile Screengrab Thumbnails Of Website |
| ✔ General Performance Information |
| ✔ Page Statistics |
| ✔ Opportunities |
| ✔ Audit Passed Successfully |
| ✔ Diagnostics |
| ✔ Manage Installation: |
| ✔ Create/Restore/Download/Delete WordPress Backups |
| ✔ Browse/Install/Manage Themes |
| ✔ Search And Install Themes Directly From WordPress.com Base |
| ✔ Preview Theme Before Installation |
| ✔ Activate/Deactivate Installed Themes |
| ✔ Update Installed Themes |
| ✔ Browse, Install And Manage Plugins |
| ✔ Search And Install Plugins Directly From WordPress.com Base |
| ✔ Activate/Deactivate Installed Plugins |
| ✔ Update Installed Plugins |
| ✔ Browse And Install Plugin Packages |
| ✔ Perform Bulk Changes On Themes, Plugins, And Backups |
| ✔ View/Create/Edit/Delete WP Config Records |
| ✔ View/Create/Edit/Delete WordPress User Accounts With Specified Privileges |
| ✔ Perform Actions: |
| ✔ Log In To Control Panel |
| ✔ Access Credentials Setup |
| ✔ Clear Cache |
| ✔ Clone To New Domain |
| ✔ Update To Newest Version |
| ✔ Change Domain |
| ✔ Toggle Auto Upgrade Of: |
| ✔ WordPress Installation |
| ✔ WordPress Plugins |
| ✔ WordPress Themes |
| ✔ Create Staging |
| ✔ Push Staging To Live Environment |
| ✔ Enable/Disable SSL |
| ✔ Enable/Disable Debug Mode |
| ✔ Enable/Disable Maintenance Mode |
| ✔ Create Instance Image |
| ✔ Delete |
| ✔ Single Sign-On Into WordPress Panel From Product View |
- Supported Modules:
| ✔ cPanel (Root Access Required) |
| ✔ cPanel Extended - With Complete Integration |
| ✔ DirectAdmin (Admin Account Required) |
| ✔ DirectAdmin Extended |
| ✔ Plesk (Root Access Required) |
| ✔ Plesk Extended |
- Supported Integrations:
| ✔ Softaculous Auto Installer - Premium (cPanel, Plesk, DirectAdmin) |
| ✔ WP Toolkit (cPanel, Plesk) - View Wiki To See Differences In Support |
- General Info:
| ✔ Automatic Let's Encrypt SSL Installation (DirectAdmin Only) |
| ✔ Fully Integrated With Lagom WHMCS Client Theme |
| ✔ Multi-Language Support |
| ✔ Supports PHP 8.1 Back To PHP 7.4 |
| ✔ 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
| In this short tutorial we will show you how to successfully install WordPress Manager For WHMCS. We will guide you step by step through the whole installation process. |
| 1. Log in to our client area and download the module. |
|
| 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.2 and later. |
|
| Previous updates of the module may contain two packages dedicated to various PHP versions. 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. |
|
| 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. |
|
[edit] cPanel (WHM) Installation
| Important: Root access is required to perform the installation successfully! |
| 1. Upload and extract the 'UploadToWHM' folder into the /root cPanel directory. Files in your cPanel /root/uploadToWHM/ directory should look like these on the following screen. |
|
2. Once the module is uploaded, enter the /root/uploadToWHM/ catalog and run the following command in the console:sh install.sh After a brief moment you should see a confirmation that the plugin has been successfully installed. |
|
[edit] DirectAdmin Installation
| Important: Admin account is required to perform the installation successfully! |
| 1. In the 'uploadToDirectAdmin' folder find the 'wordpress_cli.tar.gz' package. Next, log in to your DirectAdmin panel as an administrator and go to 'Plugin Manager' . |
|
| 2. Once in the 'Add Plugin' , select the 'File' option and choose the 'wordpress_cli.tar.gz' package to upload. Additionally, mark the 'Install after upload' option and press the 'Add Plugin' button. |
|
| 3. Once the plugin is uploaded and successfully installed, you should see it on the plugins list. |
|
[edit] Plesk Installation
| Note: The current version of the module requires your Plesk server configured in WHMCS to use username and password as authentication to the Plesk API. We also recommended using Plesk version 17.8.11 at least. |
| Important: Root access is required to perform the installation successfully! |
| 1. In the 'uploadToPlesk' folder find the 'wordpress-manager-cli-X.X-X.zip' package. Next, log in to your Plesk panel as an administrator and go to the 'Extensions' section. |
|
| 2. Once you are in the 'Extensions' section, go to the 'My Extensions' tab and select the 'Upload Extension' option. In the opened window choose the 'wordpress-manager-cli-X.X-X.zip' package to upload and press the 'OK' button. Important: If for some reason the 'Upload Extension' button is disabled, you will need to install the free panel.ini editor extension. |
|
| 3. Once the plugin is uploaded and successfully installed, you will see it on the plugins' list. |
|
[edit] WHMCS Installation
| 1. Extract the 'modules' catalog into the main WHMCS directory. |
|
| 2. When you install WordPress Manager For WHMCS for the first time, you have to rename the 'license_RENAME.php' file. This file is located in 'modules/addons/wordpress_manager/license_RENAME.php.' Rename it from 'license_RENAME.php' to 'license.php'. |
|
| 3. In order to configure your license key, you have to edit the previously renamed 'license.php' file. Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'. |
|
| 4. In the next step, set up the 'storage' folder as recursively writable. This folder is available at 'your_whmcs/modules/addons/WordpressManager/' . |
|
| 5. Now you have to activate the module in your WHMCS system. Log in to your WHMCS admin area. Click 'System Settings' , then choose 'Addon Modules'. |
|
| 6. Then, you need to permit access to this module. To do so, click on the 'Configure' button, choose 'Full Administrator' and press 'Save Changes'. |
|
| 7. Now you have to add a cron job as shown below (5 - 10 minutes interval is recommended). This cron job is responsible for both: synchronization of WordPress installations and 'Enable SSL' action when installing new WordPress instances. php -q /your_whmcs/modules/addons/WordpressManager/cron/cron.php Synchronize Do not forget to replace 'your_whmcs' with your WHMCS root location. |
| 8. Good job! You have just successfully installed WordPress Manager For WHMCS! Now, in your WHMCS, press 'Addons' and then 'WordPress Manager'. |
|
[edit] Management
| This section has been divided into two main parts to allow full and, at the same time, easy understanding of the functionality of the whole module. In the first part 'Management of Addon' you will see a general outlook of the module's basic configuration, through the product management from the admin area. The second part describes additional settings and tools concerning WordPress installations that can be used while working in the client area. |
[edit] Admin Area
| Now that your module is already configured, you may access it at 'Addons' → 'WordPress Manager'. |
[edit] Home
| The 'Home' section is the first open when entering the addon. You will see here a quick summary of the WordPress connected elements and a list of all active WordPress installations with any details on their installation. |
|
[edit] Product Settings
| In the 'Product Settings' section you can see the list of compatible products present in your system that WordPress can be configured with. Activate the products and press the 'Edit' icon marked on the screen below. |
|
[edit] General
In the 'General' section you will need to set up some specific options concerning the plugins installation. Take a look at the below notes to learn about all of the possibilities.
|
|
| Note: By default, installation script names in the client area will be displayed without their IDs. If you still want to change their names to more client-friendly, you can do it in a language file. Go to the Tips section and look for more details in the second point. |
[edit] Test Installation (up to 1.7.1 version)
|
Important: If the module version you are using is 1.8.0 or later, test installation is no longer required to perform the below described actions!
Note: The below steps should be possible if you have already made the basic Product Settings configuration. So, to start, proceed to the 'WordPress Management' section of the product in the Client Area on any of your test accounts. Next, click on the 'New Installation' button. |
|
| There are two sections to complete. Firstly, provide the details of your installation. Remember to enter your domain properly. |
|
| Now, go to the 'Other' section of your installation and fill in the details. You may also decide which options should be enabled for your installation. Remember to click 'Create' and wait until the 'New Installation' is ready. |
|
| Finally, you can come back to 'WordPress Manager' . Go to 'Product Settings' and click on the 'Edit' icon next to the preferred product. You will find the 'Test Installation' option here. As presented below, start typing your domain name that was provided in the previous step of creating 'New Installation' . Choose your 'Test Installation' and save changes. |
|
[edit] Plugins Blacklist
| This section of the Product Settings includes a list of blocked plugins - those which your clients are not allowed to install. |
| In order to add a plugin to the list simply start typing its name in the search field and press enter to see the results. Remember that you must have previously set any "Test Installation" to be allowed to add any plugins to the list. |
|
| Add the selected plugin to the blacklist. It will no longer be available for clients to install if the "Blocked Plugins" option has been enabled in the General section. |
|
[edit] Themes Blacklist
| This section of the Product Settings includes a list of blocked themes - those that your clients will not be able to install. |
| If you want to add a theme to the list, simply start typing its name in the search field and press enter to see the results. Add the selected themes to the blacklist. Remember that you must have previously set any "Test Installation" to be allowed to add any themes to the list. |
|
| Your clients will not be able to install the previously added themes if the "Blocked Themes" option has been enabled in the General section. If you decide to remove the preferred themes from the 'Blocked' section, you may easily do this by clicking the appropriate button. |
|
[edit] Client Area Features
| In this section, you can define which options should be enabled for clients. To make it easier, the available options are divided into two parts, the 'Management Options' and 'Action Options' . |
|
[edit] Plugins
| In the 'Plugins' section you may prepare ready-made packages with selected by you plugins or prepare custom plugins and then offer them to install to your clients. In this quick and convenient way, your clients will be given an offer with perfectly adjusted and suitable plugins to shorten the time of searching and verification. |
|
| In the 'General' part, enter the package name, select the directory of the test installation, describe the package in short. Save the changes and then move to the 'Plugins' tab. In this part you will also need to enable the package once it is prepared. |
|
| Add plugins by searching through the existing ones, start typing the plugin name, press enter and the results will appear. Add a single plugin or use mass action button to add plugins in bulk. |
|
| Added plugins will appear on the list of included immediately. You may always delete any unwanted plugins when editing the package by pressing the bin icon. |
|
| Once you have the packages ready, move again to the General configuration of a product and select which of the packages will be available to choose from by clients or be automatically preinstalled for a single product. Surely, you may assign a different set of packages to each product. |
|
| There is also the possibility to add 'Custom Plugins' . Press the following button to do so. |
|
| Now, provide a name and description of your 'Custom Plugin' . Then, complete the 'URL' and finally define a version. |
|
| If you wish to modify your 'Custom Plugins' , you can easily do this by pressing the 'Edit' button. |
|
[edit] Themes
| In the 'Themes' section you may prepare ready-made packages with selected by you themes or create your 'Custom Themes' and automatically install them along with the WordPress instance. In this quick and convenient way, your clients will have quick access to preinstalled themes on their WordPress without the need of searching them on their own. |
|
| In the 'General' part, enter the package name, select the directory of the test installation, describe the package in short. Save the changes and then move to the 'Themes' tab. In this part you will also need to enable the package once it is prepared. |
|
| Add themes by searching through the existing ones, start typing the theme name, press enter and the results will appear. Add a single theme or use mass action button to add themes in bulk. |
|
| Added themes will appear on the list of included immediately. You may always delete any unwanted themes when editing the package by pressing the bin icon. |
|
| Once you have the packages ready, move again to the General configuration of a product and select which of the packages will be installed automatically for a single product. Surely, you may assign a different set of packages to each product. |
|
| There is also the possibility to add 'Custom Themes' . Press the following button to do so. |
|
| Now, provide a name and description of your 'Custom Theme' . Then, complete the 'URL' and finally define a version. |
|
| If you wish to modify your 'Custom Themes' , you can easily do this by pressing the 'Edit' button. |
|
[edit] Instance Images
| This section is dedicated to WordPress images that are used to allow clients to add WordPress installations using this very images of WordPress. To create such an image, simply press the 'Add Image' button and then follow the steps described below. |
|
| In order to properly configure a new instance image you will need to set up the below options. Please be aware that to create such an instance image you will need to deliver full access data to a server with WordPress installations that will be used to create an image.
|
|
| Once you have the images ready, move again to the General configuration of a product and select which of the images will be available for a single product. Surely, you may assign different sets of images to each product. |
|
[edit] Other
[edit] Logs
| The module activities are recorded in the section named 'Logs'. All entries can be deleted at any time, just click the button marked on the screen below. Keep in mind that you can remove multiple logs at once. |
|
[edit] Tasks
This section gives you the view on module tasks to enable SSL in two scenarios:
|
|
| Press the 'Information' button to get a quick view on the basic information on the task and log details. |
|
| Logs section will include information on errors only. If a task is completed successfully, no information will be included here. |
|
| All tasks can be deleted separately. To do that, just click the button marked on the screen below. Keep in mind that you can remove multiple tasks at once. |
|
[edit] Settings
| Provide 'Google API Token For PageSpeed Insights' and define the cron interval to run the speed test. The API token is required to successfully enter and use the 'Website Details' section of the WordPress instance in the client area. The section underneath explains how and where you can find the required API Key. There is also a list of protocols. Select the ones that you want to enable to use for clients in the client area. |
|
[edit] Google API Token
| In order to get your Google API token necessary for the Website Details section to work, open the following site: https://developers.google.com/speed/docs/insights/v5/get-started Scroll down to 'Acquiring and using an API key' section. There, press 'Get a Key' button: |
|
| 'Enable PageSpeed Insights API' modal will appear. Select your project or create a new one, and then press 'Next'. |
|
| That's all! Your Google API key is ready, copy it and paste in the 'Google API Token' field in the WordPress For WHMCS module Settings as described in the above section. |
|
[edit] Email Templates
| By default, the module creates the 'New WordPress Information' email template You can find it in your WHMCS 'Setup' → 'Email Templates' section. This template can be used to send WordPress details to the customer when the automatic installation is enabled after the service creation. Additionally, you may use the merge fields variables, which will be replaced to the corresponding WordPress installation details when are sent to the customer:
|
|
[edit] Client Area
| Now that you already have the module configured, you may see the process of adding and managing the WordPress installations by your clients. In the client area, find and choose your product with WordPress management support and then move directly to the relative section. |
|
[edit] WordPress Installations
| Extended view, toggled by the admin in the module addon, read more here.
At the top of the page, you will find all WordPress installations located in dedicated segments. Every installation has its own section with screen grabs, installation details and instant access to action tools. |
|
| The standard view of the WordPress Management page includes the very same information as the extended view, yet they are placed in a simple list form. Underneath the list there is also section dedicated to 'Reseller Accounts'. The former one contains a list with basic information regarding every installation, including the domain, related product, URL etc. |
|
Use action buttons marked on the screen to perform actions on a single installation:
|
|
Among additional actions you will find the options to:
|
|
| You may also delete or update multiple WordPress instances to the newest version at once, use mass actions to do so (standard view only). |
|
| If you wish, you may create a backup of the instances before processing the update. |
|
[edit] New Installations
| As mentioned above, there are three ways to create a new WordPress Installation. The first basic way is to simply install a completely new and clean instance 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. |
|
| A new window with two tabs will open. In the first Details tab, fill in the following fields:
Note that only those fields marked with * (e.g. 'Site Name') are required to complete the creation. |
|
Complete the configuration by switching to the Other tab and enter the remaining fields (optional):
If you have entered all the data correctly, you can now press the 'Create' button to complete the installation. |
|
[edit] Import From Remote Server
| The second way to add a new installation is by importing an existing installation from a remote FTP server. Press the additional actions button to find the redirection. |
|
First of all, fill out the data on the source server:
|
|
Then move to the other tab, to provide any data on the destination.
Press the 'Import' button to finalize the process. |
|
[edit] Use Instance Image
| It is also possible to use an existing instance image. |
|
Provide the below enumerated and described details, then press 'Create' to complete:
Note: the process may take from a few up to a dozen or so minutes for the instance to appear on the list, depending on the instance size or complexity. |
|
[edit] Installation Management
| Once you have successfully created a new installation, you can edit its advanced options or simply remove it in case you no longer need it. Let us view the management options and available actions now. Note: Please be aware that deleting installations "(3)" is not possible from this section for the WP Toolkit for Plesk API. To delete an instance, you need to log into the Plesk panel. |
|
|
[edit] Installation Details
| On the very first page, when you enter the edit section, there is an exemplary configuration of your installation in the 'Management' section. You will find there all the basic information, such as domain and database details, available at hand. |
|
[edit] Website Details
| Desktop and mobile website details based on Google "PageSpeed Insights" statistics. This section requires to previously generate and provide the 'Google API Token'. Follow this instructions to learn how to do that. |
|
[edit] Backups
| As the name suggests, this section provides you with an ability to create backups. You are allowed to download, restore and delete a particular backup. |
|
| Surely you can delete multiple backups at once. Take a look at the screenshot below. |
|
| When creating a backup installation, decide whether to backup directory only, data directory or database. Select location and then confirm the action. Note: Keep in mind that creating a backup might take a longer while. Backup will appear on the list when it is ready. |
|
[edit] Themes
| Here you are enabled to activate, disable, update and delete the existing theme. Add new themes to your WordPress installation in the 'Add New' tab. |
|
| In order to add a new theme, start typing in the desired theme's name in the search box, press enter to see the actual results. You may press the theme thumbnail to preview the on wp-themes.com. Afterwards, press the icon marked on the screenshot below to continue. |
|
| Confirm the installation. |
|
| If there are any 'Custom Themes' accessible for adding, they will be located here. |
|
| Use 'Mass Action' buttons to update or delete numerous themes with a single click. |
|
[edit] Plugins
| Here you are enabled to activate, deactivate, delete or update the already existing plugins. You can also add new plugins to your WordPress installation in the 'Add New' tab. |
|
| To add a new plugin, you are required to type in at least the initial letters of the desired plugin's name into the search field to see the actual results. Afterwards, press the symbol marked on the screenshot below, and confirm your choice in the window that should be visible on your screen. |
|
|
| Press the info icon to read its short description. |
|
| In case the plugin seems interesting, just press the 'Install' button. |
|
| There is also an option to add your custom plugins, simply press adequate icon and confirm the action. |
|
| 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. |
|
[edit] Plugin Packages
| Plugin Packages allow to install a bunch of pre-organized plugins at once. Information on how to prepare such packages can be found here. Simply press the '+' button to install the package with plugins that seems especially attractive to you. |
|
[edit] Config
| In this section you can directly alter the records from the wp-config.php file. This file is located in the root of your WordPress file directory and contains your website's configuration details such as database connection information. You are allowed to edit or delete already existing config records as well as create new ones. Important: Be particularly careful when editing these config records! You can find more information about editing the 'wp-config.php' file here. |
|
| When creating a new config record, enter its proper name, value and choose one of the two available types ('Constant' or 'Variable'). |
|
[edit] Users
Enter this section to manage existing users and create new ones. You are allowed to perform following actions on a single user:
|
|
When creating a new user, you will have to provide the following data to complete:
|
|
[edit] Available Actions
In the 'Actions' area you can find the following options to:
Important: Please refer to the WP Toolkit Integration section for the list of troublesome features and make sure they are supported by the API you are using. Underneath you can find a detailed description of all the remaining actions. Please take a look. |
|
[edit] Clone
This action will result in cloning the installation to another domain. To clone the installation you need to:
The cloned installation will appear on the list of installations after a while. |
|
[edit] Change Domain
| If you want to change the domain of your WordPress installation, simply provide here a new one. Decide whether to create a backup at the same time and enable/disable SSL for the new domain. |
|
[edit] Manage Auto Upgrades
Set up the automatic upgrades rules. Here you may enable or disable automatic upgrades:
|
|
[edit] Staging
| Create staging instances from an application to test the upgrades or changes before using them in the live environment. |
|
| Please be patient, as the whole process may take a few minutes. The staging instance will appear on the list of your installations after the first cron synchronization. Push the staging installation to the live environment once you are sure it works fine and changes suit your needs. |
|
| In case you need to customize the installation before pushig it live simply toggle the 'Customize' option. Then define the specification and confirm to finish. |
|
[edit] SSL
| Turn on or off SSL for the installation. Remember that enabling SSL will result in changes being made in your WordPress database configuration, it is advised to back up your installation. Along with enabling SSL, a free Let's Encrypt SSL will be installed on DirectAdmin products (note that this feature is not available for 'cPanel'). |
|
[edit] Debug Mode
| Check whether the debug mode is currently enabled or disabled. Change the mode by pressing the 'Change' button. |
|
[edit] Maintenance Mode
| Check the current status of the website, turn off/on maintenance mode according to your needs by pressing the 'Change' button. |
|
[edit] Instance Image
| Turn on instance image on the WordPress installation. Simply, toggle the 'Mark As Image' option and then fill in the below options. Note: The 'FTP Password' input is encoded in the database, which makes is completely safe and secure. |
|
[edit] Reseller Accounts
| Existing Reseller's Accounts with the number of WordPress installations. Keep in mind that this section is visible only when such accounts exist in the client's cPanel or DirectAdmin panels. In case no such accounts have been detected, this section is hidden. Note: Plesk resellers accounts are not yet currently supported. The table includes the name of the product, reseller's account name on which the instances are installed as well as their number. |
|
Press the edit icon to view the list of existing installations. Among other allowed actions there are:
|
|
| The only difference is the need to select a customer when adding a new installation. If there is no username available here to choose, the reseller must create an extra account in the cPanel or DirectAdmin panels. All the remaining options are exactly the same as in case of standard WordPress installations described in the above sections. |
|
| Using mass actions you may also update multiple WordPress instances to the newest version at once or delete them. |
|
[edit] WP Toolkit Integration
| As an alternative to the Softaculous auto-installer, you have the option to benefit from the WP Toolkit integration available for cPanel/WHM or Plesk. Please note that if you are using the free version of WP Toolkit, certain features may not be accessible or fully functional within the WordPress Manager module. |
| Important! By default, all the API support all features enumerated on the product features list, available at the top of this documentation. |
| List of troublesome features with API compatibility status: |
| Feature Name | Softaculous | WP Toolkit for Plesk | WP Toolkit for cPanel/WHM | |
|---|---|---|---|---|
| 1. | Clone an instance | ✔️ | ✔️ | ❌ |
| 2. | Delete an instance | ✔️ | ❌ | ✔️ |
| 3. | Download backups | ✔️ | ❌ | ✔️ |
| 4. | Push staging to live environment | ✔️ | ❌ | ❌ |
| 5. | Create staging | ✔️ | ❌ | ❌ |
| 6. | Use instance image | ✔️ | ❌ | ❌ |
| 7. | Access setup section (Installation Details → Actions → Setup) |
❌ | ✔️ | ✔️ |
| Depending on your API selection, be sure to customize the Client Area Features in your product configuration. This ensures that your clients have access only to the supported functionalities while disabling any unsupported ones. |
[edit] Tips
1. In case you wish to remove one of your plugins from WHM, make sure you delete the additional content too:
/usr/local/cpanel/Cpanel/API/Wordpress.pm /usr/local/cpanel/share/WordPressManager/wp |
| 2. If you wish to change the names of your WordPress installations scripts to more friendly in the client area, you can do this in a language file. Simply open your default 'english.php ' file located in '/yourWHMCS/modules/addons/WordpressManager/langs' directory and add a new language record in the following format: $_LANG['WordPress Script Name']="WordPress Friendly Name"; |
| 3. When using WordPress Manager module with cPanel, you will also need to whitelist 'phar' support in your php.ini on the WHM server. You can do this by adding or editing the below record: suhosin.executor.include.whitelist = phar |
4. It is possible to set language for WordPress auto-installation. In the Product Custom Fields section you should complete:
en|English,ar|Arabic,zh_CN|Chinese,fr_FR|French,de_DE|German,el|Greek,it_IT|Italian,ja|Japanese,ko_KR|Korean,pl_PL|Polish,ru_RU|Russian, sl_SI|Slovenian,sk_SK|Slovak,es_ES|Spanish,tr_TR|Turkish,uk|Ukrainian,vi|Vietnamese
|
| 5. You can set a username and password for the administrator panel in WordPress using the following product custom fields. Remember that this method works only when the 'Auto Install WordPress After Service Creation' option is set to 'Based on Installation Script' . Please note that these product custom fields work only for a clean installation, and do not work with instance images. wp_username|Username wp_password|Password If a client completes the username and password, then the account will be created on the basis of the provided data. |
[edit] Language Overrides
| Incorporating language customizations - the module readily accommodates language overrides, allowing you to tailor the language files to your preferences. The language file english.php remains unencoded and can be modified to suit your needs. However, it's recommended to avoid altering the core file itself, and instead, leverage the capability of using overrides. Here's how to apply language overrides:
~/langs/overrides/english.php.
For example: Original yourWHMCS/modules/servers/moduleName/langs/english.php: $_LANG['Search'] = 'Search'; Override yourWHMCS/modules/servers/moduleName/langs/overrides/english.php: $_LANG['Search'] = 'Look for'; By following these steps, you can seamlessly implement language customizations without altering the core language file, ensuring your changes will not be lost after every module update. Remember that some of the modules have more than one language file, located under /addons and /servers paths. You may create the override files for both of them. |
[edit] Update Instructions
| An essential guidance through the process of updating the module is offered here. Important: If you are performing an update from a previous version of WordPress Manager with cPanel, you have to also update the files and run again the installation script on your WHM server. |
[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 WordPress Manager For WHMCS module to unlock these benefits. 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 do not see the config records, make sure that you have also updated the WHM files to the latest version. |
| 3. Installation of Let's Encrypt SSL is available only for DirectAdmin products. |
| 4. Native integration with cPanel Extended module works seamlessly except for one aspect, specifically access via 'Manage Account → WordPress Manager', where an issue is encountered. You may smoothly enter the WordPress Manager via: 'Actions → WordPress Management'. |
| 5. The module supports two APIs: Softaculus and WP Toolkit. If you are changing the API from WP Toolkit to Softaculous, when there are already existing installations, you must remember to synchronize the instances. Solution: Proceed to cPanel → Softaculous and press the "Scan" button. |
|
| When changing the API from Softaculous to WP Toolkit, trigger the scanning in cPanel → WP Toolkit: |
|
After the scan is successfully complete, wait until the data is synchronized in the module by running the following cron command:
php -q /yourWHMCS/modules/addons/WordpressManager/cron/cron.php Synchronize That is all, the installations can now be managed via target API. |
| 6. If you experience issues with the proper functionality of a Plesk-based module, one potential cause might be difficulties in retrieving the accurate external WHMCS IP address. To eliminate this as a factor, we recommend configuring the variable ipServerWhmcs with a specific IP address in the configuration file located at: app/config/configuration.yml. ipServerWhmcs: '123.456.78.910' |