acme-dns-01-duckdns.js/README.md

2.2 KiB

acme-dns-01-duckdns | a Root project

DuckDNS + Let's Encrypt for Node.js

This handles ACME dns-01 challenges, compatible with ACME.js, Greenlock.js, and more. Passes acme-dns-01-test.

Features

  • Compatible
    • Let's Encrypt v2.1 / ACME draft 18 (2019)
    • DuckDNS API
    • ACME.js, Greenlock.js, and others
  • Quality
    • node v6 compatible VanillaJS
    • < 100 lines of code
    • Zero External Dependencies*

* just @root/request which is also a Root project and has no dependencies at all

Install

npm install --save acme-dns-01-duckdns@3.x

Register and DuckDNS Domain and Save the API Token:

Usage

First you create an instance with your credentials:

var dns01 = require('acme-dns-01-duckdns').create({
	baseUrl: 'https://www.duckdns.org/update', // default
	token: 'xxxx'
});

Then you can use it with any compatible ACME library, such as Greenlock.js or ACME.js.

Greenlock.js

var Greenlock = require('greenlock-express');
var greenlock = Greenlock.create({
	challenges: {
		'dns-01': dns01
		// ...
	}
});

See Greenlock Express and/or Greenlock.js documentation for more details.

ACME.js

// TODO

See the ACME.js for more details.

Build your own

See acme-dns-01-test for more implementation details.

Tests

# node ./test.js domain-record api-token
node ./test.js example.duckdns.org xxxxxx

Authors

  • Aneem Patrabansha
  • AJ ONeal

See AUTHORS for contact info.

Legal

acme-dns-01-duckdns.js | MPL-2.0 | Terms of Use | Privacy Policy

Copyright 2019 The Root Group LLC