An fs-based strategy for node-letsencrypt for setting, retrieving, and clearing ACME challenges issued by the ACME server
Iet uz failu
AJ ONeal 11f38bee5c v2.0.0 2016-08-05 04:10:33 -04:00
.gitignore Initial commit 2016-08-04 23:22:20 -06:00
LICENSE Initial commit 2016-08-04 23:22:20 -06:00
README.md v2.0.0 2016-08-05 04:10:33 -04:00
index.js v2.0.0 2016-08-05 04:10:33 -04:00
package.json v2.0.0 2016-08-05 04:10:33 -04:00

README.md

le-challenge-fs

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
});

Exposed Methods

For ACME Challenge:

  • setChallange(opts, domain, key, val, done)
  • getChallange(opts, domain, key, done)
  • removeChallange(opts, domain, key, done)

For node-letsencrypt internals:

  • getOptions() returns the internal defaults merged with the user-supplied options