acme-dns-01-vercel
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

acme-dns-01-vercel

Vercel 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-vercel

Generate Vercel API Token:

Usage

First you create an instance with your credentials:

var dns01 = require('acme-dns-01-digitalocean').create({
	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

There are only 5 methods:

  • init(config)
  • zones(opts)
  • set(opts)
  • get(opts)
  • remove(opts)
dns01
	.set({
		identifier: { value: 'foo.example.co.uk' },
		wildcard: false,
		dnsZone: 'example.co.uk',
		dnsPrefix: '_acme-challenge.foo',
		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

You will need to add environment variables:

VERCEL_TOKEN
DOMAIN

npm test

Authors

  • Freddie Ergatoudis

See AUTHORS for contact info.

Legal

MIT License | Terms of Use | Privacy Policy

Copyright 2023

Package Sidebar

Install

npm i acme-dns-01-vercel

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

12 kB

Total Files

9

Last publish

Collaborators

  • freddieerg