v3.0.2: update docs
This commit is contained in:
parent
35c396a321
commit
baa35c2f93
24
README.md
24
README.md
|
@ -1,6 +1,4 @@
|
||||||
# [greenlock-challenge-test](https://git.coolaj86.com/coolaj86/greenlock-challenge-test.js.git)
|
# [greenlock-challenge-test](https://git.rootprojects.org/root/greenlock-challenge-test.js.git) | A [Root](https://rootprojects.org) Project
|
||||||
|
|
||||||
| A [Root](https://rootprojects.org) Project |
|
|
||||||
|
|
||||||
The test harness you should use when writing an ACME challenge strategy
|
The test harness you should use when writing an ACME challenge strategy
|
||||||
for [Greenlock](https://git.coolaj86.com/coolaj86/greenlock-express.js) v2.7+ (and v3).
|
for [Greenlock](https://git.coolaj86.com/coolaj86/greenlock-express.js) v2.7+ (and v3).
|
||||||
|
@ -35,8 +33,22 @@ tester.test('http-01', domain, challenger).then(function () {
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Reference Implementations
|
||||||
|
|
||||||
|
These are plugins that use the v2.7+ (v3) API, and pass this test harness,
|
||||||
|
which you should use as a model for any plugins that you create.
|
||||||
|
|
||||||
|
* [greenlock-challenge-http](https://git.rootprojects.org/root/greenlock-challenge-http.js)
|
||||||
|
* [greenlock-challenge-dns](https://git.rootprojects.org/root/greenlock-challenge-dns.js)
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
See `example.js` (it works).
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
|
Here's a quick pseudo stub-out of what a test-passing plugin object might look like:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
tester.test('http-01', 'example.com', {
|
tester.test('http-01', 'example.com', {
|
||||||
set: function (opts) {
|
set: function (opts) {
|
||||||
|
@ -84,9 +96,3 @@ tester.test('http-01', 'example.com', {
|
||||||
|
|
||||||
Note: The `API.get()`, `API.set()`, and `API.remove()` is where you do your magic up to upload a file to the correct
|
Note: The `API.get()`, `API.set()`, and `API.remove()` is where you do your magic up to upload a file to the correct
|
||||||
location on an http serever, set DNS records, or add the appropriate data to the database that handles such things.
|
location on an http serever, set DNS records, or add the appropriate data to the database that handles such things.
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
See `example.js` (it works).
|
|
||||||
|
|
||||||
Will post reference implementations here later...
|
|
||||||
|
|
|
@ -1,8 +1,9 @@
|
||||||
{
|
{
|
||||||
"name": "greenlock-challenge-test",
|
"name": "greenlock-challenge-test",
|
||||||
"version": "3.0.1",
|
"version": "3.0.2",
|
||||||
"description": "The base set of tests for all ACME challenge strategies. Any `greenlock-challenge-` plugin should be able to pass these tests.",
|
"description": "The base set of tests for all ACME challenge strategies. Any `greenlock-challenge-` plugin should be able to pass these tests.",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
|
"homepage": "https://git.rootprojects.org/root/greenlock-challenge-test.js",
|
||||||
"dependencies": {},
|
"dependencies": {},
|
||||||
"devDependencies": {},
|
"devDependencies": {},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
@ -10,7 +11,7 @@
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://git.coolaj86.com/coolaj86/greenlock-challenge-test.js.git"
|
"url": "https://git.rootprojects.org/root/greenlock-challenge-test.js.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"Let's Encrypt",
|
"Let's Encrypt",
|
||||||
|
@ -22,6 +23,6 @@
|
||||||
"module",
|
"module",
|
||||||
"strategy"
|
"strategy"
|
||||||
],
|
],
|
||||||
"author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
|
"author": "AJ ONeal <solderjs@gmail.com> (https://solderjs.com/)",
|
||||||
"license": "MPL-2.0"
|
"license": "MPL-2.0"
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue