le-challenge-memory.js/README.md

1.5 KiB

Join the chat at https://gitter.im/Daplie/letsencrypt-express

| letsencrypt (library) | letsencrypt-cli | letsencrypt-express | letsencrypt-koa | letsencrypt-hapi |

le-challenge-memory

An in-memory strategy for node-letsencrypt for setting, retrieving, and clearing ACME challenges issued by the ACME server

  • Safe to use on ephemeral services (i.e. AWS)
  • DO NOT use with node cluester (i.e. letsencrypt-cluster)

Install

npm install --save le-challenge-standalone@2.x

Usage

var leChallenge = require('le-challenge-standalone').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 user supplied options, if any (no effect)