Vultr DNS for Let's Encrypt / ACME dns-01 challenges with ACME.js and Greenlock.js
Go to file
AJ ONeal 9b6d363328 v3.0.2: doc and test updates 2019-07-16 11:59:48 -06:00
lib v3.0.2: doc and test updates 2019-07-16 11:59:48 -06:00
.gitignore v3.0.2: doc and test updates 2019-07-16 11:59:48 -06:00
.prettierrc add .prettierrc, and make prettier 2019-06-13 03:53:54 -06:00
AUTHORS change to use AUTHORS file to list contributors 2019-06-11 21:09:55 +03:00
README.md v3.0.2: doc and test updates 2019-07-16 11:59:48 -06:00
example.env v3.0.2: doc and test updates 2019-07-16 11:59:48 -06:00
index.js initial commit 2019-06-10 16:54:39 +03:00
package-lock.json v3.0.2: doc and test updates 2019-07-16 11:59:48 -06:00
package.json v3.0.2: doc and test updates 2019-07-16 11:59:48 -06:00
test.js v3.0.2: doc and test updates 2019-07-16 11:59:48 -06:00

README.md

acme-dns-01-vultr | a Root project

Vultr DNS + Let's Encrypt for Node.js

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

Install

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

Usage

First you create an instance with your API token:

var dns01 = require('acme-dns-01-vultr').create({
	baseUrl: 'https://api.vultr.com/v1/dns', // default
	token: 'xxxx'
});

Then you can use it with any compatible ACME module, 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

dns01
	.set({
		identifier: { value: 'foo.example.com' },
		wildcard: false,
		dnsHost: '_acme-challenge.foo.example.com',
		dnsAuthorization: 'xxx_secret_xxx'
	})
	.then(function() {
		console.log('TXT record set');
	})
	.catch(function() {
		console.log('Failed to set TXT record');
	});

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

Tests

# node ./test.js domain-zone api-key
node ./test.js example.com xxxxxx