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.
58
README.md
58
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
|
||||
|
||||
@ -14,9 +14,7 @@ Passes [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js)
|
||||
- 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>
|
||||
- [x] **Zero Dependencies**
|
||||
|
||||
# Install
|
||||
|
||||
@ -30,25 +28,26 @@ Register and DuckDNS Domain and Save the API Token:
|
||||
|
||||
# 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
|
||||
First you create an instance with your credentials:
|
||||
|
||||
```js
|
||||
greenlock.manager.defaults({
|
||||
challenges: {
|
||||
'dns-01': {
|
||||
module: 'acme-dns-01-duckdns',
|
||||
var dns01 = require('acme-dns-01-duckdns').create({
|
||||
baseUrl: 'https://www.duckdns.org/update', // default
|
||||
token: 'xxxxxxx'
|
||||
}
|
||||
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
|
||||
// ...
|
||||
}
|
||||
});
|
||||
```
|
||||
@ -59,26 +58,11 @@ documentation for more details.
|
||||
|
||||
### ACME.js
|
||||
|
||||
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'
|
||||
});
|
||||
// TODO
|
||||
```
|
||||
|
||||
```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.
|
||||
See the [ACME.js](https://git.rootprojects.org/root/acme-v2.js) for more details.
|
||||
|
||||
### Build your own
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"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",
|
||||
"main": "index.js",
|
||||
"files": [
|
||||
|
Loading…
x
Reference in New Issue
Block a user