This document outline the basic installation, configuration and the basic usage of the WHMCS DNS Suite Module
Requirements
In order to use the module's functionality, you will need the following
- DirectAdmin hosting account with ability to create addon domains
- PHP INTL module enabled on your WHMCS server
The DirectAdmin hosting account should not be on the same hosting server you serve your regular hosting with.
Your WHMCS server must have outgoing port to the DirectAdmin account (default is 2222) open in order to connect to the DirectAdmin server.
Installation
Upload all the files in the modules folder to your WHMCS /modules/addons directory.
Language Uploads
The module includes English as the base language. If you wish to translate it to your enabled language in WHMCS. Make a copy of the english.php in /modules/addons/dnssuite/lang/ to your associated language. For example, french.php. The filename must match to the ones in the WHMCS/lang/french.php
Configuration
Module Activation
Log into your WHMCS admin backend and enable the module by going to Setup → Addon Modules → DNS Suite Management → Activate
Once activated, click on Configure and fill in the license key and make any settings adjustment.
Module Options
| Option | Description |
|---|---|
| Respect WHMCS DNS Setting | Enabling this will make the module respect each domain's DNS management setting. |
| Disable Client Management without Correct Nameservers (v1.22) | Enabling this will disable client ability to modify the settings in the Client Area when the domain's nameserver is pointing to the nameservers set in this module |
| Email Verify Template | This is the email template for when an email destination is added and an email with the Pin will be send to the email address for verification |
| Restrict Sub-accounts | When enabled, sub-accounts without the Manage Domains permission (Set under main account) will not be able to use the module |
| Enable email notification | Allow client to set to receive email notification on changes made |
| Notification Email Template | The email template name to use when to send out the email notification |
| DirectAdmin URL | The hostname or IP without http://or https:// |
| DirectAdmin Custom Port | Enter your custom DirectAdmin port here, if using default 2222 then leave empty |
| DirectAdmin Login/Password/SSL Connection | This is the login credentials for you DirectAdmin Account |
| Web template file name (Professional edition only) | The ZIP package name of the web templates you want to extract files from onto new domains |
| Enable PHP for domain | Allow PHP files to be run on new domains. The DA account must have PHP function enabled. |
| Enable SSL for domain | Enable HTTPS for the client domain. Recommend to turn this off as it can lead to browser security warning due to invalid SSL. |
| Large DB exclusion | When this option is enabled, the Admin panel will no longer load the list of Active domains in the Drop Down search. You will have to fill in the domain manually. This is useful if you have a large domain database |
| Fetch from NS on load | When enabled Clients will load records from the DA Server regardless of the local cache |
| Fetch from NS on load (Admin) | When enabled Admin will load records from the DA Server regardless of the local cache |
| TTL on zone refresh | The amount of time (in seconds) before the local cache expires |
| Default Nameserver 1-5 | The default nameserver for the DA server |
| Default TTL | The default TTL for the records |
| Display link under Domain Service Page (Admin) (v1.2) | |
| Display under Domain menu | When enabled it will display the DNS Manager link under the WHMCS Navigation menu Domains Tab |
| Menu Showing Order | The order in the Domains menu for the DNS Manager link to appear |
| Display in Domain details side bar | When enabled, a new link Manage DNS Record, Email Forwarding & Redirect will appear on the side Manage bar of a domain details page |
| Create on Pre-Registrar (v1.13) | Create domain on DA server pre-registrar hook (Required for registry that need an active zone on the nameservers) |
| Create on Registration | Creates the domain on the DA server upon registration process |
| Create on Transfer | Creates the domain on the DA server upon transfer |
| DNS Editor | Enable the permission for client to Modify DNS Records |
| DNS Templates (Professional edition Only) | Enable clients to Restore DNS Templates from the system |
| User Custom DNS Templates (Professional edition Only) | Enable clients to create their custom DNS Template |
| User Custom DNS Template Limit | The number of user DNS template allow to create |
| Dynamic DNS Support (Professional edition Only) | Allow client to update DNS records via the API |
| Dynamic DNS API Use limit | The number of API call each IP can call per hour |
| Enable Brute Force Detection | Enabling this will block an IP if it is exceeding the per hour API limit |
| Bruteforce Timer | The amount of seconds to check in the bruteforce log before denying |
| Bruteforce Ban Timer | The amount of seconds to ban the IP address from accessing the API |
| Dynamic DNS API Brute Froce limit | Limit how many unsuccessful API call each IP can call per hour |
| SubDomain Limit (Premimum/Pro Edition only) | Limit how many subdomain can set per domain. (To disable set to -1, for unlimited set to 0) |
| URL Forwarder (Premimum/Pro Edition only) | Enable the ability for the client to manage web redirects |
| URL Masked Redirect (Premimum/Pro Edition only) (v1.2) | Enable users to use masked redirects |
| Hash for Connector (v1.2) | The hash key needed to connect to the remote file connector when using Masked Redirect |
| URL Forward Limit | Limit how many URL redirect can set per domain (For unlimited set to 0) |
| Email Forwarder (Premium/Pro Edition only) | Enable the ability for the client to setup Email Forwarding (For unlimited set to 0) |
| Email Forwarder Limit | Limit how many Email forwarder can set per domain (For unlimited set to 0) |
| Destination Email Slots Limit | The number of email destination each domain can have for forwarding (For unlimited set to 0) |
| Email Catch-all (Premimum/Pro Edition only) | Enable the ability for the client to setup Email CatchAll |
| DNS Modification Settings & Limits | All the settings below are for the DNS editor. They are self-explanatory. (For unlimited set to 0) |
| Table of Contents | ||
|---|---|---|
|