root/greenlock-manager-test.js
2
0
Fork 0
mirror of https://git.coolaj86.com/coolaj86/greenlock-manager-test.js.git synced 2025-04-20 14:30:40 +00:00
Code Issues 2 Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
AJ ONeal 2019-10-31 00:09:09 -06:00
parent 742ef6159a
commit 8be22ecbae
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -16,13 +16,15 @@ A greenlock manager is just a set of a few callbacks to keeps track of:
- `renewAt` (ex: '45d') - `renewAt` (ex: '45d')
- `challenges` (plugins for 'http-01', 'dns-01', etc) - `challenges` (plugins for 'http-01', 'dns-01', etc)
The callbacks are: The **callbacks** are:
- `set({ subject, altnames, renewAt })` to save site details - `set({ subject, altnames, renewAt })` to save site details
- `find({ subject, altnames, renewBefore })` which returns a list of matching sites (perhaps all sites) - `find({ subject, altnames, renewBefore })` which returns a list of matching sites (perhaps all sites)
- `remove({ subject })` which marks a site as deleted - `remove({ subject })` which marks a site as deleted
- `defaults()` which either **gets** or **sets** the global configs that apply to all sites - `defaults()` which either **gets** or **sets** the global configs that apply to all sites
When do they get called? Well, whenever they need to.
# Some Terminology # Some Terminology
- `subject` refers to the **primary domain** on an SSL certificate - `subject` refers to the **primary domain** on an SSL certificate
@ -45,6 +47,7 @@ You can start _really_ simple: just make a file that exports a `create()` functi
'use strict'; 'use strict';
var MyManager = module.exports; var MyManager = module.exports;
MyManager.create = function(options) { MyManager.create = function(options) {
console.log('The tests will make me stronger'); console.log('The tests will make me stronger');
return {}; return {};