mirror of
https://git.coolaj86.com/coolaj86/acme-dns-01-duckdns.js.git
synced 2025-04-20 06:00:41 +00:00
Compare commits
No commits in common. "master" and "v3.0.0" have entirely different histories.
84
README.md
84
README.md
@ -1,4 +1,4 @@
|
|||||||
# [acme-dns-01-duckdns](https://git.rootprojects.org/root/acme-dns-01-duckdns.js) | a [Root](https://rootprojects.org) project
|
# [acme-dns-01-duckdns](https://git.rootprojects.org/root/acme-dns-01-duckdns.js) | a [Root](https://rootrpojects.org) project
|
||||||
|
|
||||||
DuckDNS + Let's Encrypt for Node.js
|
DuckDNS + Let's Encrypt for Node.js
|
||||||
|
|
||||||
@ -7,16 +7,14 @@ Passes [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js)
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Compatible
|
- Compatible
|
||||||
- [x] Let's Encrypt v2.1 / ACME draft 18 (2019)
|
- [x] Let's Encrypt v2.1 / ACME draft 18 (2019)
|
||||||
- [x] DuckDNS API
|
- [x] DuckDNS API
|
||||||
- [x] ACME.js, Greenlock.js, and others
|
- [x] ACME.js, Greenlock.js, and others
|
||||||
- Quality
|
- Quality
|
||||||
- [x] node v6 compatible VanillaJS
|
- [x] node v6 compatible VanillaJS
|
||||||
- [x] < 100 lines of code
|
- [x] < 100 lines of code
|
||||||
- [x] **Zero External Dependencies**\*
|
- [x] **Zero Dependencies**
|
||||||
|
|
||||||
<small>\* just `@root/request` which is also a Root project and has no dependencies at all</small>
|
|
||||||
|
|
||||||
# Install
|
# Install
|
||||||
|
|
||||||
@ -26,39 +24,10 @@ npm install --save acme-dns-01-duckdns@3.x
|
|||||||
|
|
||||||
Register and DuckDNS Domain and Save the API Token:
|
Register and DuckDNS Domain and Save the API Token:
|
||||||
|
|
||||||
- <https://www.duckdns.org/>
|
- <https://www.duckdns.org/>
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
Then you can use this with any compatible ACME library,
|
|
||||||
such as Greenlock.js or ACME.js.
|
|
||||||
|
|
||||||
### Greenlock CLI
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npx greenlock defaults --challenge-dns-01 acme-dns-01-duckdns --challenge-dns-01-token xxxx
|
|
||||||
```
|
|
||||||
|
|
||||||
### Greenlock API
|
|
||||||
|
|
||||||
```js
|
|
||||||
greenlock.manager.defaults({
|
|
||||||
challenges: {
|
|
||||||
'dns-01': {
|
|
||||||
module: 'acme-dns-01-duckdns',
|
|
||||||
baseUrl: 'https://www.duckdns.org/update', // default
|
|
||||||
token: 'xxxxxxx'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
First you create an instance with your credentials:
|
First you create an instance with your credentials:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
@ -68,17 +37,32 @@ var dns01 = require('acme-dns-01-duckdns').create({
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Then you can use it with any compatible ACME library,
|
||||||
|
such as Greenlock.js or ACME.js.
|
||||||
|
|
||||||
|
### Greenlock.js
|
||||||
|
|
||||||
```js
|
```js
|
||||||
acme.certificates.create({
|
var Greenlock = require('greenlock-express');
|
||||||
account,
|
var greenlock = Greenlock.create({
|
||||||
accountKey,
|
challenges: {
|
||||||
csr,
|
'dns-01': dns01
|
||||||
domains,
|
// ...
|
||||||
challenges: { 'dns-01': dns01 }
|
}
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
See the [ACME.js](https://git.rootprojects.org/root/acme.js) for more details.
|
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.
|
||||||
|
|
||||||
### Build your own
|
### Build your own
|
||||||
|
|
||||||
@ -94,8 +78,8 @@ node ./test.js example.duckdns.org xxxxxx
|
|||||||
|
|
||||||
# Authors
|
# Authors
|
||||||
|
|
||||||
- Aneem Patrabansha
|
- Aneem Patrabansha
|
||||||
- AJ ONeal
|
- AJ ONeal
|
||||||
|
|
||||||
See AUTHORS for contact info.
|
See AUTHORS for contact info.
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "acme-dns-01-duckdns",
|
"name": "acme-dns-01-duckdns",
|
||||||
"version": "3.0.1",
|
"version": "3.0.0",
|
||||||
"description": "DuckDNS for Let's Encrypt / ACME dns-01 challenges with ACME.js and Greenlock.js",
|
"description": "DuckDNS for Let's Encrypt / ACME dns-01 challenges with ACME.js and Greenlock.js",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"files": [
|
"files": [
|
||||||
|
Loading…
x
Reference in New Issue
Block a user