MX Registrar For WHMCS
(→Installation and Configuration) |
(→About MX Registrar For WHMCS) |
||
(102 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
− | <meta name="keywords" content="mx registrar for whmcs, mx registrar configuration, whmcs mx registrar management, whmcs mx registrar installation, whmcs mx registrar common problems, about whmcs mx registrar, whmcs mx registrar documentation, whmcs mx registrar faq, whmcs mx registrar help, whmcs mx registrar guide, whmcs mx registrar wiki, whmcs mx registrar tutorial, whmcs mx registrar tips, whmcs mx registrar wiki"></meta> | + | <meta name="keywords" content="mx registrar for whmcs, mx registrar configuration, whmcs mx registrar management, whmcs mx registrar installation, whmcs mx registrar common problems, about whmcs mx registrar, whmcs mx registrar documentation, whmcs mx registrar faq, whmcs mx registrar help, whmcs mx registrar guide, whmcs mx mexican registrar wiki, whmcs mx registrar tutorial, whmcs mx registrar tips, whmcs mx mexico registrar wiki"></meta> |
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The MX Registrar For WHMCS Module."></meta> | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The MX Registrar For WHMCS Module."></meta> | ||
− | =About [ | + | =About [https://www.modulesgarden.com/products/whmcs/mx-registrar MX Registrar For WHMCS]= |
{| | {| | ||
− | |style="padding: 10px 0px 10px 0px;"|'''MX Registrar For WHMCS is a registrar module that | + | |style="padding: 10px 0px 10px 0px;"|'''MX Registrar For WHMCS''' is a domain registrar module that enables automation of Mexico ''(.mx)'' domains provisioning in your WHMCS.<br /> |
− | + | The module utilizes MX Registrar WHOIS Module and allows you to maintain full control over each ordered Mexican domain through your WHMCS admin area. | |
|} | |} | ||
− | *'''Features:''' | + | <!--a comment maybe? --> |
+ | *'''Module Features:''' | ||
{| | {| | ||
− | |style="padding: 10px 0px 0px 30px;"|✔ | + | |style="padding: 10px 0px 0px 30px;"|✔ Disable Auto Renewal After Successful Domain Registration |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Disable Auto Renewal After Successful Domain Renewal |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Suspend Domain X Days After Expiration |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Delete Domain X Days After Expiration |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Synchronize Domain Expiration Date And Status |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Synchronize Domain Transfer Status | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 30px;"|✔ Toggle WHOIS Server | ||
+ | |} | ||
+ | *'''Admin Area Features:''' | ||
+ | {| | ||
+ | |style="padding: 10px 0px 0px 30px;"|✔ Register/Transfer/Renew Domain | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Request Domain Deletion | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Approve/Reject/Cancel Domain Transfer | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Update Contact Details | ||
|} | |} | ||
{| | {| | ||
Line 27: | Line 47: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Get EPP Code |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Lock/Unlock Registrar | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 30px;"|✔ Toggle Domain Auto Renewal | ||
+ | |} | ||
+ | *'''Client Area Features:''' | ||
+ | {| | ||
+ | |style="padding: 10px 0px 0px 30px;"|✔ Enable/Disable Domain Auto Renewal | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Manage Nameservers | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Update Contact Details | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 30px;"|✔ Get EPP Code | ||
+ | |} | ||
+ | *'''General Info:''' | ||
+ | {| | ||
+ | |style="padding: 10px 0px 0px 30px;"|✔ Utilizes MX Registrar WHOIS Module | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Supports TLS 1.1 and 1.2 | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.3 | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One" | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.8 Back To WHMCS V8.3 | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later |
|} | |} | ||
− | |||
{| | {| | ||
− | |style="padding: | + | |style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/mx-registrar#open-source-version Open Source Version] |
|} | |} | ||
=Installation and Configuration= | =Installation and Configuration= | ||
{| | {| | ||
− | |style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure MX Registrar For WHMCS.''' <br /> | + | |style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/mx-registrar MX Registrar For WHMCS.]''' <br /> |
We will guide you step by step through the whole installation and configuration process. <br /> | We will guide you step by step through the whole installation and configuration process. <br /> | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 20px 0px 20px 15px;"|'''1. Log in to | + | |style="padding: 20px 0px 20px 15px;"|'''1. Log in to our client area and download the module.''' |
|} | |} | ||
{| | {| | ||
Line 49: | Line 103: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/> |
− | + | In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. --> | |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''3. When you install MX Registrar for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/> |
− | File is located | + | The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/> |
+ | '''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].'' | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 15px;"| <!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/mx-registrar#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.''' | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory. <br/> | ||
+ | The content of the package to upload should look like this. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:werw.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 15px 15px;"|'''4. When you install MX Registrar For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> | ||
+ | File is located in '' 'modules/registrars/mxregistrar/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' ''. | ||
|} | |} | ||
{| | {| | ||
Line 63: | Line 135: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br /> |
− | Enter your | + | Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products' ''. |
|} | |} | ||
{| | {| | ||
Line 70: | Line 142: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''6. Now you have to generate your certificate. To do so, open your linux root console and paste this line:'''<br /> |
openssl req -nodes -newkey rsa:1024 -keyout epp_complete.key -out epp_complete.csr | openssl req -nodes -newkey rsa:1024 -keyout epp_complete.key -out epp_complete.csr | ||
− | Afterwards enter details you will be asked for. | + | where:<br/> |
+ | -keyout - name of key file<br/> | ||
+ | -out - name of CSR file<br/> <br/> | ||
+ | If you run the above command exactly, then certificate will be generated in the catalog you currently are in.<br/> | ||
+ | If you enter a direct path for example:<br/> | ||
+ | /var/www/whmcs/epp_complete.csr | ||
+ | then it will be generated directly in the pointed catalog. | ||
+ | |||
+ | Afterwards, enter details you will be asked for. | ||
|} | |} | ||
{| | {| | ||
Line 78: | Line 158: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''7. Send '' 'epp_complete.csr' '' file along with your host IP to Registry.MX and wait for an email with certificate.'''<br /> |
− | As soon as you | + | As soon as you get it, create new file '' 'epp_complete.pem' '' which must be composed of generated earlier '' 'epp_complete.key', '' certificate and certificate file that you have received from Registry.MX.<br /> |
− | Content of your '' 'epp_complete.pem' '' file | + | Content of your '' 'epp_complete.pem' '' file has to be similar to:<br /> |
-----BEGIN RSA PRIVATE KEY----- | -----BEGIN RSA PRIVATE KEY----- | ||
MIICXAIBAAKB3gwIBAgICdAIcw9F... | MIICXAIBAAKB3gwIBAgICdAIcw9F... | ||
Line 89: | Line 169: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 15px;"|'''8. Copy '' 'epp_complete.pem' '' file you have just created to your MX Registrar module folder, which is located in '' 'your_whmcs/modules/registrars/mxregistrar' ''.''' |
|} | |} | ||
{| | {| | ||
Line 95: | Line 175: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|''' | + | |style="padding: 10px 0px 15px 15px;"|'''9. Now you have to activate the module in your WHMCS system. '''<br /> |
− | Log in to your WHMCS admin area and go to '' 'Setup' '' → '' 'Products/Servers' '' → '' 'Domain Registrars' ''. Afterwards find '' 'MX Registrar' '' and press '' 'Activate' '' button. | + | Log in to your WHMCS admin area and go to '' 'Setup' '' → '' 'Products/Servers' '' → '' 'Domain Registrars' ''.<br /> |
+ | Afterwards, find '' 'MX Registrar' '' and press '' 'Activate' '' button. | ||
|} | |} | ||
{| | {| | ||
Line 102: | Line 183: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''10. In the next step you need to configure test mode.'''<br /> |
To do so, enter '' 'Server' '', '' 'Certificate File Name' '', '' 'Sandbox Username' '' and '' 'Sandbox Password' ''.<br /> | To do so, enter '' 'Server' '', '' 'Certificate File Name' '', '' 'Sandbox Username' '' and '' 'Sandbox Password' ''.<br /> | ||
− | Afterwards tick '' 'Test Mode' '' checkbox and press '' 'Save Changes' ''. | + | Afterwards, tick '' 'Test Mode' '' checkbox and press '' 'Save Changes' ''. |
|} | |} | ||
{| | {| | ||
Line 112: | Line 193: | ||
==Accreditation== | ==Accreditation== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|''' | + | |style="padding: 10px 0px 15px 15px;"|'''11. In order to connect with live server you have to pass accreditation test.'''<br /> |
To do so, enter '' 'your_whmcs/modules/registrars/mxregistrar/mx_accreditation.php?domain=testmx0.mx' '' to your web browser.<br /> | To do so, enter '' 'your_whmcs/modules/registrars/mxregistrar/mx_accreditation.php?domain=testmx0.mx' '' to your web browser.<br /> | ||
You should see something like on the screen below. | You should see something like on the screen below. | ||
Line 120: | Line 201: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|''' | + | |style="padding: 0px 0px 20px 15px;"|'''12. Now go to '' 'Setup' '' → '' 'Products/Servers' '' → '' 'Domain Registrars' ''. Afterwards find '' 'MX Registrar' '' and press '' 'Configure' '' button. |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:MX14.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|''' | + | |style="padding: 0px 0px 20px 15px;"|'''13. Enter '' 'Username' '', '' 'Password' '' and '' 'Server' '' for live server and unmark '' 'Test Mode' '' checkbox. Afterwards press '' 'Save Changes' ''.''' |
|} | |} | ||
{| | {| | ||
Line 142: | Line 223: | ||
==Management of TLDs== | ==Management of TLDs== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|Adding new TLD is quite simple. To add it, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domain Pricing' ''.<br /> | + | |style="padding: 10px 0px 15px 15px;"|Adding a new TLD is quite simple. To add it, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domain Pricing' ''.<br /> |
Enter your TLD and choose '' 'MX Registrar' '' from '' 'Auto Registration' '' dropdown menu as shown on the screen below.<br /> | Enter your TLD and choose '' 'MX Registrar' '' from '' 'Auto Registration' '' dropdown menu as shown on the screen below.<br /> | ||
− | Here you can also decide whether to offer your customers | + | Here you can also decide whether to offer your customers features like EPP Code. Then press '' 'Save Changes' ''. |
|} | |} | ||
{| | {| | ||
Line 162: | Line 243: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|MX Registrar For WHMCS can now use its custom MX Registrar WHOIS. <br /> |
+ | If you wish to use such option you have to replace the default [https://docs.whmcs.com/WHOIS_Servers WHMCS WHOIS] with the custom one. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 15px;"|'''For WHMCS V7'''<br/> | ||
+ | Create a custom whois.json file located at ''WHMCS_DIR/resources/domains/whois.json'' | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 15px;"|Line format that shall be added at the end of the above file: | ||
+ | .tld|YOUR_WHMCS/modules/registrars/mxregistrar/whois.php?domain= | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 15px;"|Take a look at the exemplary line: | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:MX20.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 15px;"|'''For WHMCS V6 or earlier'''<br/> | ||
+ | Add them to the already existing ''WHMCS_DIR/includes/whoisservers.php'' file. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 15px;"|Line format that shall be added at the end of the above file: | ||
+ | .tld|YOUR_WHMCS/modules/registrars/mxregistrar/whois.php?domain=|HTTPREQUEST-free | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 15px;"|Take a look at the exemplary line: | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:MX20_1.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 15px;"|''Remember to change '.tld' in the beginning of the line to the tld (i.e. .mx or com.mx) you wish to set up!'' | ||
+ | If you have added the line properly, while checking domain availability WHMCS will be using this custom WHOIS MX Registrar. | ||
|} | |} | ||
==Ordering== | ==Ordering== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|Ordering .mx domain goes alike | + | |style="padding: 10px 0px 15px 15px;"|Ordering .mx domain goes alike ordering other domains. A typical order is presented on the screen below. |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:MX11.png]] |
|} | |} | ||
==Management of Domain== | ==Management of Domain== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|In the admin area you can manage all the aspects of the domain. | + | |style="padding: 10px 0px 15px 15px;"|In the admin area client overview → '' 'Domains' '' tab you can manage all the aspects of the domain.<br /> |
− | + | Along with basic actions like '' 'Register' '', '' 'Renew' '' and '' 'Transfer' '' you can order '' 'Modify Contact Details' '', '' 'Get EPP Code' '' and '' 'Request Delete' ''.<br /> | |
+ | In addition to that, you can also enable/disable auto renew by pressing on '' 'Disable Auto Renew' ''/'' 'Enable Auto Renew' '' button.<br /> | ||
+ | You can even manage transfer status owing to '' 'Approve Transfer' '', '' 'Reject Transfer' '' and '' 'Transfer Cancel' '' buttons. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:MX12.png]] |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 15px 15px;"|Last but not least ability is locking client's domain, preventing them from making any changes to it.<br /> | ||
+ | To do so, simply tick '' 'Registrar Lock'' ' and press '' 'Save Changes' ''. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 25px;"|[[File:MX13.png]] | ||
+ | |} | ||
+ | |||
+ | ==Management of Expired Domain== | ||
+ | {| | ||
+ | |style="padding: 10px 0px 15px 15px;"|Thanks to our module, you can automatically suspend and terminate expired domain.<br /> | ||
+ | Cron job used for automatic suspension and termination is called along with WHMCS cron job.<br /> | ||
+ | Go to '' 'Setup' '' → '' 'Products/Servers' '' → '' 'Domain Registrars' '' and press '' 'Configure' '' next to MX Registrar. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:MX14.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 15px 15px;"|To suspend the domain 2 days after the domain expiration date and terminate the domain completely after the next 5 days, use the following configuration:<br /> | ||
+ | Mark both '' 'Suspend Expired Domain' '' and '' 'Terminate Expired Domains' '' checkboxes.<br /> | ||
+ | Enter '' '2' '' into '' 'Suspend Expired Domain After' '' textbox and '' '7' '' (it is the number of days counting from the expiry date) into '' 'Terminate Expired Domains After' '' textbox.<br /> | ||
+ | Confirm the new configuration by clicking the'' 'Save Changes' '' button. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 25px;"|[[File:MX15.png]] | ||
|} | |} | ||
=Tips= | =Tips= | ||
{| | {| | ||
− | |style="padding: 10px 0px 30px 15px;"| | + | |style="padding: 10px 0px 30px 15px;"|1. If you want to view logs on the module, proceed to '' 'Utilities' → 'Logs' → 'Module Log'. '' Make sure '' 'Debug Logging' '' is enabled. |
|} | |} | ||
+ | =Update Instructions= | ||
+ | {| | ||
+ | |style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/> | ||
+ | Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/> | ||
+ | To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/> | ||
+ | |} | ||
=Common Problems= | =Common Problems= | ||
{| | {| | ||
− | |style="padding: 10px 0px 10px 15px;"|1. When you have problems with connection, check your certificate. To do so, open console and use this command (place it in one line): | + | |style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.''' |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 5px 15px;"|2. If you still have problems with connection, check your certificate. To do so, open console and use this command (place it in one line): | ||
openssl s_client -cert /your_whmcs/modules/registrars/mxregistrar/epp_complete.pem -key | openssl s_client -cert /your_whmcs/modules/registrars/mxregistrar/epp_complete.pem -key | ||
/your_whmcs/modules/registrars/mxregistrar/epp_complete.pem -connect beta.epp.registry.mx:700 | /your_whmcs/modules/registrars/mxregistrar/epp_complete.pem -connect beta.epp.registry.mx:700 | ||
+ | |||
+ | It is important that port 700 (or other currently used) must be open to avoid problems with connection. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 15px;"|3. When you get '' 'Object does not exists' '' error, ensure that your registrar module have unmarked '' 'Test Mode' '' checkbox. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 10px 15px;"|4. When you are receiving incorrect EPP code, ensure you are owner of domain. |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 10px 15px;"| | + | |style="padding: 0px 0px 10px 15px;"|5. If one of the TLDs you have configured is unavailable, please make sure you have set up pricing in a default currency. |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 15px;"| | + | |style="padding: 0px 0px 30px 15px;"|6. If you are getting errors about incorrect '' 'State' '', check if you are using correct accent for the word.<br /> |
For example '' 'M<span style="color: #ff0000;">e</span>xico' '' is incorrect state name, you should use '' 'M<span style="color: #ff0000;">é</span>xico' '' instead. | For example '' 'M<span style="color: #ff0000;">e</span>xico' '' is incorrect state name, you should use '' 'M<span style="color: #ff0000;">é</span>xico' '' instead. | ||
|} | |} |
Revision as of 16:54, 22 January 2024
Contents |
About MX Registrar For WHMCS
MX Registrar For WHMCS is a domain registrar module that enables automation of Mexico (.mx) domains provisioning in your WHMCS. The module utilizes MX Registrar WHOIS Module and allows you to maintain full control over each ordered Mexican domain through your WHMCS admin area. |
- Module Features:
✔ Disable Auto Renewal After Successful Domain Registration |
✔ Disable Auto Renewal After Successful Domain Renewal |
✔ Suspend Domain X Days After Expiration |
✔ Delete Domain X Days After Expiration |
✔ Synchronize Domain Expiration Date And Status |
✔ Synchronize Domain Transfer Status |
✔ Toggle WHOIS Server |
- Admin Area Features:
✔ Register/Transfer/Renew Domain |
✔ Request Domain Deletion |
✔ Approve/Reject/Cancel Domain Transfer |
✔ Update Contact Details |
✔ Update Nameservers |
✔ Get EPP Code |
✔ Lock/Unlock Registrar |
✔ Toggle Domain Auto Renewal |
- Client Area Features:
✔ Enable/Disable Domain Auto Renewal |
✔ Manage Nameservers |
✔ Update Contact Details |
✔ Get EPP Code |
- General Info:
✔ Utilizes MX Registrar WHOIS Module |
✔ Supports TLS 1.1 and 1.2 |
✔ Supports PHP 8.1 Back To PHP 7.3 |
✔ Supports WHMCS Themes "Six" And "Twenty-One" |
✔ Supports WHMCS V8.8 Back To WHMCS V8.3 |
✔ Requires ionCube Loader V12 Or Later |
✔ Easy Module Upgrade To Open Source Version |
Installation and Configuration
This tutorial will show you how to successfully install and configure MX Registrar For WHMCS. We will guide you step by step through the whole installation and configuration process. |
1. Log in to our client area and download the module. |
![]() |
2. In the downloaded file you might find one or two packages that support different PHP versions. In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later. |
![]() |
Previous updates of the module may contain two packages dedicated to various PHP versions. The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4. |
![]() |
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'. |
3. Extract the package and upload its content into the main WHMCS directory. The content of the package to upload should look like this. |
![]() |
4. When you install MX Registrar For WHMCS for the first time you have to rename 'license_RENAME.php' file. File is located in 'modules/registrars/mxregistrar/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' . |
![]() |
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file. Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products' . |
![]() |
6. Now you have to generate your certificate. To do so, open your linux root console and paste this line:openssl req -nodes -newkey rsa:1024 -keyout epp_complete.key -out epp_complete.csr where: /var/www/whmcs/epp_complete.csr then it will be generated directly in the pointed catalog. Afterwards, enter details you will be asked for. |
![]() |
7. Send 'epp_complete.csr' file along with your host IP to Registry.MX and wait for an email with certificate. As soon as you get it, create new file 'epp_complete.pem' which must be composed of generated earlier 'epp_complete.key', certificate and certificate file that you have received from Registry.MX. -----BEGIN RSA PRIVATE KEY----- MIICXAIBAAKB3gwIBAgICdAIcw9F... -----END RSA PRIVATE KEY----- -----BEGIN CERTIFICATE----- MIID6zCCA1SgAwIBAgICAIcwDQYJ... -----END CERTIFICATE----- |
8. Copy 'epp_complete.pem' file you have just created to your MX Registrar module folder, which is located in 'your_whmcs/modules/registrars/mxregistrar' . |
![]() |
9. Now you have to activate the module in your WHMCS system. Log in to your WHMCS admin area and go to 'Setup' → 'Products/Servers' → 'Domain Registrars' . |
![]() |
10. In the next step you need to configure test mode. To do so, enter 'Server' , 'Certificate File Name' , 'Sandbox Username' and 'Sandbox Password' . |
![]() |
Accreditation
11. In order to connect with live server you have to pass accreditation test. To do so, enter 'your_whmcs/modules/registrars/mxregistrar/mx_accreditation.php?domain=testmx0.mx' to your web browser. |
![]() |
12. Now go to 'Setup' → 'Products/Servers' → 'Domain Registrars' . Afterwards find 'MX Registrar' and press 'Configure' button. |
![]() |
13. Enter 'Username' , 'Password' and 'Server' for live server and unmark 'Test Mode' checkbox. Afterwards press 'Save Changes' . |
![]() |
You have just successfully installed and configured MX Registrar For WHMCS. |
Management
MX Registrar allows you to manage your TLDs in your WHMCS system.
In this short guide we will present you the possibilities of our module. |
Management of TLDs
Adding a new TLD is quite simple. To add it, go to 'Setup' → 'Products/Services' → 'Domain Pricing' . Enter your TLD and choose 'MX Registrar' from 'Auto Registration' dropdown menu as shown on the screen below. |
![]() |
As you can see 'Open Pricing' field has appeared. Click on it and set up your pricing. |
![]() |
In newly opened window you can set your prices. Remember to save the changes! |
![]() |
MX Registrar For WHMCS can now use its custom MX Registrar WHOIS. If you wish to use such option you have to replace the default WHMCS WHOIS with the custom one. |
For WHMCS V7 Create a custom whois.json file located at WHMCS_DIR/resources/domains/whois.json |
Line format that shall be added at the end of the above file:
.tld|YOUR_WHMCS/modules/registrars/mxregistrar/whois.php?domain= |
Take a look at the exemplary line: |
![]() |
For WHMCS V6 or earlier Add them to the already existing WHMCS_DIR/includes/whoisservers.php file. |
Line format that shall be added at the end of the above file:
.tld|YOUR_WHMCS/modules/registrars/mxregistrar/whois.php?domain=|HTTPREQUEST-free |
Take a look at the exemplary line: |
![]() |
Remember to change '.tld' in the beginning of the line to the tld (i.e. .mx or com.mx) you wish to set up!
If you have added the line properly, while checking domain availability WHMCS will be using this custom WHOIS MX Registrar. |
Ordering
Ordering .mx domain goes alike ordering other domains. A typical order is presented on the screen below. |
![]() |
Management of Domain
In the admin area client overview → 'Domains' tab you can manage all the aspects of the domain. Along with basic actions like 'Register' , 'Renew' and 'Transfer' you can order 'Modify Contact Details' , 'Get EPP Code' and 'Request Delete' . |
![]() |
Last but not least ability is locking client's domain, preventing them from making any changes to it. To do so, simply tick 'Registrar Lock ' and press 'Save Changes' . |
![]() |
Management of Expired Domain
Thanks to our module, you can automatically suspend and terminate expired domain. Cron job used for automatic suspension and termination is called along with WHMCS cron job. |
![]() |
To suspend the domain 2 days after the domain expiration date and terminate the domain completely after the next 5 days, use the following configuration: Mark both 'Suspend Expired Domain' and 'Terminate Expired Domains' checkboxes. |
![]() |
Tips
1. If you want to view logs on the module, proceed to 'Utilities' → 'Logs' → 'Module Log'. Make sure 'Debug Logging' is enabled. |
Update Instructions
Essential guidance through the process of updating the module is offered here. Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price! |
Common Problems
1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |
2. If you still have problems with connection, check your certificate. To do so, open console and use this command (place it in one line):
openssl s_client -cert /your_whmcs/modules/registrars/mxregistrar/epp_complete.pem -key /your_whmcs/modules/registrars/mxregistrar/epp_complete.pem -connect beta.epp.registry.mx:700 It is important that port 700 (or other currently used) must be open to avoid problems with connection. |
3. When you get 'Object does not exists' error, ensure that your registrar module have unmarked 'Test Mode' checkbox. |
4. When you are receiving incorrect EPP code, ensure you are owner of domain. |
5. If one of the TLDs you have configured is unavailable, please make sure you have set up pricing in a default currency. |
6. If you are getting errors about incorrect 'State' , check if you are using correct accent for the word. For example 'Mexico' is incorrect state name, you should use 'México' instead. |