Update 'README.md'

This commit is contained in:
jarombridges 2019-07-12 02:12:58 +00:00
parent 7be3b204a3
commit ee5a21f1b8
1 changed files with 80 additions and 1 deletions

View File

@ -1,3 +1,82 @@
# acme-dns-01-gandi.js # acme-dns-01-gandi.js
Gandi DNS + Let's Encrypt for Node.js - ACME dns-01 challenges w/ ACME.js and Greenlock.js Gandi LiveDNS + Let's Encrypt for Node.js - ACME dns-01 challenges w/ ACME.js and Greenlock.js
Features
Compatible
Lets Encrypt v2.1 / ACME draft 18 (2019)
Gandi.net LiveDNS 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-gandi
Generate Gandi LiveDNS API Token:
Login to your account at:
https://account.gandi.net/
Under the Security section, click the link next to 'Production API key' to generate a token.
Usage
First you create an instance with your credentials:
var dns01 = require('acme-dns-01-gandi').create({
baseUrl: 'https://dns.api.gandi.net/api/v5/', // 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
Jarom Bridges
AJ ONeal
See AUTHORS for contact info.
Legal
acme-dns-01-gandi.js | MPL-2.0 | Terms of Use | Privacy Policy
Copyright 2019 The Root Group LLC