This one module gives Caddy the ability to solve the ACME DNS challenge with over 75 DNS providers.

This module wraps DNS providers that are implemented by go-acme/lego which uses an old API that is no longer supported by Caddy. As such, this module is a temporary shim until a sufficient number of providers are ported to the new libdns interfaces.

You can use this module to get up and running quickly with your provider of choice, but instead of using this module long-term, please consider contributing to a libdns package for your provider instead.

The libdns implementations offer better performance, lighter dependencies, easier maintainability with growth, and more flexible configuration.

1. Get Caddy with the lego-deprecated plugin installed
   • Pre-Built Download:
     https://caddyserver.com/download?package=github.com%2Fcaddy-dns%2Flego-deprecated
   • Build with xcaddy:

     xcaddy build --with github.com/caddy-dns/lego-deprecated

   • Build manually:
     https://github.com/caddyserver/caddy/#with-version-information-andor-plugins
2. Find your DNS Provider and provider code, in the lego DNS documentation
   • Example: CloudFlare is cloudflare, DNSimple is dnsimple
3. Set the lego provider's credentials and other ENVs in your environment configuration
   • Example: CLOUDFLARE_API_KEY=xxxxxxxx
4. Configure the ACME issuer
   via Caddy JSON

   {
   	"module": "acme",
   	"challenges": {
   		"dns": {
   			"provider": {
   				"name": "lego_deprecated",
   				"provider_name": "<provider_code>"
   			}
   		}
   	}
   }

   or Caddyfile

   tls {
   	dns lego_deprecated <provider_code>
   }
   

5. (don't forget to replace <provider_code> with the name of your provider, such as cloudflare or dnsimple)

Unlike other modules in the caddy-dns repositories, this one can only be used in the ACME issuer module for solving the DNS challenge. Even though it shares the more general dns.providers namespace with other provider modules, using this module in any other place in your config will result in errors.