Skip to main content

Obtain certificates using a DNS TXT record for DuckDNS domains

Project description

Certbot DNS DuckDNS Plugin

Plugin for certbot for a DNS-01 challenge with a DuckDNS domain.


PyPI PyPI - Python Version GitHub PyPI - Downloads


Table of Contents

  1. About
  2. Installation
    1. With pip (recommend)
    2. From source
  3. Usage
  4. Third party notices
  5. License

About

certbot_dn_duckdns is a plugin for certbot to create the DNS-01 challenge for a DuckDNS domain. The plugin takes care of setting and deleting the TXT entry via the DuckDNS API.

Installation

With pip (recommend)

Use the following command to install certbot_dns_duckdns with pip:

pip3 install certbot_dns_duckdns

You can also very easily update to a newer version:

pip3 install certbot_dns_duckdns -U

From source

git clone https://github.com/infinityofspace/certbot_dns_duckdns
cd certbot_dns_duckdns
pip install .

Usage

Make sure before you start that you have a current version of certbot installed. You can read how to install certbot in the official documentation.

Note: Normally, the PYPI version of certbot is installed with the installation of certbot_dns_duckdns and does not require any further installation or configuration.

You can check if certbot is installed with:

certbot --version

Below are some examples of how to use the plugin:

Generate a certificate for a DNS-01 challenge of the domain "example.duckdns.org":

certbot certonly \
  --non-interactive \
  --agree-tos \
  --email <your-email> \
  --preferred-challenges dns \
  --authenticator dns-duckdns \
  --dns-duckdns-token <your-duckdns-token> \
  --dns-duckdns-propagation-seconds 60 \
  -d "example.duckdns.org"

Generate a wildcard certificate for a DNS-01 challenge of all subdomains "*.example.duckdns.org":

certbot certonly \
  --non-interactive \
  --agree-tos \
  --email <your-email> \
  --preferred-challenges dns \
  --authenticator dns-duckdns \
  --dns-duckdns-token <your-duckdns-token> \
  --dns-duckdns-propagation-seconds 60 \
  -d "*.example.duckdns.org"

Generate a certificate for a DNS-01 challenge of the domain "example.duckdns.org" without an account (i.e. without an email address):

certbot certonly \
  --non-interactive \
  --agree-tos \
  --register-unsafely-without-email \
  --preferred-challenges dns \
  --authenticator dns-duckdns \
  --dns-duckdns-token <your-duckdns-token> \
  --dns-duckdns-propagation-seconds 60 \
  -d "example.duckdns.org"

Generate a staging certificate (i.e. temporary testing certificate) for a DNS-01 challenge of the domain " example.duckdns.org":

certbot certonly \
  --non-interactive \
  --agree-tos \
  --email <your-email> \
  --preferred-challenges dns \
  --authenticator dns-duckdns \
  --dns-duckdns-token <your-duckdns-token> \
  --dns-duckdns-propagation-seconds 60 \
  -d "example.duckdns.org" \
  --dry-run

You can find al list of all available cli options in the official documentation of certbot.

Third party notices

All modules used by this project are listed below:

Name License
certbot Apache 2.0
requests Apache 2.0
zope.interface ZPL-2.1
setuptools MIT

Furthermore, this readme file contains embeddings of Shields.io.

License

MIT - Copyright (c) 2021 Marvin Heptner

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

certbot_dns_duckdns-0.2.tar.gz (5.9 kB view hashes)

Uploaded Source

Built Distribution

certbot_dns_duckdns-0.2-py3-none-any.whl (8.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page