Resellerclub Mods Console v3 Documentation

Upload files and folders

1. Upload the folder "modules" from the unzipped local folder \resellerclubmods_core_x.x.x into the whmcsroot/ folder. The "whmcsroot" folder is where you have installed your WHMCS.

Activate and Configure

Log into your WHMCS System and goto Setup > Addon Modules

1. Click the Button "Activate" and then "Configure"
   
   


2. This will show the configuration options for the Resellerclub Mods Console. Set your Reseller ID and API Key. You can leave the field for the Reseller Password empty. A description for the available options are below the following screenshot:
   
   

   Config Options

   LogicBoxes Reseller Accounts - ResellerClub, NetEarthOne, Resell.biz (stargate) and ResellerCamp

   • Reseller ID: Set your Reseller ID. The Reseller ID is a numeric value and not your Reseller Login username. To find your Reseller ID, read this KB Article here
   
   
   • API Key: Set your API Key. You can find your API Key in your LogicBoxes Reseller Account » Settings » API.
   
   
   • Reseller Password: Set your Reseller Password (Deprecated). You can leave this field empty.
   
   

   Other LogicBoxes Reseller Account

   • Domain Registrar: If you have setup another LogicBoxes Registrar module instead of one of the four built-in Modules, for example "Resellerid", then you can setup the account by selecting the registrar from the dropdown menu.
   
   
   • Reseller ID: Set your Reseller ID. The Reseller ID is a numeric value and not your Reseller Login username. To find your Reseller ID, read this KB Article here
   
   
   • API Key: Set your API Key. You can find your API Key in your LogicBoxes Reseller Account » Settings » API.
   
   
   • License Key: Set the license key for the Product or Products you ordered previously. You can find the License Key for each Product in our Client Area Products details page.
   
   

   L.C.D.Registrar Module

   • DNSSEC Support: By default, the DNSSEC Interface is available to manage these records for any TLD configured in the below field. You can disable the interface to your customers.
   
   
   • TLD's with DNSSEC Support: Up to date, DNSSEC Support is only offered for com, net, org, in and me Domains. You can configure and extend the default list for any other TLDs with DNSSEC Support.
   
   
   • Domain Transfer Additional fields: Transfer for some ccTLD's requires the same additional domain fields as for register. By default the field is prefilled with the domain extensions who requires additional domain fields while transfering a domain name. You can always extend the list by adding other Domain extensions
   
   
   • Renew Redemption Domains: With this option activated, a restore request for a domain in redemption period will be automatically send to the registrar once a pending renewal invoice has been paid. For further details and additional configuration steps in WHMCS visit the following link: WHMCS - Domain Grace and Redemption Grace Periods
   
   
   • Auto disable ID Protection: Tick to toggle off automatically ID Protection Service when registrar unlock is requested from the client or admin area
   
   
   • Limit IDN: You can limit the IDN feature to those TLD's which are explicitly configured to auto register with the L.C.D.Registrar Module
   
   
   • Nameservers for Transfers: By default, the LCD Registrar module does not pass nameservers for domain transfers. You can force to use always the specified Nameservers (default or custom) for Domain Transfers by activating this option.
   
   
   • Ignore Domain Transfersync: Tick to ignore the built-in WHMCS Transfer sync. Disabling is recommended if you use a third party advanced transfer sync tool.
   
   
   • Disable Re-sent Email Buttons: By default, customers can re-send the RAA / IRTP Verification Email and GDPR Autorization Email. Tick to disable the re-sent buttons and show only the pending status messages.
   
   
   • New gTLD Premium Domains: Tick to enable selling new gTLD Premium Domains. If not enabled, available domains considered as "premium domains" will be shown as unavailable.
   
   
   • Selling Premium Domains: By default, the module does not offer these feature. If you would like to sell premium domains, then you need to activate this feature first.
   
   
   • Premium TLDs: Specify the TLDs for which premium domains should be looked up. Leave empty to show only results for the searched domain TLD. (comma separated eg. com,net,org)
   
   
   • Premium Domain Results: Specify the number of results to show. If empty, the default value of 5 will be used.
   
   
   • Selling Domain Suggestion: Tick to enable Suggest Domain Names
   
   
   • Suggest TLDs: Specify the TLDs for which suggest domains should be looked up (example: com,net,org). Leave empty to show only results for the searched domain TLD. To check for alternative TLDs insert an asterisk (example: *)
   
   
   • Suggest Domain Results: Specify the number of results to show. If empty, the default value of 5 will be used
   
   
   • Exact Match: true or false. By default always false. Will return TLD alternatives when set to true and Suggest TLDs has been set with an asterisk (*)
   
   
   • Spin Score: By default results will not be filtered based on the score value. You can set here a value to filter the results based on a score value. Example: 0.550 - This will not show results below this score
   
   
   • Premium/Suggest Domain lookup: Select the registrar to use for premium and suggest domain lookup. This should be one of the registrar's you use for register domains!
   
   
   • ID Protection Addon: Tick to enable Pro-rata charge for the ID Protection Addon
   
   
   • Disable ID Protection Invoicing: Tick to disable invoicing for the ID Protection Addon. This is especially useful when you offer free id protection and do not want the system to generate an invoice with a zero amount
   
   
   • Dns Management Addon: Tick to enable Pro-rata charge for the Dns Management Addon
   
   
   • Disable Dns Management Invoicing: Tick to disable invoicing for the Dns Management Addon. This is especially useful when you offer free Dns Management and do not want the system to generate an invoice with a zero amount
   
   
   • Email Forwarding Addon: Tick to enable Pro-rata charge for the Email Forwarding Addon
   
   
   • Disable Email Forwarding Invoicing: Tick to disable invoicing for the Email Forwarding Addon. This is especially useful when you offer free Email Forwarding and do not want the system to generate an invoice with a zero amount
   
   

   R.A.M.Dns Interface

   • DNS Check Global: R.A.M.Dns Interface comes with a Name server check and auto change function. It checks if the domain name has been configured with the correct Reseller DNS Servers and offers the possibility to change automatically to the partially or fully branded Reseller Name servers. You can globally disable the check and change function by activating the Checkbox.
   
   
   • DNS Check Hosting: This options acts like the "DNS Check Global" but only if the domain has a non LogicBoxes Hosting account. If activated, the function to check and change DNS Servers will not be offered if the domain uses a non LogicBoxes Hosting Account.
   
   
   • Google Apps DNS Records: By default, the DNS interface shows 1-click Google Apps DNS Record setup for A, CNAME, MX, SRV and TXT(spf) records. If you do not want to expose these buttons, then tick the checkbox.
   
   
   • DNSSEC Support: By default, the DNSSEC Interface is available to manage these records for any TLD configured in the below field. You can disable the interface to your customers.
   
   
   • TLD's with DNSSEC Support: Up to date, DNSSEC Support is only offered for com, net, org, in and me Domains. You can configure and extend the default list for any other TLDs with DNSSEC Support.
   
   
   • Domain Forwarding Check: The Build-In Domain forwarding Interface in R.A.M.Dns Interface always checks if a domain has an active hosting plan and disallows the Domain forwarding Service to be activated. You can disable the Hosting Service Check for the Domain forwarding Activation Process by checking the Checkbox.
   
   

   R.A.M.Email Interface

   • EMAIL Name Server Check: R.A.M.Email Interface comes with a Nameserver check and auto change function. It checks if the domain name has been configured with the correct Reseller DNS Servers and offers the possibility to change automatically to the partially or fully branded Reseller Nameservers. As a second option it shows the DNS Records setup for the Domain Name's existing Nameservers if the customer do not want to change to recommended Nameservers. You can disable the check and change function by checking the Checkbox
   
   
   • Hosting Account Check: By default, FREE Email Service will not be accessible if a domain has a hosting account associated in your WHMCS. This is useful to avoid MX Record conflicts between the Hosting account and the FREE Email service. However, you can disable the check function and allow FREE Email Service.
   
   
   • FREE Email Accounts. By default, FREE Email Service allows Email accounts setup. With every domain, 2 Email accounts can be created by the customer. You can globally disable this feature to allow only Email forwarder Service.
   
   

   R.E.M.Domain Interface

   • Whois ID Protection: R.E.M.Domain Interface allows the customers to activate/deactivate the WHOIS ID protection instantly from the Client Area Domain Contact details page. If you do not want to offer your customers the possibility to activate/deactivate the WHOIS ID protection, then uncheck the checkbox.
   
   
   • DNSSEC Support: By default, the DNSSEC Interface is available to manage these records for any TLD configured in the below field. You can disable the interface to your customers.
   
   
   • TLD's with DNSSEC Support: Up to date, DNSSEC Support is only offered for com, net, org, in and me Domains. You can configure and extend the default list for any other TLDs with DNSSEC Support.
   
   

   Miscellaneous

   • Hide v3 Modules: Hide a v3 Module from the Addon Home and Sidebar if the corresponding new v4 Module has been installed
   
   
   • Disable Basic Transliteration: Tick to disable Basic Transliteration for Customer Account register and Domain Contacts Creation
   
   
   • WHMCS Admin API User: Some of our Modules makes use of the WHMCS Internal API. You can use any of the Admin Users you have setup in WHMCS
   
   
   • API Url: Must be always "https://httpapi.com" if not changed previously by the LogicBoxes Registrar
   
   
   • Domain API Url: The LogicBoxes Domain API URL: https://domaincheck.httpapi.com. Do not change this unless instructed!
   
   
   • Access Control: Select The Administrator Roles who should have access to the addon from the admin area.

Finally, click the button "Save Changes".

Check and Verify

Access now the Addon from the "Addons Tab" » ResellerClub Mods Console and check the product and configuration details for the products you have a valid license:

The Addon installation is complete. Now you can proceed with the installation for the purchased module. Once you have installed and used the product for the first time, the license and product information will be automatically validated and updated. If you have correctly set your product license key and your ResellerClub / LogicBoxes credentials, then you will see something similar like the following screenshot based on your activated product:

Setup the Admin Area Homepage Widget

By default, Admin Area Home Widgets are not enabled. Follow the instructions below to enable the Widget:

1. Goto Setup » Staff Management » Administrator Roles and select the Admin Group who should have permission to see the widget on the admin home page.


2. Under the "Widgets" Section you will see the new widget called "Resellerclub Mods Management Core Console ". Tick the checkbox and "Save Changes"

From any previous version

To update the Resellerclub Mods Console, follow the instructions below step by step:

Do not upload files individually into locations not indicated by these instructions.

1. Download the ResellerClub Mods Management Core Console, available from any of the product license details page in the Client Area. Unzip the file with your prefered decompresion software


2. Upload the the complete folder "modules" from the unzipped local folder \resellerclubmods_core_x.x.x\ into the whmcsroot/ folder. The "whmcsroot" folder is where you have installed your WHMCS


3. Access the Resellerclub Mods Console Addon to get the new version number stored

The update has been finished.