Personal tools
Namespaces

Variants
Actions

WithoutDNS For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎API Configuration)
(→‎Tips)
 
(73 intermediate revisions by one user not shown)
Line 2: Line 2:
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The WithoutDNS For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The WithoutDNS For WHMCS Module."></meta>
  
−
=About [https://www.modulesgarden.com/products/whmcs/withoutdns WithoutDNS For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/withoutdns WithoutDNS For WHMCS]=  
 +
{|
 +
|style="padding: 10px 0px 10px 0px;"|'''WithoutDNS For WHMCS''' is an addon module that integrates the WithoutDNS platform with your WHMCS.<br/> It simplifies website testing and migration by generating a temporary URL that points your domain to a selected server IP via a proxy. <br/>
 +
This lets you preview and test your site on the new server without editing your local hosts file.
 +
|}
 
<!-- fixed -->
 
<!-- fixed -->
  
−
*'''Synchronization Benefits:'''
+
*'''Main Functionality:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Access 91 Powerful Business Reports
+
|style="padding: 10px 0px 0px 30px;"|✔ Allow Clients To Generate Temporary URLs To View Their Websites Without Configured DNS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Use WithoutDNS Free Plan Without Account:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ All Generated URLs Are Valid For 15 Minutes
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ URLs Are Branded With WithoutDNS Service
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Daily Limit Of 3 URLs Shared Across All Clients
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Use [https://withoutdns.com/pricing WithoutDNS Paid Pro Plans] To Access All Functionalities Without Free Plan Limits
 
|}
 
|}
  
−
*'''General Features:'''
+
*'''Admin Area:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Secure Synchronization With No Personal Data Stored
+
|style="padding: 10px 0px 0px 30px;"|✔ Configure API Connection With Pro Plan:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Fully GDPR Compliant
+
|style="padding: 0px 0px 0px 45px;"|✔ API Token
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.2 Back To PHP 7.3
+
|style="padding: 0px 0px 0px 45px;"|✔ Temporary Domain
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V8.12 Back To WHMCS V7.2
+
|style="padding: 0px 0px 0px 45px;"|✔ Test Connection
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Addon Module Configuration:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Select Menu Location In Client Area:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Main Menu
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ "My Domain" Page
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ "My Services" Page
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Enable WithoutDNS For:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ All Clients
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Clients With Active Products
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Clients With Specific Products
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Generated URL Limit Type:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Unlimited
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Limit Per Client
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Limit Per Product
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Set URL Limit Value
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Set URL Expiration Time In Hours
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Temporary Website URLs:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ View Related Client And Item
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ View Domain/URL And IP Address
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ View/Copy Temporary URL
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ View Expiration Date
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View/Manage Module Logs
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Access WithoutDNS Management Account
 
|}
 
|}
  
−
*'''Exclusive Promo Code From ModulesGarden:'''
+
*'''Client Area:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Create Temporary Website URLs:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Provide URL For Already Owned Service
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Provide Target Server IP Address
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Website Original URL/Domain 
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Website IP Address
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Website Temporary URL
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Temporary URL Expiration Date
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Delete Website Temporary URL
 +
|}
 +
 
 +
*'''General Info:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.3 Back To PHP 8.1
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Twenty-One" And "Lagom WHMCS Client Theme"
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.13 Back To WHMCS V8.9
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 30px 30px;"|✔ '''Save 25%''' For '''3 Months''' On The MetricsCube Platform With Coupon: '''WHMCS25%_MC'''
+
|style="padding: 0px 0px 30px 30px;"|✔ Requires ionCube Loader V14 Or Later
 
|}
 
|}
  
 
=Installation and Synchronization=
 
=Installation and Synchronization=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''We have prepared a short but comprehensive tutorial that will show you how to successfully install [https://www.modulesgarden.com/products/whmcs/metricscube-business-analytics MetricsCube Business Analytics For WHMCS] module and synchronize your WHMCS with MetricsCube.'''<br/>
+
|style="padding: 10px 0px 15px 15px;"|'''We have prepared a short but comprehensive tutorial that will show you how to successfully install [https://www.modulesgarden.com/products/whmcs/withoutDNS WithoutDNS For WHMCS] module and synchronize your WHMCS with WithoutDNS platform.'''<br/>
 
Although the process is extremely easy and intuitive, go over the below guide to assure it is fast, smooth and trouble-free.   
 
Although the process is extremely easy and intuitive, go over the below guide to assure it is fast, smooth and trouble-free.   
 
|}
 
|}
Line 53: Line 176:
 
|style="padding: 10px 0px 15px 15px;"|'''3. Now, you have to activate the addon module in your WHMCS system.'''<br/>
 
|style="padding: 10px 0px 15px 15px;"|'''3. Now, you have to activate the addon module in your WHMCS system.'''<br/>
 
Please log in to your WHMCS admin area. Once there, navigate to the '' 'System Settings' '' section and select '' 'Addon Modules'.'' <br/>
 
Please log in to your WHMCS admin area. Once there, navigate to the '' 'System Settings' '' section and select '' 'Addon Modules'.'' <br/>
−
Find 'MetricsCube Connector' on the list of addons and click the '' 'Activate' '' button.
+
Find 'WithoutDNS' on the list of addons and click the '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
Line 63: Line 186:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_4.png]]
 
|}
 
|}
 
{|
 
{|
Line 69: Line 192:
 
|}
 
|}
  
−
==Sign Up And Synchronize With WithoutDNS==
+
==Sign Up With WithoutDNS Account==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Now, move to ...........
+
|style="padding: 10px 0px 20px 15px;"|'''Creating an account and purchasing a Pro plan is entirely optional. The addon works without a WithoutDNS account, though certain limitations will apply.'''<br/> If you want to use the addon with full functionality and no restrictions, please follow the guide below to set up the API connection.<br/>
 +
 
 +
It is possible to connect your WHMCS to a WithoutDNS account directly from the addon interface. Simply, press the '''Manage Account''' button in the addon menu.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Enter ................
+
|style="padding: 0px 0px 20px 15px;"|You will be redirected to the WithoutDNS login page. Log in with your existing account, or if you're a new user, choose a plan that suits your needs and sign up.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|On pressin
+
|style="padding: 0px 0px 15px 15px;"|Once logged in, navigate to the API Configuration section, which you can find in the dropdown menu under your account name in the top-right corner.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In '
+
|style="padding: 0px 0px 15px 15px;"|Click the "Generate Token" button to create a new API token.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_7.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|When move
+
|style="padding: 0px 0px 15px 15px;"|Copy the generated API token and store it securely. You’ll need it shortly to complete the connection setup in WHMCS.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|You've nailed it! There is nothing to stop you now from using all MetricsCube tools and boosting the productivity of your business processes!
+
|style="padding: 0px 0px 30px 15px;"|Return to the WHMCS admin area to complete the addon configuration and establish a connection between your WHMCS and your WithoutDNS account if needed.
 
|}
 
|}
  
 
=WithoutDNS Addon Management=
 
=WithoutDNS Addon Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|As soon as the...........
+
|style="padding: 10px 0px 30px 15px;"|'''Once the addon is installed and activated, you can proceed with its configuration to begin using it fully.'''<br/>
 +
Read through the sections below to learn about all the possibilities of the WithoutDNS For WHMCS module.<br/> You will find out how to adjust the module to your business's attributes.
 
|}
 
|}
  
−
==Addon Configuration==
+
==API Configuration==  
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|Use the settings below to customize how the WithoutDNS addon behaves within your WHMCS installation:
+
|style="padding: 10px 0px 15px 15px;"|Integrating the API is optional, but without it, certain limitations will apply:  
−
* '''Menu Location''' - Choose where the WithoutDNS addon will appear in the client area navigation:
+
* Links generated without the API will only remain active for '''15 minutes'''.
−
** '''Main Menu''' - Displays as a new top-level item after "Open Ticket" (default).
+
* URLs will include '''WithoutDNS branding'''.
−
** '''Services''' - LListed under the "My Services" section.
+
* A daily '''limit of 3 links''' applies, and this quota is shared across all clients.<br/ >
−
** '''Domains''' - Listed within the "My Domains" section.
+
To gain unrestricted access and additional features, you will need to enter your generated API credentials as described in the previous steps.<br/> If you do not have an API key yet, you can get a plan [https://withoutdns.com/pricing#pro-pricing here].
−
* '''Enable WithoutDNS for''' - Define which clients are granted access to the addon:
+
−
** All Clienst - Available to every client in the system (default).
+
−
** Clients with an active product -  Only accessible to clients with at least one active service.
+
−
** Clienst with specific products - Access is granted only to clients who own products selected in the "Required Products" dropdown list.
+
−
* '''Generated URL Limit Type''' - Specify how URL generation limits should be enforced:
+
−
** unlimited - no restrictions on the number of generated URLs (default setting)
+
−
** Limit Per Client -  restrict th enumber of URLs each client can generate
+
−
** Limit per product - restrict th enumber of URLs based on the specific product owned by the client
+
−
* '''URL Expiration Time (hours)''' - Specifies the default lifespan of generated URLs in hours (default 48h) with the option for customization as needed.
+
 
|}
 
|}
−
 
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_9.png]]
 
|}
 
|}
−
 
−
==API Configuration==
 
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|Using the API is not required, but skipping it will impose certain limitations::
+
|style="padding: 0px 0px 15px 15px;"|Paste the '''API token''' you generated during the setup process into the API Token field. This is required to authenticate your WHMCS system with the WithoutDNS API.<br/>
−
* Links generated without the API will only remain active for 15 minutes.
+
Click "Test Connection" to confirm that the API token is working. If the connection is successful, save your changes.
−
* These links will display the WithoutDNS branding.
+
−
* A daily limit of 3 links applies, and this quota is shared across all clients.<br/ >
+
−
TTo gain unrestricted access and additional features, you’ll need to enter your API credentials.
+
−
If you don’t have an API key yet, you can get a plan [https://withoutdns.com/pricing#pro-pricing here].
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_9_1.png]]
−
* '''API Token''' -  Enter the API token obtained during the earlier setup steps. This token is required to authenticate your WHMCS installation with the WithoutDNS API.
+
−
* '''Temporary Domain''' - Select one of the available proxy domains associated with your WithoutDNS account. This domain will be used to generate temporary access links.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 15px 15px;"|Once connected, the '''Temporary Domain''' field will appear. Select one of the available proxy domains linked to your account.<br/>
 +
Choose between an EU or US-based domain, which will be used for generating temporary URLs.
 
|}
 
|}
−
 
−
==Websites==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|By default, once the synchronization of your WHMCS is completed, the personal data of your clients are not processed to MetricsCube.<br/> Therefore, some features offered by MetricsCube can be unavailable.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_9_2.png]]
−
 
+
−
If you would like to benefit fully from the possibilities provided by MetricsCube, you can grant access to personal data.<br/> To do so, simply click on the '' 'Configure' '' button in the '' 'Data Synchronization' ''tab.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 30px 15px;"|That is all, you may now use the module without restrictions.  
 
|}
 
|}
 +
 +
==Addon Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Once a new popup window opens, you will notice a possibility to tick additional configuration options. There are:  
+
|style="padding: 10px 0px 15px 15px;"|Use the settings below to customize how the WithoutDNS addon behaves within your WHMCS installation:
−
* '''General Data''' - stands for general data sharing required by MetricsCube to provide core services such as reporting, therefore this option is switched on by default.
+
* '''Menu Location''' - Choose where the '''Site Previes''' button will appear in the client area navigation:
−
* '''Live Data Synchronization''' - only if selected, data on recent activities in your system, such as users online, income or news feed, will be gathered and displayed in the Live Dashboard section.<br/>'' '''Note:''' Keep in mind that both slow connection with API and actions overload may noticeably slow down the application.''
+
** '''Main Menu''' - Appears as a new menu item after "Open Ticket" ''(default)''.
−
* '''Detailed User Data''' - this option allows you to transfer to MetricsCube additional data about your clients such as first name, last name, company name, email address, web hosting and domains assigned to them. <br/>[https://www.docs.modulesgarden.com/images/0/07/MCC22.png Here] you can check an exemplary report along with the personal data of clients.<br/>If this option is disabled, the client’s WHMCS will encrypt sensitive personal information and convey it in coded form.<br/>[https://www.docs.modulesgarden.com/images/b/b1/MCC23.png Here] you can find the previous example of the report without the consent to process the data.<br/>If this option is enabled, the generated reports will be more detailed and straightforward.<br/> '' '''Note:''' Please keep in mind that all data sent to MetricsCube is safely encrypted using the strong algorithm SHA-256.''
+
** '''Services''' - Displays under "My Services" section.
−
* '''User Tracking''' - this option permits you to monitor the activity of your clients on the basis of logs generated through WHMCS. <br/> For instance, you can check when and which websites were browsed by your customers or verify if your clients have already read the answer for a ticket. <br/> '' '''Note:''' Please remember that this functionality is currently during the development '''and is not available yet.''' <br/>If you tick this option right now, you may be sure that once this functionality is completed, you will be granted access to it instantly.''
+
** '''Domains''' - Displays under "My Domains" section.
 +
* '''Enable WithoutDNS for''' - Define which clients are granted access to the addon functionality:
 +
** '''All Clients''' - Enabled for every client ''(default)''.
 +
** '''Clients with an active product''' - Only available to clients with at least one active service.
 +
** '''Clienta with specific products''' -  Only available to clients with selected products defined in the ''Required Products'' dropdown.
 +
* '''Generated URL Limit Type''' - Set how limits on URL generation should be enforced:
 +
** '''Unlimited''' - No restrictions on how many URLs a client can generate ''(default)''.
 +
** '''Limit Per Client''' -  Each client is given an individual limit.
 +
** '''Limit per product''' -  The limit is applied based on the specific product(s) the client owns.
 +
* '''URL Expiration Time (hours)''' - Defines how long generated URLs remain active. The default is 48 hours, but this can be customized.<br/>
  
−
'''Important:''' Please, be aware that the data update in MetricsCube, once you opt in or opt out for additional data synchronization, may take '''up to 24h'''.
+
Once your configuration is complete, click '''Submit''' to save your settings.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_10.png]]
 
|}
 
|}
  
−
 
+
==Websites==
−
==Logs==
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|The MetricsCube Connector For WHMCS addon module allows to download Connector Logs. Press the button as shown on the screen to fetch logs.
+
|style="padding: 10px 0px 15px 15px;"|The '''Sites''' section in the admin area displays all temporary sites created by clients.<br/>
 +
This list includes all fields visible to clients, along with additional administrative details:
 +
* '''Client''' - Displays the username of the client who created the site.
 +
* '''Related Item''' - Product or service associated with the temporary site
 +
* '''Domain/URL''' -  The domain linked to the temporary URL.
 +
* '''IP Address''' - Server IP assigned to the site.
 +
* '''Temporary URL''' – An access link, valid for a limited time.
 +
* '''Expires At''' – Time when the temporary URL will expire.<br/>
 +
 
 +
'''''Note:''' Expired sites are automatically removed from the system during the daily WHMCS cron job, no additional cron setup is required.<br/> If a client's account is deleted from WHMCS, all of their associated sites will also be removed.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_11.png]]
 
|}
 
|}
 +
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In case there are any issues and fetching logs is hampered, you will need to create or modify the log file in a required directory. <br/>
+
|style="padding: 10px 0px 15px 15px;"|The module keeps a detailed log of all client activity within the module. This includes actions such as URL generation, setting changes, and access events.<br/ >
−
The correct path will be generated automatically and may be copied from the error notification that will appear on your screen. Please set the privileges as defined in the notifications. <br/>  
+
For more information about logging functionality, refer to the ModulesGarden [https://www.docs.modulesgarden.com/Logs Logs wiki article].
−
When ready, patiently wait until the next synchronization.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_12.png]]
 
|}
 
|}
  
−
==Manage Account==
+
==Client Area==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|It is possible to connect your WHMCS to MetricsCube with another account from one addon. Simply, press the second button on the addon dashboard.
+
|style="padding: 10px 0px 15px 15px;"|The '''Site Previews'''  section, where clients can manage their temporary access links, is available in one of three locations depending on the addon configuration: 
 +
* '''Main Menu''' - Displays as a new item after "Open Ticket" ''(default, as presented on the screen below)''.
 +
* '''Services''' - Listed under the ''"My Services"'' section.
 +
* '''Domains''' - Listed within the ''"My Domains"'' section.
 +
Locate the appropriate menu item based on your setup and click it to access the '' 'Site Previews'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|This very moment you will see a warning notification on the consequences of such action.<br/>
+
|style="padding: 0px 0px 15px 15px;"|This section allows you to create temporary URLs to preview your website, even if DNS records are not yet set up.<br/>  
−
Connecting with another account will reset your current configuration and your WHMCS will be no longer synchronized with your existing MetricsCube account.<br/>  
+
Press '''Create Site''' button to generate a new, temporary link.
−
You will have to go through the process from the beginning.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_15.png]]
 
|}
 
|}
−
==Client Area Experience==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Grant
+
|style="padding: 0px 0px 15px 15px;"|Fill in the following fields:
 +
* '''Site URL/Domain''' - Enter the full URL or just the domain name of the site you want to preview.
 +
* '''Service''' - Select a service from the dropdown to automatically fetch the associated IP address. If the service has a dedicated IP, it will be used. <br/> Select "No Service" to manually specify an IP address. Note that this option is available only if '''Enable WithoutDNS for''' is set to '''"All Clients"''' in the [[#Addon_Configuration|addon configuration]].
 +
* '''Target Server IP Address''' - This field appears if you select '''"No Service"''' in the ''Service'' field. <br/>Enter the IP address of the server hosting the website for the entered Site URL/Domain. Leave it empty to preview the site on the current server.<br/>
 +
Press '''Confirm''' to generate the temporary URL.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Mark the
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_16_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
|style="padding: 0px 0px 15px 15px;"|Once created, your temporary site will appear in the list below. The following details are displayed:
−
|}
+
* '''Domain/URL''' - The domain linked to the temporary URL.
−
 
+
* '''IP Address''' - The IP address associated with the selected service.
−
=WithoutDNS Platform=
+
* '''Temporary URL''' - The active access link. Click the copy icon for quick sharing.
−
{|
+
* '''Expires At''' - The expiration time of the generated link.
−
|style="padding: 10px 0px 15px 15px;"|Here it is! Ready, complex and so much detailed analysis of your business.<br/>
+
* '''Actions''' - Option to manually delete a URL (available only on paid plans). <br/> '''''Note:'''  Free URLs cannot be deleted manually. They expire automatically after 15 minutes.''
−
Quickly [https://dashboard.metricscube.io/sign-in sign in] to your account and start the exploration.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"| Most of all, accurate and flexible reports that will help you look deep into your company's performance.<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_17.png]]
−
Browse, change the periods and search for anything you might only need. 
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_3.png]]
+
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|1. Take a look at our [https://www.youtube.com/@MetricsCube YouTube] channel! You will find there short videos presenting three different methods of installing your MetricsCube Connector For WHMCS.<br/>
+
|style="padding: 10px 0px 30px 15px;"|1. To unlock the full potential of the WithoutDNS For WHMCS addon, consider configuring the API connection with your WithoutDNS Pro account.<br/> While the addon functions without an account, setting up the API removes limitations such as the 15-minute URL lifespan and the daily limit of three URLs.  
−
Stay tuned as other videos are coming soon!
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|2. Step into the MetricsCube [https://www.metricscube.io/blog Blog] where you will find the latest Release Notes together with thought-provoking Business Guides.<br/>
+
−
Get the gist of the web hosting industry, let yourself be guided across the various reports types and finally reach for practical advice on how to boost your business development.  
+
 
|}
 
|}
  
Line 254: Line 369:
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. When you encounter problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you encounter problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 30px 15px;"|2. If you encounter any issues with redirection to WHMCS via buttons like '''View in WHMCS''' in the MetricsCube pop-up, please ensure the '''Administration Panel URL'''' in '''MetricsCube → My Application''' settings is accurately configured.
 

Latest revision as of 10:01, 17 April 2025

Contents

[edit] About WithoutDNS For WHMCS

WithoutDNS For WHMCS is an addon module that integrates the WithoutDNS platform with your WHMCS.
It simplifies website testing and migration by generating a temporary URL that points your domain to a selected server IP via a proxy.

This lets you preview and test your site on the new server without editing your local hosts file.

  • Main Functionality:
✔ Allow Clients To Generate Temporary URLs To View Their Websites Without Configured DNS
✔ Use WithoutDNS Free Plan Without Account:
✔ All Generated URLs Are Valid For 15 Minutes
✔ URLs Are Branded With WithoutDNS Service
✔ Daily Limit Of 3 URLs Shared Across All Clients
✔ Use WithoutDNS Paid Pro Plans To Access All Functionalities Without Free Plan Limits
  • Admin Area:
✔ Configure API Connection With Pro Plan:
✔ API Token
✔ Temporary Domain
✔ Test Connection
✔ Set Up Addon Module Configuration:
✔ Select Menu Location In Client Area:
✔ Main Menu
✔ "My Domain" Page
✔ "My Services" Page
✔ Enable WithoutDNS For:
✔ All Clients
✔ Clients With Active Products
✔ Clients With Specific Products
✔ Generated URL Limit Type:
✔ Unlimited
✔ Limit Per Client
✔ Limit Per Product
✔ Set URL Limit Value
✔ Set URL Expiration Time In Hours
✔ View Temporary Website URLs:
✔ View Related Client And Item
✔ View Domain/URL And IP Address
✔ View/Copy Temporary URL
✔ View Expiration Date
✔ View/Manage Module Logs
✔ Access WithoutDNS Management Account
  • Client Area:
✔ Create Temporary Website URLs:
✔ Provide URL For Already Owned Service
✔ Provide Target Server IP Address
✔ View Website Original URL/Domain 
✔ View Website IP Address
✔ View Website Temporary URL
✔ View Temporary URL Expiration Date
✔ Delete Website Temporary URL
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 8.3 Back To PHP 8.1
✔ Supports WHMCS Themes "Twenty-One" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.13 Back To WHMCS V8.9
✔ Requires ionCube Loader V14 Or Later

[edit] Installation and Synchronization

We have prepared a short but comprehensive tutorial that will show you how to successfully install WithoutDNS For WHMCS module and synchronize your WHMCS with WithoutDNS platform.

Although the process is extremely easy and intuitive, go over the below guide to assure it is fast, smooth and trouble-free.

[edit] Install The Addon

1. First of all, you need the package, therefore log in to our client area and download the module.
WDNS 1.png
2. Open the FTP Client, log into the server with WHMCS installed. Then, open the main catalogue and upload the folder with files you have extracted previously.

The content of your package should look like on the below screen:

WDNS 2.png

[edit] Activate The Addon

3. Now, you have to activate the addon module in your WHMCS system.

Please log in to your WHMCS admin area. Once there, navigate to the 'System Settings' section and select 'Addon Modules'.
Find 'WithoutDNS' on the list of addons and click the 'Activate' button.

WDNS 3.png
4. After the module has been activated, you will need to enable access to your Admin Role.

To do that, click on 'Configure', select the admin roles that should have access to the module, and save changes.

WDNS 4.png
Your module has just been successfully installed and activated!

[edit] Sign Up With WithoutDNS Account

Creating an account and purchasing a Pro plan is entirely optional. The addon works without a WithoutDNS account, though certain limitations will apply.
If you want to use the addon with full functionality and no restrictions, please follow the guide below to set up the API connection.

It is possible to connect your WHMCS to a WithoutDNS account directly from the addon interface. Simply, press the Manage Account button in the addon menu.

WDNS 13.png
You will be redirected to the WithoutDNS login page. Log in with your existing account, or if you're a new user, choose a plan that suits your needs and sign up.
WDNS 5.png
Once logged in, navigate to the API Configuration section, which you can find in the dropdown menu under your account name in the top-right corner.
WDNS 6.png
Click the "Generate Token" button to create a new API token.
WDNS 7.png
Copy the generated API token and store it securely. You’ll need it shortly to complete the connection setup in WHMCS.
WDNS 8.png
Return to the WHMCS admin area to complete the addon configuration and establish a connection between your WHMCS and your WithoutDNS account if needed.

[edit] WithoutDNS Addon Management

Once the addon is installed and activated, you can proceed with its configuration to begin using it fully.

Read through the sections below to learn about all the possibilities of the WithoutDNS For WHMCS module.
You will find out how to adjust the module to your business's attributes.

[edit] API Configuration

Integrating the API is optional, but without it, certain limitations will apply:
  • Links generated without the API will only remain active for 15 minutes.
  • URLs will include WithoutDNS branding.
  • A daily limit of 3 links applies, and this quota is shared across all clients.

To gain unrestricted access and additional features, you will need to enter your generated API credentials as described in the previous steps.
If you do not have an API key yet, you can get a plan here.

WDNS 9.png
Paste the API token you generated during the setup process into the API Token field. This is required to authenticate your WHMCS system with the WithoutDNS API.

Click "Test Connection" to confirm that the API token is working. If the connection is successful, save your changes.

WDNS 9 1.png
Once connected, the Temporary Domain field will appear. Select one of the available proxy domains linked to your account.

Choose between an EU or US-based domain, which will be used for generating temporary URLs.

WDNS 9 2.png
That is all, you may now use the module without restrictions.

[edit] Addon Configuration

Use the settings below to customize how the WithoutDNS addon behaves within your WHMCS installation:
  • Menu Location - Choose where the Site Previes button will appear in the client area navigation:
    • Main Menu - Appears as a new menu item after "Open Ticket" (default).
    • Services - Displays under "My Services" section.
    • Domains - Displays under "My Domains" section.
  • Enable WithoutDNS for - Define which clients are granted access to the addon functionality:
    • All Clients - Enabled for every client (default).
    • Clients with an active product - Only available to clients with at least one active service.
    • Clienta with specific products - Only available to clients with selected products defined in the Required Products dropdown.
  • Generated URL Limit Type - Set how limits on URL generation should be enforced:
    • Unlimited - No restrictions on how many URLs a client can generate (default).
    • Limit Per Client - Each client is given an individual limit.
    • Limit per product - The limit is applied based on the specific product(s) the client owns.
  • URL Expiration Time (hours) - Defines how long generated URLs remain active. The default is 48 hours, but this can be customized.

Once your configuration is complete, click Submit to save your settings.

WDNS 10.png

[edit] Websites

The Sites section in the admin area displays all temporary sites created by clients.

This list includes all fields visible to clients, along with additional administrative details:

  • Client - Displays the username of the client who created the site.
  • Related Item - Product or service associated with the temporary site
  • Domain/URL - The domain linked to the temporary URL.
  • IP Address - Server IP assigned to the site.
  • Temporary URL – An access link, valid for a limited time.
  • Expires At – Time when the temporary URL will expire.

Note: Expired sites are automatically removed from the system during the daily WHMCS cron job, no additional cron setup is required.
If a client's account is deleted from WHMCS, all of their associated sites will also be removed.

WDNS 11.png

[edit] Logs

The module keeps a detailed log of all client activity within the module. This includes actions such as URL generation, setting changes, and access events.

For more information about logging functionality, refer to the ModulesGarden Logs wiki article.

WDNS 12.png

[edit] Client Area

The Site Previews section, where clients can manage their temporary access links, is available in one of three locations depending on the addon configuration:
  • Main Menu - Displays as a new item after "Open Ticket" (default, as presented on the screen below).
  • Services - Listed under the "My Services" section.
  • Domains - Listed within the "My Domains" section.

Locate the appropriate menu item based on your setup and click it to access the 'Site Previews'.

WDNS 14.png
This section allows you to create temporary URLs to preview your website, even if DNS records are not yet set up.

Press Create Site button to generate a new, temporary link.

WDNS 15.png
Fill in the following fields:
  • Site URL/Domain - Enter the full URL or just the domain name of the site you want to preview.
  • Service - Select a service from the dropdown to automatically fetch the associated IP address. If the service has a dedicated IP, it will be used.
    Select "No Service" to manually specify an IP address. Note that this option is available only if Enable WithoutDNS for is set to "All Clients" in the addon configuration.
  • Target Server IP Address - This field appears if you select "No Service" in the Service field.
    Enter the IP address of the server hosting the website for the entered Site URL/Domain. Leave it empty to preview the site on the current server.

Press Confirm to generate the temporary URL.

WDNS 16.png
WDNS 16 1.png
Once created, your temporary site will appear in the list below. The following details are displayed:
  • Domain/URL - The domain linked to the temporary URL.
  • IP Address - The IP address associated with the selected service.
  • Temporary URL - The active access link. Click the copy icon for quick sharing.
  • Expires At - The expiration time of the generated link.
  • Actions - Option to manually delete a URL (available only on paid plans).
    Note: Free URLs cannot be deleted manually. They expire automatically after 15 minutes.
WDNS 17.png

[edit] Tips

1. To unlock the full potential of the WithoutDNS For WHMCS addon, consider configuring the API connection with your WithoutDNS Pro account.
While the addon functions without an account, setting up the API removes limitations such as the 15-minute URL lifespan and the daily limit of three URLs.

[edit] Update Instructions

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

[edit] Common Problems

1. When you encounter problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=WithoutDNS_For_WHMCS&oldid=75796"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community
WithoutDNS For WHMCS