Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Install Applications)
 
(767 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<meta name="keywords" content="directadmin extended for whmcs, directadmin extended configuration, directadmin extended management, directadmin extended installation, directadmin extended guide, modulesgarden directadmin extended, directadmin extended wiki, directadmin extended tutorial, directadmin extended tips, whmcs directadmin module wiki, directadmin extended common problems, about directadmin extended, directadmin extended documentation, directadmin extended faq, directadmin extended 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 DirectAdmin Extended For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta>
  
=About [http://www.modulesgarden.com/products/whmcs/directadmin_extended/features DirectAdmin Extended For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
|style="padding: 10px 0px 10px 0px;"|'''DirectAdmin Extended For WHMCS''' introduces automation of DirectAdmin accounts management and provisioning in your WHMCS.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''Hosting Quota Notifications For WHMCS''' allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage.
The module will also let your clients manage their web hosting accounts directly in your client area as well as install various applications with the inbuilt installer.
+
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/Suspend/Unsuspend/Terminate Account
+
|style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Change Package And Password Of Account
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Log In To Each DirectAdmin Account On Click
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Enable Automatic Suspension Of Accounts Per Product - Upon Reaching Bandwidth Limit
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features And Template Per Product
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define FTP Backups End-Points Per Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define Backup Directory Paths Per Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Choose And Configure Application Auto Installer To Use Per Product - Softaculous Or Installatron
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ View All DirectAdmin Extended Products In One Place
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
|}
+
*'''Client Area Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Remote Access And Management Of:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Applications And Their Backups
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ FTP Accounts
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Databases
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Subdomains
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Addon Domains
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Backups
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ File Manager
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Statistics
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Emails
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Email Forwarders
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Autoresponders
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Vacation Messages
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Mailing Lists
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ SPAM Filters
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Spamassasin Setup
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Cron Management
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Apache Handlers
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Error Pages
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ SSL Certificates
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Parked Domains
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Site Redirections
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ DirectAdmin
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Webmail
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ phpMyAdmin
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Account Resource Usage
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Change Account Password
+
|}
+
*'''Application Auto Installer Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Ordering Process:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Auto Install Chosen Application After Account Creation
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Auto Install Application Chosen By Client During Order - Owing To Configurable Options
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Allow Custom Settings Of Auto Installed Application - Owing To Custom Fields
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Area:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Install New Applications With Softaculous And Installatron
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ View And Manage Installed Applications
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Backup Installed Applications
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ View And Manage Created Backups
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Restore Applications From Backups
+
|}
+
{|
+
|style="padding: 0px 0px 10px 45px;"|✔ Delete Applications Along With Their Backups
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Utilizes Ajax Loaded Pages - Similar To Those From cPanel
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
|}
+
{|
+
|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 WHMCS Template Five
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
 
|}
 
|}
  
=Installation and Configuration=
+
=Installation=
 
{|
 
{|
|style="padding: 10px 0px 20px 0px;"|'''This tutorial will focus on how to successfully install and manage DirectAdmin Extended For WHMCS.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br />
We will guide you step by step through the whole installation 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 your client area and download DirectAdmin Extended 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:DA_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:DA_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''3. When you install DirectAdmin Extended for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
File is located in '' 'modules/servers/directadminExtended/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:DA_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key you have to edit a previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
Enter your license key between quotation marks as presented on the following screen. 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 30px 25px;"|[[File:DA_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
==Addon Activation==
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''5. Now, you have to activate the module in your WHMCS system.'''<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 />
Log in to your WHMCS admin area. Click '' 'Setup' '' then choose '' 'Addon Modules'.''<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' ''.  
Afterwards, find '' 'DirectAdmin Extended Cenetr' '' and press '' 'Activate' '' button.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
+
To do so, click on '' 'Configure' '' button, select required administrator groups and press '' 'Save Changes'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_6.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''7. Well done! You have just successfully installed DirectAdmin Extended For WHMCS!'''<br />
+
Now, in your WHMCS system press '' 'Addons' '' then press '' 'DirectAdmin Extended'.'' You will see a following screen. <br />
+
Let's proceed to configuration of your freshly installed module.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_7.png]]
+
 
|}
 
|}
  
==Server Configuration==
+
==Configuration of Addon==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''8. Now we will show you how to configure a new server.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
To do so log in into your WHMCS and go to '' 'Setup' '' → '' 'Products/Services' '' '' 'Servers'.''<br />
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
Afterwards press '' 'Add New Server'. ''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''9. Next, enter your server name, IP address, username and password. Choose '' 'DirectadminExtended' '' from a dropdown menu and press '' 'Save Changes'. '''''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
Here you can also provide other server details like nameservers or the maximum number of accounts.
+
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:DA2_9.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''10. After you configure your server correctly, you will see a following screen.'''<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:DA2_10.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''11. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes'. '''''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_11.png]]
+
 
|}
 
|}
  
==Product Configuration==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services'. '''''<br />
 
If you do not have a product group, click on '' 'Create a New Group'. '' If you do, simply move to step number 14.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_12.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|'''13. Enter product group name and press '' 'Save Changes'. '''''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_13.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''14. When you have a product group, you can create your product and assign it with DirectAdmin Extended. If you already have a product, jump to step 16th.'''<br />
 
To create a product click on '' 'Create a New Product'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_14.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|'''15. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue'. '''''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_15.png]]
 
|}
 
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''16. Now you need to move to '' 'Module Settings' '' section, choose both '' 'DirectadminExtended' '' and your previously created server group from dropdown menus.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
Enter your '' 'Package Name' '' and choose your '' 'Reseller IP' '' if required. DirectAdmin Extended won't work properly without specified package name.<br />
+
You can access your module in '' 'Addons' '' '' 'Hosting Quota Notifications' ''.
You can also activate the functionality to automatically suspend accounts when the bandwidth limit is reached. Simply, tick '' 'Suspend at Limit'. '' <br/> Don't forget to press '' 'Save Changes' '' in the end.  
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_16.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
 
|}
 
|}
  
==Addon Configuration==
+
=Configuration and Management=
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'''17. Go to '' 'Addon Modules' '' → '' 'DirectAdmin Extended'. '' '''<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.'''
You will find there dashboard with precise data on available products and servers:
+
*see the number of ''active/suspended/terminated'' products
+
*check the number of active accounts
+
*log into panel
+
*upgrade your DirectAdmin products
+
*press '' 'Documentation' '' tab to be moved to this very site!
+
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_17_0.png]]
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
 +
You can enable/disable any of them, as well as alter or completely remove them.<br />
 +
Press '' 'Create New Group' '' to proceed.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|'''19. Proceed to '' 'Features' '' section and find the product you are interested in and press '' 'Configuration' '' button next to it.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_17.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 15px 15px;"|'''18.  You should find there boxes dedicated to '' 'Features', 'Applications', 'Client Area Template', 'FTP Backup End Points' '' and '' 'Backup Directory Paths'.'' '''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
If you have already another product configured, you may copy its configuration now. Find one more box '' 'Copy Configuration From' '' and choose product from dropdown menu.<br/>To show you an example, we will set the configuration from the beginning, we will not use other product's configuration.<br/>
+
Select the features you would like to activate for your customers.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_18.png]]
+
|style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br />
 +
As you can see, we have defined limits for both bandwidth and disk.<br />
 +
Settings shown below result in sending notification to client upon:
 +
*bandwidth usage growth by 5GB during 21 days.
 +
*disk usage growth by 100GB over period of 14 days.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''19.  Choose whether to activate '' 'Install Applications' '' option.'''<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
In case you wish to activate this option, you will have to select '' 'Auto Installer' '' from a dropdown menu. Afterwards activate '' 'Install Button' '' and '' 'Backup Button'. ''<br />
+
You can also choose desired language of the applications by typing in its two letter code into the '' 'Language' '' field. A complete list of language codes can be found [http://softaculous.com/docs/Scripts_Language_Codes  here].<br />
+
If the field is left blank, a default value, which is '' 'en' '' (english) will be used.<br />
+
''Note: You can also create a configurable option with app to be installed, you can find the instruction to do that [http://www.docs.modulesgarden.com/DirectAdmin_Extended_For_WHMCS#Assignment_of_Configurable_Options_To_Application_Autoinstall here].''
+
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_19.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''20. Finally, select from the available which client area template shall be used for this product.''' <br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
''Note that by default only one template is available. If you have more templates prepared, they will also appear here to choose from.''<br />
+
'''Do not forget to '' 'Save' '' changes once product configuration is ready!'''
+
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_20.png]]
+
|style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br />
 +
The only requirement is their type being set to '' 'Product/Service' ''.<br />
 +
Additionally, you can use {if} statement, as shown below:
 +
{if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if}
 +
{if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if}
 +
It will allow you to use this email template for bandwidth and disk notifications at the same time.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''21. (Optional) You can define FTP backup path under '' 'FTP Backups End Points'. '''''<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
Simply, fill out form with '' 'Backup Name', 'Host', 'Port', 'User', 'Password' '' and '' 'Path to Files'.''<br />
+
Afterwards, save it through pressing '' 'Save' '' button.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_21.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''22. (Optional) Now, under Backup Directory Path enter backup path which can be found in your DirectAdmin server → '' 'Admin Backup/Transfer' '' →'' 'Local' '' textbox.'''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_22.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''23.That's all, you have just correctly created and customized a new product, now you can check the results.'''<br />
+
This is what your customers should see in their client area.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_23.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''24. From now on, all your clients who ordered a previously created product will be able to manage their DirectAdmin accounts via your WHMCS system.'''<br />
+
Here a view of the ordered product summary in admin area. Available actions:
+
*Log In To Control Panel
+
*Use Module Commands: '' 'Create', 'Suspend', 'Unsuspend', 'Terminate' '' the product; '' 'Change Package' and 'Change Password' ''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_23_0.png]]
+
 
|}
 
|}
  
=Management=
+
=Tips=
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''DirectAdmin Extended allows your customers to manage their DirectAdmin accounts via client area in your WHMCS system.''' <br />
+
|style="padding: 10px 0px 30px 15px;"|
In this short guide we will present you the possibilities of our addon module.
+
|}
+
==Your Account==
+
{|
+
|style="padding: 10px 0px 30px 15px;"|In the below sections you will find basic tools used to manage your DirectAdmin account shown and described.<br>
+
Analyze them carefully to enjoy full and easy management.
+
|}
+
===Install Applications===
+
{|
+
|style="padding: 10px 0px 20px 15px;"| Manage your applications straight from WHMCS client area. Install new applications, create backups if needed and delete unused apps.<br/>
+
''Read more about applications [http://www.docs.modulesgarden.com/DirectAdmin_Extended_For_WHMCS#Install_Applications here].
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_23_1.png]]
+
 
|}
 
|}
  
===FTP Accounts===
+
=Update Instructions=
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"| Manage FTP Accounts in the easiest possible way. Type in your login, generate a new password and select directory.
+
|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/>
Manage the accounts to be able to access your website files through an FTP protocol.  
+
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 30px 25px;"|[[File:DA2_24.png]]
 
|}
 
 
===Databases===
 
{|
 
|style="padding: 10px 0px 20px 15px;"| Owing to MySQL Management you can create/delete new databases.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_25.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|You can also add users to particular databases. Remember that you may always use secure password generator while creating a user. <br/>
 
Use action buttons to delete useless users or change their password.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_25_1.png]]
 
|}
 
 
===File Manager===
 
{|
 
|style="padding: 10px 0px 20px 15px;"|Manage files and folders of your cPanel account. Upload files, create folder to categorize the files, compress, extract etc.<br/>
 
View the list of files with specific data on them: name, file size, last modification date and given permissions.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_26.png]]
 
|}
 
 
===Subdomains===
 
{|
 
|style="padding: 10px 0px 20px 15px;"| Create subdomains for your website sections. Just choose domain from the list of available domains and type in subdomain name. <br/> Once created modify or remove the subdomain if needed.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_27.png]]
 
|}
 
 
===Addon Domains===
 
{|
 
|style="padding: 10px 0px 20px 15px;"| Add and manage your addon domains. Enter new domain name, specify bandwidth and disc space, select options you may need:
 
*'' 'Secure SSL' ''
 
*'' 'CGI Access' ''
 
*'' 'PHP Access'''
 
''Note! Make sure Addon Domains feature has been enabled for your account before using it!''
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_28.png]]
 
|}
 
 
===Backups===
 
{|
 
|style="padding: 10px 0px 15px 15px;"| This tab allows you to backup your DirectAdmin user account.<br />
 
You can select what exactly you want to backup.  Mark checkboxes next to the setting you would like to make the backup of.<br />
 
Afterwards, press '' 'Backup' '' button to order it.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_29.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"| Our module allows you to restore your backups, you can do it through pressing '' 'Restore' ''button next to backup.<br />
 
To delete backup simply press an adequate icon.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_30.png]]
 
|}
 
 
===Site Summary===
 
{|
 
|style="padding: 10px 0px 20px 15px;"|Proceed to '' 'Site Summary' '' section in order to check and analyze some statistics.<br/> Control usage level for each setting here.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_32.png]]
 
|}
 
 
==E-Mail Management==
 
{|
 
|style="padding: 10px 0px 30px 15px;"|E-mail management section includes all tools related to emails. Go through them to learn more.
 
|}
 
===Emails===
 
{|
 
|style="padding: 10px 0px 20px 15px;"| Create/edit/delete email accounts that are associated with your domains.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_33.png]]
 
|}
 
 
===Email Forwarders===
 
{|
 
|style="padding: 10px 0px 20px 15px;"| In addition to managing email accounts, you are allowed to create and delete email forwarders either.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_34.png]]
 
|}
 
 
===SPAM Filters===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|SPAM Filers give to you possibility to define SPAM settings such as:
 
*block email address
 
*block email domains
 
*block email with chosen word
 
*block email longer than specific value
 
*define action for blocked emails
 
*adult filter
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_35.png]]
 
|}
 
===Autoresponders===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|This page enables you to set up autoresponders to email boxes from this DirectAdmin accounts.<br />
 
Autoresponder replies to each email received by the email box.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_36.png]]
 
|}
 
 
===Vacation Messages===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Vacation Messages is similar to Autoresponders shown above.<br />
 
The only difference is that vacation message replies only to the first email received per email address.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_37.png]]
 
|}
 
===Mailing Lists===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|On this page you can configure your mailing lists. Create a new mailing list by providing its name. <br/>
 
Underneath, you can find a list of your mailing lists. Use action buttons to delete a list, view its details and alter settings.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_38.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Modify mailing list in '' 'Settings' '' section.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_39.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|When you '' 'View' '' the list, you will be moved to section where subscribers can be added to the list.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_40.png]]
 
|}
 
 
===Spamassasin Setup===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|On this page you can configure your Spamassasin.<br />
 
You can set up:
 
*Action performed on spam emails
 
*Threshold
 
*Define separete actions for spam emails of above defined threshold
 
*Define whether to change spam email subject or leave it intact
 
*Choose how spam should be delivered
 
*Specify blacklisted email addresses
 
*Specify whitelisted email addresses
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_41.png]]
 
|}
 
 
==Advanced Features==
 
{|
 
|style="padding: 10px 0px 30px 15px;"|Advanced tools used to configure sophisticated settings of your account.
 
|}
 
===Parked Domains===
 
{|
 
|style="padding: 10px 0px 20px 15px;"| In '' 'Parked Domains' '' section you may manage your aliases and pointers.<br/> Have access to the content of one domain from another one!
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_46.png]]
 
|}
 
 
===Site Redirections===
 
{|
 
|style="padding: 10px 0px 20px 15px;"| Easy access to site redirections is very useful. Within a few seconds, you can redirect the page to point to another.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_47.png]]
 
|}
 
===Cron Jobs===
 
{|
 
|style="padding: 10px 0px 20px 15px;"| Cron Jobs Management allows you to easily add and remove your cron jobs.<br/>
 
Choose its specific timing and type in the command to be executed.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_42.png]]
 
|}
 
 
===SSL Certificates===
 
{|
 
|style="padding: 10px 0px 15px 15px;"| This feature moves completely the management of your Private Keys, CSR Keys and SSL Certificates into your WHMCS client area.<br />
 
Here you can conveniently manage all the aspects of your SSL Certificates without the necessity to log in to your Direct Admin account.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_45.png]]
 
|}
 
 
===Apache Handlers===
 
{|
 
|style="padding: 10px 0px 20px 15px;"|Under '' 'Apache Handlers' '' page you can define custom handlers for chosen file extensions or specific files.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_44.png]]
 
|}
 
===Custom Error Pages===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Defining custom apache error pages is easy with '' 'Error Pages'. ''<br />
 
Here you can define HTML code of error pages displayed during 401, 403, 404 and 500 errors.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_43.png]]
 
|}
 
 
==Install Applications==
 
{|
 
|style="padding: 10px 0px 15px 15px;"| Install apps is a very interesting and time saving feature of DirectAdmin Extended. In seconds you can install your favorite applications without even accessing DirectAdmin! <br />
 
Firstly, you need to enable one of the two auto-installation managers. To do so, go to '' 'Addons' → 'DirectAdmin Extended Center' → 'Features' ''<br />
 
Press '' 'Configure' '' button next to a product your are interested in. There find '' 'Applications ' '' box. <br/>
 
Enable '' 'Install App' '' checkbox, select autoinstaller from a dropdown menu (you can choose '' 'Installatron' '' or '' 'Softaculous' '').<br />
 
You can also choose desired language of the application by entering value into the '' 'Language' '' field. [http://softaculous.com/docs/Scripts_Language_Codes Complete list of language codes can be found here.]<br />
 
If the field is left blank, the default value '' 'en' '' (english) will be used.<br />
 
Finish setting it up by enabling '' 'Install Button' '' and '' 'Backup Button'. '' Do not forget to save the changes.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_48.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|To see available applications list, simply click on '' 'Install Applications!' '' then click on '' 'Install New' '' button as shown on the following screen.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_49.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Afterwards you will see an extensive menu of application categories. For presentation purposes we will install '' 'Wordpress' '' located at '' 'Content Management'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_50.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Let's enter '' 'Content Management' '' category and press the button '' 'Install Now!' '' next to '' 'Wordpress'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_51.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Now you can enter necessary installation details and press '' 'Install Application' '' when ready.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_52.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|If the installation process has been successful your newly installed application will appear on the list of installed ones.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_53.png]]
 
|}
 
 
==Management of Autoinstalled Apps==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|To set up DirectAdmin Extended product with autoinstalled app, follow these steps:<br />
 
In the beginning go to '' 'Product/Services', '' find your product connected with DirectAdmin Extended and enter '' 'Custom Fields' '' tab.<br />
 
You will need to add 8 custom fields.<br />
 
These are:'' 'Directory', 'Database Name', 'Database Username', 'Database Password', 'Table Prefix', 'Site Name', 'Site Description' '' and '' 'Language'. ''<br />
 
Remember to set the field type as '' 'Text Box', '' tick '' 'Required Field ' '' and '' 'Show on Order Form'. '' Everything is shown on the screen below.<br />
 
''Note 1: 'Site Description' is needed only for Softaculous autoinstaller.''<br />
 
''Note 2: 'Database Name', 'Database Username' and 'Database Password' fields do not need to be filled upon ordering product by client.''<br />
 
''If they are not filled, database will be automatically generated.''<br />
 
''Note 3: For Installatron autoinstaller use 'Site Title' in place of 'Site Name'.''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_55.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Afterwards, go to '' 'Addons' '' → '' 'DirectAdmin Extended Center' '' → '' 'Features' → 'Configuration'. ''<br />
 
Enable'' 'Install App' '' in Applications section. Select auto installer and app to install from dropdown menus. Confirm through pressing '' 'Save' '' button.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_56.png]]
 
|}
 
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Once you add all the custom fields they will appear while placing an order.<br />
 
Voila! Now your customers can personalize each application without the necessity of installing it later. 
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_56_1.png]]
 
|}
 
 
==Assignment of Configurable Options To Application Autoinstall==
 
{|
 
|style="padding: 10px 0px 15px 15px;"| With help of its functionality you can let your clients decide which application they would like to install on their new DirectAdmin account.<br />
 
While placing an order your customer chooses application and along with account creation this very application will be installed on the account.<br />
 
There is nothing else you need to do. Application will be instantly ready to use!<br />
 
To set up this feature go to '' 'DirectAdmin Extended Functions', '' press '' 'Install Apps', '' tick '' 'Install App', 'Assign To Configurable Options' '' and choose '' 'Auto Installer'. ''<br />
 
Save these settings through pressing '' 'Save Changes' '' and click on a floppy disk icon to download the list of apps.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_57.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|These are the names of values that you can enter in configurable options fields which we will configure in the next step.<br />
 
For example, if you would like to set up '' '4images' '' in your applications list, you will need to enter value '' '4images 1.7.11'. ''<br />
 
'''1. If you make a mistake with the application name, the autoinstall will not work.'''<br />
 
'''2. If you do not enter the version number, the autoinstall will install the latest version of the application.'''<br />
 
Now, when you know what values should be entered in configurable options for particular applications, we can proceed further.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_58.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Go to your WHMCS → '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Options' '' and press '' 'Create a New Group'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_59.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Enter '' 'Group Name' '' by your choice, select product you want to assign configurable options to, then press '' 'Save Changes'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_60.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Now click on '' 'Add New Configurable Option'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_61.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|This moment is very important. As an '' 'Option Name', '' you have to type in '' 'Installation App'. '' '''In other case entire functionality will not work.'''<br />
 
Here you can set up as many applications as you want. To do so enter the name of value e.g. '' 'Wordpress 3.7.1' '' and press '' 'Save Changes'. ''<br />
 
Repeat this as many times as you need and do not forget to set the '' 'Option Type' '' to '' 'Dropdown'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_62.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|As you can see on the following screen we decided to offer our customers 5 applications.<br />
 
When you finish adding applications press '' 'Save Changes' '' and '' 'Close Window'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_63.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Afterwards go to '' 'DirectAdmin Extended', '' enable '' 'Assign To Configurable Options' '' and choose '' 'Applications' '' from a dropdown menu.<br />
 
Please note that you can have more configurable options groups. Press '' 'Save Changes' '' and that's it. You have just successfully assigned configurable options to application autoinstall.<br />
 
Let's check out what your customers are going to see in their client area while placing the order.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_64.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|As you can see a dropdown menu with our previously set up applications has shown up.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_65.png]]
 
|}
 
 
==Backups Management For Apps==
 
{|
 
|style="padding: 10px 0px 20px 15px;"| You can also create a backup of your installation. It is very easy! To do so click '' 'Create Backup'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_66.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"| After a few seconds you should see a '' 'Success' '' message as a confirmation of the operation performed.<br />
 
To manage your backups simply press '' 'Backups'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_67.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"| Here you can quickly view, delete or restore your existing backups.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_68.png]]
 
|}
 
 
==Log In To DirectAdmin==
 
{|
 
|style="padding: 10px 0px 20px 15px;"| With a single click of a button '' 'Log In To DirectAdmin' '' you can log in to your DirectAdmin without the necessity to enter login details.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_69.png]]
 
|}
 
 
==Log In To Webmail==
 
{|
 
|style="padding: 10px 0px 20px 15px;"| You can easily log in to your webmail by clicking '' 'Log In To Webmail'. '' You will be redirected to that site on the run.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_70.png]]
 
|}
 
 
==Log In To PhpMyAdmin==
 
{|
 
|style="padding: 10px 0px 20px 15px;"| In order to enter phpMyAdmin, press '' 'PhpMyAdmin' '' button as shown on the following screen.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_71.png]]
 
|}
 
 
==Management of Resource Usage==
 
{|
 
|style="padding: 10px 0px 20px 15px;"| At product overview tab you can find your product current resource usage and limits assigned to the product.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_72.png]]
 
|}
 
 
==Management of Existing Products==
 
{|
 
|style="padding: 10px 0px 30px 15px;"|'''You can easily use DirectAdmin Extended module with your already configured DirectAdmin products.<br />
 
To do so change type of servers and module names of products from '' 'Directadmin' '' to '' 'DirectadminExtended' ''.<br />
 
Additional information about how to correctly configure your servers and products you can find at points 8-16 in '' 'Installation and Configuration' '' section.
 
|}
 
 
==Management of Billing==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|When you combine DirectAdmin Extended 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 />
 
Module allows you to charge your customers basing on the server resources used.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:DA2_73.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display your customers the current server resource usage and their cost.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA2_74.png]]
 
|}
 
 
=Tips=
 
{|
 
|style="padding: 10px 0px 5px 15px;"|1. Keep in mind that user packages and reseller packages are two different things.<br />
 
When you configure a typical product for your customers in the WHMCS, you would usually need to enter one of your user packages, not the reseller packages.
 
|}
 
{|
 
|style="padding: 0px 0px 5px 15px;"|2. To manage SSL certificates, your customers require an owned IP.<br />
 
In other case module will return the following error: '' 'You can manage SSL certificates when you own the IP you are using. Info for admins: Assign an owned IP'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 10px 25px;"|[[File:DA_75.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|To add owned IP, log in to your DirectAdmin admin area, go to '' 'IP Management' '' section, add the IP and assign it to the admin.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 25px;"|[[File:DA_76.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 5px 15px;"|Afterwards manage the user for whom you want to add the IP.<br />
 
Set IP to your previously created IP, save changes and make sure that this IP will be current IP of your customer.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 25px;"|[[File:DA_77.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 5px 15px;"|If you add more IP addresses with free status in your DirectAdmin, you can quickly assign those IP addresses to your customers in WHMCS.<br />
 
For this purpose, simply type the IP in the '' 'Dedicated IP' '' field, press '' 'Enter' '' on your keyboard and update the product package through clicking on '' 'Change Package' '' button.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:DA_78.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. If you have problems with connection make sure that port '''2222''' is open.
+
|}
+
{|
+
|style="padding: 0px 0px 5px 15px;"|3. If after installation, you 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 30px 15px;"|4. You cannot change direct admin port to other than '''2222''', due to WHMCS DirectAdmin module limitation.<br />
+
DirectAdmin Extended For WHMCS rely on default WHMCS DirectAdmin module.
+
 
|}
 
|}

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