certbot/certbot-dns-cloudflare/docs/index.rst

.. certbot-dns-cloudflare documentation master file, created by
   sphinx-quickstart on Tue May  9 10:20:04 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to certbot-dns-cloudflare's documentation!
==================================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. automodule:: certbot_dns_cloudflare
   :members:

.. toctree::
   :maxdepth: 1

   api


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Cloudflare DNS Authenticator Implement an Authenticator which can fulfill a dns-01 challenge using the Cloudflare API. Applicable only for domains using Cloudflare for DNS. Testing Done: * `tox -e py27` * `tox -e lint` * Manual testing: * Used `certbot certonly --dns-cloudflare -d`, specifying a credentials file as a command line argument. Verified that a certificate was successfully obtained without user interaction. * Used `certbot certonly --dns-cloudflare -d`, without specifying a credentials file as a command line argument. Verified that the user was prompted and that a certificate was successfully obtained. * Used `certbot certonly -d`. Verified that the user was prompted for a credentials file after selecting cloudflare interactively and that a certificate was successfully obtained. * Used `certbot renew --force-renewal`. Verified that certificates were renewed without user interaction. * Negative testing: * Path to non-existent credentials file. * Credentials file with unsafe permissions (644). * Credentials file missing e-mail address. * Credentials file with blank API key. * Credentials file with incorrect e-mail address. * Credentials file with malformed API key. * Credentials file with invalid API key. * Domain name not registered to Cloudflare account. 2017-05-02 13:12:23 -04:00			`.. certbot-dns-cloudflare documentation master file, created by`
			`sphinx-quickstart on Tue May 9 10:20:04 2017.`
			`You can adapt this file completely to your liking, but it should at least`
			contain the root `toctree` directive.

			`Welcome to certbot-dns-cloudflare's documentation!`
			`==================================================`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Contents:`

Put API link at the bottom of DNS plugin docs (#5699) * Put link to API at the bottom for future docs. * Put API link at the bottom of existing docs. 2018-03-12 20:10:23 -04:00			`.. automodule:: certbot_dns_cloudflare`
			`:members:`

Cloudflare DNS Authenticator Implement an Authenticator which can fulfill a dns-01 challenge using the Cloudflare API. Applicable only for domains using Cloudflare for DNS. Testing Done: * `tox -e py27` * `tox -e lint` * Manual testing: * Used `certbot certonly --dns-cloudflare -d`, specifying a credentials file as a command line argument. Verified that a certificate was successfully obtained without user interaction. * Used `certbot certonly --dns-cloudflare -d`, without specifying a credentials file as a command line argument. Verified that the user was prompted and that a certificate was successfully obtained. * Used `certbot certonly -d`. Verified that the user was prompted for a credentials file after selecting cloudflare interactively and that a certificate was successfully obtained. * Used `certbot renew --force-renewal`. Verified that certificates were renewed without user interaction. * Negative testing: * Path to non-existent credentials file. * Credentials file with unsafe permissions (644). * Credentials file missing e-mail address. * Credentials file with blank API key. * Credentials file with incorrect e-mail address. * Credentials file with malformed API key. * Credentials file with invalid API key. * Domain name not registered to Cloudflare account. 2017-05-02 13:12:23 -04:00			`.. toctree::`
			`:maxdepth: 1`

			`api`


			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`