Personal tools
Namespaces

Variants
Actions

WithoutDNS For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Tips)
 
(82 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''' is a
+
|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 -->
−
*'''Addon Module:'''
+
 
 +
*'''Main Functionality:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|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;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Use WithoutDNS Free Plan Without Account:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔  
+
|style="padding: 0px 0px 0px 45px;"|✔ All Generated URLs Are Valid For 15 Minutes
 
|}
 
|}
−
 
−
=Installation=
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/abandoned-cart Abandoned Cart For WHMCS.]''' <br />
+
|style="padding: 0px 0px 0px 45px;"|✔ URLs Are Branded With WithoutDNS Service
−
We will guide you step by step through the whole installation and configuration process. <br/>
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
+
|style="padding: 0px 0px 0px 45px;"|✔ Daily Limit Of 3 URLs Shared Across All Clients
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_1.png]]
+
|style="padding: 0px 0px 10px 30px;"|✔ Use [https://withoutdns.com/pricing WithoutDNS Paid Pro Plans] To Access All Functionalities Without Free Plan Limits
 
|}
 
|}
−
<!--
+
 
 +
*'''Admin Area:'''
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''2. In the downloaded file you will find a package that supports PHP 7.4 up to 8.1.'''
+
|style="padding: 10px 0px 0px 30px;"|✔ Configure API Connection With Pro Plan:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP74_81.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ API Token
 
|}
 
|}
−
-->
 
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the extension into the main WHMCS directory.<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ Temporary Domain
−
Extracted files in your WHMCS directory should look like this:
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_2.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Test Connection
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Abandoned Cart For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.<br />
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Addon Module Configuration:
−
This file is located in '' 'modules/addons/AbandonedCart/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_3.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Menu Location In Client Area:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''  <br />
+
|style="padding: 0px 0px 0px 60px;"|✔ Main Menu
−
Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_4.png]]
+
|style="padding: 0px 0px 0px 60px;"|✔ "My Domain" Page
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In the next step, set up the  '' 'storage' '' folder as recursively writable.'''<br />
+
|style="padding: 0px 0px 0px 60px;"|✔ "My Services" Page
−
This folder is available at '' 'your_whmcs/modules/addons/AbandonedCart/' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_5.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Enable WithoutDNS For:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
+
|style="padding: 0px 0px 0px 60px;"|✔ All Clients
−
Log in to your WHMCS admin area. Go to '' 'System Settings' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Abandoned Cart' '' and press the '' 'Activate' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_6.png]]
+
|style="padding: 0px 0px 0px 60px;"|✔ Clients With Active Products
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 0px 60px;"|✔ Clients With Specific Products
−
To do so, click on the '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_7.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Generated URL Limit Type:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Abandoned Cart For WHMCS!'''<br />
+
|style="padding: 0px 0px 0px 60px;"|✔ Unlimited
−
You can access your module at '' 'Addons' '' → '' 'Abandoned Cart'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_8.png]]
+
|style="padding: 0px 0px 0px 60px;"|✔ Limit Per Client
 
|}
 
|}
−
 
−
=Configuration and Management=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Abandoned Cart For WHMCS''' allows you to control all the actions that take place in your marketplace. <br/>
+
|style="padding: 0px 0px 0px 60px;"|✔ Limit Per Product
−
Check the manual below to learn how to configure the module to take all the advantages it has to offer.
+
 
|}
 
|}
−
==Addon Module==
 
−
===Dashboard===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the dashboard you can find the summary graphs of recently created shopping cart.<br/>
+
|style="padding: 0px 0px 0px 45px;"|✔ Set URL Limit Value
−
The first graph illustrates the number of all shopping carts created within the selected period of time. You may choose between 1, 3, 6 and 12 months to show the statistics for.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_9.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Set URL Expiration Time In Hours
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_10.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ View Temporary Website URLs:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|The second graph is dedicated to show the summary of completed orders only.
+
|style="padding: 0px 0px 0px 45px;"|✔ View Related Client And Item
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_11.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ View Domain/URL And IP Address
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|The last graph "Existing Clients Carts / All Carts (%)" represents the percentage of cars created by the existing clients ''(unlogged guests are not taken into consideration)''<br/> towards the number of all carts ''(created by existing clients and guests together)''.
+
|style="padding: 0px 0px 0px 45px;"|✔ View/Copy Temporary URL
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_12.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ View Expiration Date
 
|}
 
|}
−
 
−
===Shopping Carts===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The '' 'Shopping Carts' '' section, as its name suggests, contains a list of all identified carts, with details included, as follows:<br/>
+
|style="padding: 0px 0px 0px 30px;"|✔ View/Manage Module Logs
−
* client full name and its company name ''(if known)''
+
−
* the URL to the order if created
+
−
* the cart details<br/>
+
−
Press the "Snapshots" button to find more specific information on the cart content and actions performed within that cart.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_13.png]]
+
|style="padding: 0px 0px 10px 30px;"|✔ Access WithoutDNS Management Account
 
|}
 
|}
 +
 +
*'''Client Area:'''
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Under "Snapshots" there are details on the cart content, visible at the moment of the last snapshot being taken. <br/> You will find there also the history of changes made by the client, such as:  
+
|style="padding: 10px 0px 0px 30px;"|✔ Create Temporary Website URLs:
−
* adding a new product/addon/domain
+
−
* removing a product/addon/domain
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_14.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Provide URL For Already Owned Service
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Right next to the shopping cart details you will find a button which after pressing shows a direct URL to the abandoned cart.
+
|style="padding: 0px 0px 0px 45px;"|✔ Provide Target Server IP Address
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_14_1.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ View Website Original URL/Domain 
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_14_2.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ View Website IP Address
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|This URL can be automatically placed in the email message sent to a client provided a dedicated "Restore Abandoned Cart" option has been previously enabled [[#General_Settings|(more here)]].<br/> On pressing, the client can get his abandoned cart restored and he will be allowed to continue shopping with the already filled in cart with all the items.<br/> You may also use this URL to resend it manually.
+
|style="padding: 0px 0px 0px 30px;"|✔ View Website Temporary URL
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_14_3.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ View Temporary URL Expiration Date
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You may send email template reminders to preferred clients directly from the shopping carts list. Send emails to single clients or choose several recipients.
+
|style="padding: 0px 0px 10px 30px;"|✔ Delete Website Temporary URL
 
|}
 
|}
 +
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_14_4.png]]
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_14_5.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.3 Back To PHP 8.1
 
|}
 
|}
−
 
−
===Reminders===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|"Reminders" is the clue section of the whole module. Compose the reminders settings to deliver adjusted notifications to clients who abandoned their cart. <br/> Press '' 'Create Reminder' '' button to create your first rule.
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Twenty-One" And "Lagom WHMCS Client Theme"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_15.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.13 Back To WHMCS V8.9
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Configure the reminder by providing the details as explained below:
+
|style="padding: 0px 0px 30px 30px;"|✔ Requires ionCube Loader V14 Or Later
−
* '''Status''' - enable/disable the reminder
+
|}
−
 
+
−
* '''Name''' - give the reminder a unique name
+
  
−
* '''Email Template for Existing Clients''' - choose the email template that will be used to send an email message notifying your already logged in/registered client; "Abandoned Cart - Logged In Client Notification" is the default module template.  
+
=Installation and Synchronization=
−
 
+
{|
−
* '''Email Template for Guests''' - choose the email template that will be used send an email message notifying your guest clients who visited your client area and started shopping; "Abandoned Cart - Open Ticket For Guest" is the default module template. <br/> You may preview and adjust the email templates content at ''your WHMCS → System Settings → Email Templates.''<br/> '''''Note:''' A support ticket is opened at the same time within a dedicated support department.''
+
|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.
−
* '''Related Products/Addons/Domains''' - select items; if any has been added to the cart, a related reminder will be sent to the interested client (logged in or guest who provided the email address)
+
−
 
+
−
* '''Include Carts Created More Than X Days Ago''' - type in the number of days, only carts created BEFORE will be verified
+
−
 
+
−
* '''Include Carts Created Less Than X Days Ago''' - type in the number of days, only carts created AFTER will be verified,<br/> as illustrated: only carts created between the last 3 and 7 days will be checked
+
−
 
+
−
Press '' 'Confirm' '' when your reminder configuration is ready.
+
 
|}
 
|}
 +
==Install The Addon==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_16.png]]
+
|style="padding: 10px 0px 20px 15px;"|'''1. First of all, you need the package, therefore log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|The just created reminder rule will appear on the list with crucial details visible on the front page for a quick and easy preview. <br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_1.png]]
−
You may enable/disable the reminder, edit and delete it using the actions buttons.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_17.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''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.'''<br />
 +
The content of your package should look like on the below screen:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_2.png]]
 
|}
 
|}
  
−
===General Settings===
+
==Activate The Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Under the '' 'General Settings' '' section you will find the cron details - setting it up is crucial for the module's correct behavior and configuration.
+
|style="padding: 10px 0px 15px 15px;"|'''3. Now, you have to activate the addon module in your WHMCS system.'''<br/>
−
'''Cron Task'''<br/>
+
Please log in to your WHMCS admin area. Once there, navigate to the '' 'System Settings' '' section and select '' 'Addon Modules'.'' <br/>
−
Set up the cron that is responsible for sending email messages, based on created reminders as explained in the [[#Reminders|previous step]]. Once a day is recommended to assure fluent module performance.
+
Find 'WithoutDNS' on the list of addons and click the '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''General Settings:'''
+
|style="padding: 0px 0px 15px 15px;"|'''4. After the module has been activated, you will need to enable access to your Admin Role.'''<br/>
−
 
+
To do that, click on '' 'Configure','' select the admin roles that should have access to the module, and save changes.
−
* '''Client Email Address''' - related to new visitors only; when a guest client starts to browse your store, he or she will be asked to provide an email address before being allowed to continue and complete the order:
+
−
**Disabled
+
−
**Require email address - the client will be forced to enter the email address to be able to continue the shopping
+
−
**Allow to skip this step - the client can type in the email address or press "Skip" to continue shopping, if "Skip" is pressed, no data will be collected by the module
+
−
 
+
−
* '''Force Login/Registration''' - related to new visitors and unlogged clients; when a client adds an item to the cart, he or she will be forced to either log in (if the account already exists) or register a new account (new clients).<br/> Otherwise, continuing the shopping will be impossible.<br/> '''''Important:''' Being logged in or at least providing an email address is required for the module correct behavior, without the email address no messages will be sent to remind clients about their abandoned carts.''<br/> '''''Note:''' We highly recommend enabling just one of the options, otherwise, guest clients will be forced to provide an email address in the first step and register an account in the next one.''
+
−
+
−
* '''Restore Abandoned Cart''' - if enabled, clients will receive a direct link to their abandoned cart, in the module reminding email message, with its all contents restored to easily complete the order.
+
−
 
+
−
* '''Support Department''' - select one of the available support departments. A ticket to remind the guest clients about their abandoned carts will be opened within this department. <br/>
+
−
When your configuration is ready, do not forget to press the '' 'Submit' '' button to save your changes.
+
−
 
+
−
* '''Allow To Save Shopping Carts''' - when turned on, customers have the ability to save their shopping carts while placing an order.<br/> They can later access these carts from their profiles and share them with other customers using session URLs, instantly restoring the cart's contents.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|'''Your module has just been successfully installed and activated!'''
 
|}
 
|}
  
−
===Logs===
+
==Sign Up With WithoutDNS Account==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|The '' 'Logs' '' section contains information an all actions taken by the module.
+
|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:AC_20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You may always delete the logs if their number is extensive.<br/>
+
|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.
−
Use the action button for mass removal of all existing log entries.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_20_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_5.png]]
 
|}
 
|}
−
 
−
==Client Area==
 
−
===Email/Login Requirement===
 
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|Once an unlogged client visits your marketplace, they will be asked to leave some of their personal data. The extent of what exactly must be provided depends on the module [[#General_Settings|configuration]].
+
|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 15px 15px;"|The moment the client starts browsing your store, they will be either:
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_6.png]]
−
*forced to provide an email address in order to be allowed to complete the shopping ''([[#General_Settings|"Client Email Address"]] option is set to "Require email address")''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_22.png]]
+
|style="padding: 0px 0px 15px 15px;"|Click the "Generate Token" button to create a new API token.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_7.png]]
−
*asked to enter an email address in order to be allowed to complete the shopping ''([[#General_Settings|"Client Email Address"]] option is set to "Allow to skip this step")''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_22_1.png]]
+
|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 15px;"|
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_8.png]]
−
*forced to log in or register a new account in order to be allowed to complete the shopping ''([[#General_Settings|"Force Login/Registration"]] option is enabled)''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_23.png]]
+
|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=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If '' 'Log in' '' is selected, the potential customer will be redirected to the standard client area login page.
+
|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.
 
|}
 
|}
 +
 +
==API Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_23_1.png]]
+
|style="padding: 10px 0px 15px 15px;"|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.<br/ >
 +
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].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|For '' 'Register' '' choice, the visitor will be asked to create a new account using a standard form.
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_23_2.png]]
+
|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/>
 +
Click "Test Connection" to confirm that the API token is working. If the connection is successful, save your changes.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Being logged in or leaving an email address is required for the module to be able to send email messages to clients reminding them about abandoned carts and their content.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_9_1.png]]
−
This is how an exemplary email notification sent to a client might look like:
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_24.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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Guest clients who leave only the email address and have no account in your system will get quite a similar notification email.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_9_2.png]]
−
'''''Note:''' The system will open a new support ticket in a dedicated department at the same time. Only the assigned admin will have access to this ticket.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_25.png]]
+
|style="padding: 0px 0px 30px 15px;"|That is all, you may now use the module without restrictions.  
 
|}
 
|}
  
−
===Shopping Lists===
+
==Addon Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Clients have the convenience of storing their shopping carts to be viewed and finalized in the future.<br/> By clicking the "Save Cart" button while in your cart, the current contents of the cart will be promptly saved and stored in your shopping lists.
+
|style="padding: 10px 0px 15px 15px;"|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.<br/>
 +
 
 +
Once your configuration is complete, click '''Submit''' to save your settings.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_28.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_10.png]]
 
|}
 
|}
 +
 +
==Websites==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_29.png]]
+
|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 15px 15px;"|Once you have saved the cart as a shopping list, you can then access the list and manage it according to your needs.<br/> You will find the "My Shopping Lists" button in your account details dropdown menu.
+
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_11.png]]
 
|}
 
|}
 +
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_30.png]]
+
|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/ >
 +
For more information about logging functionality, refer to the ModulesGarden [https://www.docs.modulesgarden.com/Logs Logs wiki article].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Once you navigate to the "My Shopping Lists" page, you will find all your stored carts with basic details on the dashboard.  
+
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_12.png]]
−
Allowed actions on a :
+
−
- Shopping cart URL
+
−
- Shopping cart items
+
−
- Delete saved shopping cart
+
 
|}
 
|}
 +
 +
==Client Area==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_31.png]]
+
|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 15px 15px;"|Clients may copy a direct URL to the cart and distribute it to others by providing them with the link. Upon opening the link, they will receive an identical copy of your shopping cart, allowing them to place their orders more quickly.
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_32.png]]
+
|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/> 
 +
Press '''Create Site''' button to generate a new, temporary link.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Explore the contents of this shopping list by previewing the items. Check details on the item types and their current availability in the store.
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_15.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_33.png]]
+
|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 15px;"|Easily remove individual carts or utilize the mass action button to eliminate multiple items at once.
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_34.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WDNS_16_1.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.
 +
* '''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). <br/> '''''Note:'''  Free URLs cannot be deleted manually. They expire automatically after 15 minutes.''
 
|}
 
|}
−
 
−
=WithoutDNS platform=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|
+
|style="padding: 0px 0px 30px 25px;"|[[File:WDNS_17.png]]
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"| 1. The module collects information on products, addons and domains left in the cart. No data on configurable options, custom fields etc. related to products is stored.  
+
|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.  
 
|}
 
|}
  
Line 358: Line 369:
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. In case of connection problems, please 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.'''
 
|}
 
|}

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