coolaj86
/
acme-challenge-test.js
1
0
Fork 0
Code Issues 2 Pull Requests Releases Wiki Activity

v3.0.2: update docs

This commit is contained in:
AJ ONeal 2019-04-15 22:50:02 -06:00
parent 35c396a321
commit baa35c2f93
2 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,6 +1,4 @@
# [greenlock-challenge-test](https://git.coolaj86.com/coolaj86/greenlock-challenge-test.js.git)
| A [Root](https://rootprojects.org) Project |
# [greenlock-challenge-test](https://git.rootprojects.org/root/greenlock-challenge-test.js.git) | A [Root](https://rootprojects.org) Project
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).
@ -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
Here's a quick pseudo stub-out of what a test-passing plugin object might look like:
```js
tester.test('http-01', 'example.com', {
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
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...

7
package.json
View File

@ -1,8 +1,9 @@
{
"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.",
"main": "index.js",
"homepage": "https://git.rootprojects.org/root/greenlock-challenge-test.js",
"dependencies": {},
"devDependencies": {},
"scripts": {
@ -10,7 +11,7 @@
},
"repository": {
"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": [
"Let's Encrypt",
@ -22,6 +23,6 @@
"module",
"strategy"
],
"author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
"author": "AJ ONeal <solderjs@gmail.com> (https://solderjs.com/)",
"license": "MPL-2.0"
}