{"id":17458953,"url":"https://github.com/caseywebb/le-challenge-redis","last_synced_at":"2025-05-07T02:28:47.751Z","repository":{"id":24744919,"uuid":"102344269","full_name":"caseyWebb/le-challenge-redis","owner":"caseyWebb","description":"Redis Challenge Strategy for LetsEncrypt (node-greenlock)","archived":false,"fork":false,"pushed_at":"2023-03-06T11:57:21.000Z","size":1788,"stargazers_count":2,"open_issues_count":19,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-07T02:28:35.800Z","etag":null,"topics":["greenlock","le-challenge","letsencrypt","letsencrypt-challenge","node-greenlock","node-letsencrypt","redis"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"wtfpl","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/caseyWebb.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-04T09:33:41.000Z","updated_at":"2022-01-10T17:18:29.000Z","dependencies_parsed_at":"2024-10-20T19:48:38.038Z","dependency_job_id":null,"html_url":"https://github.com/caseyWebb/le-challenge-redis","commit_stats":{"total_commits":365,"total_committers":4,"mean_commits":91.25,"dds":0.1424657534246575,"last_synced_commit":"e238500093784f21240b86f4ca4ab73ce25451b1"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caseyWebb%2Fle-challenge-redis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caseyWebb%2Fle-challenge-redis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caseyWebb%2Fle-challenge-redis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caseyWebb%2Fle-challenge-redis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caseyWebb","download_url":"https://codeload.github.com/caseyWebb/le-challenge-redis/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252801227,"owners_count":21806278,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["greenlock","le-challenge","letsencrypt","letsencrypt-challenge","node-greenlock","node-letsencrypt","redis"],"created_at":"2024-10-18T04:38:19.755Z","updated_at":"2025-05-07T02:28:47.719Z","avatar_url":"https://github.com/caseyWebb.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# le-challenge-redis\n\n[![NPM][npm-shield]][npm]\n[![License][license-shield]][license]\n[![Build][build-status-shield]][build-status]\n[![Coverage][codecov-shield]][codecov]\n\nA [Redis][] strategy for [greenlock][] for setting, retrieving,\nand clearing ACME challenges issued by the ACME server\n\n- Safe to use on ephemeral / load-balanced services (AWS Lambda, Google Cloud Functions, et al.)\n\n## Install\n\n```bash\n$ yarn add le-challenge-redis@3.x\n```\n\n## Usage\n\n```javascript\nconst Greenlock = require('greenlock')\nconst { GreenlockRedisChallenge } = require('le-challenge-redis')\n\nconst challenge = GreenlockRedisChallenge.create({\n  /**\n   * Prefix to use for redis key\n   */\n  prefix: 'greenlock-acme-challenge',\n  /**\n   * Redis Client Options\n   *\n   * https://www.npmjs.com/package/redis#rediscreateclient\n   */\n  redisOptions: {}\n})\n\nconst greenlock = Greenlock.create({\n  challenges: {\n    'http-01': challenge\n  }\n})\n```\n\n\u003e See [greenlock's documentation][greenlock] for further usage information\n\n## Exposed Methods\n\nFor ACME Challenge:\n\n- `set(opts): Promise\u003cnull\u003e`\n- `get(opts): Promise\u003c{ keyAuthorization: string }\u003e`\n- `remove(opts): Promise\u003cnull\u003e`\n\nFor greenlock internals:\n\n- `getOptions()` returns the user supplied options, if any (no effect)\n\n\u003e Built with [Greenlock](https://git.rootprojects.org/root/greenlock.js) (a [Root](https://rootprojects.org) project).\n\n[redis]: https://redis.io/\n[greenlock]: https://www.npmjs.com/package/greenlock\n[npm]: https://npmjs.com/package/le-challenge-redis\n[npm-shield]: https://img.shields.io/npm/v/le-challenge-redis.svg\n[license]: ./LICENSE\n[license-shield]: https://img.shields.io/npm/l/le-challenge-redis.svg\n[build-status]: https://github.com/caseyWebb/le-challenge-redis/actions/workflows/test.yml\n[build-status-shield]: https://img.shields.io/github/workflow/status/caseyWebb/le-challenge-redis/Node%20CI/master\n[codecov]: https://codecov.io/gh/caseyWebb/le-challenge-redis\n[codecov-shield]: https://img.shields.io/codecov/c/github/caseyWebb/le-challenge-redis.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaseywebb%2Fle-challenge-redis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaseywebb%2Fle-challenge-redis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaseywebb%2Fle-challenge-redis/lists"}