greenlock-challenge-manual.js/README.md

55 lines
1.4 KiB
Markdown
Raw Normal View History

2016-08-10 03:20:19 +00:00
[![Join the chat at https://gitter.im/Daplie/letsencrypt-express](https://badges.gitter.im/Daplie/letsencrypt-express.svg)](https://gitter.im/Daplie/letsencrypt-express?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
| [letsencrypt](https://github.com/Daplie/node-letsencrypt) (library)
| [letsencrypt-cli](https://github.com/Daplie/letsencrypt-cli)
| [letsencrypt-express](https://github.com/Daplie/letsencrypt-express)
| [letsencrypt-koa](https://github.com/Daplie/letsencrypt-koa)
| [letsencrypt-hapi](https://github.com/Daplie/letsencrypt-hapi)
|
le-challenge-manual
===================
A manual cli-based strategy for node-letsencrypt.
Prints the ACME challenge Token and Key and then waits for you to hit enter before continuing.
Install
-------
```bash
npm install --save le-challenge-manual@2.x
```
Usage
-----
```bash
var leChallenge = require('le-challenge-manual').create({
, debug: false
});
var LE = require('letsencrypt');
LE.create({
server: LE.stagingServerUrl
, challenge: leChallenge
});
```
NOTE: If you request a certificate with 6 domains listed,
it will require 6 individual challenges.
Exposed Methods
---------------
For ACME Challenge:
* `set(opts, domain, key, val, done)`
* `get(defaults, domain, key, done)`
* `remove(defaults, domain, key, done)`
For node-letsencrypt internals:
* `getOptions()` returns the internal defaults merged with the user-supplied options