le-challenge-redis

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).