Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
 
(532 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="unban center for whmcs, unban center configuration, whmcs unban center management, whmcs unban center installation, whmcs unban center common problems, about whmcs unban center, whmcs unban center documentation, whmcs unban center faq, whmcs unban center help, whmcs unban center guide, whmcs unban center wiki, whmcs unban center tutorial, whmcs unban center tips, whmcs unban center wiki"></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 Unban Center 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 [http://www.modulesgarden.com/products/whmcs/unban_center/features Unban Center For WHMCS]=
+
 
−
{|
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
−
|style="padding: 10px 0px 10px 0px;"|'''Unban Center For WHMCS''' allows your clients to easily unban IP addresses in submodules such as cPanel, DirectAdmin, InterWorx and Plesk directly from your WHMCS client area.<br/>Additionally, the module lets you create your own submodules in order to integrate them with other systems and control panels.
+
−
|}
+
−
<!-- fixed -->
+
−
*'''Client Area Features:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Automatically Detect And Unban IP Address From:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Control Panel
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Control Panel Hosted On Client's VPS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Check If IP Address Is Banned
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Show Reason Of Ban
+
−
|}
+
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Time Until Next Available Unban Action
+
|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.
 +
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 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;"|✔ Configure Per Product:
+
|style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Enable/Disable Unban Ability
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Configure Unban Behavior
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Black List Of IP Addresses - Protected From Unban Action
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Unban Delay - Protection From Abuse
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define If Customer Can Unban Other IP Address Than Their Current One
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Default Settings
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Products Using Product Group Settings - Control Panel
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Products Using Default Settings - VPS / Dedicated Server
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Unban Single Client From Chosen Product
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Unban Multiple Clients From Chosen Control Panel
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Check If Client IP Address Is Banned
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ View And Clear Logs
+
−
|}
+
−
*'''Supported Modules:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ cPanel & [http://www.modulesgarden.com/products/whmcs/cpanel_extended/features cPanel Extended For WHMCS] - CSF and cPHulk
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Plesk & [http://www.modulesgarden.com/products/whmcs/plesk_extended/features Plesk Extended For WHMCS] - Fail2Ban
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ DirectAdmin & [http://www.modulesgarden.com/products/whmcs/directadmin_extended/features DirectAdmin Extended For WHMCS] - CSF
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ InterWorx & [http://www.modulesgarden.com/products/whmcs/interworx_extended/features InterWorx Extended For WHMCS] - Native Firewall
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports IPv4 and IPv6
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Intuitive Creation Of Additional Submodules
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.3 Up To PHP 7
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure Unban Center 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 and configuration process.  
+
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to your 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:UB_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<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/>
−
Files in your WHMCS directory should look like on the following screen.
+
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
Line 121: Line 72:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:gfhfguj.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Unban Center For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<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 />
−
File is located in '' 'modules/addons/unbanCenter/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
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:UB_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file. '' '''<br />
+
|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 />
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → '' 'My Products'. ''  
+
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:UB_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
 
|}
 
|}
 +
 +
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<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 '' 'Unban Center' '' and press '' 'Activate' '' button.
+
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:UB_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
−
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
+
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:UB_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''8. Go to '' 'Addons' '' → '' 'Unban Center' '' → '' 'Integration Code' '' tab and follow the instructions of integration to allow access from the client area.'''<br />
+
−
The integration codes differ depending on the WHMCS version and template you are using.<br/>
+
−
Once you perform the integration properly, the status of the integration will change to  '''Done.'''<br/>
+
−
<br/>
+
−
If you run Unban Center on '''WHMCS V5.x''' then you will have to copy and paste the below code:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_7.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|If you run Unban Center on the latest '''WHMCS V6.x.x''' then you will have to firstly decide which template you use:<br/>
+
−
*Integration code for WHMCS V6.x.x, template '''''SIX'''''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_7_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|
+
−
*Integration code for WHMCS V6.x.x, template '''''FIVE'''''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_7_2.png]]
+
 
|}
 
|}
 +
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. You have just successfully installed Unban Center For WHMCS!'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
−
You can access your module at '' 'Addons' '' → '' 'Unban Center'. ''
+
You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_8.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
 
|}
 
|}
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Unban Center For WHMCS allows you to provide your clients with an ability to easily unban desired IP addresses from external server.'''<br />
+
|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.'''
−
Additionally, you are able to protect specific IP addresses from the unban action.
+
 
|}
 
|}
−
==Unban Types==
+
==Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Our module has been designed in a way that you may now manage banned IP addresses on several different panels of particular type.<br/>
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
−
These are:
+
You can enable/disable any of them, as well as alter or completely remove them.<br />
−
*'''cPanel''' - unban on '''CSF, cPHulk''' ''(Blacklist Management and History Reports)'' or '''both''' at once
+
Press '' 'Create New Group' '' to proceed.
−
*'''DirectAdmin''' - unban on '''CSF'''
+
−
*'''InterWorx''' - unban on '''native firewall'''
+
−
*'''Plesk''' - unban on '''Fail2Ban'''<br/>
+
−
It is also possible to unban only the current IP address. You simply need to select such option ''(i.e. Allow the user to unban a current IP address only)'' <br/>while setting the configuration or create a list of IP addresses that, no matter what type you have chosen, will not be unbanned ''(Black List of IP Addresses).''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|Now read the below sections to learn about advanced configuration of banned IPs management in both control panels and VPS/dedicated servers.
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
−
 
−
==Control Panels==
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|At the '' 'Control Panels' '' tab you can easily enable and configure unban action for all or for chosen servers only.
+
|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.
 
|}
 
|}
−
===Configuration of Single Product===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let's show you how to enable unban functionality for cPanel Extended product.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
−
Start with marking '' 'Enabled' '' checkbox and then define time intervals to declare how often your client will be able to perform unban action on a specific product.<br />
+
−
Afterwards, press '' 'Advanced Settings'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_11.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 20px 15px;"|Next, select desired value from '' 'Unban Type', '' remember that in case of cPanel you may choose between:
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
−
*Unban on CSF
+
−
*Unban on cPHulk ''(Blacklist Management and History Reports)''
+
−
*Unban on both of the above<br/>
+
−
Enter IP addresses that will be unable to be unbanned into '' 'Black List of IP Addresses' '' textbox if there are such.<br />
+
−
Additionally, you can permit your clients to unban any IP address through unmarking checkbox as shown on the following screen.<br />
+
−
Confirm those settings through pressing '' 'Save Changes' '' button.
+
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
−
===Configuration of Multiple Products===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can configure multiple products from one product group at once.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
−
All product groups containing at least one supported module will be displayed in our module → '' 'Control Panels' '' tab.<br />
+
−
Press '' 'Advanced Settings' '' next to the desired product group to proceed.
+
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_1.png]]
+
|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 15px 15px;"|On the following screen you can see unban functionality settings for a product group.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
As you may have noticed there are two tabs, '' 'cPanel' '' and '' 'cPanel Extended For WHMCS'. ''<br />
+
−
It means that products in a selected product group are using both cPanel and cPanel Extended For WHMCS modules.<br />
+
−
This way you can set up unban functionality for cPanel and cPanel Extended products separately.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_2.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Product group settings apply only to disabled products or products marked as '' 'Uses Group Settings'. ''<br />
+
−
Therefore, unban feature settings of product group will not be applied to modified product even if it belongs to that group.<br />
+
−
Products for which group settings are applied to are marked with '' 'Uses Group Settings' '' as shown on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_2_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|You can force group settings for all products in that group through using '' 'Set For All' '' button.<br />
+
−
''Note: '' 'Set For All' '' will force group settings only for enabled products.''<br />
+
−
''In order to apply group settings to all products, disable group, enable it and press '' 'Set For All'. '' ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12_2_2.png]]
+
−
|}
+
−
==VPS/Dedicated Servers==
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|'''''VPS/Dedicated Servers''''' tab allows you to set configuration for default submodules and all available products.<br/> Unban IP addresses in several different panels set up on any VPS or dedicated server.
+
−
|}
+
−
===Default Submodules===
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|Our product offers four already configured submodules to perform unban action in. These are:
+
−
*cPanel & cPanel Extended for WHMCS ''(unban on CSF, cPHulk or both)''
+
−
*Plesk & Plesk Extened For WHMCS ''(Fail2Ban)''
+
−
*DirectAdmin & DirectAdmin Extended For WHMCS ''(CSF)''
+
−
*InterWorx & InterWorx Extended For WHMCS ''(native firewall)''
+
−
You may also create your own submodules, to learn how to do that, please read carefully this [http://www.docs.modulesgarden.com/Unban_Center_For_WHMCS#Creating_3rd_Party_Submodule section].
+
−
|}
+
−
====Settings====
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Select desired value from '' 'Unban Type' '' and enter IP addresses that will be unable to be unbanned into '' 'Black List of IP Addresses' '' text area.<br />
+
−
What is more, you can allow your clients to unban any IP address if you unmark checkbox as shown on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_18.png]]
+
 
|}
 
|}
  
−
===Available Products===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|Check selected product and press '' 'Advanced Settings'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_18_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Enable unban functionality for that product. Now you can either choose to use '' 'Default' '' settings (declared for default submodule)<br/>
 
−
or configure new settings for the product separately. Remember to '' 'Save Changes'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_18_2.png]]
 
−
|}
 
−
==Unban Users==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'' 'Unban Users' '' tab allows you to unban your clients IP address from any of the external servers on which they own an account.<br />
 
−
You can unban IP address assigned to your client accounts as well as custom IP address. Press '' 'Unban' '' as shown on the following screen.<br />
 
−
''Note: You will be able to unban only from external servers enabled at '' 'Unban Center For WHMCS' '' → '' 'Control Panels' '' and '' 'VPS/Dedicated Servers'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_3.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Data on '' 'VPS host Address', 'Username', 'Password' '' will be filled in automatically. Select '' 'SSL Connection' ''' if you wish.<br/>
 
−
''Note! These details will appear only in case of VPS products used by the client.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_4.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|You may now check the status of the client's IP. Press '' 'Check Client IP Address'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_41.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Alternatively, fill in IP address to check.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_42.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|To unban client's IP, fill in the data just like in case of checking IP status and press '' 'Unban Client IP Address'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_43.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|You can also type in a given IP and press '' 'Unban' '' then.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_44.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|To unban multiple accounts at once, select checkbox near accounts to unban and press '' 'Unban Selected' '' as shown on the screen below.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12_6.png]]
 
−
|}
 
−
==Client Area==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Please note that client area button '' 'Unban Your IP' '' is visible only if you have properly inserted integration codes, the integration is precisely described in installation section [http://www.docs.modulesgarden.com/Unban_Center_For_WHMCS#Installation point 7.]<br/>
 
−
Let's proceed to the client area → '' 'Services' ''  → '' 'My Services' '' in order to try out unban action.<br />
 
−
Press '' 'Unban Your IP' '' to proceed to '' 'Unban Center'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_13.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Now, select product for which you want to perform unban IP address action.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_14.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|You will see a full product name and its status, underneath you will find IP address to be unbanned and VPS host details (provided you have selected a VPS product).
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_15.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Check if your IP is banned or unban it immediately. Once the action is completed you will be notified about the results.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_15x.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|In case you have set up a low delay time, you will need to wait for the next unban attempt.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_15_4.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_15_3.png]]
 
−
|}
 
−
==Logs==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|All unban requests and their results can be found at '' 'Unban Center' '' → '' 'Logs' '' tab.<br />
 
−
You can find here information related to user or admin who requested unban action and its date.<br/>
 
−
Use  '' 'Clear Logs' '' button to delete old and unnecessary log entries.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_16.png]]
 
−
|}
 
−
==Creating 3rd Party Submodule==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|The main goal of Unban Center For WHMCS is allowing you to quickly and easily create additional submodules.<br />
 
−
All you need is a little knowledge of PHP programming language and documentation of integrated module API.<br />
 
−
Required information regarding the submodule itself is located inside the exemplary submodule.<br />
 
−
It can be found at '' 'your_whmcs/modules/addons/unbanCenter/submodules/'. ''<br />
 
−
Owing to that, you are able to make your offer much more competitive and extend it to other systems, control panels and servers.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_17.png]]
 
−
|}
 
−
{|'
 
−
|style="padding: 0px 0px 30px 15px;"|Start with renaming copy of '' 'sample' '' folder to the name used by 3rd party module. <br />
 
−
Let's say folder with module to integrate with Unban Center For WHMCS, which is located in '' 'your_whmcs/modules/servers/' '' is named '' 'dummyIntegration'. ''<br />
 
−
For that case, your folder at '' 'your_whmcs/modules/addons/unbanCenter/submodules/' '' should be named '' 'dummyIntegration'. ''<br />
 
−
File '' 'sampleUnbanSubmodule' '' located in the previously renamed folder should be renamed to '' 'dummyIntegrationUnbanModule'. ''<br />
 
−
Afterwards, edit file '' 'dummyIntegrationUnbanModule' '' and follow instructions inside.
 
−
|}
 
 
=Tips=
 
=Tips=
 
{|
 
{|
Line 411: Line 170:
 
|}
 
|}
  
−
=Common Problems=
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|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/>
−
|}
+
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/>
−
|style="padding: 0px 0px 5px 15px;"|2. After update some functionalities are not working properly.<br />
+
−
''Cause:'' Your browser store old JavaScript in its cache.<br />
+
−
''Solution:'' Reload full page by using key combination to [http://en.wikipedia.org/wiki/Wikipedia:Bypass_your_cache bypass your cache].
+
 
|}
 
|}
 +
=Common Problems=
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|3. When upgrading your module to the latest version to run on WHMCS V6.x.x, remember to insert appropriate integration code for the template you are using.<br/>
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
There is a different code for template ''Five'' and for template ''Six.''  
+
 
|}
 
|}

Latest revision as of 12: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