From 685ef09951ed7bea98212dfc3d3b66e767fa61fb Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Thu, 18 Aug 2016 13:07:55 -0600 Subject: [PATCH 1/5] fix #76 add migration notes --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1350506..77e3ddc 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,14 @@ Migrating from v1.x =================== Whereas v1.x had a few hundred lines of code, v2.x is a single small file of about 50 lines. -Now All of the behavior has moved to the various plugins, which each have their own options, respectively. + +A few important things to note: + +* Delete your v1.x `~/letsencrypt` directory + * (otherwise you get `{ type: 'urn:acme:error:malformed', detail: 'Parse error reading JWS', status: 400 }`) +* `approveRegistration` has been replaced by `approveDomains` +* All of the behavior has moved to the various plugins, which each have their own options +* Use https and http directly, don't rely on the silly `.listen()` helper. It's just there for looks. Usage ===== From 287d0b6606a2756dbeec9e5dce8268cfe8bd7608 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Fri, 19 Aug 2016 13:31:37 -0600 Subject: [PATCH 2/5] fix #79 put colon in example in the right place --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 77e3ddc..4d2dd8a 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ var lex = require('letsencrypt-express').create({ // If you wish to replace the default plugins, you may do so here // -, challenges: { 'http-01:' require('le-challenge-fs').create({ webrootPath: '/tmp/acme-challenges' }) } +, challenges: { 'http-01': require('le-challenge-fs').create({ webrootPath: '/tmp/acme-challenges' }) } , store: require('le-store-certbot').create({ webrootPath: '/tmp/acme-challenges' }) // You probably wouldn't need to replace the default sni handler From c65539bf6c8c2487ca71cdcfaa8ec8f0f4e2978b Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Fri, 19 Aug 2016 16:22:57 -0600 Subject: [PATCH 3/5] update example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d2dd8a..69b4f19 100644 --- a/README.md +++ b/README.md @@ -152,7 +152,7 @@ function approveDomains(opts, certs, cb) { ```javascript // handles acme-challenge and redirects to https -require('http').createServer(lex.middleware()).listen(80, function () { +require('http').createServer(lex.middleware(require('redirect-https')())).listen(80, function () { console.log("Listening for ACME http-01 challenges on", this.address()); }); From 5aaf3d9fd39b2c8f3338259a4ad339a8d85c29e4 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Fri, 19 Aug 2016 16:29:31 -0600 Subject: [PATCH 4/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 69b4f19..2f7462c 100644 --- a/README.md +++ b/README.md @@ -94,8 +94,8 @@ Whereas v1.x had a few hundred lines of code, v2.x is a single small file of abo A few important things to note: -* Delete your v1.x `~/letsencrypt` directory - * (otherwise you get `{ type: 'urn:acme:error:malformed', detail: 'Parse error reading JWS', status: 400 }`) +* Delete your v1.x `~/letsencrypt` directory, otherwise you get this: + * `{ type: 'urn:acme:error:malformed', detail: 'Parse error reading JWS', status: 400 }` * `approveRegistration` has been replaced by `approveDomains` * All of the behavior has moved to the various plugins, which each have their own options * Use https and http directly, don't rely on the silly `.listen()` helper. It's just there for looks. From fd8c02545777142000901c3037623bce7f81f440 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Tue, 30 Aug 2016 08:54:48 -0600 Subject: [PATCH 5/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 2f7462c..caa8431 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,8 @@ Install npm install --save letsencrypt-express@2.x ``` +**Important**: Use node v4.5+ or v6.x, node <= v4.4 has a [known bug](https://github.com/nodejs/node/issues/8053) in the `Buffer` implementation. + QuickStart ==========