DNS Manager For WHMCS

About DNS Manager For WHMCS

DNS Manager For WHMCS is an end-to-end module that enables your customers to be in charge of their DNS zones. Thanks to a wide variety of submodules, combined with options allowing you to prepare ready packages, your DNS Manager For WHMCS is there for you to surely meet your expectations. As an administrator, you have full control over DNS zones and possess access to a broad range of management options. The Wiki page for DNS Manager For WHMCS 2.x can be found here.

• Admin Area Features:

✔ Define DNS Servers

✔ Define Packages

✔ Create DNS Zones

✔ View And Edit Existing Zones

✔ Add And View DNS Slave Zones

✔ Lock/Unlock Zones From Edition By Clients

✔ Migrate Zones Between Chosen Servers

✔ Import Zones From Chosen Server

✔ Export Zone To TXT File In BIND Format

✔ Auto-Synchronize Zones And DNS Records Between Multiple Servers

✔ Manage Zones Backups

✔ Define, Manage And Duplicate DNS Records Set

✔ Apply DNS Record Sets To Multiple Zones At Once

✔ Wipe Existing Zone Records Upon Applying DNS Records Set

✔ Set Up Automated Tasks And Execution Time

✔ Toggle Administrator Notifications And Choose Who Send Them To

✔ Modify Notifications Email Templates

✔ Allow Creation Of PTR Record Without DNS Zone

✔ Protect DNS Zones On Product Termination

✔ Manage Client Area Zones Features:

✔ Select Default Template

✔ Toggle DNS Management Link

✔ Choose Scope Of Zones Management:

✔ Allow DNS And rDNS Management

✔ Allow Only DNS Management

✔ Allow Only rDNS Management

✔ Allow Domain/Products/Addon/Other Items Zones With:

✔ Only That Domain

✔ Only That Product Domain

✔ Only Domains From Owned Domains Items

✔ Only Domains From Products Items

✔ Only Domains From Both Owned Domains And Product Items

✔ Any Custom Domain

✔ Exclude Used Domains From Zone Creation

✔ Allow Zones With Related Service IP Addresses Only

✔ Allow Zones With Custom Subnet IP Addresses

✔ Allow rDNS With Custom IP Address

✔ Allow DNS With Custom IP Address

✔ Allow Management Of DNS Record Sets

✔ Display Full DNS Record Names

✔ Allow Management Of Zones Backups

✔ Define Zones Backups Limit

✔ Define Time Interval To Refresh Slave Zones

✔ Choose Whether To Display Zone's Product Name

✔ Display Suggested Nameservers From Submodule

✔ Display DNS Manager Button In Services Sidebar Menus

✔ Define Zone Statuses Displayed In Client Area

✔ SOA Warning

✔ Available Domain

✔ Active

✔ Pending

✔ Define Blocked DNS Strings With Regex Support

✔ Define Logs And Notifications Settings

✔ Define Which Zone Actions To Log:

✔ Create/Terminate Zone

✔ Add/Edit/Remove Record

✔ View Details And Notifications Related To Zones And Servers Load

✔ View Information About Automated Tasks

✔ View Scheduled Tasks Progress

✔ Display Usage Of DNS Servers

✔ View Email Notifications Statistics

✔ View Logs

• Client Area Features:

✔ View List Of Owned Packages

✔ View Domain Status

✔ Add And Manage New Zones Within Package Limit

✔ Add And View DNS Slave Zones

✔ View Zones Limit Per Package

✔ Add And Manage Zones Records Within Records Limits

✔ Export DNS Zone To TXT File In BIND Format

✔ View DNS Records Limits Per Zone

✔ Toggle DNSSEC For Zone

✔ View DNSSEC Details Of Zone

✔ Manage In Bulk

✔ Add/Modify/Delete/List DNS Records

✔ Change DNS Record Sets

✔ Delete Zones

✔ Add And Manage rDNS PTR Records

✔ Add, Manage And Duplicate DNS Records Sets

✔ Create Zone From DNS Records Set

✔ Manage Zones Backups:

✔ Create Manual Backups

✔ View Automated Backups

✔ Restore Backups

✔ Preview Zones List In Created Backups

✔ Export To File

✔ Import From File

✔ View Bulk Management Tasks

• Automation Features:

✔ Provision Packages

✔ Migrate Zones

✔ Import Zones

✔ Clear Unused Zones

✔ Clear Logs

✔ Backup Zones

• Server Settings:

✔ Allow rDNS Records

✔ Enable DNSSEC

✔ Allow Multiple PTR Records

✔ Use Cache To Optimize Loading Time

✔ Overwrite SOA Record

✔ Populate Nameservers

✔ Define Nameservers

• Package Settings:

✔ Define Zones Limit Per Package

✔ Define Items (Products/Domains/Products Addons) Purchase Of Which Results In Receiving Package

✔ Define If Single Instance Of Package Should Be Assigned To Each Client

✔ Define Servers Used By Package

✔ Define Allowed Record Types

✔ Define Total Records Limit

✔ Define Record Limits Per Type

✔ Define Default TTL For Records

✔ Define Automation Settings For Creating First Zone

✔ Allow To Create DNS Slave Zones

✔ Assign Default DNS Records Set

✔ Allow Client To Create Zone Using Chosen DNS Records Sets

✔ Introduce DNS Management Functionality If Domain Registrar Does Not Support It By Default

✔ Toggle Client And Administrator Notifications

✔ Define Allowed/Blocked IP Addresses For Zones And DNS Records Creation

• Supported DNS Servers:

✔ 4PSA

✔ AtomiaDNS

✔ AWS Route 53

✔ BIND 9

✔ CentralNic Reseller (former RRPproxy)

✔ Cloudflare (DNSSEC Support)

✔ cPanel (DNSSEC Support)

✔ cPanel DNSOnly

✔ DigitalOcean

✔ DirectAdmin (DNSSEC Support)

✔ DNS Made Easy

✔ DNS Pod

✔ DNS.com

✔ DynECT

✔ EuroDNS

✔ Freenom

✔ Google Cloud DNS

✔ InterWorx

✔ Nettica

✔ Openprovider

✔ OpenSRS

✔ OVH

✔ Plesk

✔ PowerDNS Hosted

✔ PowerDNS V4 (DNSSEC Support)

✔ Rackspace

✔ Rage4 DNS

✔ Simple DNS Plus

✔ Simple DNS Plus V8 And V9 (DNSSEC Support)

✔ Storm On Demand

✔ Zonomi

• Supported DNS Record Types:

✔ A

✔ AAAA

✔ AFSDB

✔ ALIAS

✔ ANAME

✔ CAA

✔ CERT

✔ CNAME

✔ DNAME

✔ DNSKEY

✔ DS

✔ HINFO

✔ HTTPRED

✔ ISDN

✔ LOC

✔ MB

✔ MD

✔ MF

✔ MG

✔ MINFO

✔ MR

✔ MX

✔ NAPTR

✔ NEC

✔ NEC3

✔ NS

✔ NSEC3PARAM

✔ PTR

✔ RP

✔ RRSIG

✔ SMIMEA

✔ SOA

✔ SRV

✔ SSHFP

✔ TLSA

✔ TXT

✔ URI

✔ URL

✔ WKS

✔ X25

• General Info:

✔ Supports IDN Zones

✔ AJAX Loaded Pages In Admin Area

✔ Supports Template Customization

✔ Connect With DNS Manager Using Its API

✔ Integrated With IP Manager For WHMCS - Complete Control And Easy Assignment Of IP Subnets

✔ Fully Integrated With Lagom WHMCS Client Theme

✔ Multi-Language Support

✔ Supports PHP 8.2 Back To PHP 7.4

✔ Supports WHMCS Themes "Six", "Twenty-One" And "Croster"

✔ Supports WHMCS V8.11 Back To WHMCS V8.8

✔ Requires ionCube Loader V13 Or Later

✔ Easy Module Upgrade To Open Source Version

Installation

In this short tutorial we will show you how to successfully install DNS Manager 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.

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

3. When you install DNS Manager For WHMCS for the first time you have to rename the 'license_RENAME.php' file. This file is located in 'modules/addons/DNSManager3/license_RENAME.php.' Rename it from 'license_RENAME.php' to 'license.php'.

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

5. In the next step, set up the 'storage' folder as recursively writable. This folder is available at 'your_whmcs/modules/addons/DNSManager3/storage' .

6. Now you have to activate the module in your WHMCS system. Go to 'WHMCS Admin Area' → 'System Settings' → 'Addon Modules' . Afterward, find 'DNS Manager' and activate the addon.

7. In the next step, you need to permit access to this module. To do so click on the 'Configure' button, choose 'Full Administrator' and press 'Save Changes'.

8. Good job! You have just successfully installed DNS Manager For WHMCS! Now in your WHMCS system press 'Addons' then press 'DNS Manager'.

Configuration and Management

This section has been divided into two main parts to allow full and, at the same time, easy understanding of the whole module functionality. In the first part 'Basic Configuration' an exemplary flow of basic configuration of servers, through creating packages and then zones management from both the client and the administrator side has been presented. In the second part, there are additional settings and tools that can be used while working with DNS Manager For WHMCS.

Basic Configuration

In the first place we would like to show you the process of configuring your DNS manager in a simple example. Follow the steps below to see how the process looks like in practice. Proceed to 'Addons' → 'DNS Manager'. There are several sections, but the one you should be interested in the most, in the beginning, is named 'Servers'. You will find it under the 'Settings' tab.

Server Configuration

To start your work, add a new server.

To add a new server you must fill out some data to allow connection with it. As an example, we will try to connect with a cPanel server. Additionally, you may declare here whether you need rDNS, Multiple PTR, or Cache. Select the desired options. Please note, that there is also an option Enable DNSSEC available. However, it is currently compatible only with CloudFlare, cPanel, DirectAdmin, PowerDNS V4 and Simple DNS Plus V8 And V9 submodules. DNSSEC (DNS Security Extensions) - allows enabling validation and authentication of the origin and integrity of DNS data. If you enable this option, the client will be allowed to turn on DNSSEC for a zone and display its DNSSEC-related details accordingly.

If you want to have the nameserver records populated each time a new zone is created, make sure to check the Populate Nameservers option. A similar scenario applies to the Overwrite SOA Record checkbox which stands for automatically assigned nameservers in the SOA record.

Once you have chosen a server from the dropdown menu, 'Configuration' and 'Nameservers' tabs appear. Enter your username, password, Hostname/IP, and any other details needed to connect successfully. Now, press 'Nameservers' and enter the nameservers that will be visible for your customers in their client area. Remember to save the changes when ready.

Please also note that the configuration differs per selected submodule.

Now, that you have servers on the list, you may manage them. Turn it on/off by changing their status (1.), edit (2.), test connection (3.) and delete (4.).

BIND 9 Configuration

DNS Manager For WHMCS offers solutions not only for remote DNS servers, but it can also support your own DNS server created using BIND 9. Please note that currently DNSSEC for BIND 9 is not supported yet. In this part, we will show you an exemplary BIND 9 configuration. Firstly, go to the 'Servers' section in the 'Settings' tab, click 'Add Server' and select 'Bind9' module.

Now, move to the 'Configuration' tab and provide essential data to your BIND 9 server configuration. The 'Path To Bind9 Config Directory' filed is used to locate the BIND 9 'named.conf.local' configuration file. Please remember that all paths presented on the screens below are only an illustration and you need to adjust to directory paths on your own BIND 9 server. The module should also have permissions set to access these directories. Thanks to the provided backup paths, you can also easily revert a backup copy in case of any breakdown so it is extremely important to carry out the configuration properly. Also, note that the module can create a large number of backup files within a newly created 'zones' directory based on the provided path. Important: Remember that paths to 'Bind9 Config Directory' and 'Backup Directory' should start with / and be absolute.

Another obligatory step to set up is 'Nameservers' . Fill in at least one nameserver and its IP address. Do not also forget to save the changes.

Once the configuration has been established successfully, you can test your connection, and view your ready server which can be easily managed here.

Management of Packages

Packages - these are collections of settings related to the products for sale. Thanks to these, the client will be allowed to create specific zones and will possess access to DNS Management in the Client Area. Click 'Add Package' to see how to configure it and what exactly can be specified there.

1. In the 'General' section you have to: name the newly created package define the number of zones per item (limit of zones that a client may then create within this package) decide if you allow creating slave zones Important: The module allows the creation of two types of DNS zones, master and slave ones: Primary (Master) DNS zones – it is a holder of the original zone file (all the DNS records for the zone). You can manage a host through this zone. Secondary (Slave) DNS zone – it holds a copy of the zone file. You can use them for better performance, for hiding your primary zones, for backups and redundancy. 2. Here, you can also decide if zones should be created automatically after defined actions. These are: New Item - zones will be created automatically for every new product being activated Pending Domain Transfer - zones will be automatically created for the domains during their transfer: Before - a new zone will be created right before launching the transfer to the registrar After - the transfer occurs first, and only if it ends successfully a new zone is created Pending Domain Registration - zones will be created automatically for newly registered domains Before - a new zone will be created shortly before sending a registration request to the registrar After - a new zone will be created once the status of the registration request is received from the registrar Domain with DNS Management - zones will be created automatically for domains that have been ordered with the 'DNS Management' domain addon Existing Zone Update - if a zone already exists, it will be updated with newly added record sets 3. Define the maximum, allowed limit of records. 4. Choose DNS Record Sets that will be applied to this package. Default DNS Record Set - this default set will be automatically applied upon the zone creation DNS Record Sets - choose the sets created by the administrator that will also be available for clients to choose from when adding a new zone

Items

Assign Domains, Products or/and Product Addons from available ones to the package. Here you can also allow clients to create their own free zones. Simply select the option under the 'Other' section. Remember that you may use this option for one package only.

Servers

Assign the package to the previously added server. Note: You may always assign the package to more than one server. Due to extra synchronization, you may select which server will be marked as 'Master Server '. As a result, once you modify the 'Master Server' and run cron commands, all performed changes (such as adding, deleting new records etc.) will be implemented to other servers as well.

Records

In this part, you may define the record types that you want to enable and declare their limit. Note: The 'Total' value cannot be lower than the sum of limits set for individual records.

Notifications

Here, you may configure which notification will be sent to clients and administrators.

Registrars

In this part, you may allow the 'DNS Management ' option for selected here registrars that do not support DNS management by default.

Please note that the inbuilt WHMCS DNS Management will be used to handle the above functionality.

IP Management

In the last part, you can specify which IP addresses can be used by your clients while creating a package. If you do not provide anything, clients can use any IP address without any limitations. The 'IP Addresses Blacklist' section allows you to ban IP addresses. This will prevent users from using specified IP addresses. Remember to save the changes when the package configuration is ready.

Enable the newly created package to allow it to be used.

Client Area

In order to take advantage of the brand new management page in the client area, you need to allow access to the DNS Manager addon. Navigate to 'Addons' → 'DNS Manager' → 'Settings' → 'Global Settings', and enable 'DNS Management Link.' This will enable a 'Manage DNS' button in the Client Area.

DNS Management in Client Area

Now, that we already have the module configured you may see how clients will add and then manage their zones. In the client area find the button 'Manage DNS', it will redirect you to the management page.

Zones

In here, clients may add new zones. To do so, simply type in the name of the zone and choose the IP address from the available or enter your custom IP address. It depends on your configuration - read more about possible options here. From the dropdown menu clients can also define record sets. If they do not have any added, the default one created by the administrator in the admin area will be selected. When clients create sets by themselves, they can use the one defined by them as default, or choose another from the list.

Standard list view of DNS Zones: Note: You can turn on this mode in the 'DNS Manager addon' → 'Settings' → 'Global Settings' → 'Other' → 'Zones Single Table View'.

The module gives you the possibility of creating two types of zones. These are master zones and slave zones. For more info please read this section. Form to create a master DNS zone:

If you wish to create a slave zone, this is how the form will look like:

Allowed actions on a zone: edit an existing zone delete zone

Press 'Edit' to see details of the zone, you may edit the zone here and add new records if limits allow you.

Enter a new record's name, choose the type from available, etc.

In the case of slave zones, press the dedicated icon (2.) to only view the zone records list. You may force the slave zone to refresh by pressing the button (1.) - related to slave zones on servers other than PowerDNSv4. A new task will be added to the queue and the zone will be refreshed with the setup time interval.

DNSSEC

If the 'Enable DNSSEC' option has been selected ('CloudFlare', 'cPanel', 'DirectAdmin', 'PowerDNS', 'PowerDNS V4' and 'Simple DNS Plus V8 And V9' submodules), the client may turn it on. To do so, navigate to 'Additional Actions' → 'DNSSEC'.

Enable DNSSEC here, you will then get access to DNNSSEC details for the zone, including keys and delegation signer records. Press 'Rectify Zone' to comply with DNSSEC.

Bulk Management

Under this section you may manage numerous DNS zones. Select at least one zone on the list and press the 'Choose Action' button. There are six allowed actions that can be performed on zones. Allowed actions: Add Record Modify Record Delete Record List Records Change Record Set Delete Zones

Add Record - define the newly created record type, name, TTL, and address.

List Records - search for records manually by typing in exactly what you need or enable 'Regular Expression' to broaden your search results. Use regex syntax, for example: /abc/ - all records including "abc" string (lower case only) /[\d]+/ - all records including numbers /^www/ - all records that start with "www" (lower case only) /\.com$/ - all records that end with ".com" (lower case only) /[abc]/i - all records that include "a," "b" or "c" letters (lower or capital case, any position)

Modify Record - you may modify existing records. Search for records manually by typing in exactly what you need or enable 'Regular Expression' to broaden your search results. Use regex syntax, for example: Search: /(\d+)abc/i Replace With: def$1 The above example will result in exchanging all records that include a string of numbers followed by abc letters to a 'def' phrase with the same string of numbers: phrase2137abc → phrasedef2137

Delete Record - select the record type and specify which records shall be deleted. Enter specific data or use regular expressions.

Change Record Set - choose a new record set. You may enable the 'Wipe Records' option to clear the selected zone at the same time.

Delete Zones - remove all the selected DNS zones.

rDNS

If you have allowed the rDNS management in the client area by selecting either 'Allow DNS And rDNS Management' or 'Allow Only rDNS Management' option (read more here) in global settings, your clients can create PTR records for IPv4 and IPv6 addresses without any related zone. To do so, press 'Add PTR Record'.

Select the related item, then depending on the configuration enter the IP address or choose IP or Subnet from the available list. Note: Subnets are available only if you have integrated your DNS Manager with IP Manager For WHMCS - see below options for more details.

Your newly created rDNS record should appear on the list. You may edit RDATA or delete the record completely.

Record Sets

You can add and manage records sets in the 'Record Sets' section as shown below.

Click the 'Add Record Set' button and provide the necessary details. It can be also set as default.

Your newly created DNS record should appear on the list. You may edit the record set, edit general record set data, or duplicate or delete it completely.

Backups

Backup Tasks You can manage fully your zone backups. Move to the mentioned section to see any options. Note that this option must have been previously allowed by your administrator in general settings. Press the 'Create Backup' button to start.

A new task is added immediately. Now, all you need to do is edit the added backup task and select the zones from available that will be processed and stored in a backup file. Press the 'Create Zones Backup' button when ready.

The just-added task to back up the zones is now visible on the list of all tasks. There is also information on the task progress and number of zones already processed. To see details, press the 'Show List' button. Important: Keep in mind that you must wait until the next execution of the "Cron Importer" to start processing. If it is set to more than 5 minutes, you will not see the results on the run.

Manual Backups List Here you will find a list of all files with a number of backed-up zones. In order to upload a ready backup file, simply press the 'Upload File' button.

Select the file from your store, keep in mind that only the previously downloaded backup files can be used. Surely, such a file can be edited in any editor to adjust the records inside it to your needs, but you must be careful and stick to its form.

Use the action buttons to start the tasks: 1. - Show Backup File Content 2. - Download the file. 3. - Restore backup file. This action, when stared, is also visible on the list of tasks above. 4. - Delete the file.

Tasks

You will find a list of current tasks in 'Tasks' section. Among all tasks there are import tasks, migration, and synchronization tasks.

According to specifically set-up cron jobs all created tasks are regularly executed. Here, you can see the current status of each task. If it is queuing for the next cron run, is currently executed, aborted, or complete. Check when they were executed for the last time (Last Execution) and when the task was added. Available actions: call execution manually and remove the task.

Zone Management

In the administrator panel, you can spot all your client zones. You are free to preview those already existing. You will see whose zone it is, its type, on which server it is created, and its status (created/deleted).

You can always add a new custom zone directly for your client from your admin area. To do so, press the button marked on the screen below.

Now, you are required to fill out the visible fields.

If you select a service that is in a package with the allowed option to create slave zones, a dedicated switcher will appear. Important: The module may create two types of zones, master and slave ones. Master type zones are created on DNS servers and the records are synchronized via AXFR protocol by itself. In the case of slave zones, the module creates a slave zone on DNS servers and that is the DNS server that performs the synchronization. ("PowerDNSV4" only, in the case of other servers like "cPanel", you have to manually force the synchronization).

Note that both the admin and client area allow the user to apply a record set to a single or to multiple zones.

Actions on zones from the admin area: Change Related Item - choose one of the available items from a dropdown menu and save changes Edit DNS Zone Records- modify existing records or add new ones Add DNS Zone - use this button to create a zone on the server Import DNS Zone From File - choose a file from which zones will be imported Export DNS Zone To File - choose a file to which zones will be exported Export DNS Zone To TXT File In BIND Format - a TXT file will be saved just after pressing the button Lock/Unlock DNS Zone - if you lock a zone, it will not be possible to edit this zone in the client area Delete DNS Zone - if you use this button, the zone will be deleted both from WHMCS and from the server Remove DNS Zone From WHMCS - zone will still be available on the server Refresh Slave Zone - press this button to manually add the task to the queue and force refreshing a slave zone via AXFR protocol (slave zones created on servers other than PowerDNSv4) View DNS Zone - press to see a list of records; you may also refresh the slave zone from this level (slave zones only)

Additional Tools

Global Settings

This section has been designed to allow quick and simple configuration of global settings from one place.

Templates

Choose a default template that will be used in the client area. If you have more than one template then you may allow your clients to switch between them. Decide whether you wish to use a ready-configured redirection to the DNS Management page in the client area.

Logs And Notifications

In this part, you may impose when log entries and notifications should be removed from the system database. If you wish you may also check the 'Log Successful Actions' option to store all entries in logs (DNS Manager → Settings → Logs). 'Log Zone Actions' - select single actions on zones, logs on them will be stored in the module as well.

Slave Zones

The following section is dedicated to the created in the module slave zones on servers other than PowerDNSv4 (in its case, the slave zones are refreshed automatically). Here, you may define the time interval at which the slave zones will be refreshed and their information synchronized with a remote DNS master server using the AXFR protocol. Note that the time is measured in hours.

Other

The box with 'Other' options available is a crucial part of the configuration where you can manage IP Manager For WHMCS module and manage PTR records creation. Besides, here you can switch off the guide with simple instructions visible on the dashboard.

1. Client Area Management - depending on the configuration, the client has access to: DNS And rDNS Management - give your clients full access to DNS management in the client area. rDNS Management Only - create PTR records for IPv4 and IPv6 addresses without a related zone. If this option is enabled your clients will be only allowed to add reverse DNS with no zone related. Other sections are blocked DNS Management Only - the 'rDNS' tab will be blocked for the client

2. Domain/Product/Addon/Other Item Options - restrict clients to manually create zones using the indicated domains only. Allow Only That Domain Allow Only That Product Domain Allow Only Domains From Domains Items Allow Only Domains From Product Items Allow Only Domains From Domains And Product Items Allow Custom Domain

3. Exclude Used Domains From Zone Creation - select to exclude the already used domains from the possibility of being used again in a newly added zone

4. Related Service IP Addresses Only - create zones and PTR records with a related IP address only. When adding a new zone/PTR record you can choose from available hosting-related IP addresses only as marked on the screen below.

5. Custom Subnet IP Address - create zones and PTR records with an IP address included in a subnet related to the product. Note: This option works only if you have integrated your DNS Manager with IP Manager For WHMCS.

5. rDNS Custom IP Address - create PTR records with a custom IP, and enter a new IP address to create a new PTR. Note: Both IPv4 and IPv6 are supported by DNS Manager For WHMCS.

6. Custom IP Address - create zones with a custom IP address. If you have no IP addresses to choose from, you have to enter a new IP address. Note: Both IPv4 and IPv6 are supported by DNS Manager For WHMCS.

7. Client Area Record Sets - clients may manage DNS record sets.

8. Client Area Backups and Client Area Backups Limit - clients are given the option to create backups of their zones and upload backup files. It is advised to set a limit on the number of allowed backups. Default '-1' indicates unlimited

9. Protect Zones On Product Termination - zones are not automatically deleted once the product has been terminated.

10. Show Product Name - a full product name is shown, instead of the general type with an order number.

11. Show Nameservers - submodule nameservers will be displayed in the 'Edit Zone' section of the client area.

12. Show DNS Manager Button - the 'DNS Manager' button will show up in the sidebar section of products which have zones created. Thanks to this button you can easily move to the 'Edit Zone' section.

Notifications

In this part, set which notification should be sent to clients and which to the administrator. Select the ones that interest you. Press 'Modify' and you will be quickly redirected to the email template page where you can adjust it to your needs.

Use the 'Exclude' button to specify domains, products, and addons that the zones assigned to them will NOT be included in notifications.

Use the 'Include' button to specify which admin users will receive notifications.

Client Area Zones Status

Checking the selected boxes will result in an additional status concerning a given domain in the client area.

Pressing the Modify button next to a given option will cause a new window to appear where you can set up your own custom status by means of HTML. Your new description can include the {$domain} variable which will give the domain address back in the status message.

You can see an example status on the screen below.

Record Sets

Create ready made sets of DNS records. You will find them in 'Settings' → 'Records Sets'. Press 'Add Set' to create a new one.

Enter the newly created set name.

Once your new set appears on the list, you may edit that set in order to create records. Press 'Edit Record Set' to continue.

List of records will appear. Please use the 'Add Record' button to continue.

Now, fill out the data as required. Note: You may add adequate variables for domain and IP address and then these fields will be automatically changed to domain/zone IP when this record set is used. For example, if you have the 'example.com' domain with '123.123.123.123' IP address all you have to do is add the following variable to the DNS Record Set: {$domain} - will return full 'example.com' domain address {$domainname} - will return only 'example' name {$domainextension} - will return 'com' extension {$ip} will return the '123.123.123.123' IP address; that can be: IP address assigned to the domain by a client, provided while creating a zone hosting dedicated IP address WHMCS server address provided it is a hosting {$serverhostname} - will return the DNS server address or its IP address, depending on which one has been provided in the module's DNS server configuration in the admin area, e.g.: yourdnsserver.com or 12.23.34.45 {$ns1}, {$ns2}, {$ns3}, {$ns4} and {$ns5} - will return the addresses of the global nameservers specified in the order basing on the sequential number of the corresponding data in the variables {$serverassignedipX} – allows you to use 'Assigned IP Addresses' from another server configuration ( WHMCS → System Settings → Servers). Important! You need to replace X with a number. For example: If you provide {$serverassignedip1} in the DNS Record Set, the first address from the 'Assigned IP Addresses' section will be used.

Created DNS Records Sets can be then used while preparing ready packages, as it was described. Ready-made sets allow much faster and more personal configuration of packages. There is also the possibility of duplicating the selected DNS Record Sets.

DNS Blocked Strings

Proceed to Settings → Blocked Strings now. In this section, you may define a list of words that will not be allowed to be used while creating DNS and rDNS records.

In order to add certain words, simply type them in the adequate box. Allowed formats: each word in a new line space separated coma separated coma with space separated Allowed regular expression options: test* - all expressions that begin with a 'test' word *test - all expressions that end with a 'test' word rec...ord - three dots inside will block all expressions with any three signs inside a word rec*ord - an asterisk inside will block all expressions that begin with a 'rec' and end with a 'ord' as in example You may create a separate list for DNS records and another one for rDNS or create one shared list for both of them. In the latter case just select the 'Use same values as for DNS' option like on the screen below.

At the very bottom, you may also create a list of clients who will be excluded from the above restrictions. All the other clients will have to follow the 'Blocked Strings' rule. Remember to save the changes in the end.

In practice, when a client will be trying to create a record using one of the forbidden words, the action will be blocked.

DNS Manager Logs

This section helps you keep track of all the activities carried out in DNS Manager. Find them here: 'Settings' → 'Logs'.

DNS Manager Tasks

Check the list of current tasks. Use the cron tasks to delete all tasks with the 'Finished' or 'Canceled' status: php -q /yourwhmcs/modules/addons/DNSManager3/cron/cron.php JobsCleaner --clean

Cron Jobs

In order to manage your cron job tasks proceed to 'Tools' → 'Cron'. Here, you will find five information boxes, each one responsible for the management of a separate cron task. These are: migration, import, synchronization, cleaner, and backup.

At the very top, there is an info box with general cron details, such as the recommended time interval of a cron execution (5 minutes is suggested). The last execution time and run-time period are listed below. (Keep it as frequent as possible.) Note 1: The module cron will delete finished/canceled tasks each run. Note 2: The module cron is separate from the WHMCS daily cron, which for the purposes of the module only deletes joblogs and finished/canceled tasks after 30 days have passed.

Migration Cron - responsible for calling added tasks to migrate zones between servers. Choose an interval and declare how many zones can be migrated during a single execution. Import Cron - responsible for calling added tasks to import zones from an external server to WHMCS. Choose an interval and declare how many zones can be imported during a single execution (Admin and Client backup tasks). Select the option to automatically check recognized records to perform the import much faster. Mark Active Users/Services and only such will be imported. Import Priority - decide whether these should be services that will be assigned to a client firstly ('Services, Domains' sequence) at Related Items or domains if selected the other way round. Synchronization Cron - this cron job is responsible for regular synchronization of created zones. Choose an interval and declare how many zones can be synchronized during a single execution. Note: When NS records are inconsistent with nameservers set in the server configuration, this cron job also deletes the zones.

Cleaner Cron - this option is a little bit more complex. Just like in case of other cron jobs, firstly choose an interval and declare how many zones should be cleared during a single execution. Then you may specify the conditions of clearing zones and records. Warning: By default, the cron job is disabled and the 'Notify Only' option is enabled. You will need to change these settings manually if you would like to have the zones removed. What is more, when the cron is enabled and the 'Notify Only' feature disabled, the module will send the warning about the zones deletion as an additional layer of safety. Define which zones get removed: Excluded from Package - if no longer match with any package. Unmodified for - have not been modified for a specified period. Missing in WHOIS - their domain is not found in WHOIS Lookup. Without Records - no chosen records are included. Inactive Services - with canceled, terminated and/or suspended status. Inactive Domains - with canceled and/or expired status. Decide for which of the following services, the PTR Records should be removed: Terminated Services Cancelled Services Suspended Services

Backup Schedule Cron - in this section, you can schedule your backups. Similarly as previously, complete these fields according to your preferences. Stored Backups Limit - you can set the maximum number of backups that will be stored. If the provided number is exceeded, then the oldest backups will be overwritten. Important: For this function to work properly, the Import Cron has to be running. It's also crucial to configure both crons correctly: Backup Schedule Cron cannot queue more tasks, than the Import Cron can handle. Example: There are: 100 clients Each client has between 1 and 100 zones Backup Schedule Cron is set to run every 3 hours

This means the Backup Schedule Cron will create a maximum of 1000 tasks for the Import Cron to handle. By extension, the Import Cron has to be configured in such a way, to handle those 1000 tasks across 3 hours and still have some leeway for other tasks. The suggested configuration of the 'Import Cron' here would be: Run every 5 minutes Zones per Execution: 30 This means a maximum of 1080 tasks across 3 hours, which exceeds the potential tasks from the Backup Schedule Cron and leaves some additional space for unrelated tasks.

Import

This is an additional tool that allows the import of zones that exist on outside servers to WHMCS. Move to Tools' → 'Import' in your admin panel. You will find here a list of 'Import' assignments with information on which server they are imported from, total number of already imported zones and the number of all zones, progress of the import task. To add a new import task press 'Import Zones'.

Choose a server that you want to import zones from.

Now, when the new import task appears on the list of awaiting imports, schedule the action.

When the schedule is confirmed, preview the list of imported zones to assign a client and a related product to the zone. To do so, press the button as marked on the screen.

A list of zones appears, press 'Queue Import' to add zones into the import queue or 'Import Now' to import them immediately. Select the related client and item in the next window. If you do not schedule import tasks, regular cron execution will trigger the import.

Zone Backup

The 'Zone Backups' section allows you to export your zones to a file and, when needed, easily import them on the server.

To export zone automatically, press 'Export To File', define from which server you wish to export it, and click on 'Confirm'. Note: Automatic backups will export all zones of every user.

Click on 'Add Export' and define details for the action: Destination Server Source File

Schedule the task. Remember to confirm the action.

You can now move to the list of zones. Press the button marked on the screen.

A list of zones appears, press 'Queue Export' to add zones to the export queue or 'Export Now' to export them immediately.

Tasks

DNS Manager addon 'Tasks' section includes a list of tasks with their current status and allowed actions: View task information details and logs Download Task File (csv) Delete task

rDNS Records

Your clients' rDNS records can be viewed and managed here. Click on the 'Add PTR Record' button to add a new record to a client.

Select the client and fill in the record-related fields.

Records can be modified and deleted using the respective action buttons.

Dashboard

The home page of DNS Manager which can be used to get a quick and clear preview on the crucial parts of the module: added servers with the number of zones created on them, summary of email messages sent to clients and finally the most important notifications.

Custom cPanel Zone Templates

You can allow your customers to create zones without cPanel Default Records. To do so, you need to create your own Zone Template in the WHM. If you do not know how to create your own Zone Template, you can follow this short guide made by cPanel: Edit Zone Templates Guide To apply your newly created zone template simply log in to your WHMCS and go to 'Addons' → 'cPanel Extended Functions' → 'Configuration'. As a module choose 'cPanel' and enter the name of your zone template in the 'Template' field as shown on the screen below. Remember to save changes.

IP Manager For WHMCS Integration

As it has been mentioned above, some of the options in our DNS Manager For WHMCS are available if you are also using IP Manager For WHMCS simultaneously. In this section you will learn how to integrate the two products to work together. For more information on the IP manager module configuration please refer to our documentation. Let us take a look at the IP Manager module first. There you have to create a subnet.

You can do it ether for IPv4 or IPv6 type. DNS Manager For WHMCS supports both types.

When ready, create a proper configuration and assign the required products to it.

Assign created subnet to this configuration.

Under 'Relations Configuration' → 'Products' define the number of IP addresses that will be allowed for a client. By default this is only one address.

Move to DNS Manager now and create an appropriate package where you declare limits for zones, select the product and allow records types and limits that will be provided within the purchased service.

Now, a client upon purchase of such service may now use assigned IP addresses from the subnet and manage the DNS zones and rDNS zones according to limits specified in the package.

The client may now add PTR records within the related service.

Create zones with IP addresses included in a subnet related to a service in IP Manager.

You only need to remember that relevant options must be enabled in the 'Global Settings' section.

DNS Manager Migrator

If you have been already using DNS Manager For WHMCS, you can migrate data from your current system to the latest version. To do so, follow the below steps: 1. Activate DNS Manager For WHMCS V2.x.x. 2. Run the following command in your browser or in the console: your_whmcs_path\modules\addons\DNSManager2\cron\migration.php 3. Follow the steps that you see on your screen now. Note: It is advised to use your console to do the migration between the previous and the new versions of your DNS Manager in case you have a huge number of zones (if more than 1000, it is highly recommended). 4. Once the script has run and the migration is complete you need to review the configuration of your servers to alter their naming which is the most important enable migrated servers and packages. Freshly migrated servers and packages are by default disabled.

Once the migration of zones is ready you can migrate rDNS records. To do so: 1. Run the command in your browser or in the console: your_whmcs_path\modules\addons\DNSManager2\cron\ptr_migration.php 2. Follow the steps that you see on your screen now. 3. Your PTR records will be assigned to adequate zones. In case when the pointing domain does not exist, the required zone will be created and added to the client's account (if no other user already has it). 4. Migrated rDNS records are visible on the edition page of its zone as PTR records.

API Methods

You may access your DNS Manager For WHMCS API. Here is a short instruction on how to do that: The main required command that has to be used is: 'dnsmanager' Additionally, you have to define 'dnsaction' with some specific value. Note: the 'action' parameter is no longer used since the 2.7.0 version due to not being allowed as a method to be executed as external. These specific values can be: 'getServerList' - returns the list of servers in DNS Manager 'saveRDNS' - allows adding new rDNS record. Additional parameters are required here, these are: 'serverid' - ID of a server 'ip' - IP address that will be used 'clientid' - ID of a client, record will be assigned to that client 'ttl' - value of TTL for record 'rdata' - record's value 'removeRDNS' - allows removing existing rDNS record. Additional, required parameters: 'serverid' - ID of a server 'ip' - IP address that will be used Exemplary use: <?php // Set Vars $command = 'dnsmanager'; $values = array( 'dnsaction' => 'getServerList', 'params' => array() ); $adminuser = 'DemoAdmin'; // Call API $results = localAPI($command, $values, $adminuser); var_dump($results); ?> Since the 2.7.0 version, there are new methods available: 'createZone' - creates a zone. Additional parameters are required here, these are: 'action = dnsmanager' 'dnsaction = createZone ' - DNS action, that DNS Manager should execute 'zone_name' - name of the zone being created 'type = 1 or 2' - type of related item. Use 1 for domain or 2 for the product 'relid' - ID of the related item (hosting ID, domain ID) 'userid' - ID of user 'zone_ip' - IP address assigned to the zone. If empty, a default IP address will be used 'recordSet' - ID of the DNS Record Set, it can be downloaded from the base, table: 'DNSManager3_SetRecord', field: 'setid' (In module version 3.3.2 and earlier, the mentioned table name was: "dns_manager2_setrecord") Exemplary use: $postfields = array( 'action' => 'dnsmanager', 'dnsaction' => 'createZone', 'zone_name' => 'zonename.com', 'type' => '1', 'relid' => '2', 'zone_ip' => '192.168.56.101', 'userid' => '1', 'recordSet' => '2', ); 'updateZone' - updates the zone with the records specified in the request. Any records not included in the request are removed. Use these parameters: 'action = dnsmanager' 'dnsaction = updateZone' - DNS action that DNS Manager should execute 'zone_id' - ID of the zone that should be updated (use ID from WHMCS) 'records' - array of the records that should be updated (added/changed/removed) if DNS Manager compares these records and add/change/remove the corresponding difference. These are: 'name' - name of the node to which this record pertains 'type' - type of the updating resource record (e.g. MX) 'class' - class node 'ttl' - number of seconds that the RR stays valid (e.g. 14400) 'data' - additional specific RR data Exemplary use: $result = localAPI('dnsmanager' , array( 'dnsaction' => 'updateZone', 'zone_id' => 2, 'records' => array( array( 'name' => 'example.website.com', 'type' => 'A', 'class' => 'IN', 'ttl' => '14440', 'data' => '192.168.56.101', ), array( 'name' => 'example.website.com', 'type' => 'A', 'class' => 'IN', 'ttl' => '14440', 'data' => '192.168.56.102', ), ) ),'admin'); 'getZone' - returns the zone with records. Use these parameters: 'action = dnsmanager' 'dnsaction = getZone' - DNS action that DNS Manager should execute 'zone_id' - ID of the zone that should be retrieved (use ID from the dns_manager2_zone table) 'zone_name' - name of the zone 'removeZone' - deletes the zone. Use these parameters: 'action = dnsmanager' 'dnsaction = removeZone' - DNS action that DNS Manager should execute 'zone_id' - ID of the zone that should be removed (use ID from WHMCS) 'addRecord' - adds new record. Use these parameters: 'action' => 'dnsmanager' 'dnsaction' => 'AddRecord' - DNS action that DNS Manager should execute 'zone_id' => ID of the zone (use ID from WHMCS) 'record' => data of the new record that should be added Exemplary use: $values = [ 'dnsaction' => 'addRecord', 'zone_id' => 19, 'record' => [ 'name' => 'mail2', 'type' => 'MX', 'class' => 'IN', 'ttl' => '14440', 'data' => [ 'preference' => 2, 'exchange' => 'mailtest.com.' ] ] ]; $results = localAPI($command, $values); 'editRecord' - edit an existing record. Use these parameters: 'action' => 'dnsmanager' 'dnsaction' => 'AddRecord' - DNS action that DNS Manager should execute 'zone_id' => ID of the zone (use ID from WHMCS) 'record' => new data of the record Exemplary use: $values = [ 'dnsaction' => 'editRecord', 'zone_id' => 19, 'record' => [ 'line' => 29, 'name' => 'mail3', 'type' => 'MX', 'class' => 'IN', 'ttl' => '14440', 'data' => [ 'preference' => 3, 'exchange' => 'mailtest.com.' ] ] ]; $results = localAPI($command, $values); 'removeRecord' - remove a record. Use these parameters: 'action' => 'dnsmanager' 'dnsaction' => 'AddRecord' - DNS action that DNS Manager should execute 'zone_id' => ID of the zone (use ID from WHMCS) 'record' => data of the record that should be removed Exemplary use: $values = [ 'dnsaction' => 'removeRecord', 'zone_id' => 19, 'record' => [ 'line' => 29, 'name' => 'mail3', 'type' => 'MX', 'class' => 'IN', 'ttl' => '14440', 'data' => [ 'preference' => 3, 'exchange' => 'mailtest.com.' ] ] ]; // Call API $results = localAPI($command, $values); Under 'record' you can include: 'line' => only for editRecord and removeRecord actions. 'name' => name of the record. 'type' => type of the record. 'class' => only 'IN' value supported. 'ttl' => TTL of the record. 'data' => record details depending on its type. Below is a list of available details per type. Type Data A address AAAA address AFSDB subtype, hostname ALIAS target ANAME aname CAA flag, tag, target CERT type, keytag, algorithm, certificate CNAME cname DNAME target DNSKEY protocol, flags, algorithm, publickey DS keytag, algorithm, digesttype, digest Def value HINFO cpu, os HTTPRED keywords, title, hardlink, redirecttype, link ISDN isdnaddress, sa LOC version, size, horiz_pre, vert_pre, latitude, longitude, altitude MB madname MD madname MF madname MG mgmname MINFO rmailbx, emailbx MR newname MX preference, exchange NAPTR order, preference, flags, services, regexp, replacement NS nsdname NSEC nextownername, recordtypes NSEC3 algorithm, flags, iterations, salt, nexthashowner, recordtypes NSEC3PARAM algorithm, flags, iterations, salt RP mbox, txtdname RRSIG type, algorithm, labels, ttl, signatureexpiration, signatureinception, keytag, signer, signature SMIMEA certusage, selector, matchingtype, certdata SOA mname, rname, serial, refresh, retry, expire, minimum SPF txtdata SRV priority, weight, port, target SSHFP algorithm, type, fingerprint TLSA certusage, selector, matchingtype, certdata TXT txtdata URI priority, weight, target URL target WKS address, protocol, bitmap X25 psdnaddress

Use Cases

This section provides exemplary scenarios that demonstrate common use cases and detail how the module's functionalities can be applied in practice. Review the following scenarios to see practical examples of module usage.

Offering DNS Management For Ordered Services

Offering your clients a way to manage DNS zones for products they purchase is one of the core features of the DNS Manager For WHMCS module. First, open the addon and navigate to 'Settings' → 'Servers' to configure a server that will be used to handle DNS Zones. In our case, this will be a cPanel server. Note: More information on how to configure a server can be found in the Server Configuration section.

Next, navigate to 'Settings' → 'Packages' to configure a package. Enable zone creation on 'New Items' and set up the 'Limits'. Note: More information on packages can be found in the Management of Packages section.

Include your products and domains under Items.

Select the server prepared in the previous step.

Make sure either (or both) the 'DNS Management Link' or 'Show DNS Manage Button' is enabled under 'Settings' → 'Global Settings'. Note: Detailed explanation of the other settings can be found in the Global Settings section.

Once clients purchase a product with an appropriate TLD in the domain, they can manage its DNS zones. This option will be available in the client area under 'Domains' → 'Manage DNS' or on the product page under 'Actions', depending on the global settings. Note: More information on the options available to the client can be found in the Client Area section.

Deploying Backup DNS Server For External DNS Zones

If you would like to create a backup of an external DNS zone, a great way to do that would be to utilize the DNS Manager For WHMCS 'slave zone' functionality. Follow the instructions below to see how you can do that. 1. Make sure your package allows for the creation of slave zones.

2. Under 'Domains' → 'Manage DNS' clients can create a slave zone by clicking on the 'Add DNS Zone' button.

3. Select the related item, enable the 'Slave Zone' toggle, and input the slave zone details. Click on 'Confirm' to create the zone.

Delivering DNS Zone Management With rDNS For Ordered Servers

Offering DNS zone management along with rDNS for ordered servers is another core feature of 'DNS Manager For WHMCS'. First, open the addon and navigate to 'Settings' → 'Servers' to configure a server that will be used to handle DNS Zones. In our case, this will be a cPanel server. Make sure to allow rDNS Records at this stage Note: More information on how to configure a server can be found in the Server Configuration section.

Next, navigate to 'Settings' → 'Packages' to configure a package. Remember to include your product, for example, a Proxmox VM. Note: More information on packages can be found in the Management of Packages section.

Select the server prepared in the previous step.

Make sure either (or both) the 'DNS Management Link' or 'Show DNS Manage Button' is enabled under 'Settings' → 'Global Settings'. Note: Detailed explanation of the other settings can be found in the Global Settings section.

Once a client purchases the VM with an appropriate TLD in the domain, they can manage its DNS zones. This option will be available in the client area under 'Domains' → 'Manage DNS' or on the product page under 'Actions', depending on the global settings. Note: More information on the options available to the client can be found in the Client Area section.

Provided the relevant option is enabled in the package settings (step 1), the rDNS tab will be available as well. Note: More information on rDNS can be found in the rDNS section.

Managing Client rDNS Records As Admin

Admins have the ability to manage all of their clients' rDNS records from a single place. First, make sure rDNS record management is enabled. Open the addon and navigate to 'Settings' → 'Servers' to configure a server. Make sure to allow rDNS Records here. Note: More information on how to configure a server can be found in the Server Configuration section.

Next, navigate to 'Settings' → 'Packages' to configure a package. Remember to include the products you want to manage rDNS records for. Note: More information on packages can be found in the Management of Packages section.

Select the server prepared in the previous step.

After the product is deployed and reaches your client, you will be able to manage its rDNS records in the addon. Open the 'rDNS Records' tab in the addon. You will see a list of rDNS records across your clients and their services.

You can use the search function to find specific records. The action button allows you to edit or delete them as needed.

Finally the 'Add PTR Record' button can be found above the list, and will allow you to add new records for any of your clients. Important: Remember that your clients will be able to manage rDNS Records on their own if you enable the 'DNS Management Link' or 'Show DNS Manage Button' options under 'Settings' → 'Global Settings' .

Using Reseller Account For cPanel Server

DNS Manager For WHMCS can be used not only with the root account of cPanel but also with reseller accounts. 1. First, make sure that the reseller account has DNS-related privileges granted in the WHM panel.

2. Open the DNS Manager addon and navigate to 'Settings' → 'Servers' to add a new server or edit an existing cPanel server.

3. Fill in the necessary fields as explained in Servers Configuration. For the 'Username' and 'User Password' use the reseller credentials and enable the 'Reseller Account' switch.

4. Click on 'Confirm' when ready.

5. All that remains is to change the server's status to 'Enabled'.

Providing DNS Zone Management For Domains Without It

If you use a domain registrar that does not support DNS management by default, you may use DNS Manager For WHMCS to introduce such an option. Navigate to 'System Settings' → 'Domain Pricing'. Find the domain you want to use and enable 'DNS Management', then set the registrar that does not support DNS Management under 'Auto Registration'. You can set its price in the 'Domain Addons' table at the bottom.

Now open the DNS Manager addon, navigate to 'Settings' → 'Packages' and prepare a package. Move to the 'Registrars' tab and select your TLD. Note: The TLD has to be included in the package under 'Item' first.

When the domain is ordered, there will be an option to include DNS Management as an addon on the order form. Later on, the option will still be available in the client area under 'Domains' → 'My Domains' → 'Addons'.

After the option is purchased, the in-build WHMCS DNS Management will be available, just as it would for a registrar that does support DNS Management. Note: If the function does not seem to work, make sure that you have set up the 'your_whmcs/modules/addons/DNSManager3/app/Legacy/DNSManager2/storage' folder as recursively writable.

Tips

1. Keep track of your 'pending' and 'progress' 'Tasks' to set an optimum interval time for the task's execution. For example, set an interval in the way that half of the time the task is set to the pending status.

2. While using the OVH submodule, note that each time a client wants to remove a zone, the administrator will receive an email sent by OVH. Only after its confirmation, a given zone will be terminated successfully.

3. 255 characters in TXT records is a maximum limit for the 'PowerDNS' and 'cPanel' submodules.

4. As this module supports template system, any changes made in the module's template files will be saved after the upgrade process.

5. In case you are using cPanel or cPanel Extended provisioning modules with DNS Manager, it is highly advised to enable the Existing Zone Update option. Otherwise, the DNS zone will be previously created by the provisioning module, not by the DNS Manager where an error notification on the already existing zone will appear. That will cause such a zone not to be visible on the Zones List. If the mentioned option is enabled, DNS Manager will fail to check whether the zone already exists and consequently the created by the provisioning module entry will be added to the Zones List.

6. Please note that from the 2.13.0 version of the module, it is obligatory to use a dot at the end of each domain while adding or editing 'DNS Records' and 'DNS Record Sets' . If you do not provide a dot, the module will double your domain. Take a look at the following examples, on the left side we present what is typed by a client, and on the right side you can see the module’s interpretation: An exemplary zone name is example.com @ → example.com. example.com → example.com.example.com. example.com. → example.com. www.example.com. → www.example.com. www.example.com → www.example.com.example.com. www → www.example.com. www. → www.example.com. www.@ → www.example.com.

7. Now you may use 'API Token' instead of 'API Key' to configure the Cloudflare submodule. Before you generate your 'API Token' in your Cloudflare panel, please remember to set the following read/edit permissions there: User/User Details – Read Zone/Zone – Edit Zone/Zone Settings - Edit Zone/DNS - Edit

8. How to correctly add translations of the DNS server errors into the language file: Most errors include a string with a domain name, to add a custom error message, you have to replace this string with :domain_word: phrase. An example of a currently displayed error message: RRset A.testdnsipdefault.by. IN CNAME: Conflicts with pre-existing non-CNAME RRset In this case A.testdnsipdefault.by. must be replaced with :domain_word: A correctly generated lang snippet will look as follows: $_LANG['addonCA']['dashboard']['errors']['RRset :domain_word: IN CNAME: Conflicts with pre-existing non-CNAME RRset'] = "Some serious problem occurred with :domain_word:"; As a result the below message will be displayed in the module: Some serious problems occurred with A.testdnsipdefault.by. Of course, you may skip the domain name in the final output or add a fully customized error message: $_LANG['addonCA']['dashboard']['errors']['RRset :domain_word: IN CNAME: Conflicts with pre-existing non-CNAME RRset'] = "Some serious problem occurred"; $_LANG['addonCA']['dashboard']['errors']['RRset :domain_word: IN CNAME: Conflicts with pre-existing non-CNAME RRset'] = 'My custom translation'; If you do not add any translation into the lang file, an original error message will be displayed.

Update Instructions

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

Migration from V2x.x to V3.x.x

If you want to migrate your DNS Manager For WHMCS to version 3.0, please follow the below steps: Keep both module addons DNS Manager and DNS Manager v3 active Full module configuration is still located in the DNS Manager addon module, your old data are not lost Move to DNS Manager v3 addon module → 'Settings' to enable access to Client Area with support for 'Twenty-One' theme Set up a new cron task (DNS Manager v3 addon module → Settings) Go back to DNS Manager addon module → 'Settings' → 'Global Settings' → 'Client Area Zones Status' and again save the content. Note: Entered content might not be correctly displayed in the new client area view, saving the changes will ensure there are no unexpected errors or missing information.

Migration from V3x.x to V3.4.0

When updating the module to version 3.4.0 keep in mind that: With version 3.4.0 all DNS Manager For WHMCS functionality can be found in one addon. The DNS Manager V2 addon can be safely deactivated and deleted after the module update as it is no longer required for module configuration or management. You need to reissue your module license to ensure proper functionality and avoid any interruptions. Database migration will be done automatically after module update, but can also be triggered manually via script: php -q /yourwhmcs/modules/addons/DNSManager3/cron/cron.php upgrade-3-3-to-3-4

Migration from V2 to V3.5.0

If you are still using the module in version V2 and wish to upgrade it directly to version 3.5.0, please follow the steps below precisely. Any deviation may cause errors and impact module functionality. 1. Update to the latest V2 version: Begin by updating the module to the latest V2 version, which is 2.16.0. Ensure this version is installed before starting the upgrade process. 2. Install the 3.0.0 Beta Version: Follow these steps to install the 3.0.0 Beta version: Keep both module addons DNS Manager and DNS Manager v3 active. Full module configuration is still located in the DNS Manager addon module, your old data are not lost. Move to DNS Manager v3 addon module → 'Settings' to enable access to Client Area with support for 'Twenty-One' theme. Set up a new cron task (DNS Manager v3 addon module → Settings) Go back to DNS Manager addon module → 'Settings' → 'Global Settings' → 'Client Area Zones Status' and again save the content. Note: Entered content might not be correctly displayed in the new client area view, saving the changes will ensure there are no unexpected errors or missing information. 3. Important! Now you must update the module to every next version one by one! Update the module in the following order: 3.1.0 → 3.1.1 → 3.2.0 → 3.2.1 → 3.3.0 → 3.3.1 → 3.3.2 4. Upgrade to version 3.4.0: When updating to version 3.4.0, note the following: With version 3.4.0 all DNS Manager For WHMCS functionality can be found in one addon. The DNS Manager V2 addon can be safely deactivated and deleted after the module update as it is no longer required for module configuration or management. You need to reissue your module license to ensure proper functionality and avoid any interruptions. Database migration will be done automatically after module update, but can also be triggered manually via script: php -q /yourwhmcs/modules/addons/DNSManager3/cron/cron.php upgrade-3-3-to-3-4 5. Final updates: Complete the migration by updating the module through the following versions, in order: 3.4.1 → 3.4.2 → 3.5.0 Important: Contact our support team by opening a ticket to request the necessary module packages. These packages are no longer available for direct download from your ModulesGarden account.

Migration of Zones

'Migration' is another useful tool that you may use to manage zones efficiently. With this tool, you may migrate zones between servers. Keep in mind, that if you wish to transfer the relation that exists in the DNS Manager module to the target server, you must select the 'Move Management To Target Server' option. Otherwise, only the zone will be copied from the original to the target server, the relation to the original server will remain in the module. Remember that migrated zones are available on both servers now! Migration does not delete zones, just copy them to the new server!

To add a migration task, press 'Add Migration', specify from which server you wish to migrate zones, and the target server, as simple as that. Note 1: Migration does not copy DNS Manager settings, to illustrate: if you are migrating zones that exist in DNS Manager their locations for example are not updated. Note 2: You can decide if the option of managing zones should be transferred to the target server. To do it, please tick 'Move Management To Target Server'.

Schedule the migration. Remember to confirm the action.

Move to the list of zones to assign clients and products. Press the button marked on the screen.

Select zones and 'Migrate Zones' for mass migration or use action buttons next to single zones.

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 DNS Manager 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.

2. jQuery 1.9 is required to work properly.

3. In case you cannot see any zone records in your client area after import or migration actions, then disable the cache for the DNS server. To do so, edit the 'General' section of the server.

4. Once you have problems with manually created zones for specific domains, along with the 'Subdomain is not allowed' or 'Invalid zone name' error, make sure to add the .tld that you would like to use to the following file: modules\addons\DNSManager2\storage\tld.list

5. In case your backup task started in your client area is not being processed, make sure that your Cron Import job is not disabled or set to a low frequency.

6. Error: "The selected zone is already taken" Reason 1: A zone with the same name already exists in dns_manager2_zone table (you can also find it on the 'Zones List' in the addon) Reason 2: Other client is using such domain with a product or has it registered. It is allowed as long as the other client's domain status is: Cancelled, Transferred Away, Fraud or Terminated Solution: Find the domain in WHMCS and cancel it Reason 3: Zone already exists on the DNS server (e.g. cPanel)

7. Error: "Message: API failure: (XID 2ugbb6) You do not have access to a domain named “domain.tld”." If you encounter the above error for a zone associated with a cPanel server, it means that you need to set root user permissions for the token that is used in the cPanel submodule configuration.

8. Problem: The DNS Manager button in the client area menu with the Lagom Client Theme is missing. Solution: Use the Lagom Client Theme addon to manually add the missing item to the menu via the menu manager.