Skip to content

Files

Latest commit

9ea603f · Aug 4, 2023

History

History
executable file
·
65 lines (50 loc) · 4.33 KB

README.md

File metadata and controls

executable file
·
65 lines (50 loc) · 4.33 KB

Gandi Registrar for WHMCS

Use Gandi.net as registrar in WHMCS.

PHP 8.x Compatibility WHCMS 8.7.x Compatibility

Features

  • TLD prices import: supported
  • TLD grace and redemption import: supported
  • Domain registration operations: supported
  • Domain renewal operations: supported
  • Domain transfer operations: supported
  • Domain transfer protection (lock/unlock): supported
  • Domain EPP management: supported
  • Name servers management: supported
  • DNNSEC operations: supported (only zsk)
  • DNS records creation, update and deletion: supported
  • DNS templates for registration and transfer: supported
  • DNS snapshots creation, restoration and deletion: supported
  • DNS ttl management: supported (needs template customization)
  • Extended DNS record types: supported (needs template customization)
  • WHOIS privacy protection: supported (see following note about ID Protect)
  • Domain delete operations: not supported
  • Domain release operations: not supported
  • Vanity name servers: not supported

💡️️ The WHMCS IDProtect operations are not implemented in this module: by default, all anonymization options are enforced to true for TLDs supporting it, whatever is specified for each individual TLD. There is no reason why privacy should be optional!

How to install

  1. In your WHCMS installation, in the modules/registrars/, create a gandi directory.
  2. Download the latest release.
  3. Unzip & copy all files in the gandi directory.
  4. Make a symbolic link named resources/domains/additionalfields.php pointing to modules/registrars/gandi/resources/domains/additionalfields.php.
  5. Activate the addon in the Setup->Domain Registrars section of WHMCS admin.

How to configure

In the Setup->Domain Registrars section of WHMCS admin, you have access to the following settings:

  • API key: set it your own, personal, API key for Gandi APIs.
  • Organization: select the organization to which domains operations will be billed.
  • Registration / transfer templates: chose the DNS templates to apply after registration / transfer success (these templates are set in your gandi reseler account).
  • DNS to use: if you choose Gandi Live DNS, all domain registrations will specify Gandi LiveDNS as DNS and all DNSSEC and snapshots options will be available to your customers (see note below).
  • DNS record types: choose extended to take full advantage of Gandi LiveDNS (needs template customization)
  • Security, privacy & performance: check to display a summary in the domain details page of the client area.

💡️️ Gandi Registrar for WHMCS allows you to delegate your DNS handling to Gandi LiveDNS. To do so, you have to select "Gandi LiveDNS" in this module settings and have livedns.gandi.net as default name servers in WHMCS main domains config. Note livedns.gandi.net is not an existing host, it's just the easiest way to fill some gaps in the WHMCS APIs.

Languages

To have this module's interface in your own language, you have to copy the content of the right file located in /resources/lang/ directory and paste it in your main WHMCS language file.

If you have translated these strings in a not yet supported language, please share it ❤️

Uncovered TLDs

All TLDs managed by Gandi are registrable except the following:

  • TLDs reserved for Gandi Corporate Services (see list);
  • TLDs that require heavy development work to be integrated into the WHMCS workflow (see list).

Contributing

Before submitting an issue or a pull request, please read the contribution guidelines.

⚠️ The master branch is the current development state of the module. If you want a stable, production-ready version, please pick the last official release.

Attribution

Gandi Registrar for WHMCS is a fork of Gandi/whmcs_Gandi-module which has been archived during spring 2022. Thank you, Gandi, for starting such a module!