Difference between revisions of "Domains Tab"

From WHMCS Documentation

(Domain Sync Enabled)
(Auto Renew Requires Product)
 
(34 intermediate revisions by 6 users not shown)
Line 1: Line 1:
For information regarding domain management in WHMCS [[Domains_Management|refer to this page]].
+
{{General Settings}}<br/>
 +
 
 +
The '''Domains''' tab allows you to configure how WHMCS registers and renews domains. For information, see [[Domains_Management]], [[Domain Namespinning]], and [[Domain Pricing]].
 +
 
 +
You can access this tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
 +
 
 +
<div class="docs-alert-info">
 +
<i class="fa fa-question-circle"></i>
 +
In WHMCS 7.6 and later, you can configure the following settings at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings > Automation Settings''':
 +
* '''Domain Sync Enabled'''
 +
* '''Sync Next Due Date'''
 +
* '''Domain Sync Notify Only'''
 +
</div>
  
 
===Domain Registration Options===
 
===Domain Registration Options===
Unticking these options will hide the associated option from the order form. For example if you do not wish customers to transfer domain names to you, unticking the checkbox will remove the option from the order form.
+
 
When all options are unticked the ''Choose a Domain'' domain checker will also be removed from the default template homepage.
+
Unchecking these options will hide the associated option from the order form. For example, if you do not wish customers to transfer domain names to you, unchecking the checkbox will remove the option from the order form.
 +
 
 +
When all options are unchecked, the '''Choose a Domain''' domain checker will also be removed from the default template homepage.
  
 
===Enable Renewal Orders===
 
===Enable Renewal Orders===
When enabled clients will see domain renewal options in the client area and a renewal category in the shopping cart allowing for them to renew domains at any time. When unticked clients will only be able to renew domains when the renewal invoice is automatically generated.
+
 
 +
When enabled, clients will see domain renewal options in the client area and a renewal category in the shopping cart allowing for them to renew domains at any time.  
 +
 
 +
When disabled, clients will only be able to renew domains when the renewal invoice is automatically generated.
  
 
===Auto Renew on Payment===
 
===Auto Renew on Payment===
 +
 
Enabling will renew domains automatically at the registrar (eNom, ResellerClub etc) when the renewal invoice is paid.
 
Enabling will renew domains automatically at the registrar (eNom, ResellerClub etc) when the renewal invoice is paid.
 +
 +
For more information, see [[Domains_Management#Domain_Renewals_2|Domain Renewals]].
 +
 +
===Auto Renew Requires Product===
 +
 +
With this option ticked, domain names with a Recurring Amount value of 0.00 will only be renewed if there is a corresponding service under the same client with a matching domain name and next due date. If there is none, the domain renewal will not be processed and a "Free Domain Renewal Manual Action Required" error emailed to admins along with an entry in the '''Activity Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs'''.
 +
 +
This is useful for preventing accidental free domain renewals when [[Common_Promotions|offering free domains]]. Under certain circumstances the Next Due Date of the domain and the service can fall out of sync.
 +
 +
If you do wish to renew the domain, navigate to the client's Domains tab and click the "Renew" Module Command button.
  
 
===Default Auto Renewal Setting===
 
===Default Auto Renewal Setting===
If enabled, your customers will automatically be invoiced for the renewal of domain names in line with your automation settings. You can override this on an individual domain level by ticking the Do Not Renew checkbox on the client’s domain tab. For more information [[Domains_Management#Automatic_Renewal|refer to this page]].
 
  
===Domain Sync Enabled===
+
If enabled, your customers will automatically be invoiced for the renewal of domain names in line with your automation settings. You can override this on an individual domain level by ticking the Do Not Renew checkbox on the client’s domain tab. For more information, see [[Domains_Management#Automatic_Renewal|Domains Management]].
Automatically checks and updates the Status and Expiry Date of domains names against your domain registrar to ensure the date in WHMCS is always correct (registrar permitting). To use this feature tick the option and configure the following cron job on your server:
+
 
 +
===Create To-Do List Entries===
 +
 
 +
When enabled, entries will be created automatically in the [[System_Utilities#To-Do_List|To-Do List]] when a domain-related action occurs that requires manual intervention. For example, if a domain registration fails due to an error, with this option enabled an entry will appear.
  
php -q /path/to/home/public_html/whmcspath/crons/domainsync.php
+
===Allow IDN Domains===
  
 +
Check this option to allow domains to contain any characters, including UTF-8.
  
This can be configured as often as you like, however to avoid overloading your domain registrar we advise to run no more frequently than every 4 hours.
+
If you don't check this option, WHMCS will only allow clients to use <tt>a</tt>-<tt>z</tt> and <tt>0</tt>-<tt>9</tt> in domain names.
  
For additional security the /crons directory can be moved outside the publicly accessible directory, for more information refer to [[Further_Security_Steps#Move_the_crons_folder|Further Security Steps]]
+
=== Domain Grace and Redemption Fees ===
  
===Sync Next Due Date===
+
Enabling this will activate the [[Domain Grace and Redemption Grace Periods]] functionality, allowing clients to place renewal orders for domains after the expiration date, and be charged according to your grace /redemption pricing scale specified at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Pricing]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Pricing'''.
Used in conjunction with the above feature, when ticked the Next Due Date will be synchronized with domain name's Expiry Date. The number field can also be used to specify how far in advance of the Expiry Date to set the Next Due Date - the default setting 0 means the Expiry Date and Next Due Dates will be the same. Increasing the number means the renewal invoice will be due before the domain's expiry date, useful if your clients use slow payment methods such as cash or cheques which need time to clear.
 
  
===Domain Sync Notify Only===
+
When this option is disabled, domain renewal invoices will be cancelled upon the domain passing the expiration date.
Used in conjunction with the Domain Sync options above, enabling this will email a list of domain names to your administrators which have incorrect Statuses and Expiry Dates, but not change them.
 
  
===Allow IDN Domains===
+
When this option is enabled, with grace periods and [[Domain_Grace_and_Redemption_Grace_Periods#Setting_Grace_Periods.2FRedemption_Grace_Periods_and_Fees_in_WHMCS|grace renewal prices defined]], domain renewal invoices will remain in unpaid status for the duration of the grace and redemption periods.
Ticking this option allows domains containing any character to be used. When unticked WHMCS will only allow clients to use a-z and 0-9 in domains.
 
  
===Bulk Domain Search===
+
If this feature is enabled, but no grace or redemption periods are configured, domain renewal invoices will be cancelled upon the domain passing the expiration date.
Enables/Disables the Bulk Domain Checker option for your visitors. Select the TLDs below:
 
  
===Bulk Check TLDs===
+
===Domain Grace and Redemption Fee Billing===
Select additional TLDs to be automatically checked when a customer looks up a domain’s availability on the shopping cart. For example, they search for example.com, you can also show them the results for example.net, example.org and example.co.uk. This is a great way to upsell your customers. Hold Ctrl and left-click to select multiple TLDs.
 
  
'''Note:''' This only applies to the shopping cart process and not the bulk domain checker.
+
This setting controls how additional domain renewal fees are invoiced. When a domain is renewed during the grace period or the redemption period, chose whether to add the fee to the customer's existing domain renewal invoice, or create a new invoice just for the fees.
  
 
===Default Nameservers===
 
===Default Nameservers===
In these fields specify the default nameservers to be used for standalone domain orders, these would typically be your own or that of an outside DNS management service (eg. your domain registrar). For example in order to use eNom's DNS management service the default nameservers would be:
+
 
 +
In these fields specify the default nameservers to be used for standalone domain orders, these would typically be your own or that of an outside DNS management service (eg. your domain registrar). For example, in order to use eNom's DNS management service the default nameservers would be:
  
 
  dns1.name-services.com
 
  dns1.name-services.com
Line 50: Line 77:
 
  dns5.name-services.com
 
  dns5.name-services.com
  
 +
When a domain is ordered alongside a hosting service the appropriate nameservers set under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers''' are used instead.
  
When a domain is ordered alongside a hosting service the appropriate nameservers set under Setup > Products/Services > Servers > Edit are used instead.
+
===Default Contact Details===
  
===Default Contact Details===
+
Specify which details will be displayed in the WHOIS database for domains registered through WHMCS upon initial registration (registrar module permitting).  
Specify which details will be displayed in the whois database for domains registered through WHMCS (registrar module permitting). The client's details will always be used as the registrant contact, ticking ''Use Clients Details'' will use their details for all other contacts. But by unticking this option and entering your details in the fields beneath these will be used as the Billing, Admin and Technical contacts instead.
+
 
 +
The client's details will always be used as the registrant contact. Checking '''Use Clients Details''' will use their details for all other contacts. If you uncheck this option and enter your details in the fields beneath, they will be used as the Billing, Admin, and Technical contacts instead.
 +
 
 +
Users will be able to change this later in the Client Area.

Latest revision as of 16:30, 12 May 2022


The Domains tab allows you to configure how WHMCS registers and renews domains. For information, see Domains_Management, Domain Namespinning, and Domain Pricing.

You can access this tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.

In WHMCS 7.6 and later, you can configure the following settings at Configuration () > System Settings > Automation Settings or, prior to WHMCS 8.0, Setup > General Settings > Automation Settings:

  • Domain Sync Enabled
  • Sync Next Due Date
  • Domain Sync Notify Only

Domain Registration Options

Unchecking these options will hide the associated option from the order form. For example, if you do not wish customers to transfer domain names to you, unchecking the checkbox will remove the option from the order form.

When all options are unchecked, the Choose a Domain domain checker will also be removed from the default template homepage.

Enable Renewal Orders

When enabled, clients will see domain renewal options in the client area and a renewal category in the shopping cart allowing for them to renew domains at any time.

When disabled, clients will only be able to renew domains when the renewal invoice is automatically generated.

Auto Renew on Payment

Enabling will renew domains automatically at the registrar (eNom, ResellerClub etc) when the renewal invoice is paid.

For more information, see Domain Renewals.

Auto Renew Requires Product

With this option ticked, domain names with a Recurring Amount value of 0.00 will only be renewed if there is a corresponding service under the same client with a matching domain name and next due date. If there is none, the domain renewal will not be processed and a "Free Domain Renewal Manual Action Required" error emailed to admins along with an entry in the Activity Log at Configuration () > System Logs or, prior to WHMCS 8.0, Utilities > Logs.

This is useful for preventing accidental free domain renewals when offering free domains. Under certain circumstances the Next Due Date of the domain and the service can fall out of sync.

If you do wish to renew the domain, navigate to the client's Domains tab and click the "Renew" Module Command button.

Default Auto Renewal Setting

If enabled, your customers will automatically be invoiced for the renewal of domain names in line with your automation settings. You can override this on an individual domain level by ticking the Do Not Renew checkbox on the client’s domain tab. For more information, see Domains Management.

Create To-Do List Entries

When enabled, entries will be created automatically in the To-Do List when a domain-related action occurs that requires manual intervention. For example, if a domain registration fails due to an error, with this option enabled an entry will appear.

Allow IDN Domains

Check this option to allow domains to contain any characters, including UTF-8.

If you don't check this option, WHMCS will only allow clients to use a-z and 0-9 in domain names.

Domain Grace and Redemption Fees

Enabling this will activate the Domain Grace and Redemption Grace Periods functionality, allowing clients to place renewal orders for domains after the expiration date, and be charged according to your grace /redemption pricing scale specified at Configuration () > System Settings > Domain Pricing or, prior to WHMCS 8.0, Setup > Products/Services > Domain Pricing.

When this option is disabled, domain renewal invoices will be cancelled upon the domain passing the expiration date.

When this option is enabled, with grace periods and grace renewal prices defined, domain renewal invoices will remain in unpaid status for the duration of the grace and redemption periods.

If this feature is enabled, but no grace or redemption periods are configured, domain renewal invoices will be cancelled upon the domain passing the expiration date.

Domain Grace and Redemption Fee Billing

This setting controls how additional domain renewal fees are invoiced. When a domain is renewed during the grace period or the redemption period, chose whether to add the fee to the customer's existing domain renewal invoice, or create a new invoice just for the fees.

Default Nameservers

In these fields specify the default nameservers to be used for standalone domain orders, these would typically be your own or that of an outside DNS management service (eg. your domain registrar). For example, in order to use eNom's DNS management service the default nameservers would be:

dns1.name-services.com
dns2.name-services.com
dns3.name-services.com
dns4.name-services.com
dns5.name-services.com

When a domain is ordered alongside a hosting service the appropriate nameservers set under Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers are used instead.

Default Contact Details

Specify which details will be displayed in the WHOIS database for domains registered through WHMCS upon initial registration (registrar module permitting).

The client's details will always be used as the registrant contact. Checking Use Clients Details will use their details for all other contacts. If you uncheck this option and enter your details in the fields beneath, they will be used as the Billing, Admin, and Technical contacts instead.

Users will be able to change this later in the Client Area.