JSPM

le-challenge-redis

3.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 288
  • Score
    100M100P100Q98264F
  • License WTFPL

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

Package Exports

  • le-challenge-redis

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (le-challenge-redis) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

le-challenge-redis

NPM License Build Coverage

A Redis strategy for greenlock for setting, retrieving, and clearing ACME challenges issued by the ACME server

  • Safe to use on ephemeral / load-balanced services (AWS Lambda, Google Cloud Functions, et al.)

Install

$ yarn add le-challenge-redis@3.x

Usage

const Greenlock = require('greenlock')
const { GreenlockRedisChallenge } = require('le-challenge-redis')

const challenge = GreenlockRedisChallenge.create({
  /**
   * Prefix to use for redis key
   */
  prefix: 'greenlock-acme-challenge',
  /**
   * Redis Client Options
   *
   * https://www.npmjs.com/package/redis#rediscreateclient
   */
  redisOptions: {}
})

const greenlock = Greenlock.create({
  challenges: {
    'http-01': challenge
  }
})

See greenlock's documentation for further usage information

Exposed Methods

For ACME Challenge:

  • set(opts): Promise<null>
  • get(opts): Promise<{ keyAuthorization: string }>
  • remove(opts): Promise<null>

For greenlock internals:

  • getOptions() returns the user supplied options, if any (no effect)

Built with Greenlock (a Root project).