Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="wordpress manager for whmcs, wordpress manager configuration, wordpress manager management, wordpress manager installation, wordpress manager guide, modulesgarden wordpress manager, wordpress manager wiki, wordpress manager tutorial, wordpress manager tips, wordpress module wiki, wordpress manager common problems, about wordpress manager, wordpress manager documentation, wordpress manager faq, wordpress manager help, wordpress cpanel, wordpress whm, wordpress directadmin, wordpress, whmcs, cpanel, whm, directadmin, extended"></meta>
+
<meta name="keywords" content="hosting quota notifications for whmcs, hosting quota notifications configuration, whmcs hosting quota notifications management, whmcs hosting quota notifications installation, whmcs hosting quota notifications common problems, about whmcs hosting quota notifications, whmcs hosting quota notifications documentation, whmcs hosting quota notifications faq, whmcs hosting quota notifications help, whmcs hosting quota notifications guide, whmcs hosting quota notifications wiki, whmcs hosting quota notifications tutorial, whmcs hosting quota notifications tips, whmcs hosting quota notifications wiki"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The WordPress Manager For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta>
  
−
=About [https://www.modulesgarden.com/products/whmcs/wordpress-manager WordPress Manager For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
−
|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 in your WHMCS. <br />
+
|style="padding: 10px 0px 10px 0px;"|'''Hosting Quota Notifications For WHMCS''' allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage.
−
Your clients will be able to perform WordPress updates, explore and install plugins, create backups and carry out bulk actions on key elements.<br/>
+
Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.<br />
−
You will easily handle the list of services that shall include the WordPress management capabilities, and control customer activity thanks to module logs.
+
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
 +
<!--a comment maybe? -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View Active WordPress Installations, Clients And Products Summary
+
|style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View WordPress Installations List
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Supported Products
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Debug Logs Per Product
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Select Installation Scripts Per Product
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Access Module Logs
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
−
 
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View/Create/Edit/Delete WordPress Installations
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Create/Restore/Download/Delete WordPress Backups
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Browse And Install Plugins
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Perform Bulk Changes On Plugins And Backups
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ View/Create/Edit/Delete WP Config Records
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Provide Installation Details
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ View Installation Details:
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ WordPress Version
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Domain And URL
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Product On Which Is Installed
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Site Name
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Creation Date
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Directory Path
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Database Access Details
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Debug Status
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Manage Installation:
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Log In To Control Panel
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Clear Cache
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Clone To New Domain
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Change Domain
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Change Auto Upgrade Of:
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 60px;"|✔ WordPress Installation
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 60px;"|✔ WordPress Plugins
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 60px;"|✔ WordPress Theme
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Update To Newer Version
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Delete
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Plugins Management:
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Search And Install Plugins Directly From WordPress.com Base
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Update Installed Plugins
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 45px;"|✔ Activate/Deactivate Installed Plugins
 
−
|}
 
−
 
−
*'''Supported Modules:'''
 
−
{|
 
−
|style="padding: 10px 0px 0px 30px;"|✔ DirectAdmin
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ [https://www.modulesgarden.com/products/whmcs/directadmin-extended DirectAdmin Extended]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ cPanel
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 30px;"|✔ [https://www.modulesgarden.com/products/whmcs/cpanel-extended cPanel Extended] (With Supported Integration)
 
−
|}
 
−
 
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Requires [https://www.softaculous.com/ Softaculous] Auto Installer
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
 
 
|}
 
|}
 
{|
 
{|
Line 151: Line 48:
 
|}
 
|}
  
−
=Installation and Configuration=
+
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''In this short tutorial we will show you how to successfully install WordPress Manager For WHMCS.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br />
−
We will guide you step by step through the whole installation process.
+
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
−
 
+
==Installation==
 
{|
 
{|
 
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
 
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
 
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
 
|}
 
|}
Line 171: Line 68:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Choose the one with the right PHP version. In the package you will find another three folders.'''<br/>As presented on the screen below, the first one is supposed to be uploaded on WHMCS, the second one is aimed for DirectAdmin while the last one is for WHM (cPanel).
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
 +
The content of PHP version files should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WM_1s2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
−
==cPanel (WHM) Installation==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''1. Upload and extract the '' 'UploadToWHM' '' folder into the '''/root''' cPanel directory.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
Files in your cPanel ''/root/uploadToWHM/'' directory should look like these on the following screen.  
+
File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Once the module is uploaded, enter the '''/root/uploadToWHM/''' catalog and run the following command in the console:<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
−
sh install.sh
+
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' ''.  
−
After a brief moment you should see a confirmation that the plugin has been successfully installed.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WM_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
−
|}
+
−
==DirectAdmin Installation==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|'''1. In the '' 'uploadToDirectAdmin' '' folder find the '' 'wordpress_cli.tar.gz' '' package.'''<br />
+
−
Next log in to your DirectAdmin panel as administrator and to to the '' 'Plugin Manager' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_2_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''2. Now in the '' 'Add Plugin' '' select '' 'File' '' option and choose the '' 'wordpress_cli.tar.gz' '' package to upload.'''<br/> Additionally mark the '' 'Install after upload' '' option and press '' 'Add Plugin' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_2_2.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''3. Once the plugin is uploaded and successfully installed you should see it on the plugins list.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WM_2_3.png]]
+
 
|}
 
|}
  
−
==WHMCS Installation==
+
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Extract the '' 'modules' '' catalog into the main WHMCS directory.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S2_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. When you install WordPress Manager For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
−
This file is located in '' 'modules/addons/wordpress_manager/license_RENAME.php.' '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''3. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
+
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S4.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''4. In the next step, set up the  '' 'storage' '' folder as recursively writable.'''<br />
+
−
This folder is available at '' 'your_whmcs/modules/addons/WordpressManager/' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S4s.png]]
+
−
|}
+
−
{|
+
−
|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 '' 'Setup' '', then choose '' 'Addon Modules'. ''<br />
+
−
Afterwards, find '' 'WordPress Manager' '' and press the '' 'Activate' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S_3.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''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'.'' '''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S_4.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''7. Now you have to add a cron job as shown below (5 - 10 minutes interval is recommended).'''<br />
+
−
php -q /your_whmcs/modules/addons/WordPressManager/cron/cron.php Synchronize
+
−
Do not forget to replace 'your_whmcs' with your WHMCS root location.
+
−
|}
+
−
{|
+
−
|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 30px 25px;"|[[File:WM_S2_6.png]]
+
 
|}
 
|}
  
−
=Management=
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|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.<br/>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.<br/> The second part describes additional settings and tools concerning WordPress installations that can be used while working in the client area.
 
−
|}
 
−
 
−
===Admin Area===
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|Now that your module is already configured, you may access it from '' 'Addons' '' → '' 'WordPress Manager' ''.
 
−
|}
 
−
====Home====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Home' '' should be your first choice. <br/>
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
−
In this section you will see all active WordPress installations and the list of the clients who already have them.
+
You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WM_S2_188.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
 
|}
 
|}
  
−
====Product Settings====
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In the '' 'Product Settings' '' section you can see the list of compatible products that WordPress can be configured with.
+
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.'''
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_181.png]]
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
 +
You can enable/disable any of them, as well as alter or completely remove them.<br />
 +
Press '' 'Create New Group' '' to proceed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Activate your product and press the '' 'Edit' '' button marked with the green arrow.  
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S18.png]]
+
|style="padding: 0px 0px 15px 15px;"|Now, you can define all products related to this configuration and email template which will be used to notify your clients.<br />
 +
You can choose between two types of resource usage counting:<br />
 +
*Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent.
 +
*Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Enabling ''Debug Mode'' will result in the module's activity details being gathered in the '' 'Logs' '' tab. <br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
−
By choosing any '' 'Installation Scripts' '' you can allow clients to install your pre-configured WordPress instances instead performing a clean installation only.<br/>
+
−
This feature can be useful if you already have few WordPress installations ready such as custom themed, with demo content or other plugins.<br/>
+
−
If you leave this field empty then the clean WordPress instance will be installed by default.<br/>
+
−
'' '''Important:''' The dropdown will display a bunch of other installation scrips from Softaculous, not only the WordPress ones.<br/>Remember to only select your WordPress based installations, otherwise unpredictable errors might occur.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S19.png]]
+
|style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br />
 +
As you can see, we have defined limits for both bandwidth and disk.<br />
 +
Settings shown below result in sending notification to client upon:
 +
*bandwidth usage growth by 5GB during 21 days.
 +
*disk usage growth by 100GB over period of 14 days.
 
|}
 
|}
 
{|
 
{|
−
|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 still change their names to more client-friendly you can do it through a language file. <br/>Go to the [https://www.docs.modulesgarden.com/WordPress_Manager_For_WHMCS#Tips Tips] section and see for more details in the second point.''
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
−
 
+
==Logs==
−
====Logs====
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|All module activities are recorded in the section named '' 'Logs' ''.
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S2_32.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|All entries can be deleted separately. To do that, just click the button marked on the screen below.
+
|style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br />
 +
The only requirement is their type being set to '' 'Product/Service' ''.<br />
 +
Additionally, you can use {if} statement, as shown below:
 +
{if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if}
 +
{if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if}
 +
It will allow you to use this email template for bandwidth and disk notifications at the same time.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S2_34.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Keep in mind that you can remove multiple logs at once.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WM_S2_33.png]]
+
−
|}
+
−
 
+
−
===Client Area===
+
−
 
+
−
====WordPress Management====
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Now that you already have the module configured, you may see the process of adding and and managing the WordPress installations by your clients.<br/> While in the client area, find the button  '' 'My Services' '' and go to the section presented on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S2_18.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Choose your product and enter its details.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S2_19.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Now, move directly to the '' 'WordPress Management' '' section.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WM_S2_20.png]]
+
−
|}
+
−
 
+
−
====New Installation====
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|Next, you will need to add a new installation. Press the button marked on the screen below.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S2_191.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"| A new window split to three tabs will open.<br/>
+
−
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 install.<br/>Note that this field will be displayed only for domains whose products have installation scripts configured in the [https://www.docs.modulesgarden.com/WordPress_Manager_For_WHMCS#Product_Settings products settings].<br/>If it is not diplayed 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.<br/> 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.
+
−
*'''Language''' - choose a language for the installation.
+
−
'' '''Note''' that only those fields marked with '''*''' (e.g. 'Site Name') are required to complete the creation.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S2_201.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|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.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S2_202.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|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''' - optional, the table prefix for the tables created by the app.
+
−
*'''Multisite''' - if enabled, your blog will have have the '' 'Multisite' '' option. Note that your server needs to support '' 'Apache mod_rewrite' ''.
+
−
*'''Auto Upgrade''' - if enabled, the WordPress installation will be automatically updated to the latest version when a new one is available.
+
−
*'''Auto Upgrade Plugins''' - if enabled, all the 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 when available.
+
−
<!-- na razie wywalone bo ta opcja nie działała ale może jeszcze wrócić:
+
−
*'''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.
+
−
-->
+
−
If you have entered all the data correctly, you can now press the '' 'Create' '' button to complete the installation.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WM_S2_203.png]]
+
−
|}
+
−
 
+
−
====Installation Details====
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|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).<br/> Let us press the green one.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S_18.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|This is how an example configuration of your installation may look like:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S_19.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|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.
+
−
*'''Change Auto Upgrade''' - choose the status of the auto upgrading WordPress instance, its plugins and theme.
+
−
*'''Delete''' - immediately remove the complete installation along with its settings.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WM_S_120.png]]
+
−
|}
+
−
 
+
−
====Plugins====
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|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.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S_181.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|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.<br/>
+
−
Afterwards, press the symbol marked on the screenshot below, and confirm your choice in the window that should be visible on your screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_S_1811.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|The '' 'Mass Action' '' feature is also present in this section, so you will be able to handle multiple plugins more efficiently and at the same time.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WM_S_182.png]]
+
−
|}
+
−
 
+
−
====Backups====
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|As the name suggests, this section provides you with an ability to add or modify backups.<br/>You are allowed to download, restore and delete a particular backup.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_1181.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Here you can '''delete''' multiple backups at once.<br/>See the screenshot below.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WM_182.png]]
+
−
|}
+
−
====Config====
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|In this section you can directly manipulate 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 creating a new ones.<br/>
+
−
'' '''Important:''' Be particularly careful when editing these config records! You can find more information about edition 'wp-config.php' file [https://codex.wordpress.org/Editing_wp-config.php here].''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WM_20.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|When creating a new config record enter its proper name, value and chose one of three types ('' 'Constant', 'Variable' ''or '' 'All' '').
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WM_21.png]]
+
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|1. In case you wish to remove one of your plugins from WHM, make sure you delete the additional content too:
+
|style="padding: 10px 0px 30px 15px;"|
−
/usr/local/cpanel/Cpanel/API/Wordpress.pm
+
−
/usr/local/cpanel/share/WordPressManager/wp
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 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:
+
−
$_LANG['WordPress Script Name']="WordPress Friendly Name";
+
 
|}
 
|}
  
Line 491: Line 173:
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
 
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
−
 
−
'''Important:''' If you are updating from a previous version of WordPress Manager with cPanel you have to also update 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/><br/>
 
 
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
 
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
−
To take advantage of it, simply use the '' 'License Upgrade' '' button located on the product's page and a discounted invoice will be generated automatically.<br/>
+
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
 
|}
 
|}
−
 
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|2. If you do not see the [https://www.docs.modulesgarden.com/WordPress_Manager_For_WHMCS#Config config] records make sure that you have also [https://www.docs.modulesgarden.com/WordPress_Manager_For_WHMCS#Update_Instructions updated] the WHM files to the latest version.
+
 
|}
 
|}

Latest revision as of 11:02, 13 September 2018

Contents

[edit] About Hosting Quota Notifications For WHMCS

Hosting Quota Notifications For WHMCS allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage.

Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.
You can also define email templates and view details of each sent notification owing to logs.

  • Admin Area Features:
✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
✔ Configure Notification Groups
✔ Choose Between Two Types Of Group Counting:
✔ Tiered - Define Tiers Of Usage
✔ Fixed - Define Usage Grow Over Time
✔ Assign Multiple Products To Single Notification Group
✔ Assign Email Templates Per Notification Group
✔ Enable/Disable Notification Groups
✔ View Logs Of Sent Notifications
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS V7

[edit] Installation

This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.

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

[edit] Installation

1. Log in to our client area and download the module.
HQN 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. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

Drfere.png
4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/hosting_quota_notifications/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

HQN 3.png
5. In order to configure your license key, you have to edit a 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' .

HQN 4.png

[edit] Configuration of Addon

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

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules' . Afterwards, find 'Hosting Quota Notifications' and press 'Activate' button.

HQN 5.png
7. In the next step you need to permit access to this module.

To do so click on 'Configure' button, tick 'Access Control' near required admin role groups and press 'Save Changes' .

HQN 6.png
8. You have just successfully installed Hosting Quota Notifications For WHMCS!

You can access your module in 'Addons' → 'Hosting Quota Notifications' .

HQN 7.png

[edit] Configuration and Management

In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.

[edit] Configuration

In 'Configuration' page you can find the list of configured notification groups.

You can enable/disable any of them, as well as alter or completely remove them.
Press 'Create New Group' to proceed.

HQN 9.png
Now, you can define all products related to this configuration and email template which will be used to notify your clients.

You can choose between two types of resource usage counting:

  • Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent.
  • Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent.
HQN 10.png
For example, shown below module uses fixed counting type.

As you can see, we have defined limits for both bandwidth and disk.
Settings shown below result in sending notification to client upon:

  • bandwidth usage growth by 5GB during 21 days.
  • disk usage growth by 100GB over period of 14 days.
HQN 11.png

[edit] Logs

Under 'Logs' page you can view information about sent notifications.
HQN 12.png

[edit] Notifications

You can create as many notifications as you wish.

The only requirement is their type being set to 'Product/Service' .
Additionally, you can use {if} statement, as shown below: 

{if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if}
{if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if}

It will allow you to use this email template for bandwidth and disk notifications at the same time.

HQN 13.png

[edit] Tips

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

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=41245"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community