Metadata-Version: 1.1
Name: lets-do-dns
Version: 0.10.2
Summary: A letsencrypt certbot auth/cleanup hook program engineered to handle hostname ownership authentication via DigitalOcean's DNS system.
Home-page: https://github.com/jitsusama/lets-do-dns
Author: Joel Gerber
Author-email: joel@grrbrr.ca
License: Apache-2.0
Download-URL: https://github.com/jitsusama/lets-do-dns/releases/download/v0.10.2/lets-do-dns-0.10.2.tar.gz
Description: lets-do-dns
        ===========
        This program's purpose is to function as a manual authentication and
        cleanup hook for the Let's Encrypt EFF_\'s certbot_ client program when you
        wish to use ACME-DNS authentication during the certificate authentication
        process, while also using DigitalOcean_\'s DNS infrastructure for the
        creation and removal of the ACME-DNS required DNS TXT records. This program
        also supports being passed a command string that will be called during the
        cleanup hook stage of the authentication process.
        
        Installation
        ------------
        Installation of this program is quite easy, as it only has one external
        dependency, and this program includes this dependency in its setup.py
        file.
        
        That said, there are 4 ways that you can install this program;
        
        *  The first is via the normal means, that is, PyPI via PIP as so:
        
           .. code-block:: bash
        
              pip install lets-do-dns
        
        *  You can also install this program from a clone of the source
           repository, as so (remember, if you want to modify the source code
           without re-installing, pass the ``-e`` flag to PIP):
        
           .. code-block:: bash
        
              pip install .
        
        *  You can also use Docker to install/run this program. You can do this
           like so when grabbing from the Docker Hub:
        
           .. code-block:: bash
        
              docker pull jitsusama/lets-do-dns
        
        *  Finally, you can build the image from a clone of the source
           repository like so:
        
           .. code-block:: bash
        
              docker build -t jitsusama/lets-do-dns .
        
        Usage
        -----
        Make sure you pass the ``DO_APIKEY`` and ``DO_DOMAIN`` environment
        variables to certbot when it is called. Tell certbot to load this program
        by passing its name to certbot via the ``--manual-auth-hook`` and the
        ``--manual-cleanup-hook`` CLI arguments.
        
        If you would also like for this program to call your own program during
        the cleanup hook stage, make sure you pass the ``LETS_DO_POSTCMD``
        environment variable to certbot as well, specifying the invocation string
        of your program.
        
        Here's an example of how you can use this program from the CLI when
        you installed the program via PIP:
        
        .. code-block:: bash
        
           DO_APIKEY=super-secret-key \
           DO_DOMAIN=mydomain.com \
           LETS_DO_POSTCMD='echo ${CERTBOT_DOMAIN} > command_output.txt' \
           certbot certonly --manual -d myhostname.mydomain.com \
               --preferred-challenges dns \
               --manual-auth-hook lets-do-dns \
               --manual-cleanup-hook lets-do-dns
        
        Here's an example of how you can use this program from Docker when
        you pulled the image from the Docker Hub:
        
        .. code-block:: bash
        
           docker run -v "$(pwd)/my-cert-dir:/etc/letsencrypt" \
               -e "DO_APIKEY=super-secret-key" \
               -e "DO_DOMAIN=mydomain.com" \
               -e 'LETS_DO_POSTCMD="echo ${CERTBOT_DOMAIN} > /etc/letsencrypt/command_output.txt"' \
               jitsusama/lets-do-dns \
               certonly --manual -d myhostname.mydomain.com \
                   --preferred-challenges dns \
                   --manual-auth-hook lets-do-dns \
                   --manual-cleanup-hook lets-do-dns
        
        .. _EFF: https://eff.org
        .. _certbot: https://certbot.eff.org
        .. _ACME-DNS: https://tools.ietf.org/html/draft-ietf-acme-acme-06#section-8.4
        .. _DigitalOcean: https://digitalocean.com
        
Keywords: certbot,letsencrypt,DigitalOcean,DNS,SSL
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: Name Service (DNS)
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
