# acme-dns-01-desec

> deSEC DNS for Let's Encrypt / ACME dns-01 challenges with ACME.js and Greenlock.js

Latest version **3.0.0** (published 2020-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install acme-dns-01-desec
pnpm add acme-dns-01-desec
yarn add acme-dns-01-desec
bun add acme-dns-01-desec
```

## 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 | 3.0.0 |
| Published | 2020-10-10 |
| First published | 2020-10-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | rschmid |
| Keywords | desec, dns, dns-01, letsencrypt, acme, greenlock |

## Links

- npm: https://www.npmjs.com/package/acme-dns-01-desec
- Repository: https://github.com/rs22/acme-dns-01-desec
- Homepage: https://github.com/rs22/acme-dns-01-desec#readme
- Issues: https://github.com/rs22/acme-dns-01-desec/issues
- npm.io page: https://npm.io/package/acme-dns-01-desec

## Recent versions

- 3.0.0 (latest) — 2020-10-10
- 0.0.1-security — 2020-10-05

## README

# acme-dns-01-desec

deSEC DNS + Let's Encrypt for Node.js

This handles ACME dns-01 challenges, compatible with ACME.js and Greenlock.js.
Passes [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js).

## Features

- Compatible
  - [x] Let's Encrypt v2.1 / ACME draft 18 (2019)
  - [x] [deSEC v1 API](https://github.com/desec-io/desec-stack)
  - [x] ACME.js, Greenlock.js, and others
- Quality
  - [x] node v6 compatible VanillaJS
  - [x] &lt; 150 lines of code
  - [x] **Zero Dependencies**

# Install

```bash
npm install --save acme-dns-01-desec
```

Generate deSEC API Token:

- <https://desec.readthedocs.io/en/latest/auth/tokens.html>

# Usage

First you create an instance with your credentials:

```js
var dns01 = require('acme-dns-01-desec').create({
	baseUrl: 'https://desec.io/api/v1', // default
	token: 'xxxx'
});
```

Then you can use it with any compatible ACME library,
such as Greenlock.js or ACME.js.

### Greenlock.js

```js
var Greenlock = require('greenlock-express');
var greenlock = Greenlock.create({
	challenges: {
		'dns-01': dns01
		// ...
	}
});
```

See [Greenlock Express](https://git.rootprojects.org/root/greenlock-express.js)
and/or [Greenlock.js](https://git.rootprojects.org/root/greenlock.js)
documentation for more details.

### ACME.js

```js
// TODO
```

See the [ACME.js](https://git.rootprojects.org/root/acme-v2.js) for more details.

# Tests

```bash
# node ./test.js domain-zone api-token
node ./test.js example.com xxxxxx
```

---
_Source: https://npm.io/package/acme-dns-01-desec · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
