ModulesGarden Documentation
Back Home Home

Domain Allocator For WHMCS

# Domain Allocator For WHMCS

# (opens new window) About Domain Allocator For WHMCS (opens new window)

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

# Installation and Configuration

This tutorial will show you how to successfully install and configure Domain Allocator For WHMCS. (opens new window)
We will guide you step by step through the whole installation and configuration process.

# Installation

  1. Log in to our client area and download the module.
Domain Allocator For WHMCS: ModulesGarden client area product page with the Download button for the latest module

  1. Extract the package and upload its content into the main WHMCS directory.
    The content of the package to upload should look like this.

    Domain Allocator For WHMCS: file manager listing of the extracted package with the modules folder

  2. 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'.

    Domain Allocator For WHMCS: file manager showing the module folder with license file being renamed to license.php

  3. 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'.

Domain Allocator For WHMCS: license.php in a code editor with the license key entered between quotation marks

# Addon Configuration

  1. 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.

    Domain Allocator For WHMCS: WHMCS Addon Modules list with the Activate button next to Domain Allocator

  2. 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'.

    Domain Allocator For WHMCS: WHMCS Addon Modules with Access Control for admin role groups and Save Changes

  3. You have just successfully installed Domain Allocator For WHMCS!

# 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.

# Admin Area

# Dashboard

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

Domain Allocator For WHMCS: module Dashboard in the WHMCS admin area with the summary and Domain Assignment List

# 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.

Domain Allocator For WHMCS: module Configuration tab with the Products Configuration table and Change Status switches

# 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}<span style="color:#009900;">[{$LANG.cartdomainshashosting}]</span>{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>
{else}
    <a class="add_hosting btn btn-primary" href="cart.php">{$no_hsoting}</a>
{/if}

  3. You can see correctly placed code below.

Domain Allocator For WHMCS: code editor with the integration code placed in the domain configuration template
  1. This is how it should be seen in the client area.
Domain Allocator For WHMCS: WHMCS client area Domains Configuration with Manage Assignment buttons for each domain

# 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'.

Domain Allocator For WHMCS: WHMCS admin Client Profile Domains tab with the Manage Assignment button

Then select Web Hosting account to which your domain will be assigned and define this assignment type.

Domain Allocator For WHMCS: admin dialog to assign a domain to a Web Hosting Account with assignment type and Submit

# 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.

# 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.

Domain Allocator For WHMCS: WHMCS client area My Domains list with the manage button for a domain

Press 'Manage Assignment' to assign domain to Web Hosting Account.

Domain Allocator For WHMCS: client area domain management page with the Manage Assignment link in the side menu

Select preferred options from the dropdown menu and click 'Submit' button.

Domain Allocator For WHMCS: admin dialog to assign a domain to a Web Hosting Account with assignment type and Submit (2)

# 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'.

Domain Allocator For WHMCS: client area Register Domain page with a domain search result and the Checkout button

Details will be visible now. 'Manage Assignment' to assign domain to already existing Web Hosting Account is one of the choices.

Domain Allocator For WHMCS: client area Domains Configuration with the Manage Assignment button for a new domain

Just select preferred options from the dropdown menu and click 'Submit' button.

Domain Allocator For WHMCS: admin dialog to assign a domain to a Web Hosting Account with assignment type and Submit (3)

Apart from that, a new account can be ordered. To do so, press 'Order New Hosting Account' button.

Domain Allocator For WHMCS: client area Domains Configuration with the Order New Hosting Account button

Select the hosting that suits your needs most.

Domain Allocator For WHMCS: client area VPS Hostings product list with Order Now buttons for each plan

# 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.

Domain Allocator For WHMCS: WHMCS client area My Domains list with the manage button for a domain (2)

Press 'Manage Assignment' to unassign domain from Web Hosting Account.

Domain Allocator For WHMCS: client area domain management page with the Manage Assignment link in the side menu (2)

Then click the button as shown here:

Domain Allocator For WHMCS: client area dialog for an assigned domain with the Unassign Domain button

A proper note will show up.

Domain Allocator For WHMCS: client area domain page with the message that the domain was unassigned from hosting

# 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.

Domain Allocator For WHMCS: WHMCS client area My Domains list with the manage button for a domain (3)

Press 'Manage Assignment' to change the account.

Domain Allocator For WHMCS: client area domain management page with the Manage Assignment link in the side menu (3)

Then click the button as shown here:

Domain Allocator For WHMCS: client area assignment dialog with the Change Account button

Now, simply choose the new account and type of assignment. Then submit your request.

Domain Allocator For WHMCS: client area dialog to pick a new hosting account and assignment type with Submit

You have successfully changed the account and your domain has been assigned to the new one.

Domain Allocator For WHMCS: client area domain page with the message that the domain was assigned to hosting

# 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.

Domain Allocator For WHMCS: WHMCS server settings Nameservers section with primary and secondary nameservers and IPs
  1. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.

# 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.

# 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 (opens new window) 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.

# Common Problems

  1. When you have problems with connection, check whether your SELinux or firewall does not block ports.