Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Management of Packages)
 
(594 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<meta name="keywords" content="dns manager for whmcs, dns manager configuration, dns manager management, dns manager installation, dns manager guide, modulesgarden dns manager, dns manager wiki, dns manager tutorial, dns manager tips, dns module wiki, dns manager common problems, about dns manager, dns manager documentation, dns manager faq, dns manager help"></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 DNS 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/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
=About [http://www.modulesgarden.com/products/whmcs/dns_manager/features DNS Manager For WHMCS]=
+
 
{|
 
{|
|style="padding: 10px 0px 10px 0px;"|'''DNS Manager For WHMCS''' is fully featured addon module that allows your customers to manage their DNS zones.<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.
A great choice of submodules together with options such as creating ready packages make DNS Manager for WHMCS perfectly adapt to your specific needs.<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 />
As an administrator you have full control over DNS zones and access to broad range of management options.<br />
+
You can also define email templates and view details of each sent notification owing to logs.
<br />
+
Wiki of DNS Manager For WHMCS 1.9.10 can be found [http://www.docs.modulesgarden.com/index.php?title=DNS_Manager_For_WHMCS&oldid=19472 here].
+
 
|}
 
|}
 
<!--a comment maybe? -->
 
<!--a comment maybe? -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Define DNS Servers
+
|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;"|✔ Define Packages
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ View And Edit Existing Zones
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Migrate Zones Between Chosen Servers
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Import Zones From Chosen Server
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define DNS Records Set
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Automated Tasks And Execution Time
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Select Default Client Area Template
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Allow To Create PTR Record Without DNS Zone
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Administrator Notifications And Choose Who Send Them To
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Modify Notifications Email Templates
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Logs And Notifications Settings
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Details And Notifications Related To Zones And Servers Load
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Information About Automated Tasks
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Scheduled Tasks Progress
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Display Usage Of DNS Servers
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Email Notifications Statistics
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs
+
|}
+
*'''Client Area Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ View List Of Owned Packages
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Add And Manage New Zones Within Package Limit
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Add And Manage Zones Records Within Records Limits
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Add And Manage PTR Records Without DNS Zone
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle DNSSEC For Zone
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View DNSSEC Details Of Zone
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Restore Zone From DNS Records Set
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Zones Limit Per Package
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ View DNS Records Limits Per Zone
+
|}
+
*'''Automation Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Provision Packages
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Migrate Zones
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Import Zones
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Clear Unused Zones
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Clear Logs
+
|}
+
*'''Server Settings:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Allow rDNS
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable DNSSEC
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Allow Multiple PTR
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Use Cache To Optimize Loading Time
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Define Nameservers
+
|}
+
*'''Package Settings:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Define Zones Limit Per Package
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Items (Products/Domains/Products Addons) Purchase Of Which Results In Receiving Package
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define If Single Instance Of Package Should Be Assigned To Each Client
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Servers Used By Package
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Allowed Record Types
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Total Records Limit
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Record Limits Per Type
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Automation Settings For Creating First Zone
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Default DNS Records Set
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Allow Client To Restore Zone Using Chosen DNS Records Sets
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Toggle Client And Administrator Notifications
+
|}
+
*'''Supported DNS Servers:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ 4PSA
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ AtomiaDNS
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ cPanel & cPanel DNSOnly
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ DirectAdmin (DNSSEC Support)
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ DNS Made Easy
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ DNS Pod
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ DNS.com
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ DynDNS
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ EuroDNS
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Freenom
+
|}
+
{|
+
|style="padding: 0px 0px 00px 30px;"|✔ Nettica
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ OpenSRS
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Plesk
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ PowerDNS (DNSSEC Support)
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ PowerDNS Hosted
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Rackspace
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Rage4 DNS
+
|}
+
{|
+
|style="padding: 0px 0px 00px 30px;"|✔ RRPProxy
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ SimpleDNS
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Storm On Demand
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Zonomi
+
|}
+
*'''Supported DNS Record Types:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ A
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ AAAA
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ AFSDB
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ CNAME
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ DNAME
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ DS
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ HINFO
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ ISDN
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ LOC
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ MB
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ MD
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ MF
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ MG
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ MINFO
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ MR
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ MX
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ NAPTR
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ NS
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ PTR
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ RP
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ SOA
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ SRV
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ TXT
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ WKS
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ X25 
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ IDN Zones Supported
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ AJAX Loaded Pages In Admin Area
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Template Customization Support
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>IP Manager For WHMCS</u> - Complete Management of IP Subnets [http://www.modulesgarden.com/products/whmcs/ip_manager/features (read more)]
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Connect With DNS Manager Using Its API
+
|}
+
{|
+
|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 30px 30px;"|✔ Supports WHMCS V5 and V6
+
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''In this short tutorial we will show you how to successfully install DNS 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: 0px 0px 20px 15px;"|'''1. Log in to your client area and download DNS Manager For WHMCS.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_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 these.
+
'' '''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:DNS2_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''3. When you install DNS Manager 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/addons/dns_manager/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:DNS3.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 licence key between quotation marks as presented on the following screen. You can find your license key in your client area → '' 'My Products'. ''
+
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:DNS4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|<span style="color: red">'''5. This steps is required only if you are using WHMCS V5.x.x'''</span><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 />
Open your currently used template: ''yourWHMCS Templates → Default → header.tpl''<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' ''.  
Find line (usually it is line no 66): 
+
  <nowiki><li class="divider"></li></nowiki>
+
Insert this code snippet above that line: 
+
<nowiki><li><a href="index.php?m=DNSManager2">DNS Manager</a></li> </nowiki>
+
Correctly inserted code should look like these:
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DNS61.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''Note! There is no integration required for WHMCS V6.x.x!'''
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
+
Login to your WHMCS admin area. Click '' 'Setup' '' then choose '' 'Addon Modules'. ''<br />
+
Afterwards, find '' 'DNS Manager' '' and press '' 'Activate' '' button.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_3.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''7. In the next step you need to permit access to this module. To do so click on '' 'Configure' '' button, choose '' 'Full Administrator' '' and press '' 'Save Changes'.'' '''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_4.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''9. Good job! You have just successfully installed DNS Manager For WHMCS! Now in your WHMCS system press '' 'Addons' '' then press '' 'DNS Manager'. '' '''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_6.png]]
+
 
|}
 
|}
  
=Configuration and Management=
+
==Configuration of Addon==
 
{|
 
{|
|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 whole module functionality.<br/>In the first part '' 'Basic Configuration' '' an exemplary flow of basic configuration of servers, through creating packages and then zones management<br/> from both the client and the administrator side has been presented.<br/> In the second part, there are described additional settings and tools that can be used while working with DNS Manager For WHMCS.  
+
|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.
 
|}
 
|}
==Basic Configuration==
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In the first place we would like to show you the process of configuring your DNS manager on a simple example.<br/>Follow the steps below to see how the process looks like in practice.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
Proceed to  '' 'Addons' → 'DNS Manager'. '' There are several sections, but the one that you should be interested in the most in the beginning is named '' 'Servers', ''<br/> you will find it under '' 'Settings' '' tab.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_6_1.png]]
+
|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 '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
===Servers Configuration===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|To start your work, add a new server.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS_7.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|To add a new server you must fill out some data to allow connection with it. As an example, we will try to connect with cPanel server.<br/>Additionally, you may declare here whether you need rDNS, Multiple PTR or Cashe. Select the chosen options.<br/><br/>
+
Please note, that there is also option '''Enable DNSSEC''' available. However, it is currently compatible only with '''DirectAdmin''' and '''PowerDNS''' submodules.<br/>
+
DNSSEC ''(DNS Security Extensions)'' - allows enabling validation and authentication of the origin and integrity of DNS data.<br/> If you enable this option, the client will be allowed to turn on DNSSEC for a zone and display its DNSSEC-related details accordingly.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS_8.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|Once you have chosen a server from the dropdown menu, '' 'Configuration' '' and '' 'Nameservers' '' tabs appear.<br/>Enter your username, password, Hostname/IP and any other details needed to connect successfully.<br/> Now, press '' 'Nameservers' '' and enter the nameservers that will be visible for your customers in their client area. <br/>
+
Before you save the changes remember to test the connection.<br/><br/> ''Please also note that the configuration differs per selected submodule!''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS_9.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Now, that you have a ready server on the list of servers you may manage it. Turn it on/off, edit or delete.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS_10.png]]
+
 
|}
 
|}
  
===Management of Packages===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Packages - these are sets of products that will be sold and within which zones can be created by a client.<br/> '' 'Add' '' a new package to see how to configure it and what exactly you may specify there.
+
|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 20px 25px;"|[[File:DNS_11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|In general section you must obviously name the newly created package and define the number of zones per item ''(limit of zones that a client may then create within this package).''<br/> Here, you can also decide if zones should be created automatically after defined actions.<br/> These are:
+
*New Item
+
*Pending Transfer Domain
+
*Pending Registration Domain
+
*Domain with DNS Management
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS_12.png]]
+
|}
+
====Items====
+
{|
+
|style="padding: 10px 0px 15px 15px;"|Assign Domains, Products or/and Product Addons from available to the package. Here you can also allow clients to create their own free zones.<br/>
+
Simply select option under '' 'Other' '' section. Remember that you may use this option for one package only.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS_13.png]]
+
|}
+
====Servers====
+
{|
+
|style="padding: 10px 0px 15px 15px;"|Assign the package to the previously added server.<br/>
+
''Note! You may always assign the package to more than one server.''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS_14.png]]
+
|}
+
====Record====
+
{|
+
|style="padding: 10px 0px 20px 15px;"|In this part you may define which type of records you want to allow, declare their limit and choose record sets.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS_15.png]]
+
|}
+
====Registrars====
+
{|
+
|style="padding: 10px 0px 20px 15px;"|In this part you may define which type of records you want to allow, declare their limit and choose record sets.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS_15_1.png]]
+
|}
+
====Notification====
+
{|
+
|style="padding: 10px 0px 20px 15px;"|In the last part you may configure which notification will be sent to clients and administrators.<br/> Do not forget to '' 'Add' '' the newly configured package.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS_16.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Enable the newly created package to allow it to be used!
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS_17.png]]
+
 
|}
 
|}
  
===DNS Management in Client Area===
+
=Configuration and Management=
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Now, that we already have the module configured you may see how clients will add and then manage their zones.<br/> In client area find button  '' 'DNS Management', '' it will redirect you to the management page.
+
|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 30px 25px;"|[[File:DNS2_18.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.
 
|}
 
|}
====New Zones====
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|In here, clients may add new zones. To do so, simply type in the name of the zone and choose IP address from the available or enter your custom IP.<br/> It depends on your configuration - read more about possible options [http://www.docs.modulesgarden.com/DNS_Manager_For_WHMCS#Other here].
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_19.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 20px 25px;"|[[File:DNS2_19_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Allowed actions on a zone:
+
|style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br />
*edit existing zone (1)
+
As you can see, we have defined limits for both bandwidth and disk.<br />
*delete zone (2)
+
Settings shown below result in sending notification to client upon:
*create zone on the server (3)
+
*bandwidth usage growth by 5GB during 21 days.
 +
*disk usage growth by 100GB over period of 14 days.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_20.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Press '' 'Edit' '' to see details of the zone, you may edit the zone here and add new records if limits allow you.
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_45.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Enter new record's name, choose type from available etc.
+
|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 30px 25px;"|[[File:DNS2_46.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
|}
+
====Enable DNSSEC====
+
{|
+
|style="padding: 10px 0px 15px 15px;"|If '' 'Enable DNSSEC' '' option has been selected ''('DirectAdmin' and 'PowerDNS' submodules),'' client may turn it on. <br/>
+
To do so, press '' 'DNSSEC' '' button. 
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_45_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Enable DNSSEC here, you will then get access to DNNSSEC details for the zone, including keys and delegation signer records.<br/>
+
Press '' 'Rectify Zone' '' to comply with DNSSEC.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_45_3.png]]
+
|}
+
 
+
====Add rDNS Records====
+
{|
+
|style="padding: 10px 0px 20px 15px;"|If you have enabled '' 'Standalone rDNS' '' option (read more [http://www.docs.modulesgarden.com/DNS_Manager_For_WHMCS#Other  here]) in  global settings, your clients can create PTR records for IPv4 and IPv6 addresses without any related zone. <br/> To do so press '' 'Manage Reverse DNS'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_63.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Find and press '' 'Add PTR' '' button.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_64.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Select related item, then depending on the configuration enter IP address or choose IP or Subnet from the available list.<br/>''Note! Subnets are available only if you have integrated your DNS Manager with IP Manager For WHMCS - see below options for more details.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_65.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|You newly created rDNS record should appear on the list. You may edit RDATA or delete the record completely.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_66.png]]
+
|}
+
 
+
===Zones Management===
+
{|
+
|style="padding: 10px 0px 20px 15px;"|In administrator panel, there are visible all clients' zones. As an admin, you will see whose zone it is, its type,<br/> on which server it is created and its status (created/deleted).
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_21.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Actions on zones from the admin area:
+
*change related item - choose one from a dropdown menu of available items and save changes
+
*edit zone
+
*create - use this button to create zone on the server
+
*delete - if you use this button, zone will be deleted both from WHMCS and from the server
+
*remove from WHMCS - zone will still be available on the server
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_22.png]]
+
|}
+
 
+
==Additional Tools==
+
===DNS Records Sets===
+
{|
+
|style="padding: 10px 0px 20px 15px;"|Create ready made sets of DNS records. You will find them in '' 'Settings' → 'DNS Records Sets'. '' <br/>Press '' 'Add Set' '' to create a new one.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_23.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Enter the newly created set name and then choose records from the dropdown menu, press '' '+'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_24.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Now, fill out the data as required.<br/>
+
''Note: You may add adequate variables for domain and IP address and then these fields will be automatically changed to domain/zone IP when this record set is used.''<br/>
+
''All you have to do is add the following variable in DNS Records Set:''<br/><br/>
+
For domain:<br/>
+
''{$domain}''<br/>
+
For IP address:<br/>
+
''{$ip}''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_25.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Created DNS Records Sets can be then used while preparing ready packages, as it was described. <br/>Ready made sets allow much faster and more personal configuration of packages.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_26.png]]
+
|}
+
 
+
===Global Settings===
+
{|
+
|style="padding: 10px 0px 20px 15px;"|This section has been designed to allow quick and simple configuration of global settings from one place.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_27.png]]
+
|}
+
====Templates====
+
{|
+
|style="padding: 10px 0px 15px 15px;"|Choose a default template that will be used in client area.<br/>
+
If you have more than one template then you may allow your clients switch between them.<br/>
+
Decide whether you wish to use ready-configured redirection to DNS Management page in client area.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_28.png]]
+
|}
+
====Notifications====
+
{|
+
|style="padding: 10px 0px 15px 15px;"|In this part, set which notification should be sent to clients and which to administrator. Select the ones that interest you.<br/>
+
Press '' 'Modify' '' and you will be quickly redirected to the email template page where you can adjust it to your needs.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_29.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Use '' 'Exclude' '' button to specify domains, products and addons that zones assigned to them will NOT be included in notifications.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_30.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Use '' 'Include' '' button to specify which admin users notifications will be sent to.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_31.png]]
+
|}
+
 
+
====Logs And Notifications====
+
{|
+
|style="padding: 10px 0px 20px 15px;"|In this part you may impose when log entries and notifications should be removed from the system database. <br/>If you wish you may also check option '' 'Log Successful Actions' '' to store all entries in logs ''(DNS Manager → Settings → Logs).''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_32.png]]
+
|}
+
====Other====
+
{|
+
|style="padding: 10px 0px 20px 15px;"|Box with '' 'Other' '' options available is a crucial part of configuration where you can manage IP Manager For WHMCS module integration and manage PTR records creation. <br/>Besides, here you can switch off the guide with simple instructions visible on dashboard. 
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_62.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''Standalone rDNS''' - Create PTR records for IPv4 and IPv6 addresses without a related zone. If this option is enabled your clients will be allowed to add reverse DNS  with no zone related.<br/> To do so proceed to '' 'Manage DNS' → 'Manage Reverse DNS' '' in your client area.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_66_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''Related Service IPs Only''' - create zones and PTR records with a related IP address only.<br/> When adding a new zone/PTR record you can choose from available hosting related IP addresses only as marked on the screen below.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_67.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''Owned Domains Only''' - restrict clients to manually create zones using their own domains only.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_67_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''Custom Subnet IP''' - create zones and PTR records with an IP address included in a subnet related to the product. <br/>
+
''Note! This option works only if you have integrated your DNS Manager with IP Manager For WHMCS.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_68.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''revDNS Custom IP''' - create PTR records with a custom IP, enter a new IP address to create a new PTR.<br/> ''Note! Both IPv4 and IPv6 are supported by DNS Manager For WHMCS.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_68_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''Custom IP''' - create zones with a custom IP, you have no IP addresses to choose from, you have to enter a new IP address.<br/> ''Note! Both IPv4 and IPv6 are supported by DNS Manager For WHMCS.''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_69.png]]
+
|}
+
 
+
===Cron Jobs===
+
{|
+
|style="padding: 10px 0px 20px 15px;"|In order to manage your cron job tasks proceed to '' 'Tools' → 'Cron'. ''<br/>Here, you will find four information boxes, each one responsible for management of a separate cron task.<br/> These are: migration, import, synchronization and cleaner.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_33.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|At the very top, there is an info box with general cron details, such as recommended time interval of cron execution (5 minutes is suggested),<br/> the last execution time and run time period. ''(Keep it as frequent as possible!)''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_34.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''Cron Migration''' - responsible for calling added tasks to migrate zones between servers. Choose interval and declare how many zones can be migrated during a single execution.<br/>'''Cron Importer''' - responsible for calling added task to import zones from an external server to WHMCS. Choose interval and declare how many zones can be imported during a single execution.<br/> '''Cron Synchronization''' - this cron job is responsible for regular synchronization of created zones. Choose interval and declare how many zones can be synchronized during a single execution.<br/> Select '' 'Recheck Zones' '' to control already synchronized zones.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_35.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''Cron Cleaner''' - this option is a little bit more complex. Just like in case of other cron jobs, firstly choose interval and declare how many zones shall be cleared<br/> during a single execution. Then you may specify conditions of clearing zones and records.<br />
+
Zones are removed:
+
*if no longer match with any package
+
*have not been modified for a specified period of time
+
*their domain is not found in WHOIS Lookup
+
*no records are included
+
PTR Records are removed:
+
*if service is terminated or canceled
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_36.png]]
+
|}
+
 
+
===Import===
+
{|
+
|style="padding: 10px 0px 15px 15px;"|Import - this is an additional tool that allows import of zones that exist on outside servers to WHMCS.<br/> Move to  '' Tools' → 'Import' '' in your admin panel. You will find here a list of Import assignments with information on which server they are imported from,<br/> total number of already imported zones and the number of all zones, progress of import task. <br/> <br/>
+
To add a new import task press '' 'Add Import'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_37_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Choose server that you want to import zones from.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_38.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Now, when the new import task appeared on the list of awaiting imports, schedule the import.<br/>
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_37_2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|When schedule is confirmed, preview the list of imported zones to assign a client and a related product to the zone.<br/>
+
To do so, press the button as marked on the screen.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_37_3.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|A list of zones appears.<br/>
+
DNS Manager Import tool detects which client and product a domain and IP address is assigned to and automatically assigns related client and product to migrate.<br/> You can also do it manually by selecting client and product from the list of available.<br/> When ready press '' 'Import Zones' '' to import several zones at once or use action buttons for single import.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_37_4.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|If you do not schedule import tasks, regular cron execution will trigger the import.<br/> However, you always have to make sure that selected zones are assigned to related clients and products.
+
|}
+
 
+
===Migration===
+
{|
+
|style="padding: 10px 0px 15px 15px;"|'' 'Migration' '' is another useful tool that you may use to manage zones efficiently. With this tool you may migrate zones between servers. <br/>
+
Keep in mind, that when you are migrating zones from one server to another they are not imported to your WHMCS in the meantime!<br/> If you wish to update the list of migrated zones, you will have to import them to WHMCS from the final server after migration.<br/>
+
<br/>
+
Remember that migrated zones are available on both servers now! Migration does not delete zones, just copy them to the new server!
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_40.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|To add migration task, press '' 'Add migration', '' specify from which server you wish to migrate zones, and the target server, as simple as that.<br/>
+
Note! Migration does not copy DNS Manager settings, to illustrate: if you are migrating zones that exist in DNS Manager their locations for example are not updated.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_41.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Schedule the migration. Remember to confirm the action.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_41_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Move to the list of zones to assign clients and products. Press button marked on the screen.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_41_2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Select zones and  '' 'Migrate Zones' '' for mass migration or use action buttons next to single zones.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_41_3.png]]
+
|}
+
 
+
===Tasks===
+
{|
+
|style="padding: 10px 0px 20px 15px;"|You will find a list of current tasks in '' 'Tools' → 'Tasks' '' section.<br/> Among all tasks there are import tasks, migration and synchronization tasks.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_42.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|According to specifically set-up cron jobs all created tasks are regularly executed. Here, you can see current status of each task.<br/> If it is queuing for the next cron run, is currently executed, aborted or complete. Check when they were executed for the last time ''(Last Execution)'' and when the task was added. <br/>Available actions: call execution manually and remove the task.
+
|}
+
==Dashboard==
+
{|
+
|style="padding: 10px 0px 20px 15px;"|Home page of DNS Manager which can be used to get a quick and clear preview on the crucial parts of the module: added servers with number of zones created on them,<br/> summary of email messages sent to clients and finally the most important notifications.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_43.png]]
+
|}
+
<!--==Integration Codes==
+
{|
+
|style="padding: 0px 0px 15px 15px;"|With these codes you can easily change templates of your client area. You will find them in '' 'Configuration' '' → '' 'Integration Codes' '' section.<br />
+
You can download files you have to alter and check where to paste code.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_44.png]]
+
|}
+
--><br />
+
<!--==Client Area==
+
{|
+
|style="padding: 0px 0px 30px 15px;"|Find out more about dns management in your client area.
+
|}
+
===Management of DNS Zones===
+
{|
+
|style="padding: 10px 0px 20px 15px;"|Adding new DNS zone is very simple. First you need to go to your product details and open '' 'Manage DNS' '' tab. Afterwards press '' 'Add Zone'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_45.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|In next step enter your zone name, IP address and press '' 'Add Zone'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_46.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|If the operation was successful, you will see a following screen.<br />
+
In order to check your new DNS zone details press '' 'Edit' '' button.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_47.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|You will see a screen similar to the one shown below. Here you can view and edit your zone's details.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_48.png]]
+
|}
+
===Management of DNS Records===
+
{|
+
|style="padding: 10px 0px 15px 15px;"|At product view, customers can manage their DNS and rDNS records. <br />
+
To view DNS records simply go to'' 'Manage DNS' '' tab as presented on the following screen.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_49.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|Here you can view all DNS records assigned to a certain domain.<br />
+
To add new record, simply enter values to record with empty textbox fields at the bottom of page as shown on the screen below.<br />
+
You can also add multiple records at once. To do so, add new empty record by pressing '' 'More Records' '' (1) button. When you are finished, save changes by pressing '' 'Save Changes'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_50.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|You can also edit records from the list. To do so, enter changes into textboxes you want to alter and press '' 'Save Changes'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_51.png]]
+
|}
+
===Management of rDNS Records===
+
{|
+
|style="padding: 10px 0px 20px 15px;"|In order to manage rDNS go to '' 'Domain' '' → '' 'Manage DNS', '' afterwards click on '' 'Manage Reverse DNS'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS27.2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|To add new rDNS zone, press '' 'Add' '' button.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS28.2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Afterwards enter zone name, IP address, value and press '' 'Add' '' button once again.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS29.2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|You can also edit your rDNS zones. To do so, press edit button.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS30.20.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Afterwards enter desired values into textbox and press '' 'Save'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS30.20.png]]
+
|}
+
--><br />
+
<!--
+
==Template Switching In The Client Area==
+
{|
+
|style="padding: 10px 0px 15px 15px;"|Your customers can choose the complexity of zones management through switching between two templates: 'Simple' and 'Advanced'.<br />
+
To enable this functionality, go to your DNS Manager → '' 'Configuration' '' → '' 'Processing' '' and tick '' 'Allow to switch template' '' as presented on the following screen.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS51.2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|From this moment, new field '' 'Change Template' '' will show up in DNS Manager client area during zones management.<br />
+
Default template is '' 'Simple' '' and it allows your customers to edit records separately. To change template, choose '' 'Edit All Records (Advanced)' '' from a dropdown menu.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS52.2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'' 'Advanced' '' template allows your customers to edit all records. Records are grouped by type.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS53.2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|A screen below presents edit of CNAME records in Advanced template.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS54.2.png]]
+
|}
+
-->
+
==Custom cPanel Zone Templates==
+
{|
+
|style="padding: 10px 0px 15px 15px;"|You can allow your customers to create zones without cPanel Default Records. To do so you need to create your own Zone Template in the WHM.<br />
+
If you don't know how to create your own Zone Template you can follow this short guide made by cPanel: [https://documentation.cpanel.net/display/ALD/Edit+Zone+Templates Edit Zone Templates Guide]<br />
+
To apply your newly created zone template simply log in to your WHMCS and go to '' 'Addons' '' → '' 'cPanel Extended Functions' '' → '' 'Configuration'. ''<br />
+
As a module choose '' 'cPanel' '' and enter the name of your zone template in '' 'Template' '' field as shown on the screen below. Remember to save the changes.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_55.2.png]]
+
|}
+
 
+
==DNS Manager Logs==
+
{|
+
|style="padding: 10px 0px 20px 15px;"|Logs help you keep track of all the activities carried out in DNS Manager. Find them here: '' 'Settings' → 'Logs'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_60.png]]
+
|}
+
==IP Manager For WHMCS Integration==
+
{|
+
|style="padding: 10px 0px 15px 15px;"|As it has been mentioned above, some of the options in our DNS Manager For WHMCS are available if you are also using IP Manager For WHMCS simultaneously.<br/> In this section you will learn how to integrate the two products to work together.<br/>
+
Let us take a look at the IP Manager module firstly. There you have to create a subnet.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_70.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|You can do it ether for IPv4 or IPv6 type. DNS Manager For WHMCS supports both types.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_71.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|When ready, create a proper configuration and assign required products to it.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_71_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Assign created subnet to this configuration.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_71_2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_71_3.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Under '' 'Relations Configuration' → 'Products' '' define the number of IP addresses that will be allowed for a client.<br/>By default this is only one address.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_71_5.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Move to DNS Manager now and create an appropriate package where you declare limits for zones, select the product and allow records types and limits<br/> that will be provided within the purchased service.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_71_4.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Now, a client upon purchase of such service may now use assigned IP addresses from the subnet and manage the dns zones and rdns zones according to limits specified in the package.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_73.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Client may now add PTR records within the related service.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_74.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Create zones with IP addresses included in a subnet related to a service in IP Manager.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DNS2_74_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|You only need to remember that relevant options must be enabled in '' 'General Settings' '' section.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DNS2_75.png]]
+
|}
+
 
+
==DNS Manager Migrator==
+
{|
+
|style="padding: 10px 0px 15px 15px;"|If you have been already using DNS Manager For WHMCS, you can migrate data from your current system to the latest version.<br/> To do so follow the below steps:<br />
+
1. Activate DNS Manager For WHMCS V2.x.x.<br/>
+
2. Run command in your browser or in console:<br/>
+
your_whmcs_path\modules\addons\DNSManager2\cron\migration.php
+
3. Follow the steps that you see on your screen now!<br/><br />
+
''Note! It is advised to use your console to do the migration between the previous and the new versions of your DNS Manager in case you have a huge number of zones<br/>(if more than 1000, it is highly recommended).''<br/>
+
4. Once the script has run and the migration is complete you need to review the configuration of your servers to alter their naming and which is the most important '''enable migrated servers and packages.'''<br/>
+
Freshly migrated servers and packages are by default disabled.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|Once the migration of zones is ready you can migrate rDNS records.<br/>
+
To do so:<br/>
+
1. Run command in your browser or in console:<br/>
+
your_whmcs_path\modules\addons\DNSManager2\cron\ptr_migration.php
+
3. Follow the steps that you see on your screen now!<br/>
+
4. Your PTR records will be assigned to adequate zones. In case pointing domain does not exist, required zone will be created and added to the clients account (if no other user already has it).<br/>
+
5. Migrated rDNS records are visible in edition page of its zone as PTR records.
+
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
|style="padding: 10px 0px 5px 15px;"|1. Keep track of your '' 'pending' '' and in '' 'progress' '' ''' 'Tasks' ''' to set an optimum interval time for the tasks execution. <br/>
+
|style="padding: 10px 0px 30px 15px;"|
For example, set interval in the way that half of the time task is set to pending status.
+
 
|}
 
|}
{|
 
|style="padding: 0px 0px 10px 15px;"|2. 255 characters in ''TXT'' records is a maximum limit for '' 'PowerDNS' '' submodule.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|3. You may access your DNS Manager For WHMCS '''API'''. Here is a short instruction how to do that:<br/>
 
The main, required command that must be used is:
 
*'' 'dnsmanager' ''<br/>
 
Additionally, you must define '' 'action' '' with some specific value.<br>
 
These can be:
 
*'' 'getServerList' '' -  returns the list of servers in DNS Manager
 
*'' 'saveRDNS' '' - allows adding new rDNS record. Additional parameters are required here, these are:
 
**'' 'serverid' '' - ID of a server
 
**'' 'ip' '' - IP address that will be used
 
**'' 'clientid' '' - id of a client, record will be assigned to that client
 
**'' 'ttl' '' - value of TTL for record
 
**'' 'rdata' '' - record's value
 
*'' 'removeRDNS' '' - allows removing existing rDNS record. Additional, required parameters:
 
**'' 'serverid' '' - ID of a server
 
**'' 'ip' '' - IP address that will be used
 
<br/>
 
Exemplary command:
 
  
<?php
+
=Update Instructions=
 
+
// Set Vars
+
$command = 'dnsmanager';
+
$values = array( 'action' => 'getServerList');
+
$adminuser = 'DemoAdmin';
+
 
+
// Call API
+
$results = localAPI($command, $values, $adminuser);
+
var_dump($results);
+
   
+
?>
+
|}
+
<!--
+
 
{|
 
{|
|style="padding: 0px 0px 10px 15px;"|3. We recommend to run Cron once per hour.
+
|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 10px 15px;"|4. Cron checks up to 100 zones. If you have for example 200 zones, Cron will check zones from 1 to 100 first, then it will check zones from 101 to 200.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|5. If the zone is inactive or mis-configured for longer than 24 hours, Cron will automatically delete it. Single Cron run removes up to 5 such zones.
 
|}
 
{|
 
|style="padding: 0px 0px 5px 15px;"|6. '' 'Default IP' '' as the name suggests is default IP address of the zone. If you don't specify an IP address when you create a new zone, default IP will be used.<br />
 
In case you don't provide default IP neither zone IP, you won't be able to create new zone.
 
|}
 
{|
 
|style="padding: 0px 0px 5px 15px;"|7. '' 'Name' '' in PowerDNS module '' 'Connection' '' tab is the field called '' 'name' '' in the SOA record. This record is added when the zone is created.<br />
 
You can define SOA record format in the configuration of the module. Available variables are {$domain} and {$ip} in fields: '' 'Name', '' '' 'Primary', '' '' 'Hostmaster'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|8. To connect to the module using Rage4 DNS enter your API key instead of password.
 
|}
 
{|
 
|style="padding: 0px 0px 5px 15px;"|9. Variable <code>$dns_manager_is_active</code> returns true if DNS Manager Add-On is active.<br />
 
Variable <code>$dns_manager_link</code> returns a link when domain is available in DNS Manager (exists on the list in the '' 'Zones List' '').<br />
 
If you can't access DNS Management from the client area then make sure that domain for which <code>$dns_manager_link</code> is empty, is located on the '' 'Zones List'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|10. The screen below shows an example configuration of PowerDNS connection.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 25px;"|[[File:DNS57.2.png]]
 
|}
 
-->
 
 
 
=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 10px 15px;"|2. jQuery 1.9 is required to work properly.
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|3. In case you cannot see any zone records in your client area after import or migration actions, then disable cashe for the DNS server. <br/>
+
:To do so, edit the '' 'General' '' section of the server.
+
|}
+
{|
+
|style="padding: 0px 0px 25px 25px;"|[[File:DNS2_8x.png]]
+
|}
+
<!--
+
If after successful installation in your client area you receive following or similar error:
+
Fatal error: main() [function.require]: Failed opening required '/var/www/html/client/templates/dns_templates//lang/english.php'<br />(include_path='.:/usr/share/pear:/usr/share/php') in /var/www/html/client/templates/dns_templates/dns_controller.php on line 0
+
That means that you have forgotten to configure and save processing of your addon. Tutorial on how to configure processing you can find [http://docs.modulesgarden.com/index.php?title=DNS_Manager_For_WHMCS#Configuration_of_processing here]<br />
+
This was fixed in DNS Manager 1.6
+
|}
+
{|
+
|style="padding: 0px 0px 5px 15px;"|3. Access denied error on Test Connection it's a bug which might appear with dns only servers OR banned IP in cphulk.<br />
+
If you are sure that details are correct, please ignore this error and try to create/terminate the zones to see whether the connection is working.
+
|}
+
{|
+
|style="padding: 0px 0px 10px 15px;"|4. If you see a blank page right after installation process please make sure that you configured and saved processing options.
+
|}
+
{|
+
|style="padding: 0px 0px 5px 15px;"|5. 4PSA platform is very specific therefore it can cause some problems with DNS Manager. You may encounter problem with file privileges.<br />
+
When connecting 4PSA module requires to download .wsdl file to '' 'include/dns_modules/4psa/tmp/wsdl' ''. It might appear that after connecting, the DNS Manager won't work properly.<br />
+
To fix it you can create this directory on your own and set chmod 777 privileges. Afterwards try to connect and check whether the directory was created.<br />
+
If directory has been created and you still have problems, you will need to edit a following files:<br /><br />
+
- includes/dns_modules/4psa/tmp/wsdl/<strong>xxx.xxx.xxx.xxx_port</strong>/soap/schema/1.5/Client/Client.wsdl<br />
+
- includes/dns_modules/4psa/tmp/wsdl/<strong>xxx.xxx.xxx.xxx_port</strong>/soap/schema/1.5/DNSZone/DNSZone.wsdl<br />
+
- includes/dns_modules/4psa/tmp/wsdl/<strong>xxx.xxx.xxx.xxx_port</strong>/soap/schema/1.5/System/System.wsdl<br /><br />
+
Afterwards please change the content of the files below:<br />
+
FROM:<br />
+
<soap:address location="<span style="color: #0000ff;">https://</span><strong style="color: #ff0000;">some_hostname:port</strong>/soap/client_agent.php"/><br />  <br />
+
TO:<br />
+
<soap:address location="<span style="color: #0000ff;">https://</span><strong style="color: #ff0000;">YOUR_IP:port</strong>/soap/client_agent.php"/>   
+
|}
+
{|
+
|style="padding: 0px 0px 10px 15px;"|6. If you get an error: '' 'Unable to create zone:Sorry, you must enter an IP.' '', please make sure that your default IP or zone IP is not missing.
+
|}
+
{|
+
|style="padding: 0px 0px 10px 15px;"|7. If while adding ReverseDNS you get an error: '' 'Sorry, you must enter an ip. Please try again.' '', please make sure that your '' 'Default IP' '' field in module '' 'Connection' '' settings is not empty.
+
|}
+
{|
+
|style="padding: 0px 0px 10px 15px;"|8. If you get an error: '' 'Connection Error: Unable to connect to database.' '', please make sure that your database server is not blocking connection with WHMCS.
+
|}
+
{|
+
|style="padding: 0px 0px 10px 15px;"|9. If you have problems with connection make sure that port '''2086''' is open (for no SSL connections) or port '''2087''' is open (for SSL connections).
+
|}
+
{|
+
|style="padding: 0px 0px 5px 15px;"|10. If after install, you will get an ionCube encoder problem (wrong version), please open a support ticket.<br />
+
We will provide you with different version of the module encrypted with the older version of ionCube.
+
|}
+
{|
+
|style="padding: 0px 0px 10px 15px;"|11. If you are receiving a message: '' 'Operation Timed Out After 30000 Milliseconds With 0 Bytes Received.' '', make sure all the servers in the cluster are active.
+
|}
+
{|
+
|style="padding: 0px 0px 5px 15px;"|12. If you are updating your module to 1.9.10 version (compatible with the latest WHMCS v6) then remember to alter '''integration codes'''!<br/><br />
+
If you skip this step in the upgrade process the module will not work! Look at [http://www.docs.modulesgarden.com/DNS_Manager_For_WHMCS#Installation '''point 5'''] for more precise information.
+
 
|}
 
|}
-->
 

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