82 lines
2.1 KiB
Markdown
82 lines
2.1 KiB
Markdown
le-challenge-dns
|
|
================
|
|
|
|
| A [Root](https://rootprojects.org) Project
|
|
| [greenlock.js](https://git.coolaj86.com/coolaj86/greenlock.js) (library)
|
|
| [greenlock-express.js](https://git.coolaj86.com/coolaj86/greenlock-express.js)
|
|
| [greenlock-cli.js](https://git.coolaj86.com/coolaj86/greenlock-cli.js)
|
|
| [acme-v2.js](https://git.coolaj86.com/coolaj86/acme-v2.js)
|
|
|
|
|
|
|
A manual (interactive CLI) dns-based strategy for greenlock.js for setting, retrieving,
|
|
and clearing ACME DNS-01 challenges issued by the ACME server
|
|
|
|
Prints out a subdomain record for `_acme-challenge` with `keyAuthDigest`
|
|
to be tested by the ACME server.
|
|
|
|
You can then update your DNS manually by whichever method you use and then
|
|
press [enter] to continue the process.
|
|
|
|
```
|
|
_acme-challenge.example.com TXT xxxxxxxxxxxxxxxx TTL 60
|
|
```
|
|
|
|
Install
|
|
-------
|
|
|
|
```bash
|
|
npm install --save le-challenge-dns@2.x
|
|
```
|
|
|
|
Usage
|
|
-----
|
|
|
|
The challenge can be set globally like this:
|
|
|
|
```bash
|
|
var leChallengeDns = require('le-challenge-dns').create({
|
|
debug: false
|
|
});
|
|
|
|
var Greenlock = require('greenlock');
|
|
|
|
Greenlock.create({
|
|
server: LE.stagingServerUrl // Change to LE.productionServerUrl in production
|
|
, challengeType: 'dns-01'
|
|
, challenges: {
|
|
'dns-01': leChallengeDns
|
|
}
|
|
, approveDomains: [ 'example.com' ]
|
|
});
|
|
```
|
|
|
|
In can also be set in the `approveDomains` callback instead, like this:
|
|
|
|
```
|
|
function approveDomains(opts, certs, cb) {
|
|
opts.challenges = { 'dns-01': leChallengeDns };
|
|
...
|
|
cb(null, { options: opts, certs: certs });
|
|
}
|
|
```
|
|
|
|
NOTE: If you request a certificate with 6 domains listed,
|
|
it will require 6 individual challenges.
|
|
|
|
Exposed Methods
|
|
---------------
|
|
|
|
For ACME Challenge:
|
|
|
|
* `set(opts, domain, challange, keyAuthorization, done)`
|
|
* `get(defaults, domain, challenge, done)`
|
|
* `remove(defaults, domain, challenge, done)`
|
|
|
|
Note: `get()` is a no-op for `dns-01`.
|
|
|
|
For greenlock.js internals:
|
|
|
|
* `getOptions()` returns the internal defaults merged with the user-supplied options
|
|
* `loopback(defaults, domain, challange, done)` performs a dns lookup of the txt record
|
|
* `test(opts, domain, challange, keyAuthorization, done)` runs set, loopback, remove, loopback
|