greenlock-express - npm Package Compare versions

Comparing version 3.1.1 to 4.0.1

package.json

 {
     "name": "greenlock-express",
-    "version": "3.1.1",
+    "version": "4.0.1",
     "description": "Free SSL and managed or automatic HTTPS for node.js with Express, Koa, Connect, Hapi, and all other middleware systems.",
@@ -20,4 +20,4 @@ "main": "greenlock-express.js",
     "dependencies": {
-        "@root/greenlock": "^3.1.3",
-        "@root/greenlock-express": "^3.1.1",
+        "@root/greenlock": "^4.0.2",
+        "@root/greenlock-express": "^4.0.1",
         "redirect-https": "^1.1.5"
@@ -24,0 +24,0 @@ },

README.md

@@ -28,7 +28,7 @@ # [Greenlock Express](https://git.rootprojects.org/root/greenlock-express.js) is Let's Encrypt for Node
 ```bash
-npm install --save greenlock-express@v3
+npm install --save greenlock-express@v4
 ```
 
 ```bash
-npx greenlock init --maintainer-email '[e-mail]' --manager-config-file ./greenlock.json
+npx greenlock init --config-dir ./greenlock.d --maintainer-email '[e-mail]'
 ```
@@ -42,18 +42,17 @@
 
+var app = require("./app.js");
+
 require("greenlock-express")
-    .init(function() {
-        return {
-            greenlock: require("./greenlock.js"),
+    .init({
+        packageRoot: __dirname,
 
-            // whether or not to run at cloudscale
-            cluster: false
-        };
+        // contact for security and critical bug notices
+        configDir: "./greenlock.d",
+
+        // whether or not to run at cloudscale
+        cluster: false
     })
-    .ready(function(glx) {
-        var app = require("./app.js");
-
-        // Serves on 80 and 443
-        // Get's SSL certificates magically!
-        glx.serveApp(app);
-    });
+    // Serves on 80 and 443
+    // Get's SSL certificates magically!
+    .serve(app);
 ```
@@ -64,3 +63,3 @@
 <details>
-<summary>greenlock.js</summary>
+<summary>app.js</summary>
 
@@ -70,21 +69,4 @@ ```js
 
-var pkg = require("./package.json");
-module.exports = require("@root/greenlock").create({
-    // name & version for ACME client user agent
-    packageAgent: pkg.name + "/" + pkg.version,
-
-    // contact for security and critical bug notices
-    maintainerEmail: pkg.author,
-
-    // where to find .greenlockrc and set default paths
-    packageRoot: __dirname
-});
-```
-
-</details>
-
-<details>
-<summary>app.js</summary>
-
-```js
+// Here's a vanilla HTTP app to start,
+// but feel free to replace it with Express, Koa, etc
 var app = function(req, res) {
@@ -100,9 +82,16 @@ res.end("Hello, Encrypted World!");
 ```bash
-npx greenlock defaults --subscriber-email '[e-mail]' --agree-to-terms
+npx greenlock add --subject example.com --altnames example.com
 ```
 
-```bash
-npx greenlock add --subject example.com --altnames example.com
+<details>
+<summary>greenlock.d/config.json</summary>
+
+<!-- TODO update manager to write array rather than object -->
+
+```json
+{ "sites": [{ "subject": "example.com", "altnames": ["example.com"] }] }
 ```
 
+</details>
+
 ```bash
@@ -224,28 +213,23 @@ npm start -- --staging
 
+//var pkg = require("./package.json");
+var app = require("./app.js");
+
 require("greenlock-express")
-    .init(function() {
-        var pkg = require("./package.json");
-        return {
-            greenlock: require("@root/greenlock").create({
-                // name & version for ACME client user agent
-                packageAgent: pkg.name + "/" + pkg.version,
+    .init({
+        // name & version for ACME client user agent
+        //packageAgent: pkg.name + "/" + pkg.version,
 
-                // contact for security and critical bug notices
-                maintainerEmail: pkg.author,
+        // contact for security and critical bug notices
+        maintainerEmail: pkg.author,
 
-                // where to find .greenlockrc and set default paths
-                packageRoot: __dirname
-            }),
+        // where to find .greenlockrc and set default paths
+        packageRoot: __dirname,
 
-            // whether or not to run at cloudscale
-            cluster: false
-        };
+        // where config and certificate stuff go
+        configDir: "./greenlock.d",
+
+        // whether or not to run at cloudscale
+        cluster: false
     })
-    .ready(function(glx) {
-        var app = require("./app.js");
-
-        // Serves on 80 and 443
-        // Get's SSL certificates magically!
-        glx.serveApp(app);
-    });
+    .serve(app);
 ```
@@ -271,5 +255,4 @@
 ```txt
-Greenlock v3.0.0
-Greenlock Manager Config File: ~/.config/greenlock/manager.json
-Greenlock Storage Directory: ~/.config/greenlock/
+Greenlock v4.0.0
+Greenlock Config Dir/File: ./greenlock.d/config.json
 
@@ -301,4 +284,6 @@ Listening on 0.0.0.0:80 for ACME challenges and HTTPS redirects
 {
-    "manager": "greenlock-manager-fs",
-    "configFile": "./greenlock.json"
+    "manager": {
+        "module": "@greenlock/manager"
+    },
+    "configDir": "./greenlock.d"
 }
@@ -454,3 +439,3 @@ ```
     -   `npx greenlock defaults --challenge-dns-01 acme-dns-01-ovh --challenge-dns-01-token xxxx`
-    -   `npx greenlock update --subject example.com --challenge-dns-01 ./your-dns-01.js
+    -   `npx greenlock update --subject example.com --challenge-dns-01 ./your-dns-01.js`
 
@@ -533,2 +518,1 @@ # Ready-made Integrations
 [Privacy Policy](https://therootcompany.com/legal/#privacy)
-[Privacy Policy](https://therootcompany.com/legal/#privacy)

No alert changes

Worsened metrics

Total package byte prevSize

33617

-1.67%

Number of lines in readme file

509

-3.05%

Dependency changes

• + Added

  @root/greenlock@4.0.5
  (transitive)

• + Added

  @root/greenlock-express@4.0.4
  (transitive)

• - Removed

  @root/greenlock@3.1.5
  (transitive)

• - Removed

  @root/greenlock-express@3.1.1
  (transitive)

• - Removed

  @root/keypairs@0.9.0
  (transitive)

• Updated

  @root/greenlock@^4.0.2

• Updated

  @root/greenlock-express@^4.0.1