Personal tools
Namespaces

Variants
Actions

Domain Allocator For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "<meta name="keywords" content="domain allocator for whmcs, domain allocator configuration, whmcs domain allocator management, whmcs domain allocator installation, whmcs domain...")
 
(→‎About Domain Allocator For WHMCS)
 
(74 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 
<meta name="keywords" content="domain allocator for whmcs, domain allocator configuration, whmcs domain allocator management, whmcs domain allocator installation, whmcs domain allocator common problems, about whmcs domain allocator, whmcs domain allocator documentation, whmcs domain allocator faq, whmcs domain allocator help, whmcs domain allocator guide, whmcs domain allocator wiki, whmcs domain allocator tutorial, whmcs domain allocator tips, whmcs domain allocator wiki"></meta>
 
<meta name="keywords" content="domain allocator for whmcs, domain allocator configuration, whmcs domain allocator management, whmcs domain allocator installation, whmcs domain allocator common problems, about whmcs domain allocator, whmcs domain allocator documentation, whmcs domain allocator faq, whmcs domain allocator help, whmcs domain allocator guide, whmcs domain allocator wiki, whmcs domain allocator tutorial, whmcs domain allocator tips, whmcs domain allocator wiki"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Domain Gateway Allocator For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Domain Allocator For WHMCS Module."></meta>
  
−
=About [http://www.modulesgarden.com/products/whmcs/payment_gateway_allocator/features Domain Allocator For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/domain-allocator Domain Allocator For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Domain Allocator For WHMCS''' allows you to set up available domains depending on the country and the state from which your customers are.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''Domain Allocator For WHMCS''' gives your clients the opportunity to assign domains to their own hosting accounts and allows to set its type to either parked or addon.<br/>With this module domain parking and creating addon domains will be possible over the ordering process and as a measure of handling already owned domains, within both admin and client area.<br/>
−
The module supports all kinds of domains as well as countries and states from all over the world.
+
The module connects finely with web hosting accounts of cPanel, Plesk and DirectAdmin.
 
|}
 
|}
−
<!-- This is a comment -->
+
 
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Set Default Redirect Payment Gateways
+
|style="padding: 10px 0px 0px 30px;"|✔ Enable Domain Allocation For Selected Products
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Default Credit Card Payment Gateways
+
|style="padding: 0px 0px 0px 30px;"|✔ Manage Domain Assignments
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Add New Switching Rules To Payment Gateway Depending On Clients' Country And State
+
|style="padding: 0px 0px 10px 30px;"|✔ View Summary Of Domain Assignments
 
|}
 
|}
 +
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Payment Gateways Module Usage Only - Hide All Other Payment Gateways
+
|style="padding: 10px 0px 0px 30px;"|✔ Domain Allocation During Order Checkout:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Toggle Limitation Of Payment Gateways Depending On Country And State
+
|style="padding: 0px 0px 0px 45px;"|✔ Assign Domain As Parked Or Addon Domain
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Order New Web Hosting Account
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Domain Allocation In Overview Section:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Assign Domain As Parked Or Addon Domain
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Switch Domain Assignment Between Web Hosting Accounts
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 45px;"|✔ Change Nameservers To Match Web Hosting Configuration
 +
|}
 +
*'''Supported Modules:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ DirectAdmin & DirectAdmin Extended For WHMCS
 
|}
 
|}
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Pay Through Personalized Payment Gateways Adjusted To Location
+
|style="padding: 0px 0px 0px 30px;"|✔ cPanel & cPanel Extended For WHMCS
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Change Payment Method Conveniently
+
|style="padding: 0px 0px 10px 30px;"|✔ Plesk & Plesk Extended For WHMCS
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports All Redirect And Credit Card Payment Gateways
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports Every Country And State
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.3 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/domain-allocator#open-source-version Open Source Version]
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Domain Allocator For WHMCS.''' <br />
+
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/domain-allocator Domain Allocator For WHMCS.]''' <br />
 
We will guide you step by step through the whole installation and configuration process.
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Domain Allocator For WHMCS.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
Line 64: Line 83:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
−
Files in your WHMCS directory should look like these.
+
In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Domain Allocator for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
−
File is located in '' 'modules/addons/PGPC/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/>
 +
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"| <!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/domain-allocator#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory.
 +
The content of the package to upload should look like this.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:etrr5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Domain Allocator For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 +
File is located in '' 'modules/addons/DomainAllocator/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
Line 78: Line 115:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the 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'. ''
 
|}
 
|}
 
{|
 
{|
Line 85: Line 122:
 
|}
 
|}
  
−
==Configuration Of Addon==
+
==Addon Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''5. Now you have to activate the module in your WHMCS system.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
 
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Domain Allocator' '' and press '' 'Activate' '' button.
 
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Domain Allocator' '' and press '' 'Activate' '' button.
 
|}
 
|}
Line 94: Line 131:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
+
|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 desired admin role groups and press '' 'Save Changes'. ''
 
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near desired admin role groups and press '' 'Save Changes'. ''
 
|}
 
|}
Line 100: Line 137:
 
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_6.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_6.png]]
 
|}
 
|}
−
 
+
{|
 +
|style="padding: 0px 0px 30px 15px;"|'''8. You have just successfully installed Domain Allocator For WHMCS!'''
 +
|}
 +
<!--
 
==Additional Steps Required==
 
==Additional Steps Required==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''7. Now, proceed to '' 'Setup' '' → '' 'Payments' '' → '' 'Payment Gateways'. '' '''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''9. Now, proceed to '' 'Setup' '' → '' 'Payments' '' → '' 'Payment Gateways'. '' '''<br />
 
Find '' 'Redirect Per Country / State' '' and '' 'Credit Card Per Country / State' ''gateways and activate them.<br />
 
Find '' 'Redirect Per Country / State' '' and '' 'Credit Card Per Country / State' ''gateways and activate them.<br />
−
<!--'''Note: If you wish to forbid card payment or redirect payment, simply do not activate related gateway.''-->
+
'''Note: If you wish to forbid card payment or redirect payment, simply do not activate related gateway.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_x7.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. Afterwards, move to '' 'Manage Existing Gateways' '' to rename them. Press '' 'Save Changes'. '''''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''10. Afterwards, move to '' 'Manage Existing Gateways' '' to rename them. Press '' 'Save Changes'. '''''<br />
 
These gateways will be used in place of any other gateway and forward all data to a gateway depending on configuration of Domain Allocator.
 
These gateways will be used in place of any other gateway and forward all data to a gateway depending on configuration of Domain Allocator.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_x8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''9. You have just successfully installed Domain Allocator For WHMCS!'''
+
|style="padding: 0px 0px 30px 15px;"|'''11. You have just successfully installed Domain Allocator For WHMCS!'''
 
|}
 
|}
 +
-->
  
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you the possibilities of Domain Allocator For WHMCS.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''In this section we will show you the possibilities of Domain Allocator For WHMCS.'''<br/>
−
Our module allows you to define the availability of your domains depending on your customers' country or state.
+
Our module allows your clients to manage assignment of parked and addon domains.
 
|}
 
|}
−
==Settings==
+
 
 +
==Admin Area==
 +
===Dashboard===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At the '' 'Settings' '' tab you can set up the module's behavior. Configure gateway settings and default redirection rules.
+
|style="padding: 10px 0px 20px 15px;"|Here you can see the short summary on the module details and the list of all domain assignment.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 25px;"|[[File:DAlloc_9.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_7.png]]
 
|}
 
|}
 +
 +
===Products Configuration===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In '' 'Gateway Settings' '' select whether you want to allow only the two module gateways: '' 'Credit Card Per Country / State' '' and '' 'Redirect Per Country / State'. ''
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' tab you will find the list of your products. Here you can enable or disable automatic domain assignment for each of them.<br/>
−
Select '' 'Module Gateway Only' '' option -  then,  only the two above mentioned module gateways will be shown as payment options in the client area.<br />
+
''Note that not all submodules are supported thus management of your other products will not be available.''
−
'' 'Apply Switching Rules' '' - if selected, only gateways allowed by the defined switching rules are allowed in client area as payment methods.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 25px;"|[[File:DAlloc_9_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_8.png]]
 
|}
 
|}
 +
 +
===Integration Code===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Still, you have to set up '' 'Default Redirection Rules', '' no matter which option is selected in '' 'Gateway Settings'. ''<br/>
+
|style="padding: 10px 0px 20px 15px;"|In order to allow your clients to manage assignment, follow these steps.<br/>
−
Choose:
+
−
*'' 'Default CC Gateway' '' - it will be used with '' 'Credit Card Per Country / State' '' module gateway.
+
−
*'' 'Default Redirection Gateway' '' - it will be used with '' 'Redirect Per Country / State' '' module gateway.<br/>
+
−
Do not forget to save the changes when ready!
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_9_2.png]]
+
|style="padding: 0px 0px 15px 15px;"|1. Open the file found in the below directory.
 +
 +
templates/orderforms/standard_cart/configuredomains.tpl
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|2. Delete the line:<br/>
 +
{if $domain.hosting}<span style="color:#009900;">[{$LANG.cartdomainshashosting}]</span>{else}<a href="cart.php" style="color:#cc0000;">[{$LANG.cartdomainsnohosting}]</a>{/if}
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|and add the proper code:<br/>
  
−
==Gateway Switches==
+
<pre style="white-space: pre;">
 +
{if $loggedin}
 +
    {if $hostcheck}
 +
        <button data-domain-name="{$domain.domain}" class="assign_order btn btn-primary" role="button" type="button">{$btnassign}</button>
 +
    {else}
 +
        <div class="alert alert-warning alert_custom" role="alert">
 +
            {$user_no_hosting}
 +
        </div>
 +
    {/if}
 +
{else}
 +
    <div class="clear_f"></div>
 +
    <button data-domain-name="{$domain.domain}" data-toggle="modal" data-target="#loginmodal" type="button" class="login_btn btn btn-primary">{$btnlogin}</button>
 +
{/if}
 +
<div class="clear_f"></div>
 +
{if $domain.hosting}
 +
    <span class="active_hosting alert alert-info alert_custom" role="alert">{$has_hsoting}</span><br />
 +
{else}
 +
    <a class="add_hosting btn btn-primary" href="cart.php">{$no_hsoting}</a>
 +
{/if}
 +
</pre>
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Gateways Switches' '' tab allows you to define switching rules per payment gateway.<br/>
+
|style="padding: 0px 0px 20px 15px;"|3. You can see correctly placed code below.
−
You will find there a list of all active gateways in your system.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_10.png]]
 
|}
 
|}
−
===Creating New Switching Rules===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In order to limit access to a selected payment gateway, press '' '+' '' button. <br/>
+
|style="padding: 0px 0px 20px 15px;"|4. This is how it should be seen in the client area.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_10_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_11.png]]
 
|}
 
|}
 +
 +
===Client Profile===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Select a country and states ''(optional).'' The gateway will be available for clients who do purchases in that region only.
+
|style="padding: 10px 0px 20px 15px;"|When you want to assign a domain from your admin area, just look at the details in the client profile. Select '' 'Domains' '' tab and click '' 'Manage Assignment' ''.
−
Press '' 'Add' '' to complete.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_14_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Repeat the process for all gateways you wish to limit. <br/>
+
|style="padding: 00px 0px 20px 15px;"|Then select Web Hosting account to which your domain will be assigned and define this assignment type.
−
Use action buttons to edit rules or delete them.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_12.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_14.png]]
 
|}
 
|}
  
−
<!--
+
==Client Area==
−
===Modify Switching Rules===
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In order to modify switching rules, expand the desired payment gateway configuration by pressing it.
+
|style="padding: 10px 0px 15px 15px;"|Your customers can perform various actions on their domains from the client area.<br/>Read the description below to see exactly what can be done.  
 
|}
 
|}
 +
===Manage Assignment===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_13.png]]
+
|style="padding: 10px 0px 20px 15px;"|In the client area proceed to '' 'Domains' → My Domains' ''. Here clients can view basic information related to domains and perform several actions on them.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Configuration on the following screen allows this gateway to be used from United Kingdom and two states of the US - California and Texas.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_12.png]]
−
Both the country and the state in each configuration are modifiable.<br />
+
−
Select a desired option and press '' 'Save Changes'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_14.png]]
+
|style="padding: 0px 0px 20px 15px;"|Press '' 'Manage Assignment' '' to assign domain to Web Hosting Account.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To move a rule to a different gateway, press '' 'Change Gateway', '' select the desired gateway and press '' 'Save Configuration'. ''
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_14_1.png]]
+
|style="padding: 0px 0px 20px 15px;"|Select preferred options from the dropdown menu and click '' 'Submit' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_14.png]]
 
|}
 
|}
−
-->
 
  
−
===Payment Gateways On The Order Form===
+
===Register Domain===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Payment Gateway Allocator For WHMCS affects only client area. Let's take a look how the addon affects the payments process.
+
|style="padding: 10px 0px 15px 15px;"|It is also possible to register a completely new domain. Go to '' 'Domains' → 'Register a New Domain' '' and type in a name to check its availability.<br/>If so, add it to cart and click 'Checkout'.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Case One:'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_15.png]]
−
'' 'Credit Card Per Country / State' '' and  '' 'Redirect Per Country / State' '' payment methods have been activated.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_13.png]]
+
|style="padding: 0px 0px 20px 15px;"|Details will be visible now. '' 'Manage Assignment' '' to assign domain to already existing Web Hosting Account is one of the choices.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In '' 'Setting' ''  section option '' 'Module Gateway Only' '' has been selected together with two default gateways for '' 'Credit Card' '' and '' 'Redirection' '' payments.
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_16.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Just select preferred options from the dropdown menu and click '' 'Submit' '' button.
 
|}
 
|}
 
{|
 
{|
Line 224: Line 294:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Consequently, client may now choose only between:
+
|style="padding: 0px 0px 20px 15px;"|Apart from that, a new account can be ordered. To do so, press '' 'Order New Hosting Account' '' button.  
−
*'' 'Pay With Credit Card' '' option - in our case it will be '' 'SecurePay' '' gateway.
+
−
*'' 'Proceed To Payment' '' option - in our case it will be '' '2CheckOut' '' gateway.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Case Two:'''<br/>
+
|style="padding: 0px 0px 20px 15px;"|Select the hosting that suits your needs most.
−
In another scenario, in '' 'Settings' '' section of the module '' 'Apply Switching Rules' '' option is selected.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_15_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_18.png]]
 
|}
 
|}
 +
===Unassign Domain===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In '' 'Gateway Switches' '' section, there is a rule forcing clients from United States to pay with '' '2CheckOut' '' payment gateway.
+
|style="padding: 10px 0px 15px 15px;"|Clients are also given the possibility to unassign their domains.<br/>To unassign a domain go to '' 'Domains' → My Domains' '' and select one from the list.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_15_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_12.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Consequently, client Test Tester, who is from USA, has no choice, but to pay with the enforced by the admin payment gateway.
+
|style="padding: 0px 0px 20px 15px;"|Press '' 'Manage Assignment' '' to unassign domain from Web Hosting Account.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_15_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Case Three:'''<br/>
+
|style="padding: 0px 0px 20px 15px;"|Then click the button as shown here:
−
To allow all gateways in the client area, proceed to the addon → '' 'Settings' '' page and clear the settings. <br />
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_19.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Let's check payment options in the client area once again. Now, your clients are able to pay using every active payment gateway. <br/>
+
|style="padding: 0px 0px 20px 15px;"|A proper note will show up.
−
However, when selecting '' 'Pay With Credit Card' '' or '' 'Proceed To Payment' '' option, client will be redirected to a gateway keeping any switching rules.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_17.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_20.png]]
 
|}
 
|}
 +
 +
===Change Hosting Account===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If you wish to hide only part of the gateways, for example only those for which switching rules are set, proceed to '' 'Setup' '' → '' 'Payments' '' → '' 'Payment Gateways'. ''<br />
+
|style="padding: 10px 0px 15px 15px;"|Clients are also enabled to change the hosting accounts.<br/>To do so, proceed to '' 'Domains' → My Domains' '' and select one from the list.
−
Afterwards, uncheck '' 'Show On Order Form' '' checkbox next to the desired gateway and press '' 'Save Changes'. '' Repeat this step for each gateway you wish to hide from the client area.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Press '' 'Manage Assignment' '' to change the account.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Then click the button as shown here:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_19_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Now, simply choose the new account and type of assignment. Then submit your request.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_21.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You have successfully changed the account and your domain has been assigned to the new one.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_22.png]]
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|1. If you wish to forbid card payment or redirect payment, deactivate the related gateway in '' 'Setup' → 'Payments' → 'Payment Gateways'.''
+
|style="padding: 10px 0px 15px 15px;"|1. Should you encounter any problems related to nameservers, you need to check their setup in the server configuration.<br/>
 +
:Proceed to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' ''.<br/>
 +
:You need to have nameservers set for the server using cPanel, Plesk or DirectAdmin products.<br/>
 +
:Lack of their proper configuration may result in difficulties during domain assignment or changing hosting accounts.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_23.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|2. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.
 +
|}
 +
 
 +
=Update Instructions=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
 +
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
 +
|}
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
 +
 
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/domain-allocator#open-source-version Open Source version] of your Domain Allocator For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
 +
 
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 
|}
 
|}
  
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Latest revision as of 13:28, 26 April 2024

Contents

[edit] About Domain Allocator For WHMCS

Domain Allocator For WHMCS gives your clients the opportunity to assign domains to their own hosting accounts and allows to set its type to either parked or addon.
With this module domain parking and creating addon domains will be possible over the ordering process and as a measure of handling already owned domains, within both admin and client area.

The module connects finely with web hosting accounts of cPanel, Plesk and DirectAdmin.

  • Admin Area Features:
✔ Enable Domain Allocation For Selected Products
✔ Manage Domain Assignments
✔ View Summary Of Domain Assignments
  • Client Area Features:
✔ Domain Allocation During Order Checkout:
✔ Assign Domain As Parked Or Addon Domain
✔ Order New Web Hosting Account
✔ Domain Allocation In Overview Section:
✔ Assign Domain As Parked Or Addon Domain
✔ Switch Domain Assignment Between Web Hosting Accounts
✔ Change Nameservers To Match Web Hosting Configuration
  • Supported Modules:
✔ DirectAdmin & DirectAdmin Extended For WHMCS
✔ cPanel & cPanel Extended For WHMCS
✔ Plesk & Plesk Extended For WHMCS
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.10 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation and Configuration

This tutorial will show you how to successfully install and configure Domain Allocator 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.
DAlloc 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.

PHP72 74.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.
Note: Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 74.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

Etrr5.png
4. When you install Domain Allocator For WHMCS for the first time you have to rename 'license_RENAME.php' file.

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

DAlloc 3.png
5. In order to configure your license key, you have to edit the 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'.

DAlloc 4.png

[edit] Addon Configuration

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 'Domain Allocator' and press 'Activate' button.

DAlloc 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 desired admin role groups and press 'Save Changes'.

DAlloc 6.png
8. You have just successfully installed Domain Allocator For WHMCS!

[edit] Management

In this section we will show you the possibilities of Domain Allocator For WHMCS.

Our module allows your clients to manage assignment of parked and addon domains.

[edit] Admin Area

[edit] Dashboard

Here you can see the short summary on the module details and the list of all domain assignment.
DAlloc 7.png

[edit] Products Configuration

In 'Configuration' tab you will find the list of your products. Here you can enable or disable automatic domain assignment for each of them.

Note that not all submodules are supported thus management of your other products will not be available.

DAlloc 8.png

[edit] Integration Code

In order to allow your clients to manage assignment, follow these steps.
1. Open the file found in the below directory. 
templates/orderforms/standard_cart/configuredomains.tpl
2. Delete the line:
{if $domain.hosting}[{$LANG.cartdomainshashosting}]{else}<a href="cart.php" style="color:#cc0000;">[{$LANG.cartdomainsnohosting}]</a>{/if}
and add the proper code:
{if $loggedin}
    {if $hostcheck}
        <button data-domain-name="{$domain.domain}" class="assign_order btn btn-primary" role="button" type="button">{$btnassign}</button>
    {else}
        <div class="alert alert-warning alert_custom" role="alert">
            {$user_no_hosting}
        </div>
    {/if}
{else}
    <div class="clear_f"></div>
    <button data-domain-name="{$domain.domain}" data-toggle="modal" data-target="#loginmodal" type="button" class="login_btn btn btn-primary">{$btnlogin}</button>
{/if}
<div class="clear_f"></div>
{if $domain.hosting}
    <span class="active_hosting alert alert-info alert_custom" role="alert">{$has_hsoting}</span><br />
{else}
    <a class="add_hosting btn btn-primary" href="cart.php">{$no_hsoting}</a>
{/if}
3. You can see correctly placed code below.
DAlloc 10.png
4. This is how it should be seen in the client area.
DAlloc 11.png

[edit] Client Profile

When you want to assign a domain from your admin area, just look at the details in the client profile. Select 'Domains' tab and click 'Manage Assignment' .
DAlloc 14 1.png
Then select Web Hosting account to which your domain will be assigned and define this assignment type.
DAlloc 14.png

[edit] Client Area

Your customers can perform various actions on their domains from the client area.
Read the description below to see exactly what can be done.

[edit] Manage Assignment

In the client area proceed to 'Domains' → My Domains' . Here clients can view basic information related to domains and perform several actions on them.
DAlloc 12.png
Press 'Manage Assignment' to assign domain to Web Hosting Account.
DAlloc 13.png
Select preferred options from the dropdown menu and click 'Submit' button.
DAlloc 14.png

[edit] Register Domain

It is also possible to register a completely new domain. Go to 'Domains' → 'Register a New Domain' and type in a name to check its availability.
If so, add it to cart and click 'Checkout'.
DAlloc 15.png
Details will be visible now. 'Manage Assignment' to assign domain to already existing Web Hosting Account is one of the choices.
DAlloc 16.png
Just select preferred options from the dropdown menu and click 'Submit' button.
DAlloc 14.png
Apart from that, a new account can be ordered. To do so, press 'Order New Hosting Account' button.
DAlloc 17.png
Select the hosting that suits your needs most.
DAlloc 18.png

[edit] Unassign Domain

Clients are also given the possibility to unassign their domains.
To unassign a domain go to 'Domains' → My Domains' and select one from the list.
DAlloc 12.png
Press 'Manage Assignment' to unassign domain from Web Hosting Account.
DAlloc 13.png
Then click the button as shown here:
DAlloc 19.png
A proper note will show up.
DAlloc 20.png

[edit] Change Hosting Account

Clients are also enabled to change the hosting accounts.
To do so, proceed to 'Domains' → My Domains' and select one from the list.
DAlloc 12.png
Press 'Manage Assignment' to change the account.
DAlloc 13.png
Then click the button as shown here:
DAlloc 19 1.png
Now, simply choose the new account and type of assignment. Then submit your request.
DAlloc 21.png
You have successfully changed the account and your domain has been assigned to the new one.
DAlloc 22.png

[edit] Tips

1. Should you encounter any problems related to nameservers, you need to check their setup in the server configuration.
Proceed to 'Setup' → 'Products/Services' → 'Servers' .
You need to have nameservers set for the server using cPanel, Plesk or DirectAdmin products.
Lack of their proper configuration may result in difficulties during domain assignment or changing hosting accounts.
DAlloc 23.png
2. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Domain Allocator For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] Common Problems

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