Personal tools
Namespaces

Variants
Actions

WordPress Manager For WHMCS

From ModulesGarden Wiki
Revision as of 16:59, 2 March 2018 by Joanna (Talk | contribs)

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 in your WHMCS.

Your clients will be able to perform WordPress updates, explore and install plugins, create backups and carry out bulk actions on key elements.
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 Features:
✔ View Active WordPress Installations, Clients And Products Summary
✔ View WordPress Installations List
✔ Choose Supported Products
✔ Toggle Debug Logs Per Product
✔ Access Module Logs
  • Client Area Features:
✔ View/Create/Edit/Delete WordPress Installations
✔ Create/Restore/Download/Delete WordPress Backups
✔ Browse And Install Plugins
✔ Perform Bulk Changes On Plugins And Backups
✔ 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
✔ Update To Newer Version
✔ Delete
✔ Plugins Management:
✔ Search And Install Plugins Directly From WordPress.com Base
✔ Update Installed Plugins
✔ Activate/Deactivate Installed Plugins
  • General Info:
✔ Supports cPanel And cPanel Extended
✔ Requires Softaculous Auto Installer
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7

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.
As presented on the screen below, the first one is supposed to be installed on WHM (cPanel), while the second one is aimed at WHMCS.
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

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.

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
Enabling Debug Mode will result in the module's activity details being gathered in the 'Logs' tab.
WM S19.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 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
Fill in the fields. Note that only those marked with * (e.g. Database Name) are required to complete the creation:
  • Domain - Select the domain the software will be installed on.
  • Directory - Name of the installation folder for WordPress.
    E.g enter 'wptest1' in case 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.
  • Database Name - The name of a newly created database which will be created during the installation.
  • Site Name - The name of a site created for the installation.
  • 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.
  • Loginizer - If enabled, the plugin responsible for limiting the number of login attempts to WordPress installation will be installed and activated with the installation process.
  • Language - Choose a language for the installation.
  • Database Prefix - Optional, the table prefix for the tables created by the app.
  • Description - Your custom site description for the installation.
  • Administrator Password - The password of the administrator's account for the installation.
  • Multisite - If enabled, your blog will have have the Multisite option. Note that your server needs to support Apache mod_rewrite.
WM S2 201.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 - Directly log in to your WordPress panel anytime 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.
  • Delete - Immediately remove the complete installation along with its settings.
WM S 120.png

Plugins

Here you are enabled to activate, deactivate 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
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

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

Update Instructions

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

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.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
WordPress Manager For WHMCS