diff --git a/certbot-dns-cloudflare/certbot_dns_cloudflare/__init__.py b/certbot-dns-cloudflare/certbot_dns_cloudflare/__init__.py index f4820e1ca..7a9fa105c 100644 --- a/certbot-dns-cloudflare/certbot_dns_cloudflare/__init__.py +++ b/certbot-dns-cloudflare/certbot_dns_cloudflare/__init__.py @@ -1 +1,17 @@ -"""Cloudflare DNS Authenticator""" +"""Cloudflare DNS Authenticator + +This plugin automates the process of completing a dns-01 challenge +(`~acme.challenges.DNS01`) using the Cloudflare API. + +Use of this plugin requires a configuration file containing Cloudflare API +credentials, obtained from your Cloudflare +`account page `_. + +Example: + +.. code-block:: ini + + dns_cloudflare_email = cloudflare@example.com + dns_cloudflare_api_key = 0123456789abcdef0123456789abcdef01234567 + +"""