https://github.com/caseywebb/le-challenge-redis
Redis Challenge Strategy for LetsEncrypt (node-greenlock)
https://github.com/caseywebb/le-challenge-redis
greenlock le-challenge letsencrypt letsencrypt-challenge node-greenlock node-letsencrypt redis
Last synced: 17 days ago
JSON representation
Redis Challenge Strategy for LetsEncrypt (node-greenlock)
- Host: GitHub
- URL: https://github.com/caseywebb/le-challenge-redis
- Owner: caseyWebb
- License: wtfpl
- Created: 2017-09-04T09:33:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T11:57:21.000Z (about 2 years ago)
- Last Synced: 2025-05-07T02:28:35.800Z (17 days ago)
- Topics: greenlock, le-challenge, letsencrypt, letsencrypt-challenge, node-greenlock, node-letsencrypt, redis
- Language: TypeScript
- Size: 1.71 MB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# le-challenge-redis
[![NPM][npm-shield]][npm]
[![License][license-shield]][license]
[![Build][build-status-shield]][build-status]
[![Coverage][codecov-shield]][codecov]
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
```bash
$ yarn add [email protected]
```
## Usage
```javascript
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][greenlock] for further usage information
## Exposed Methods
For ACME Challenge:
- `set(opts): Promise`
- `get(opts): Promise<{ keyAuthorization: string }>`
- `remove(opts): Promise`
For greenlock internals:
- `getOptions()` returns the user supplied options, if any (no effect)
> Built with [Greenlock](https://git.rootprojects.org/root/greenlock.js) (a [Root](https://rootprojects.org) project).
[redis]: https://redis.io/
[greenlock]: https://www.npmjs.com/package/greenlock
[npm]: https://npmjs.com/package/le-challenge-redis
[npm-shield]: https://img.shields.io/npm/v/le-challenge-redis.svg
[license]: ./LICENSE
[license-shield]: https://img.shields.io/npm/l/le-challenge-redis.svg
[build-status]: https://github.com/caseyWebb/le-challenge-redis/actions/workflows/test.yml
[build-status-shield]: https://img.shields.io/github/workflow/status/caseyWebb/le-challenge-redis/Node%20CI/master
[codecov]: https://codecov.io/gh/caseyWebb/le-challenge-redis
[codecov-shield]: https://img.shields.io/codecov/c/github/caseyWebb/le-challenge-redis.svg