Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
 
(81 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="servertastic ssl for whmcs, servertastic ssl configuration, whmcs servertastic ssl management, whmcs servertastic ssl installation, whmcs servertastic ssl common problems, about whmcs servertasticssl, whmcs servertastic ssl documentation, whmcs servertastic ssl faq, whmcs servertastic ssl help, whmcs servertastic ssl guide, whmcs servertastic ssl wiki, whmcs servertastic ssl tutorial, whmcs servertastic ssl tips, whmcs servertastic ssl 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 Servertastic SSL 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 [https://www.modulesgarden.com/products/whmcs/servertastic-ssl Servertastic SSL For WHMCS]=
+
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Servertastic SSL For WHMCS''' will allow you to offer SSL certificates to your clients. They will be able to define and order a certificate directly in the client area.<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.
−
Moreover, the module will give you the access to SSL configuration details as well as enable you to terminate certificates and renew them after their expiration date.
+
Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.<br />
 +
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
 
<!--a comment maybe? -->
 
<!--a comment maybe? -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Certificate
+
|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;"|✔ Terminate Certificate
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Resend Configuration Email
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Renew Certificate
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Approver Email
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View And Edit Order ID
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Certificate Status
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Certificate Type
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Toggle Synchronization Of Expiration Date
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
*'''Client Area Features:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Configure Certificate
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View Basic Certificate Details
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Modify Approver Email
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Download Generated Certificate
+
−
|}
+
−
*'''Configurable Options:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Additional SAN Domain
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Server Count
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Certificate Validity
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Certificate Type
+
−
|}
+
−
*'''cPanel Tokens Integration:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Certificate Tokens For [https://www.modulesgarden.com/products/cpanel/servertastic-ssl Servertastic SSL For cPanel] Module
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Certificate Type
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define SAN Values
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Server Count
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Management Page Link
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Management Page Link Visibility For Client Area
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Send Generated Token Via Email
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Renewal Support - Automatically Creates New Certificate For Recurring Products After Expiration Date
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 And V7
+
 
|}
 
|}
  
−
=Installation and Configuration=
+
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure Servertastic SSL 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 20px 15px;"|'''1. Log in to our client area and download Servertastic SSL 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:ST_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 this.
+
'' '''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:e4rt5e45.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
−
 
−
==Configuration of Product==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''4. In order to create and configure a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<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 />
−
Click on '' 'Create a New Group' ''.
+
The content of PHP version files should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''5. Enter product group name and press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 +
File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. When you have a product group, you can create your 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 />
−
To create a product click on '' 'Create a New Product' ''.  
+
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:ST_7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''7. Afterwards, choose your product group and type from dropdown menus, fill in your product name and press '' 'Continue' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_8.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''8. Now, go to '' 'Module Settings' '' section, choose '' 'Servertastic SSL' '' from a dropdown menu.'''<br />
+
−
Next, click on '' 'Save Changes' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_9.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''9. Finish by filling in '' 'API Key' '' and selecting desired certificate type.'''<br />
+
−
To obtain 'API Key' log in to your '[http://reseller.servertastic.com Reseller Panel]' and click '' 'View your API Key' '':
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_10_1.png]]
+
−
|}
+
−
{|
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Additionally, mark '' 'Update Next Due Date' '' if you want to renew the certificate after reaching its expiration date (recurring products only).<br />
+
−
Confirm through pressing '' 'Save Changes' ''.<br />
+
−
''Note: You can mark '' 'Test Mode' '' to connect with the test API.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_10.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|'''Congratulations! Your module is ready for use.'''
+
 
|}
 
|}
  
−
=Management=
+
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Servertastic SSL For WHMCS allows you to offer fully configurable Servertastic certificates to your clients.<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
−
Additionally, you have the ability to view certificate details and manage each provisioned certificate.
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
 
|}
 
|}
−
==Admin Area==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the admin area you can view the details of a product and find SSL configuration status.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
−
Additionally, you can create/terminate product, resend configuration email and even change approver email.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_11.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' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In order to change approver email, fill in a new email and press '' 'Save Changes' '' as shown on the screen below.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_12.png]]
+
 
|}
 
|}
  
−
==Client Area==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Servertastic SSL For WHMCS allows your customers to order and configure SSL certificates.<br />
 
−
As you can see on the following screen, it also allows to choose from configurable options during an order.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_13.png]]
 
−
|}
 
−
===Configuration===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|A new SSL certificate needs to be configured before it can be used.<br />
 
−
Press '' 'Configure Now' '' to proceed, you will be forwarded to an external page.<br />
 
−
Proceed with configuration of your SSL certificate there.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_14.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|In the end of the process, you will receive a configuration email.<br />
 
−
As soon as you receive the email and go to the approval site, your certificate will be generated.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_15.png]]
 
−
|}
 
−
===Management===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|On the following screen you can see a successfully configured product.<br />
 
−
Here you can find provision and expiration dates, and its status.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_16.png]]
 
−
|}
 
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Additionally, you can download the certificate.
+
|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:ST_17.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
 
|}
 
|}
  
−
==Configurable Options==
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The module enables you to set up configurable options allowing clients to define the products they order.<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.'''
−
Below you can find the list of configurable options with descriptions of how they will affect an order: <br />
+
−
'''Certificate Type''' - allows client to choose from types provided in configuration, a chosen type will overwrite configuration in '' 'Module Settings' ''.<br />
+
−
'''Years''' - client can choose the amount of years when certificate is valid. Make sure you will not exceed the maximum number of years for a particular certificate.<br />
+
−
Maximum number of years for a particular certificate type can be found after a brand name followed by '' '| ''' on the '' 'Certificate Type' '' in '' 'Module Settings' '' tab.<br />
+
−
'''Servers Count''' - (required for Thawte and most of VeriSign certificates) if applicable, its range stretches from 1 to 500.<br />
+
−
'''SAN Count''' - (SAN certificates only) client can define the maximum number of domains supported by a certificate.
+
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|1. Let's create configurable options group containing each one of presented configurable options.<br />
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
−
Start by proceeding to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Options' '' and pressing '' 'Create a new Group' ''.
+
You can enable/disable any of them, as well as alter or completely remove them.<br />
 +
Press '' 'Create New Group' '' to proceed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|2. Afterwards, fill out the form with a group name and a description, select products you wish to apply to this group by holding Ctrl and clicking on each of the products.<br />
+
|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 />
−
Afterwards, press '' 'Save Changes' ''.
+
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:ST_19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|3. Press '' 'Add New Configurable Options' ''.
+
|style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br />
 +
As you can see, we have defined limits for both bandwidth and disk.<br />
 +
Settings shown below result in sending notification to client upon:
 +
*bandwidth usage growth by 5GB during 21 days.
 +
*disk usage growth by 100GB over period of 14 days.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_20.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|4a. (Years, Servers Count, SAN Count) Now, fill in option name, select '' 'Quantity' '' option type and fill in minimum and maximum allowed quantity.<br />
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
−
Afterwards, set up price per one unit and press '' 'Save Changes' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|4b. (Certificate Type, Years, Servers Count, SAN Count) Fill in option name and select '' 'Dropdown' '' from option type.
+
|style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br />
 +
The only requirement is their type being set to '' 'Product/Service' ''.<br />
 +
Additionally, you can use {if} statement, as shown below:
 +
{if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if}
 +
{if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if}
 +
It will allow you to use this email template for bandwidth and disk notifications at the same time.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_22.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|5. Now, you have to add each option separately.<br />
+
−
Do it by filling in its name, setting up its price and pressing '' 'Save Changes' '' for each of the options.<br />
+
−
''Note: As you may notice on the following screen, name is divided by '' 'I' '' sign. ''<br />
+
−
''The first part concerns system name of an option (or value) while the second part is a name under which option will be visible for client.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_23.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|6. Now, let's order a product using previously created configurable options.<br />
+
−
As you can see, using configurable option allows you to use fewer product while still allowing a full customization of the product.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_24.png]]
+
 
|}
 
|}
  
−
=cPanel Tokens Configuration=
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|To enable selling of certificates with [https://www.modulesgarden.com/products/cpanel/servertastic-ssl Servertastic SSL For cPanel] module, configure the token generator using the provisioning module for WHMCS. <br/>
+
|style="padding: 10px 0px 30px 15px;"|
−
Your WHMCS will now bill customers for the ordered certificates and generate tokens, which can be then used by customers to add their certificates in cPanel.
+
−
<br/><br/>
+
−
 
+
−
In order to start selling tokens for cPanel certificates you need to add a new product following the steps described in the '' '[https://www.docs.modulesgarden.com/Servertastic_SSL_For_WHMCS#Configuration_of_Product Configuration of Product]' '' section.<br/>
+
−
Select '' 'ServerTasticToken' '' from the module settings, enter your '' 'API Key' '' found in the ''step 9'' and save the settings.<br/>
+
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_25.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|After saving the settings in the  ''' '' 'Certificate Type' '' ''' dropdown, available certificates will appear.<br/>
 
−
'' '''Note:''' If you are using a test API key, first make sure that the 'Test Mode' option is enabled.''<br/><br/>
 
−
Then set the remaining options corresponding to the selected certificate:
 
−
*'''SAN Values''' - enter how many domain names can be protected with a single certificate.
 
−
*'''Server Count''' - enter how many different servers can indicate the domains protected by a given certificate.
 
−
*'''Management Page Link''' - Specify the address at which the customer will be able to see the generated certificate directly in the '' 'Servertastic' '' panel.
 
−
*'''Show Order Management Page link''' - select whether you want your customers to see a direct link to the certificate in the '' 'Servertastic' '' panel.
 
−
'' '''Note:''' Make sure that SAN and Server vaules are supported by the selected type of certificate. You can find more relevant information on [https://github.com/servertastic/servertastic-api/blob/master/api2.md#further-field-definitions here.]''
 
  
−
Finally, save the changes and do not forget to generate '' 'Custom Field' and '' 'Email Template' ''.
+
=Update Instructions=
−
 
+
−
|}
+
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_26.png]]
+
|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: 10px 0px 20px 15px;"|After placing an order for a configured product, the customer will have access to the generated '' 'certificate token' '', its '' 'status' '' and a direct link to the order at the '' 'Servertastic' '' panel (if that option has been enabled).
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_27.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|The client should now copy the token and complete the certificate configuration directly in the cPanel. <br/>
 
−
These steps are described on the [https://www.docs.modulesgarden.com/Servertastic_SSL_For_cPanel#Request Servertastic SSL For cPanel] wiki.
 
−
|}
 
−
 
−
=Tips=
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|1. When you press '' 'Renew' '' button in the admin area '' ('Client Profile → Products/Services') '', a new order for selected domain will be created.
 
−
:The admin can place it as '' 'Renewal' '' order type but only 90 days before the expiration date.
 
−
|}
 
−
 
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
 
|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: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Latest revision as of 12:02, 13 September 2018

Contents

[edit] About Hosting Quota Notifications For WHMCS

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

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

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

[edit] Installation

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

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

[edit] Installation

1. Log in to our client area and download the module.
HQN 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' › 'System' › 'PHP Info'.

PHP56 72.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

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

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

HQN 3.png
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products' .

HQN 4.png

[edit] Configuration of Addon

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

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

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

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

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

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

HQN 7.png

[edit] Configuration and Management

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

[edit] Configuration

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

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

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

You can choose between two types of resource usage counting:

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

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

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

[edit] Logs

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

[edit] Notifications

You can create as many notifications as you wish.

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

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

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

HQN 13.png

[edit] Tips

[edit] Update Instructions

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

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

[edit] Common Problems

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