Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Configuration of Product)
 
(468 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<meta name="keywords" content="solusvm extended cloud for whmcs, solusvm extended cloud configuration, solusvm extended cloud management, solusvm extended cloud installation, solusvm extended cloud common problems, about solusvm extended cloud, solusvm extended cloud documentation, solusvm extended cloud faq, solusvm extended cloud help, solusvm extended cloud guide, modulesgarden solusvm extended cloud, solusvm extended cloud wiki, solusvm extended cloud tutorial, solusvm extended cloud tips, solusvm extended cloud module 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 SolusVM Extended Cloud For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta>
  
=About [http://www.modulesgarden.com/products/whmcs/solusvm_extended_cloud/features SolusVM Extended Cloud For WHMCS] =
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
|style="padding: 10px 0px 10px 0px;"|'''SolusVM Extended Cloud For WHMCS''' allows your customers to create and manage multiple virtual servers in your WHMCS 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.
Clients will be able to freely resize and upgrade their servers within resource limit defined by you.<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 />
The module offers a range of functionalities owing to which your clients will be able to manage backups of flexible virtual servers as well as view graphs or access console.
+
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
<!-- fixed -->
+
<!--a comment maybe? -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate User Account
+
|style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ View Server Status
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ View Graphs: Traffic, Load, Memory
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Change Server Password
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define Product Total Resource Limits:
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Dynamically - Using Configurable Options
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Statically - Using 'Module Settings' Fields
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define Resource Range To Create VPS Within It
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features Per Product
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define OS Templates Available For Rebuild
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Friendly Names For OS Templates And Nodes
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Root Password Storing In System Database
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Root Password Change After Server Creation
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Run API Connection Test
+
|}
+
*'''Client Area Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Edit/Delete Server
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Boot/Reboot/Shutdown/Rebuild Server
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Available Resources
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable TUN/TAP And PAE
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Password: Root, Client, SSH Console And VNC Console
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Boot Order
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server Status
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Graphs: Traffic, Load, Memory
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Access SSH Console - OpenVZ And Xen Only
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Access VNC Console - KVM And Xen HVM Only
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Access NoVNC HTML5 Console - KVM And Xen HVM Only
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Access HTML5 Serial Console - OpenVZ And Xen Only
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Log In To Control Panel
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Friendly Names Of OS Templates
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Send Email Templates After Creation Of Server Based On Its Type
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Choose Server Resources While Ordering And Upgrade/Downgrade Them Freely
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Supports OpenVZ, Xen and KVM Virtualization
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>DNS Manager For WHMCS</u> - Supports PowerDNS [http://www.modulesgarden.com/products/whmcs/dns_manager/features (read more)]
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Server Resource Usage Billing [http://www.modulesgarden.com/products/whmcs/advanced_billing/features (read more)]
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V6 and V7
+
|}
+
*'''Available Configurable Options:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Memory  Limit
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Storage  Limit
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Bandwidth  Limit
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ CPU Cores Limit
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 30px;"|✔ IP Addresses Limit
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
 
|}
 
|}
  
=Installation and Configuration=
+
=Installation=
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''In this tutorial we will show you how to successfully install SolusVM Extended Cloud For WHMCS.'''<br/>
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br />
 
We will guide you step by step through the whole installation and configuration process.
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to your client area and download SolusVM Extended Cloud 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:SC1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' 'System' 'PHP Info'.'''
+
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' 'System' 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:SC2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
Line 163: Line 72:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:SC2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''4. When you install SolusVM Extended Cloud for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
File is located in '' 'modules/servers/solusvmExtendedCloud/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:SC3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key you have to edit a previously renamed '' 'license.php' '' file.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area '' 'My Products'.''
+
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area'' 'My Products' ''.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:SC4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
|}
+
==Configuration of API Access==
+
{|
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now, we will show you how to configure a new product.'''<br/>
+
Firstly, log in to your SolusVM admin area, go to '' 'Configuration' '' → '' 'API Access' '' and press '' 'Add API User'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC5.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''7. Enter your current IP and once again click on '' 'Add API User' '' button.'''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:SC6.png]]
+
|}
+
==Configuration of Server==
+
{|
+
|style="padding: 10px 0px 15px 15px;"|'''8. Now, log in to your WHMCS admin area and go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers'. '''''<br/>
+
Afterwards, press '' 'Add New Server'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC7.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''9. Enter your server name and IP address.'''
+
*'''Username''' - fill in with API User ID
+
*'''Password''' - fill in with API User Key
+
Choose '' 'SolusvmExtendedCloud' '' from a dropdown menu and press '' 'Save Changes'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC8.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''10. After you configure your server correctly, you will see a following screen.'''<br/>
+
Test your connection by pressing '' 'Test Connection'.''<br/>
+
Now, you need to create a new group for your server. For that purpose press '' 'Create New Group'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC9.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''11. Enter name, click on a previously created server and press '' 'Add'. '''''<br/>
+
Afterwards, confirm by pressing '' 'Save Changes'.''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:SC10.png]]
+
 
|}
 
|}
  
==Configuration of Product==
+
==Configuration of Addon==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure a product, click on '' 'Setup' '' '' 'Products/Services' '' '' 'Products/Services'. '''''<br/>
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
Press '' 'Create a New Group'.''
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:SC11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|'''13. Enter a product group name and press '' 'Save Changes'.'''''
+
|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 25px;"|[[File:SC12.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''14. When you have a product group, you can create your product and assign it to SolusVM Extended Cloud.<br/>
+
To create a product click on '' 'Create a New Product'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC13.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''15. Afterwards, choose a product type and product group from dropdown menus, enter your product name and press '' 'Continue'.'''''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC14.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''16. Now, go to '' 'Module Settings' '' section, choose both '' 'SolusvmExtendedCloud' '' and a previously created server group from dropdown menus.'''<br/>
+
Afterwards, press '' 'Save Changes'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC15.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''17. Select desired virtualization and press '' 'Save Changes'. '''''<br/>
+
All options of the selected virtualization will be loaded. Note that options availability differs according to a chosen virtualization!
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC16.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''18. Now, fill out '' 'Product Configuration' '' section.
+
*'''Node''' - SolusVM node to be used
+
*'''Plan''' - SolusVM plan used
+
*'''Internal IP''' - should internal IP address be allowed
+
*'''Username Prefix''' - prefix added to SolusVM usernames
+
*'''Console Port''' - port used to connect to the console
+
*'''noVNC Encryption''' - select encryption type
+
*'''Update Usage Each''' - choose hourly or daily cron
+
*'''Overages Usage''' - choose action when usage limits are exceeded
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC17.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''19. Under '' 'Client Area Features' '' section you can define which features will be available for your clients.'''<br/>
+
Feature is enabled when checkbox next to it has been marked.<br/>
+
Additionally, you can define available OS templates and ISO images.<br/>
+
'''Important 1:''' It is advised to disable features which are not supported by chosen virtualization.<br/>
+
'''Important 2:''' Keep in mind that the root password is generated automatically for KVM virtualization upon its creation and reset.<br/>
+
There is no possibility to set your own password due to SolusVM API limitations to KVM virtualization.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:SC17_1.png]]
+
 
|}
 
|}
  
==Product With Dynamic Resources==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''20. In order to set up a product with dynamic resources, press '' 'Generate Default' '' as shown on the following screen.'''<br/>
 
Configurable options allow your clients to pick product with resources tailored to their needs.<br/>
 
Configurable options can be edited and each option can be priced. Follow to [http://www.docs.modulesgarden.com/SolusVM_Extended_Cloud_For_WHMCS#Dynamic_Server_Resources_Setup_With_Configurable_Options this article] for more information.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:SC17_3.png]]
 
|}
 
==Product With Static Resources==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''21. You can also provide your clients with static resources.'''<br/>
 
Simply, fill out the fields marked on the screen below with desired limits and press '' 'Save Changes'. ''<br/>
 
''Note: Make sure that this product does not have any configurable options assigned otherwise they will overwrite limits provided in this step.''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC17_4.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''22. Define resource range limits for new VPS.'''<br/>
 
Set limits within which clients will be allowed to create their virtual machines. It will let you impose some borders on the created VPS.
 
|}
 
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:SC17_5.png]]
+
|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 15px;"|'''You have just finished the installation and configuration of the module!'''
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
 
|}
 
|}
  
=Management=
+
=Configuration and Management=
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''SolusVM Extended Cloud For WHMCS is very simple and convenient in use. Your customers are only a few clicks away from creating their own servers.'''<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.'''
The module will allow your customers to manage multiple servers and freely change their resources. Everything within your own WHMCS client area.<br/>
+
Owing to integration with Advanced Billing For WHMCS you can even offer product, which your client will be billed for depending on its usage.
+
 
+
 
|}
 
|}
==Interface==
+
==Configuration==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Now, let's check the interface of the module in the client area where you customers can create and manage virtual servers.<br/>
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
''Note: Screen below presents the module right after creation of the product. More features will be displayed after creating a server.''
+
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:SC18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|You can manage each product from your WHMCS admin area.<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 />
In addition to that, each VPS created by your clients can be easily monitored.
+
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 30px 25px;"|[[File:SC19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
==Management of Servers==
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Let's start by creating a new virtual server. To do so, click on '' 'Create Virtual Server' '' button.
+
|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:SC20.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Set server resources and click on '' 'Add New Virtual Server' '' button.
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:SC21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|As you can see on the screen below, virtual server has been successfully created.<br/>
+
|style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br />
Now let's see how we can manage our new server. To proceed, click on '' 'Manage' '' button.
+
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:SC22.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|One of the most interesting and useful options offered to the users is the upgrade.<br/>
+
Upgrade allows your customers to request a change of virtual server resources.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC23.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|Set details of server upgrade and click on '' 'Upgrade' '' button.<br />
+
Upgrade is done automatically, no e-mail notifications or confirmation are sent.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC24.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|As you can see on the following screen, virtual server has been upgraded.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC25.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Right next to '' 'Upgrade' '' option, there are '' 'Graphs'. ''<br/>
+
Press it to see generated statistics on '' 'Network Traffic', 'Load Average' '' and '' 'Memory Usage'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC25_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|For more information about management of already created virtual server visit [http://www.docs.modulesgarden.com/SolusVM_Extended_VPS_For_WHMCS#Management_of_Server SolusVM Extended VPS For WHMCS Wiki]
+
 
|}
 
|}
  
==Dynamic Server Resources Setup With Configurable Options==
+
=Tips=
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|If you want to allow your clients to dynamically set servers with resources they choose, follow these steps.<br/>
+
|style="padding: 10px 0px 30px 15px;"|
Firstly, you should have a ready product. For more information on how to create one, head to '' '[http://www.docs.modulesgarden.com/SolusVM_Extended_VPS_For_WHMCS#Configuration_of_Product Configuration of Product]' '' instruction.<br/>
+
The final result visible on the order form should be similar to the one presented on the screen below.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC28_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|If automatically generated configurable options do not fulfill your clients' needs, you can edit them using [http://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options this guide].
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC28_2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|If you decide to set pricing per server resource ordered, you can find instruction for it [http://www.docs.modulesgarden.com/General#Setting_Up_Pricing_For_Configurable_Options here].
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:SC28_3.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|If you prefer to charge your clients for server resources they actually use, you can use our [http://www.modulesgarden.com/products/whmcs/advanced_billing/features Advanced Billing For WHMCS] module.
+
 
|}
 
|}
  
==Management of DNS==
+
=Update Instructions=
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|When you combine SolusVM Extended Cloud For WHMCS with  [http://www.docs.modulesgarden.com/index.php?title=DNS_Manager_For_WHMCS&oldid=19472 DNS Manager For WHMCS], your clients will be able to manage PowerDNS zones and records from the client area.<br/>
+
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
DNS Manager For WHMCS will allow your customers to manage DNS zones, records and ReverseDNS.<br/>'' '''Important:''' SolusVM Extended Cloud For WHMCS is compatible with DNS Manager For WHMCS V2.x.x.''
+
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 20px 15px;"|To connect both modules, go to '' 'Settings' → 'Packages' '' section of DNS Manager and add a new package.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC2_26.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Name the package and provide any details you find useful. Then proceed to '' 'Item' '' section.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC2_27_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Select SolusVM Extended Cloud from the list of products and click on '' 'Add' ''.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC2_27.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Your package should now appear on the list. To change its status click on the button as shown below.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC2_28.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|To change its status click on the button as shown below.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC2_29.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Afterwards, buttons 'Manage DNS' and 'Manage Reverse DNS' will appear in the client area as shown on the screen below.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC2_30.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|You can find 'Manage DNS' option also in the left menu.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC2_30_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Depending on previously chosen settings, your customers will be able to add and remove DNS zones.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:SC2_31.png]]
 
|}
 
 
==Management of Billing==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|When you combine SolusVM Extended Cloud For WHMCS with [http://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br/>Enable '' 'Usage Records' '' extension for Solus Cloud products.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC29.png]]
 
|}
 
{|
 
|style="padding: 10px 0px 20px 15px;"|The module allows you to charge your customers basing on the server resources used by them. Set free limits and pricing for used records.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC29_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display the current server resource usage and its cost for your customers.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:SC30.png]]
 
|}
 
 
==Update of Products==
 
{|
 
|style="padding: 10px 0px 30px 15px;"|Our module is entirely compatible with SolusVM Pro module and you can easily upgrade your existing products without losing your settings.<br/>
 
1. Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' → '' 'Module Settings' '' of your product and switch '' 'Module Name' '' from '' 'Solusvmpro' '' to '' 'SolusvmExtendedCloud' ''.<br/>
 
2. Proceed to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and switch your server type from '' 'Solusvmpro' '' to '' 'SolusvmExtendedCloud' ''.<br/>
 
3. Now, click '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' → '' 'Module Settings' '' of your product and make sure that '' 'Server Group' '' is set up correctly.<br/>
 
4. The last step is generating default configurable options and custom fields through clicking on '' 'Generate default' '' button.<br/>
 
Your SolusVM Extended Cloud product is ready to use!
 
|}
 
==Debug Mode==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|SolusVM Extended Cloud is a very complex module. Therefore many things might go wrong.<br/>
 
To help you quickly solve various problems usually connected with WHMCS product/server configuration and SolusVM server configuration, we created '' 'Debug Mode'.''<br/>
 
To enable it, go to '' 'Module Settings' '' of your product and tick '' 'Debug Mode' '' as shown on the screen below.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC31.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Afterwards, go to '' 'Utilities' '' → '' 'Logs' '' → '' 'Module Log' '' and click on '' 'Enable Debug Logging' '' in order to enable it. The button should change its value to '' 'Disable Debug Logging'. ''<br/>
 
From that moment, each action performed by the module will be recorded in the log.<br />
 
In that way, you can easily check whether module correctly fetches the information about virtual servers, nodes, templates, plans etc.<br/>
 
If it does not, that indicates a problem with WHMCS product/server configuration or problem with your SolusVM server.<br/>
 
The following screen presents an exemplary module log.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SC32.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|Remember to turn off Debug Mode after you fix the problem.
 
|}
 
==Locations Management==
 
{|
 
|style="padding: 10px 0px 5px 15px;"|Underneath, you will find a short description of a real life example of managing and rotating between locations with SolusVM Extended Cloud For WHMCS.<br/>
 
Take a quick look at it and note the flow.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|Let's assume that Mr Smith has one master server called '' 'Master'. '' This is the server Mr Smith configured and connects with from WHMCS with the help of our module.<br/> This server contains 3 slave servers configured in his SolusVM environment. These are:
 
*USA
 
*Europe1
 
*Asia1<br/>
 
These three slave servers are server nodes. In this configuration example, all of Mr Smith's clients order products on '' 'Master' '' server and so they receive resources available on server 1, 2, 3.<br/> Now, when they log in to WHMCS client area, they are able to create a VPS and pick server 1, 2 or 3 from Location field.
 
|}
 
 
=Tips=
 
{|
 
|style="padding: 10px 0px 5px 15px;"|1. We made every effort to make our module as easy to install, configure and use, as possible. Therefore we paid special attention to displayed messages.<br />
 
Read carefully each message, follow the instructions and you shall have no problems with using the module.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|2. Operations performed on the virtual servers are not executed immediately. Give your SolusVM server some time to process the request and execute the operation.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|3. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.
 
|}
 
 
 
=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 5px 15px;"|2. The vast majority of problems are connected with misconfigured SolusVM server or misconfigured servers/products in your WHMCS.<br />
+
Firstly, make sure that your SolusVM server has properly configured virtual servers, nodes, node groups, templates, plans and API access.<br />
+
'''In most cases, appropriate SolusVM server configuration guarantees correct operation of the module.'''<br />
+
Afterwards, check your WHMCS server connection and product's settings. If you are certain that everything is correct, use our [[#Debug Mode|Debug Mode]].
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|3. By default our module connects with SolusVM server on port 5353. If you are using different port, you need to specify it in '' 'Hostname' '' field.<br />
+
Default port for SSL connections is 5656. To connect on that port enter your hostname as follows: '' 'yourhostname.com:5656'.'' Keep in mind that you can connect on any port.<br />
+
Field below '' 'Tick to use SSL Mode for Connections' '' switches connection type between http and https. Note that this is something different from choosing the port to connect.
+
 
|}
 
|}

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