Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document outline the basic installation, configuration and the basic usage of the WHMCS DNS Provider Module

Requirements

In order to use the module's functionality, you will need the following

  1. DirectAdmin hosting account with ability to create addon domains
  2. PHP INTL module enabled on your WHMCS server
  3. The DirectAdmin hosting account should not be on the same hosting server you serve your regular hosting with.

  4. Your WHMCS server must have outgoing port to the DirectAdmin account's server (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 and the /modules/server directory.

No template upload is needed

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/dnsprovider/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 Provider Admin→ Activate

Once activated, click on Configure and fill in the license key and make any settings adjustment.

Module Options

OptionDescription
Verification ModeThis 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
Verification IntervalWhen enabled, sub-accounts without the Manage Domains permission (Set under main account) will not be able to use the module
Allow Manual Domain Verification
Re-verify PeriodAllow client to set to receive email notification on changes made
Disable Re-Verify Suspension
Re-Verification TemplateThe hostname or IP without http://or https://
Disable Suspension Renaming
Unverified Termination PeriodThis is the login credentials for you DirectAdmin Account
Re-verification Termination PeriodThe ZIP package name of the web templates you want to extract files from onto new domains 
Migration Task Retry LimitAllow PHP files to be run on new domains. The DA account must have PHP function enabled.
Migration Task Retry IntervalWhen 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
Enable email notification
Email Verify TemplateWhen enabled Admin will load records from the DA Server regardless of the local cache
Notification Email TemplateThe amount of time (in seconds) before the local cache expires
Large DB exclusion
Fetch from NS on load
Fetch from NS on load (Admin)
TTL on zone refreshThe order in the Domains menu for the DNS Manager link to appear
Default TTLWhen enabled, a new link Manage DNS Record, Email Forwarding & Redirect will appear on the side Manage bar of a domain details page
Display under Service menu
Menu Showing OrderCreates the domain on the DA server upon registration process
Systemwide Dynamic Dns API
DNS EditorEnable the permission for client to Modify DNS Records

Enable API Force Detection
Bruteforce TimerDNS Templates (Professional edition Only)Enable clients to Restore DNS Templates from the systemUser Custom DNS Templates (Professional edition Only)
Bruteforce Ban TimerEnable clients to create their custom DNS TemplateUser Custom DNS Template LimitThe 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 limitThe number of API call each IP can call per hour
Enable Brute Force DetectionEnabling this will block an IP if it is exceeding the per hour API limit
Bruteforce TimerThe amount of seconds to check in the bruteforce log before denying
Bruteforce Ban TimerThe amount of seconds to ban the IP address from accessing the API
Dynamic DNS API Brute Froce limitLimit how many unsuccessful API call each IP can call per hour
URL Forwarder (Premimum/Pro Edition only)Enable the ability for the client to manage web redirects
URL Forward LimitLimit how many URL redirect can set per domain
Email Forwarder (Premium/Pro Edition only)Enable the ability for the client to setup Email Forwarding
Email Forwarder LimitLimit how many Email forwarder can set per domain
Destination Email Slots LimitThe number of email destination each domain can have for forwarding
Email Catch-all (Premimum/Pro Edition only)Enable the ability for the client to setup Email CatchAll


Table of Contents
absoluteUrltrue