le-challenge-webroot.js/README.md

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

le-challenge-webroot

A fs-based strategy for node-letsencrypt for setting, retrieving, and clearing ACME challenges issued by the ACME server

This places the acme challenge in an appropriate directory in the specified webrootPath and removes it once the challenge has either completed or failed.

• Safe to use with node cluster
• Safe to use with ephemeral services (Heroku, Joyent, etc)

Install

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

Usage

var leChallenge = require('le-challenge-fs').create({
  webrootPath: '~/letsencrypt/srv/www/:hostname/.well-known/acme-challenge'
, debug: false
});

var LE = require('letsencrypt');

LE.create({
  server: LE.stagingServerUrl                               // Change to LE.productionServerUrl in production
, 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