Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
 
(563 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="websitepanel extended for whmcs, websitepanel extended configuration, whmcs websitepanel extended management, whmcs websitepanel extended installation, whmcs websitepanel extended common problems, about whmcs websitepanel extended, whmcs websitepanel extended documentation, whmcs websitepanel extended faq, whmcs websitepanel extended help, whmcs websitepanel extended guide, whmcs websitepanel extended wiki, whmcs websitepanel extended tutorial, whmcs websitepanel extended tips, whmcs websitepanel extended 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 WebsitePanel Extended 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/websitepanel_extended/features WebsitePanel Extended For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''WebsitePanel Extended For WHMCS''' automates provisioning and management of WebsitePanel accounts through your system.<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.
−
The module enables your customers to order and manage their web hosting accounts straight in your WHMCS client area.
+
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.
 
|}
 
|}
−
<!-- fixed -->
+
<!--a comment maybe? -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Account
+
|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;"|✔ Change Package And Password Of Account
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Log In To Each WebsitePanel Account On Click
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features Per Product
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Hosting Plan To Limit Resource Per Product
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View All WebsitePanel And WebsitePanel Extended Products And Servers In One Place
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Run API Connection Test
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Remote Access And Management Of:
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ DNS Management - Requires DNS Manager For WHMCS
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ DNS Records
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ File Manager
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ FTP Accounts
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Web Sites
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Email Accounts
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Email Aliases
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Email Domains
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Email Groups
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Email Lists
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To WebsitePanel
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Change Account Password
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With <u>DNS Manager For WHMCS</u> - Manage DNS & rDNS Records [http://www.modulesgarden.com/products/whmcs/dns_manager/features (read more)]
+
|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 WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and Later
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
 
|}
 
|}
  
−
=Installation and Configuration=
+
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure WebsitePanel Extended 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==
 
==Installation==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''1. Log in to your client area and download WebsitePanel Extended For WHMCS.'''<br />
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
−
'''Important:''' Before the installation of WebsitePanel Extended For WHMCS, install latest version of WebsitePanel For WHMCS.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''
+
|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'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install WebsitePanel Extended for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|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 />
−
File is located in '' 'modules/servers/websitepanelextended/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' ''.
+
The content of PHP version files should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.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 />
−
Enter your license key between quotation marks as presented on the following screen.<br />
+
File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
−
You can find your license key at your client area → '' 'My Products' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
−
 
−
==Configuration of Server==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''5. Now, we will show you how to configure a new product.'''<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 />
−
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' ''.
+
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:WPE_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''6. Next, enter your server name, IP address/hostname, API username and password.'''<br />
+
−
Choose '' 'Websitepanelextended' '' from a dropdown menu and press '' 'Save Changes' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_6.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''7. It is time to create a server group. To do so, click on '' 'Create Server Group' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_8.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''8. Enter name, click on your previously created server, press '' 'Add' '' and afterwards '' 'Save Changes' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_9.png]]
+
−
|}
+
−
==Configuration of Product==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|'''9. In order to create and configure a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
+
−
Click on '' 'Create a New Group' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_10.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''10. Enter product group name and press '' 'Save Changes' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_11.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''11. When you have a product group, you can create your product.'''<br />
+
−
To create a product click on '' 'Create a New Product' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_12.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''12. Afterwards, choose your product group and type from dropdown menus, enter your product name and press '' 'Continue' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''13. Now, go to the '' 'Module Settings' '' section, choose both '' 'Websitepanelextended' '' and your previously created server group from dropdown menus.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_14.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''14. Fill in '' 'Parent Space ID' '', '' 'Plan ID' '', '' 'Enterprise Server Port' '' and '' 'Portal URL' ''  fields.'''<br />
+
−
Additionally, check '' 'Create Mail Account' '', '' 'Create Temporary Domain' '', '' 'Create Website' '', '' 'Create FTP Account' '', '' 'Count Bandwidth / Diskspace' '' and '' 'Create DNS Zone' ''.<br />
+
−
Confirm through pressing '' 'Save Changes' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_15.png]]
+
−
|}
+
−
==Configuration Of Addon==
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|'''15. Now, proceed to '' 'Setup' '' → '' 'Module Addon' '' and press '' 'Activate' '' next to '' 'WebsitePanel Extended' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_16.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''16. Press '' 'Configure' '', define access to the module and press '' 'Save Changes' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_16_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''17. Now, proceed to the '' 'Addons' '' → '' 'WebsitePanel Extended' ''.'''<br />
+
−
Press '' 'Configure' '' next to the previously created product and  define which features will be available from your WHMCS client area.<br />
+
−
Mark checkbox next to the feature in order to enable them. Press '' 'Save Changes' '' to confirm those settings.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_16_2.png]]
+
 
|}
 
|}
  
−
=Management=
+
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|''' WebsitePanel Extended For WHMCS allows you to offer WebsitePanel for your clients.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
−
In addition, your client can manage their WebsitePanel from their WHMCS client area.
+
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 30px 25px;"|[[File:WPE_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
−
==Admin Area==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the admin area you can easily suspend/unsuspend service, create/terminate it and change its password.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
−
Additionally, you can change its package and log into WebsitePanel with one click.
+
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
−
|}
+
−
==Client Area==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Let's proceed to the client area. We will show you the possibilities of our module.<br />
+
−
As you can see on the following screen, besides management from the client area, module allows your client to log into WebsitePanel through one click.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_19.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|They can also easily change password at the '' 'Change Password' '' page.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_19_1.png]]
+
−
|}
+
−
===DNS Management===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|'' 'DNS Management' '' page allows your clients to view the list of DNS zones as well as quickly enable/disable them.<br />
+
−
Additionally, they can edit DNS zones, press '' 'Edit' '' to proceed.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_20.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|As you can see, the list of current DNS records is shown.<br />
+
−
To alter any of them, modify desired value and press '' 'Update' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_21.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|To add a new record, fill in its details and press '' 'Add' '' as shown on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_22.png]]
+
 
|}
 
|}
  
−
===Web Sites===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Your clients can also manage theirs sites and add subdomains to them at the '' 'Web Sites' '' page.<br />
 
−
To add subdomain, press '' 'Create' ''.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_22_1.png]]
 
−
|}
 
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, fill in subdomain name and select domain to create it on.
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
 +
You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_22_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
 
|}
 
|}
  
−
===Email Manager===
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the '' 'Email Manager' '' page your clients are able to easily add, modify and remove mailboxes.<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.'''
−
To add a new mailbox, press '' 'Create' ''.
+
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_23.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 15px 15px;"|Now, select domain for the new mailbox, fill in email address, password, owner name and email quota.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
−
Additionally, you can set up the mailbox settings through using checkboxes marked on the following screen.<br />
+
−
Press '' 'Create' '' to save this mailbox.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_24.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.
 
|}
 
|}
−
 
−
===Email Aliases===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Email Manager' '' page allows your clients to set up email aliases.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
−
Create one, start by press '' 'Create' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_25.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 15px 15px;"|Now, fill in the address of one of your mailboxes and choose its domain.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
−
Fill in the full list of email addresses to forward to and press '' 'Create' ''.
+
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_26.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
−
===Email Domains===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Our module allows even to view and remove email domains by your clients.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_27.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.
 
|}
 
|}
−
 
−
===Email Groups===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Proceed to '' 'Email Groups' '' page and press '' 'Create' '' to add a new email group.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_29.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Now, provide an email address which will be used as an email resender.<br />
+
−
Additionally, fill in the list of email addresses which should receive email and press '' 'Create' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_30.png]]
+
 
|}
 
|}
  
−
===Email List===
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the '' 'Email Groups' '' page your client can add mailing lists.<br />
+
|style="padding: 10px 0px 30px 15px;"|
−
Press '' 'Create' '' to add a new mailing list.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_31.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Now, fill in the mailing list of email address, its description and choose list moderator.<br />
+
−
Additionally, you can set up password for mailing list by filling in password and checking '' 'Require Password' ''.<br />
+
−
You can also define who can send emails through this list by selecting desired option from the '' 'Who Can Post' '' dropdown menu.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_32.png]]
+
 
|}
 
|}
  
 +
=Update Instructions=
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If you wish to add prefix to messages from this list, fill in a desired prefix into '' 'Subject Prefix' '' and mark '' 'Require Subject Prefix' ''.<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/>
−
Next, provide message size limit and fill in the list of email addresses into '' 'Mailing List Members' ''.<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/>
−
Finish through selecting additional options and pressing '' 'Create' ''.
+
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 30px 25px;"|[[File:WPE_33.png]]
+
−
|}
+
−
 
+
−
===FTP Accounts===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|All of the FTP accounts bounded to your client WebsitePanel Extended For WHMCS product are listed in the '' 'FTP Accounts' '' page.<br />
+
−
You can easily add a new FTP account, press '' 'Create' '' to proceed.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_34.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Now, fill in FTP account username, password and its home folder.<br />
+
−
Define account rights and press '' 'Create' ''.<br />
+
−
Account will be immediately created.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_35.png]]
+
−
|}
+
−
 
+
−
===File Manager===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Your clients can access and modify directories related to their WebsitePanel Extended For WHMCS products in the '' 'File Manager' '' page.<br />
+
−
As you can see, they can use a wide variety of commands marked on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_36.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Clients can also view the content of all folders inside of their home directories, set up permissions to folders and files and calculate disk space.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_37.png]]
+
−
|}
+
−
==Configuration Possibilities==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Our module allows you to offer a wide variety of products using WebsitePanel, like product with only email accounts or only access to '' 'File Manager' '' & FTP accounts.<br />
+
−
All of that can be done owing to configuration of product → '' 'Module Settings' '' and defining client area features in the  WebsitePanel Extended addon.<br />
+
−
Sample configuration of product offering only email accounts is shown on the screens below.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_38.png]]
+
−
|}
+
−
 
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_39.png]]
+
−
|}
+
−
 
+
−
=Tips=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|
+
 
|}
 
|}
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|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;"|'''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 encounter any problem related to our module, make sure to install latest version of WebsitePanel For WHMCS.
+
 
|}
 
|}

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
Tools And Applications
Translations
General
FAQ
Community