Compare commits

...

3 Commits

Author SHA1 Message Date
d1308f5aca update instructions for greenlock v4 2020-07-29 01:55:55 +00:00
8a0cf7df5c v3.0.1: fix link typo 2019-07-03 22:31:46 -06:00
1fec61376c add note about dependencies 2019-06-29 04:04:27 -06:00
2 changed files with 46 additions and 30 deletions

View File

@ -1,4 +1,4 @@
# [acme-dns-01-duckdns](https://git.rootprojects.org/root/acme-dns-01-duckdns.js) | a [Root](https://rootrpojects.org) project
# [acme-dns-01-duckdns](https://git.rootprojects.org/root/acme-dns-01-duckdns.js) | a [Root](https://rootprojects.org) project
DuckDNS + Let's Encrypt for Node.js
@ -7,14 +7,16 @@ 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] DuckDNS API
- [x] ACME.js, Greenlock.js, and others
- Quality
- [x] node v6 compatible VanillaJS
- [x] < 100 lines of code
- [x] **Zero Dependencies**
- Compatible
- [x] Let's Encrypt v2.1 / ACME draft 18 (2019)
- [x] DuckDNS API
- [x] ACME.js, Greenlock.js, and others
- Quality
- [x] node v6 compatible VanillaJS
- [x] < 100 lines of code
- [x] **Zero External Dependencies**\*
<small>\* just `@root/request` which is also a Root project and has no dependencies at all</small>
# Install
@ -24,30 +26,29 @@ npm install --save acme-dns-01-duckdns@3.x
Register and DuckDNS Domain and Save the API Token:
- <https://www.duckdns.org/>
- <https://www.duckdns.org/>
# Usage
First you create an instance with your credentials:
```js
var dns01 = require('acme-dns-01-duckdns').create({
baseUrl: 'https://www.duckdns.org/update', // default
token: 'xxxx'
});
```
Then you can use it with any compatible ACME library,
Then you can use this with any compatible ACME library,
such as Greenlock.js or ACME.js.
### Greenlock.js
### Greenlock CLI
```bash
npx greenlock defaults --challenge-dns-01 acme-dns-01-duckdns --challenge-dns-01-token xxxx
```
### Greenlock API
```js
var Greenlock = require('greenlock-express');
var greenlock = Greenlock.create({
greenlock.manager.defaults({
challenges: {
'dns-01': dns01
// ...
'dns-01': {
module: 'acme-dns-01-duckdns',
baseUrl: 'https://www.duckdns.org/update', // default
token: 'xxxxxxx'
}
}
});
```
@ -58,11 +59,26 @@ documentation for more details.
### ACME.js
First you create an instance with your credentials:
```js
// TODO
var dns01 = require('acme-dns-01-duckdns').create({
baseUrl: 'https://www.duckdns.org/update', // default
token: 'xxxx'
});
```
See the [ACME.js](https://git.rootprojects.org/root/acme-v2.js) for more details.
```js
acme.certificates.create({
account,
accountKey,
csr,
domains,
challenges: { 'dns-01': dns01 }
});
```
See the [ACME.js](https://git.rootprojects.org/root/acme.js) for more details.
### Build your own
@ -78,8 +94,8 @@ node ./test.js example.duckdns.org xxxxxx
# Authors
- Aneem Patrabansha
- AJ ONeal
- Aneem Patrabansha
- AJ ONeal
See AUTHORS for contact info.

View File

@ -1,6 +1,6 @@
{
"name": "acme-dns-01-duckdns",
"version": "3.0.0",
"version": "3.0.1",
"description": "DuckDNS for Let's Encrypt / ACME dns-01 challenges with ACME.js and Greenlock.js",
"main": "index.js",
"files": [