Personal tools
Namespaces

Variants
Actions

DirectAdmin Licenses For WHMCS

From ModulesGarden Wiki
Revision as of 15:06, 22 July 2020 by Magdalena (Talk | contribs)

Jump to: navigation, search

Contents

About DirectAdmin Licenses For WHMCS

DirectAdmin Licenses For WHMCS will allow you to offer DirectAdmin licenses as ready products in your WHMCS.

The module will automatically provide, verify and activate DirectAdmin licenses for your customers, who will then have a chance to control them from your client area.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate License
✔ Change IP Address Assigned To License
✔ View License Details
✔ Choose Product Type And Operating System
✔ Suspend Or Terminate License On WHMCS Suspension Action
✔ Toggle Automatic Payment For Provisioned License
✔ Set Custom License Name
✔ Allow Clients To Reuse Lifetime Licenses
✔ Select Email Template And Support Department For License Error Notifications
✔ Prevent Clients From Changing IP Address Assigned To License
  • Client Area Features:
✔ Order License
✔ View License Details
✔ Change IP Address Assigned To License
✔ Change License OS
✔ Change License Name
  • General Info:
✔ Integrated With Product Linker For WHMCS - Resell Licenses In Product Bundles (read more)
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products (read more)
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.3
✔ Supports WHMCS Product Addons
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.8 And Later
✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

In this tutorial we will show you how to quickly install and configure DirectAdmin Licenses For WHMCS.

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

1. Log in to our client area and download the module.
DAL1.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.1 and later.
If you need a package for the previous versions of PHP, please contact our support.

PHP71 73.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.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
Note: Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 73.png
Important: This situation does not affect the open source version of this module which can be applied to any PHP from version 5.6 and later.
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
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.

Serwe4rw.png
4. When you install DirectAdmin Licenses For WHMCS for the first time you have to rename the 'license_RENAME.php' file.

The file is located in 'modules/servers/dalicenses/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

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

DAL4.png
6. Now we will show you how to configure a new product.

Go to 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server'.

DAL5.png
7. Next, enter your server name and enter 'directadmin.com' into the 'Hostname' field.

Afterward, fill in the username and password fields and choose 'Dalicenses' from the dropdown menu.
Select 'Secure' checkbox, remember to 'Save Changes'.

DAL6.png
8. After you have configured your server correctly, you should see the following screen.

Create a new group for your server now. Press 'Create New Group' to do so.

DAL7.png
9. Enter a name, click on your previously created server, press 'Add' then click 'Save Changes'.
DAL8.png

Configuration Of Product

10. In order to create and configure a product, click on 'Setup' 'Products/Services' 'Products/Services'.

If you do not have a product group, click on 'Create a New Group'. If you do, simply go to step 11.

DAL9.png
11. Enter a product group name and press 'Create Group'.
DAL10.png
12. When you have a product group, create your product. To create a product click on 'Create a New Product'.
DAL11.png
13. Afterward, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
DAL12.png
14. Now, go to the 'Module Settings' section, choose both 'Dalicenses' and your previously created server group from the dropdown menu.
DAL13.png
15. Next, tick the 'Auto Payment' action. Then, select which action from the dropdown menu should be performed when the license is suspended.

Choose 'Product Type' and 'OS Name' , then press Save Changes'.
Note: In the 'Custom License Name' field, the following merge fields can be used:

{whmcsVersion} {accountid} {serviceid} {addonId} {userid} {domain} {username} {packageid} {pid} {status} {type} 
{producttype} {moduletype} {serverip} {serverhostname} {action} {id} {uuid} {firstname} {lastname} {fullname} {address1}
{city} {fullstate} {state} {postcode} {countrycode} {country} {phonenumber} {tax_id} {statecode} {countryname} {phonecc}
{billingcid} {notes} {currency} {defaultgateway} {cctype} {cclastfour} {gatewayid} {securityqid} {securityqans} {groupid}
{credit} {allowSingleSignOn} {language}
DAL13 1.png
16. After modifying the module settings move to 'Custom Fields'.

In 'Field Name' enter 'IP' , choose 'Text Box' from the 'Field Type' dropdown menu, enter a description and set up the below validation:

/\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/


Important! It is a single line command, do not split it into two lines.
Mark the 'Show on Order Form' and 'Required Field' checkboxes and press the 'Save Changes' button.

DAL14.png
That's it. You have just successfully installed and configured DirectAdmin Licenses For WHMCS!

This is what a properly configured product looks like.

DAL15.png

Configuration Of Addon

This module can be also alternatively configured as to become a 'Product Addon' that can be bought additionally next to a given product.

More information concerning 'Product Addons' in WHMCS can be found here. In order to configure your addon follow the steps explained below.

1. Proceed to 'Setup' 'Products/Services' 'Product Addons' 'Add New' .

Enter a name and desired description. Then move to the 'Module Settings' tab.

NDAL.png
2. Now, as your 'Module Name' choose 'Dalicenses' and select your previously created server group from the 'Server Group' dropdown menu.

Note that the checkboxes presented on the screen are only optional.
Note: In the 'Custom License Name' field, the following merge fields can be used:

{whmcsVersion} {accountid} {serviceid} {addonId} {userid} {domain} {username} {packageid} {pid} {status} {type} 
{producttype} {moduletype} {serverip} {serverhostname} {action} {id} {uuid} {firstname} {lastname} {fullname} {address1}
{city} {fullstate} {state} {postcode} {countrycode} {country} {phonenumber} {tax_id} {statecode} {countryname} {phonecc}
{billingcid} {notes} {currency} {defaultgateway} {cctype} {cclastfour} {gatewayid} {securityqid} {securityqans} {groupid}
{credit} {allowSingleSignOn} {language}
NDAL1.png
3. In the next step of settings move to 'Custom Fields'.

In 'Field Name' enter 'IP' , choose 'Text Box' from the 'Field Type' dropdown menu, enter a description and set up the following validation:

/\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/


Important! It is a single line command, do not split it into two lines.
When ready, press the 'Save Changes' button.

DALN14.png
You have just successfully configured a new DirectAdmin Licenses For WHMCS addon. It can be assigned to other products of your choice.
NDAL8.png

Management

Our module allows you to provide DirectAdmin licenses through WHMCS.
Read through the below sections to learn how to use its functionalities efficiently.

Admin Area

You can view all important details of DirectAdmin Licenses For WHMCS products ordered by your clients in the admin area.

Additionally, our module allows you to manage your clients licenses and change licenses' IP addresses.

DAL16 1.png

Client Area

Our module allows you and your clients to, among others, quickly change license IP address.

As you know from the previous section it can be done in the admin area. We will show you now how to change IP address from the client area.
Start by pressing 'Change IP Address' as marked on the screen below.

DAL16.png
Afterward, enter a new IP address and press 'Submit'.

You have just successfully changed the license IP address.

DAL17.png
You can also change the license OS. Simply press the 'Change License OS' , choose a new OS and save the changes by clicking on 'Submit' .
DAL18.png
Finally, the license name can be also modified. To do so, simply press the 'Change License Name' button, then provide a new one and press 'Submit' to finish.
DAL19.png

Connecting With Existing License

In this section, you can find short instruction on how to connect one of your clients to your already existing DirectAdmin License.
Take the following steps to make sure that the process will be carried out properly.

1. Firstly, manually create an order for your customer in WHMCS. Choose a client and in the summary, view click on the ' Add New Order' button. Next, select a 'Product/Service' and press 'Submit Order' .
What is important, do not perform the 'Create' action. The status has to remain as 'Pending' .
More info about placing orders can be found here
2. Proceed to the newly created product's card in your admin area. Find the following empty custom fields:

  • License ID
  • IP

The above-mentioned information has to be consistent with the data from your DirectAdmin License. Now, complete these fields as presented below.
Important! Remember to make sure that the format of the provided data is compatible with the format supported by the module. You can preview it for another product of the module you have already created and enter it in a similar way.
If you completed the required data, now change the status from 'Pending' to 'Active' and 'Save Changes' .

Import DAL.png
3. If the completed data is correct, the License will be assigned successfully.
Important! Remember to manually add other missing parameters of the product in custom fields, billing cycle, etc. so they match the parameters of the connected DirectAdmin License.

Tips

1. Combine DirectAdmin Licenses For WHCMS with Product Linker For WHMCS to prepare product bundles like a VPS server with an active DirectAdmin license.

Update Instructions

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

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. Make sure that your custom field name is 'IP'. Otherwise, the module will not work properly.
3. If after the installation you get an ionCube encoder problem (wrong version), please open a support ticket.

You will be provided with a different version of the module encrypted with the older version of ionCube.

Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
DirectAdmin Licenses For WHMCS