root
/
greenlock-express.js
mirror of https://github.com/therootcompany/greenlock-express.js.git
2
1
Fork 0
Code Issues 43 Releases Wiki Activity

clarify the approveRegistration() function in README.md

This commit is contained in:
David Flanagan 2016-05-17 14:22:21 -07:00
parent 4b07df9676
commit d5c0475a01
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -42,15 +42,20 @@ npm install --save letsencrypt-express
Using .testing() will overwrite the debug flag with true */ Using .testing() will overwrite the debug flag with true */
var LEX = require('letsencrypt-express').testing(); var LEX = require('letsencrypt-express').testing();
// Change these two lines!
var DOMAIN = 'myservice.example.com';
var EMAIL = 'user@example.com';
var lex = LEX.create({ var lex = LEX.create({
configDir: require('os').homedir() + '/letsencrypt/etc' configDir: require('os').homedir() + '/letsencrypt/etc'
, approveRegistration: function (hostname, cb) { // leave `null` to disable automatic registration , approveRegistration: function (hostname, approve) { // leave `null` to disable automatic registration
// Note: this is the place to check your database to get the user associated with this domain if (hostname === DOMAIN) { // Or check a database or list of allowed domains
cb(null, { approve(null, {
domains: [hostname] domains: [DOMAIN]
, email: 'CHANGE_ME' // user@example.com , email: EMAIL
, agreeTos: true , agreeTos: true
}); });
}
} }
}); });
``` ```