AJ ONeal 79a8329179 | ||
---|---|---|
lib | ||
.gitignore | ||
.prettierrc | ||
AUTHORS | ||
LICENSE | ||
README.md | ||
index.js | ||
package-lock.json | ||
package.json | ||
test.js |
README.md
acme-dns-01-digitalocean | a Root project
Digital Ocean 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.
Features
- Compatible
- Let's Encrypt v2.1 / ACME draft 18 (2019)
- Digital Ocean v2 API
- ACME.js, Greenlock.js, and others
- Quality
- node v6 compatible VanillaJS
- < 150 lines of code
- Zero Dependencies
Install
npm install --save acme-dns-01-digitalocean@3.x
Generate Digital Ocean API Token:
Usage
First you create an instance with your credentials:
var dns01 = require('acme-dns-01-digitalocean').create({
baseUrl: 'https://api.digitalocean.com/v2/domains', // 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
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
# node ./test.js domain-zone api-token
node ./test.js example.com xxxxxx
Authors
- Aneem Patrabansha
- AJ ONeal
See AUTHORS for contact info.
Legal
acme-dns-01-digitalocean.js | MPL-2.0 | Terms of Use | Privacy Policy
Copyright 2019 The Root Group LLC