Personal tools
Namespaces

Variants
Actions

WordPress Manager For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

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 perform WordPress updates, install themes and plugins, install WordPress instances from custom scripts, create backups and toggle automatic upgrade of WordPress installation, plugins, and themes.
You will easily handle the list of services that shall include the WordPress management capabilities, and control customer activity thanks to module logs.

  • Admin Area:
✔ View Active WordPress Installations, Clients And Products Summary
✔ View WordPress Installations List
✔ Choose Supported Products
✔ Toggle Debug Logs Per Product
✔ Select Installation Scripts Per Product
✔ Add/Remove Selected Plugins From Blacklist:
✔ Prevent Blacklisted Plugins From Being Installed By Clients
✔ Remove Blacklisted Plugins From Current Installations
✔ Set Scan Interval For Blacklist Cleaner
✔ Access Module Logs
  • Client Area:
✔ View/Create/Edit/Delete WordPress Installations
✔ Create/Restore/Download/Delete WordPress Backups
✔ Browse And Install Themes
✔ Browse And Install Plugins
✔ Perform Bulk Changes On Themes, Plugins And Backups
✔ View/Create/Edit/Delete WP Config Records
✔ Provide Installation Details
✔ View Installation Details:
✔ WordPress Version
✔ Domain And URL
✔ Product On Which Is Installed
✔ Site Name
✔ Creation Date
✔ Directory Path
✔ Database Access Details
✔ Debug Status
✔ Manage Installation:
✔ Log In To Control Panel
✔ Clear Cache
✔ Clone To New Domain
✔ Change Domain
✔ Change Auto Upgrade Of:
✔ WordPress Installation
✔ WordPress Plugins
✔ WordPress Themes
✔ Update To Newer Version
✔ Delete
✔ Plugins Management:
✔ Search And Install Plugins Directly From WordPress.com Base
✔ Update Installed Plugins
✔ Activate/Deactivate Installed Plugins
  • Supported Modules:
✔ cPanel
cPanel Extended - With Complete Integration
✔ DirectAdmin
DirectAdmin Extended
  • General Info:
✔ Requires Softaculous Auto Installer
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.2 And Later

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.
WM S2 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.

PHP56 72.png
3. Choose the one with the right PHP version. In the package you will find another three folders.
As presented on the screen below, the first one is supposed to be uploaded on WHMCS, the second one is aimed at DirectAdmin while the last one is for WHM (cPanel).
WM 1s2.png

cPanel (WHM) Installation

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.

WM 2.png
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.

WM 3.png

DirectAdmin Installation

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

WM 2 1.png
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.
WM 2 2.png
3. Once the plugin is uploaded and successfully installed, you should see it on the plugins list.
WM 2 3.png

WHMCS Installation

1. Extract the 'modules' catalog into the main WHMCS directory.
WM S2 2.png
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'.

WM S3.png
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'.

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

This folder is available at 'your_whmcs/modules/addons/WordpressManager/' .

WM S4s.png
5. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Click 'Setup' , then choose 'Addon Modules'.
Afterwards, find 'WordPress Manager' and press the 'Activate' button.

WM S 3.png
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'.
WM S 4.png
7. Now you have to add a cron job as shown below (5 - 10 minutes interval is recommended).
php -q /your_whmcs/modules/addons/WordpressManager/cron/cron.php Synchronize

Do not forget to replace 'your_whmcs' with your WHMCS root location.
Note: In case you wish to stop this cron job then move to "your_WHMCS/modules/addons/WordpressManager/cron" directory and clear the file's content.

8. Good job! You have just successfully installed WordPress Manager For WHMCS! Now in your WHMCS press 'Addons' and then 'WordPress Manager'.
WM S2 6.png

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.

Admin Area

Now that your module is already configured, you may access it from 'Addons' 'WordPress Manager' .

Home

'Home' should be your first choice.

In this section you will see all active WordPress installations and the list of the clients who already have them.

WM S2 188.png

Product Settings

In the 'Product Settings' section you can see the list of compatible products that WordPress can be configured with.
WM 181.png
Activate your product and press the 'Edit' button marked with the green arrow.
WM S18.png
General
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.
  • Debug Mode - if enabled, the module's activity details will be gathered in the 'Logs' tab.
  • Installation Scripts - allow your clients to install your pre-configured WordPress instances instead of performing a clean installation only.
    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.
    If you leave this field empty, then a clean WordPress instance will be installed by default.
    Important: The dropdown will display a bunch of other installation scrips from Softaculous, not only those from WordPress.
    Remember to only select your WordPress-based installations. Otherwise, unpredictable errors might occur.

  • Test Installation - in order to get the list of applications in the "Plugins Blacklist" search, you must have at least one active WordPress instance. Select one from the available.
  • Blocked Plugins - enable if you do not wish your clients to install certain plugins due to security, safety or any other reason.
    Define the plugins that will not be allowed for installation in the "Plugins Blacklist" section.
  • Delete Blocked Plugins - enable if you wish to automatically delete plugins that have been added to the blacklist.
    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.
    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.
WM S19.png
Note: By default, installation script names in the client area will be displayed without their IDs. If you want to still 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.
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.
WM S19 2.png
Add selected plugin to the blacklist.
It will no longer be available for clients to install if "Blocked Plugins" option has been enabled in the General section.
WM S19 3.png

Logs

All module activities are recorded in the section named 'Logs' .
WM S2 32.png
All entries can be deleted separately. To do that, just click the button marked on the screen below.
WM S2 34.png
Keep in mind that you can remove multiple logs at once.
WM S2 33.png

Client Area

WordPress Management

Now that you already have the module configured, you may see the process of adding and managing the WordPress installations by your clients.
While in the client area, find the button 'My Services' and go to the section presented on the following screen.
WM S2 18.png
Choose your product and enter its details.
WM S2 19.png
Now, move directly to the 'WordPress Management' section.
WM S2 20.png

New Installation

Next, you will need to add a new installation. Press the button marked on the screen below.
WM S2 191.png
A new window split to three tabs will open.

In the first Details tab fill the following fields:

  • Domain - select the domain the software will be installed on.
  • Installation Script - here you can select any custom installation script that you want to install.
    Note that this field will be displayed only for domains whose products have installation scripts configured in the products settings.
    If it is not displayed then the clean WordPress installation will be applied.
  • Site Name - the name of a site created for the installation.
  • Description - your custom site description for the installation.
  • Directory - name of the installation folder for WordPress.
    E.g. enter 'wptest1' if you want the installation http://yourdomain.com/wptest1. In order to install it directly at e.g. http://yourdomain.com/, simply leave this field unaltered.
  • Language - choose a language for the installation.

Note that only those fields marked with * (e.g. 'Site Name') are required to complete the creation.

WM S2 201.png
In the Login Details tab enter the following fields:
  • Administrator Username - the username of the administrator's account for the installation.
  • Administrator Email - the email address of the administrator's account for the installation.
  • Administrator Password - the password of the administrator's account for the installation.
WM S2 202.png
Complete the configuration by switching to the Other tab and enter the remaining fields:
  • Database Name - the name of a newly created database which will be created during the installation.
  • Database Prefix - the table prefix for the tables created by the app (optionally).
  • Multisite - if enabled, your blog will have the 'Multisite' option. Note that your server must support 'Apache mod_rewrite' .
  • Auto Upgrade - if enabled, the WordPress installation will be automatically updated to the latest version when it is available.
  • Auto Upgrade Plugins - if enabled, all active WordPress plugins installed for this installation will be automatically updated to the latest versions when available.
  • Auto Upgrade Themes - if enabled, the active WordPress theme for this installation will be automatically updated to the latest version when available.

If you have entered all the data correctly, you can now press the 'Create' button to complete the installation.

WM S2 203.png

Installation Details

Once you have successfully created a new installation, you can edit its advanced options (the green arrow) or simply remove it in case you no longer need it (the red arrow).
Let us press the green one.
WM S 18.png
This is how an example configuration of your installation may look like:
WM S 19.png
In the 'Management' area you can find the following options:
  • Control Panel - log in to your WordPress panel directly any time you like.
  • Clear Cache - remove the cache of your installation.
  • Clone - this action will result in cloning the installation to another domain.
  • Update - after selecting this option, your WordPress will be updated to the latest version.
  • Change Domain - choose a new domain.
  • Change Auto Upgrade - choose the status of the auto upgrade option for WordPress instance, plugins and theme.
  • Delete - immediately remove the complete installation along with its settings.
WM S 120.png

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.
WM S 181 1.png
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.

Afterwards, press the icon marked on the screenshot below.

WM S 181 2.png
Confirm the installation.
WM S 181 3.png
Use 'Mass Action' buttons to update or delete numerous themes with a single click.
WM S 181 4.png

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.
WM S 181.png
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.

WM S 1811.png
Press the info icon to read its short description.
WM S 1811 0.png
In case the plugin seems interesting, just press the 'Install' button.
WM S 1811 1.png
The 'Mass Action' feature is also present in this section, so you will be able to handle multiple plugins more efficiently and at the same time.
WM S 182.png

Backups

As the name suggests, this section provides you with an ability to add or modify backups.
You are allowed to download, restore and delete a particular backup.
WM 1181.png
Here you can delete multiple backups at once.
See the screenshot below.
WM 182.png

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 edition 'wp-config.php' file here.

WM 20.png
When creating a new config record, enter its proper name, value and chose one of the three available types ( 'Constant', 'Variable' or 'All' ).
WM 21.png

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

Update Instructions

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.
Simply go here and repeat the following instructions.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the 'License Upgrade' button located on the product's page and a discounted invoice will be generated automatically.

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.
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
WordPress Manager For WHMCS