# le-challenge-fs

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

Latest version **2.0.9** (published 2019-04-27) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install le-challenge-fs
pnpm add le-challenge-fs
yarn add le-challenge-fs
bun add le-challenge-fs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.9 |
| Published | 2019-04-27 |
| First published | 2016-08-05 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 24.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | AJ ONeal |
| Maintainers | coolaj86 |
| Keywords | ACME, Let's Encrypt, http-01, webroot, fs, le-challenge-fs, le-challenge-http, le-challenge-webroot, letsencrypt |

## Links

- npm: https://www.npmjs.com/package/le-challenge-fs
- Repository: https://git.rootprojects.org/root/acme-http-01-webroot.js
- Homepage: https://git.rootprojects.org/root/acme-http-01-webroot.js#readme
- Issues: https://git.rootprojects.org/root/acme-http-01-webroot.js/issues
- npm.io page: https://npm.io/package/le-challenge-fs

## Dependencies (1)

- [@root/mkdirp](https://npm.io/package/@root/mkdirp.md) ^1.0.0

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 2.0.9 (latest) — 2019-04-27
- 2.0.8 — 2016-10-12
- 2.0.7 — 2016-10-12
- 2.0.6 — 2016-10-12
- 2.0.5 — 2016-08-31
- 2.0.4 — 2016-08-11
- 2.0.2 — 2016-08-09
- 2.0.1 — 2016-08-09
- 2.0.0 — 2016-08-05

## README

# [le-challenge-webroot](https://git.rootprojects.org/root/acme-http-01-webroot.js)

| [letsencrypt](https://git.rootprojects.org/root/greenlock.js) (library)
| [letsencrypt-cli](https://git.rootprojects.org/root/greenlock-cli.js)
| [letsencrypt-express](https://git.rootprojects.org/root/greenlock-express.js)
| [letsencrypt-cluster](https://git.rootprojects.org/root/greenlock-cluster.js)
| [letsencrypt-koa](https://git.rootprojects.org/root/greenlock-koa.js)
| [letsencrypt-hapi](https://git.rootprojects.org/root/greenlock-hapi.js)
|

An fs-based strategy for Greenlock for setting, retrieving,
and clearing ACME (Let's Encrypt) 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
-------

```bash
npm install --save le-challenge-fs@2.x
```

Usage
-----

```js
var http01Challenge = require('le-challenge-fs').create({
  webrootPath: '/srv/www/:hostname/.well-known/acme-challenge'   // defaults to os.tmpdir() + '/' + 'acme-challenge'
, debug: false
});

var Greenlock = require('greenlock');

Greenlock.create({
  ...
, challenges: {
    'http-01': http01Challenge
  }
});
```

NOTE: If you request a certificate with 6 domains listed,
it will require 6 individual challenges.

Exposed Methods
---------------

For ACME Challenge:

* `set(opts, domain, key, val, done)`
* `get(defaults, domain, key, done)`
* `remove(defaults, domain, key, done)`

---
_Source: https://npm.io/package/le-challenge-fs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._