4.0.4

update deps for #38
Add missing tlsOptions to http2 example
2024-11-16 17:28:59 +00:00 · 2020-08-03 23:18:26 -06:00 · 2020-08-03 23:18:21 -06:00 · 2020-08-03 06:37:24 +00:00 · 2020-07-29 02:39:47 +00:00 · 2020-07-29 02:38:55 +00:00
53 changed files with 2345 additions and 1982 deletions
--- a/.gitignore
+++ b/.gitignore
@ -1,3 +1,8 @@
+app.js
+server.js
+greenlock.js
+.greenlockrc
+
 # Logs
 logs
 *.log
--- a/.prettierrc
+++ b/.prettierrc
@ -1,7 +1,7 @@
 {
  "bracketSpacing": true,
  "printWidth": 120,
-  "tabWidth": 2,
+  "tabWidth": 4,
  "trailingComma": "none",
-  "useTabs": true
+  "useTabs": false
 }
--- a/README.md
+++ b/README.md
@ -1,28 +1,47 @@
-# [Greenlock Express](https://git.rootprojects.org/root/greenlock-express.js) is Let's Encrypt for Node
+# [Greenlock Express v4](https://git.rootprojects.org/root/greenlock-express.js) is Let's Encrypt for Node
+
+| Built by [Root](https://therootcompany.com) for [Hub](https://rootprojects.org/hub/) |

 ![Greenlock Logo](https://git.rootprojects.org/root/greenlock.js/raw/branch/master/logo/greenlock-1063x250.png "Greenlock Logo")

-| Built by [Root](https://therootcompany.com) for [Hub](https://rootprojects.org/hub/)
+### Free SSL for Node Web Servers

-Free SSL, Automated HTTPS / HTTP2, served with Node via Express, Koa, hapi, etc.
+Greenlock Express is a **Web Server** with **Fully Automated HTTPS** and renewals.
+
+You define your app and let Greenlock handle issuing and renewing Free SSL Certificates.
+
+```bash
+npm init
+npm install --save greenlock-express@v4
+```
+
+`server.js`:

 ```js
+"use strict";
+
+var app = require("./app.js");
+
 require("greenlock-express")
-	.init(getConfig)
-	.serve(worker);
+    .init({
+        packageRoot: __dirname,
+        configDir: "./greenlock.d",

-function getConfig() {
-	return {
-		package: require("./package.json")
-	};
-}
+        // contact for security and critical bug notices
+        maintainerEmail: "jon@example.com",

-function worker(server) {
-	server.serveApp(function(req, res) {
-		// Works with any Node app (Express, etc)
-		res.end("Hello, Encrypted World!");
-	});
-}
+        // whether or not to run at cloudscale
+        cluster: false
+    })
+    // Serves on 80 and 443
+    // Get's SSL certificates magically!
+    .serve(app);
+```
+
+`./greenlock.d/config.json`:
+
+```json
+{ "sites": [{ "subject": "example.com", "altnames": ["example.com"] }] }
 ```

 # Let's Encrypt for...
@ -47,184 +66,428 @@ function worker(server) {
    -   [x] **Wildcard** SSL
    -   [x] **Localhost** certificates
    -   [x] HTTPS-enabled Secure **WebSockets** (`wss://`)
+    -   [x] **Cloud-ready** with Node `cluster`.
 -   [x] Fully customizable
    -   [x] **Reasonable defaults**
    -   [x] Domain Management
    -   [x] Key and Certificate Management
    -   [x] ACME Challenge Plugins

-# Plenty of Examples
+# Compatibility

- [greenlock-express.js/examples/](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples)
-  - [Express](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/express.js)
-  - [Node's **http2**](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/http2.js)
-  - [Node's https](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/https.js)
-  - [**WebSockets**](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/websockets.js)
-  - [Socket.IO](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/socket-io.js)
-  - [Cluster](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/socket-io.js)
-  - [**Wildcards**](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/wildcards/README.md)
-  - [**Localhost**](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/localhost/README.md)
-  - [**CI/CD**](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/ci-cd/README.md)
+Works with _any_ node http app, including

-# Easy to Customize
+-   [x] Express
+-   [x] Koa
+-   [x] hapi
+-   [x] rill
+-   [x] http2
+-   [x] cluster
+-   [x] etc...

-<!-- greenlock-manager-test => greenlock-manager-custom -->
+# v4 QuickStart

- [greenlock.js/examples/](https://git.rootprojects.org/root/greenlock.js/src/branch/master/examples)
-  - [Custom Domain Management](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/custom-manager/README.md)
-  - [Custom Key & Cert Storage](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/custom-store/README.md)
-  - [Custom ACME Challenges](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/custom-acme-challenges/README.md)
+Serving sites with Free SSL is as easy as 1, 2, 3... 4

-# QuickStart Guide
+## Overview

-Easy as 1, 2, 3... 4
+1. Create a Project with Greenlock Express
+    - `server.js`
+    - `app.js`
+2. Setup the config file (or database)
+    - `.greenlockrc`
+    - `greenlock.d/config.json`
+3. Add Domains
+    - `npx greenlock add --subject example.com --altnames example.com`
+4. Hello, World!
+    - `npm start -- --staging`

-## 1. Create a node project
+### TL;DR

-Create an empty node project.
-
-Be sure to fill out the package name, version, and an author email.
+If you're familiar with node, npm, and npx: this is all you need to do:

 ```bash
-mkdir ~/my-project
-pushd ~/my-project
 npm init
+npm install --save greenlock-express@v4
+
+npx greenlock init --config-dir greenlock.d --maintainer-email jon@example.com
+npx greenlock add --subject example.com --altnames example.com
+
+npm start -- --staging
 ```

-## 2. Create an http app (i.e. express)
+Once you've tested that that works, you can change `app.js` to suit your needs replace the built-in callbacks for things like certificate storage as you like.

-This example is shown with Express, but any node app will doGreenlock
-works with everything.
-(or any node-style http app)
+## 1. Create your Project

-`my-express-app.js`:
+If you need to install Node.js, do so:
+
+Mac, Linux:
+
+```bash
+curl -fsS https://webinstall.dev/node | bash
+```
+
+Windows 10:
+
+```pwsh
+curl -fsSA "MS" https://webinstall.dev/node | powershell
+```
+
+Then create a directory for your project, and initialize it:
+
+```bash
+mkdir -p my-sites
+pushd my-sites
+npm init
+npm install --save greenlock-express@v4
+```
+
+## 2. Initialize and Config (Dir or DB)
+
+You can use **local file storage** or a **database**. The default is to use file storage.
+
+You'll need to create `server.js` and `greenlock.d/config.json`. You can do so using the CLI, API, or by hand.
+
+### Using the CLI (simplest, recommended)
+
+Anytime you install an npm module that contains an executable,
+you can run it using `npx`.
+
+To initialize the Greenlock config, run `npx greenlock init`:
+
+```bash
+npx greenlock init --config-dir ./greenlock.d --maintainer-email 'jon@example.com'
+```
+
+### By Hand (for advanced users)
+
+Create `server.js` like so:
+
+`server.js`:

 ```js
-"use strict";
+'use strict';

-// A plain, node-style app
+var app = require('./app.js');

-function myPlainNodeHttpApp(req, res) {
-	res.end("Hello, Encrypted World!");
-}
+require('greenlock-express')
+    .init({
+        packageRoot: __dirname,

-// Wrap that plain app in express,
-// because that's what you're used to
+        // where to look for configuration
+        configDir: './greenlock.d',

-var express = require("express");
-var app = express();
-app.get("/", myPlainNodeHttpApp);
+        // whether or not to run at cloudscale
+        cluster: false
+    })
+    // Serves on 80 and 443
+    // Get's SSL certificates magically!
+    .serve(app);
+```

-// export the app normally
-// do not .listen()
+Create `app.js` like so:
+
+`app.js`:
+
+```js
+'use strict';
+
+// Here's a vanilla HTTP app to start,
+// but feel free to replace it with Express, Koa, etc
+var app = function(req, res) {
+    res.end('Hello, Encrypted World!');
+};

 module.exports = app;
 ```

-## 3. Serve with Greenlock Express
+Greenlock uses `.greenlockrc` to figure out whether to use the file system or a database for config,
+as well as where its root directory is.

-Greenlock Express is designed with these goals in mind:
+`.greenlockrc`

- Simplicity and ease-of-use
- Performance and scalability
- Configurability and control
-
-You can start with **near-zero configuration** and
-slowly add options for greater performance and customization
-later, if you need them.
-
-`server.js`:
-
-```bash
-require("greenlock-express")
-	.init(getConfig)
-	.serve(worker);
-
-function getConfig() {
-	return {
-		// uses name and version as part of the ACME client user-agent
-    // uses author as the contact for support notices
-		package: require("./package.json")
-	};
-}
-
-function worker(server) {
-	// Works with any Node app (Express, etc)
-  var app = require('my-express-app.js');
-	server.serveApp(app);
-}
+```json
+{"manager":{"module":"@greenlock/manager"},"configDir":"greenlock.d"}
 ```

-And start your server:
+The `greenlock.d/config.json` is NOT intended to be edited by hand, as it is a substitute for a database, but it looks like this:

-```bash
-# Allow non-root node to use ports 80 (HTTP) and 443 (HTTPS)
-sudo setcap 'cap_net_bind_service=+ep' $(which node)
+```json
+{ "defaults": { "subscriberEmail": "john.doe@example.com" }, "sites": [] }
 ```

+## 3. Add Sites
+
+For security, you must specify which sites you allow to request certificates. If you need this to be dynamic (i.e. checking a database or API, see the section below on custom site managers).
+
+Every site has a "subject" (its primary domain name) and one or more "altnames" (secondary or related domain names on the same certificate).
+
+### Using CLI (simple, recommended)
+
+Simply supply the names of sites that you manage and they will be added to the file system config, or database.
+
 ```bash
-# `npm start` will call `node ./server.js` by default
-npm start
+npx greenlock add --subject example.com --altnames example.com,www.example.com
+```
+
+### By Hand (debugging only)
+
+You should NOT edit `greenlock.d/config.json` with your own tools. Use `greenlock.manager.add({})` instead.
+
+`greenlock.d/config.json`:
+
+<!-- TODO update manager to write array rather than object -->
+
+```json
+{ "sites": [{ "subject": "example.com", "altnames": [ "example.com", "www.example.com" ] }] }
+```
+
+## 4. Hello, Encrypted World!
+
+That was it! Now you can run your server!
+
+When you run `npm start`, it will automatically run `node server.js` (or `package.json.scripts.start`).
+
+For arguments that `npm start` should ignore, place them after `--`.
+
+Here we use `--staging` in order to tell greenlock to issue test certificates rather than real certificates.
+
+```bash
+# Note: you can use npm start to run server.js with the --staging flag set
+npm start -- --staging
 ```

 ```txt
-Greenlock v3.0.0
-Greenlock Manager Config File: ~/.config/greenlock/manager.json
-Greenlock Storage Directory: ~/.config/greenlock/
+> my-project@1.0.0 start /srv/www/my-project
+> node server.js

 Listening on 0.0.0.0:80 for ACME challenges and HTTPS redirects
 Listening on 0.0.0.0:443 for secure traffic
 ```

-## 4. Manage domains
+If everything worked you can visit your site in your browser, and after a few seconds you'll get a certificate warning and, after that, see a "Hello World" message. The debug (staging) certificates will be saved in `greenlock.d/staging`. Run again without `--staging` and you will get real certificates.

-Management can be done via the **CLI** or the JavaScript [**API**](https://git.rootprojects.org/root/greenlock.js/).
-Since this is the QuickStart, we'll demo the **CLI**:
+### Season to taste

-You need to create a Let's Encrypt _subscriber account_, which can be done globally, or per-site.
-All individuals, and most businesses, should set this globally:
+Now you're ready to update `app.js` with your code. For example, try this next:

 ```bash
-# Set a global subscriber account
-npx greenlock config --subscriber-email 'mycompany@example.com' --agree-to-terms true
+npm install --save express
+mkdir -p public
+echo '<h1>Hello!</h1>' >> public/index.html
 ```

-<!-- todo print where the key was saved -->
+`app.js`:

-A Let's Encrypt SSL certificate has a "Subject" (Primary Domain) and up to 100 "Alternative Names"
-(of which the first _must_ be the subject).
+```js
+'use strict';
+
+var path = require('path');
+var express = require('express');
+var app = express();
+
+app.get('/', express.static(path.join(__dirname, "public")));
+
+module.exports = app;
+
+// for development and debugging
+if (require.main === module) {
+    require('http').createServer(app).listen(3000, function () {
+        console.info("Listening for HTTP on", this.address());
+    });
+}
+```
+
+# Walkthrough
+
+For a more detail read the full
+[WALKTHROUGH](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/WALKTHROUGH.md).
+
+# Examples
+
+To see all of the examples, just browse [greenlock-express.js/examples/](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples)
+
+|        Example         | Location + Description                                                                                                                     |
+| :--------------------: | :----------------------------------------------------------------------------------------------------------------------------------------- |
+|        Express         | [./examples/express/][ex-express] how to export an express app                                                                             |
+|    Node's **http2**    | [./examples/http2/][ex-http2] how to use Node's built-in http2 server                                                                      |
+|      Node's https      | [./examples/https][ex-https] how to customize the https server                                                                             |
+|     **WebSockets**     | [./examples/websockets/][ex-websockets] how to use `on('upgrade')`                                                                         |
+| <span>Socket.IO</span> | [./examples/socket.io][ex-socketio] how to overcomplicate a persistent connection                                                          |
+|        Cluster         | [./examples/cluster/][ex-cluster] how to use Node's built-in clustering with master and worker processes                                   |
+|     **Wildcards**      | [coming someday][ex-wildcards] (ask to help create this) how to use DNS-01 for wildcard certs                                              |
+|     **Localhost**      | [coming someday][ex-localhost] (ask to help create this) how to use DNS-01 for domains that resolve to private networks, such as 127.0.0.1 |
+|       **CI/CD**        | [coming someday][ex-cicd] (ask to help create this) how to use the `--staging` environment for test deployments                            |
+|       HTTP Proxy       | [examples/http-proxy][ex-http-proxy] how to (reverse) proxy decrypted traffic to another server                                            |
+|           -            | Build your own<br>Be sure to tell me about it (open an issue)                                                                              |
+
+[ex-express]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/express/
+[ex-http2]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/http2/
+[ex-https]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/https/
+[ex-websockets]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/websockets/
+[ex-socketio]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/socketo.io/
+[ex-cluster]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/cluster/
+[ex-wildcards]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/wildcards/
+[ex-localhost]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/localhost/
+[ex-cicd]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/ci-cd/
+[ex-http-proxy]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/http-proxy/
+
+
+# FAQ
+## 1. But did YOU read the QuickStart?
+
+99% of the questions I get are answered in the QuickStart, or in the Examples.
+
+Before you go into your specific use case, just try out the QuickStart from start to finish so that you can see that the default setup works, you get feel for the "lay of the land", and you know what to edit.
+
+## 2. How to use JavaScript configuration?
+
+You don't. It's JSON on purpose.
+
+The configuration has to be serializable (i.e. could go in a database).
+
+The config file is meant for **simple** use cases, for the average dev and it is managed with `npx greenlock ...`, as shown in the QuickStart.
+
+If you have a **dynamic** or **advanced** use case (i.e. you need stuff in a database, or to change config on-the-fly), you can use the Greenlock API (not Greenlock Express) and you'll love it.
+
+If you're layering a lot of **complexity** with dev ops tools, but you don't really understand the tools that well (i.e. **Docker**), either use ENVIRONMENT variables or put the `npx greenlock ...` commands in your setup script. You MUST use a database for **lambda** "cloud functions" and such.
+
+You can also just mangle the Greenlock API to do what you want... but I don't recommend it. Keep it simple and your future self with thank you.
+
+General rule of thumb: commit code, not data / config.
+
+## 3. How to use non-standard ports (not 80, 443)?
+
+You don't. Not usually.
+
+Let's Encrypt **REQUIRES port 80** for HTTP-01 challenges.
+
+But if you're using DNS-01 or you have a proxy in place, just use the raw node server. See these examples:
+
+- [examples/http/server.js](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/http/server.js)
+- [examples/https/server.js](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/https/server.js)
+
+If you want to use Greenlock as a proxy, see this example:
+
+- [examples/http-proxy/server.js](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/http-proxy/server.js)
+
+# Troubleshooting
+
+### What if the example didn't work?
+
+Double check the following:
+
+-   **Public Facing IP** for `http-01` challenges
+    -   Are you running this _as_ a public-facing webserver (good)? or localhost (bad)?
+    -   Does `ifconfig` show a public address (good)? or a private one - 10.x, 192.168.x, etc (bad)?
+    -   If you're on a non-public server, are you using the `dns-01` challenge?
+-   **valid email**
+    -   You MUST set `maintainerEmail` to a **valid address**
+    -   MX records must validate (`dig MX example.com` for `'john@example.com'`)
+-   **valid DNS records**
+    -   Must have public DNS records (test with `dig +trace A example.com; dig +trace www.example.com` for `[ 'example.com', 'www.example.com' ]`)
+-   **write access**
+    -   You MUST set `configDir` to a writeable location (test with `touch ./greenlock.d/config.json`)
+-   **port binding privileges**
+    -   You MUST be able to bind to ports 80 and 443
+    -   You can do this via `sudo` or [`setcap`](https://gist.github.com/firstdoit/6389682)
+-   **API limits**
+    -   You MUST NOT exceed the API [**usage limits**](https://letsencrypt.org/docs/staging-environment/) per domain, certificate, IP address, etc
+-   **Red Lock, Untrusted**
+    -   You MUST switch from `npm start -- --staging` to `npm start` to use the **production** server
+    -   The API URL should not have 'acme-staging-v02', but should have 'acme-v02'
+
+# Using a Database, S3, etc
+
+If you have a small site, the default file storage will work well for you.
+
+If you have many sites with many users, you'll probably want to store config in a database of some sort.
+
+See the section on **Custom** callbacks and plugins below.
+
+# Advanced Configuration
+
+All of the advanced configuration is done by replacing the default behavior with callbacks.
+
+You can whip up your own, or you can use something that's published to npm.
+
+See the section on **Custom** callbacks and plugins below.
+
+# Easy to Customize
+
+<!-- greenlock-manager-test => greenlock-manager-custom -->
+
+<!--
+- [greenlock.js/examples/](https://git.rootprojects.org/root/greenlock.js/src/branch/master/examples)
+-->
+
+-   [Custom Domain Management](https://git.rootprojects.org/root/greenlock-manager-test.js)
+    -   edit `server.js` and/or `.greenlockrc` to switch from the default `configDir` manager to your config system or database
+    -   CLI example: `npx greenlock init --manager ./path-or-npm-name.js --manager-FOO 'set option FOO'`
+-   [Custom Key & Cert Storage](https://git.rootprojects.org/root/greenlock-store-test.js)
+    -   edit the `defaults` section of `greenlock.d/config.json` to change the certificate store or database
+    -   CLI example: `npx greenlock defaults --store greenlock-store-fs --store-base-path ./greenlock.d`
+-   [Custom ACME HTTP-01 Challenges](https://git.rootprojects.org/root/acme-http-01-test.js)
+    -   edit the `defaults` section of `greenlock.d/config.json` to change the challenges by hand
+    -   CLI example: `npx greenlock defaults --challenge-http-01 ./you-http-01.js`
+-   [Custom ACME DNS-01 Challenges](https://git.rootprojects.org/root/acme-dns-01-test.js)
+    -   edit the `defaults` section of `greenlock.d/config.json` to change the challenges by hand
+    -   CLI example: `npx greenlock defaults --challenge-dns-01 acme-dns-01-ovh --challenge-dns-01-token xxxx`
+    -   Per-site example: `npx greenlock update --subject example.com --challenge-dns-01 ./your-dns-01.js`
+    -   API example:
+        ```js
+        greenlock.sites.set({
+            subject: "example.com",
+            challenges: {
+                "dns-01": {
+                    module: "my-npm-module-name",
+                    foo: "some option",
+                    bar: "some other option"
+                }
+            }
+        });
+        ```
+
+If you're using the default `configDir` management you can edit `greenlock.d/config.json` by hand to change
+which default and per-site modules are used.
+
+You can use the CLI, even if you're using a database, buckets, or your own file storage.
+
+You can also use the API, particularly if you need to set values dynamically per-site or per-user
+rather than using the global defaults. The certificate store and all challenges can be set
+per-site, but most per-site use cases are for DNS-01.
+
+# Ready-made Integrations
+
+Greenlock Express integrates between Let's Encrypt's ACME Challenges and many popular services.
+
+| Type        | Service                                                                             | Plugin                   |
+| ----------- | ----------------------------------------------------------------------------------- | ------------------------ |
+| dns-01      | CloudFlare                                                                          | acme-dns-01-cloudflare   |
+| dns-01      | [Digital Ocean](https://git.rootprojects.org/root/acme-dns-01-digitalocean.js)      | acme-dns-01-digitalocean |
+| dns-01      | [DNSimple](https://git.rootprojects.org/root/acme-dns-01-dnsimple.js)               | acme-dns-01-dnsimple     |
+| dns-01      | [DuckDNS](https://git.rootprojects.org/root/acme-dns-01-duckdns.js)                 | acme-dns-01-duckdns      |
+| http-01     | File System / [Web Root](https://git.rootprojects.org/root/acme-http-01-webroot.js) | acme-http-01-webroot     |
+| dns-01      | [GoDaddy](https://git.rootprojects.org/root/acme-dns-01-godaddy.js)                 | acme-dns-01-godaddy      |
+| dns-01      | [Gandi](https://git.rootprojects.org/root/acme-dns-01-gandi.js)                     | acme-dns-01-gandi        |
+| dns-01      | [NameCheap](https://git.rootprojects.org/root/acme-dns-01-namecheap.js)             | acme-dns-01-namecheap    |
+| dns-01      | [Name&#46;com](https://git.rootprojects.org/root/acme-dns-01-namedotcom.js)         | acme-dns-01-namedotcom   |
+| dns-01      | Route53 (AWS)                                                                       | acme-dns-01-route53      |
+| http-01     | S3 (AWS, Digital Ocean, Scaleway)                                                   | acme-http-01-s3          |
+| dns-01      | [Vultr](https://git.rootprojects.org/root/acme-dns-01-vultr.js)                     | acme-dns-01-vultr        |
+| dns-01      | [Build your own](https://git.rootprojects.org/root/acme-dns-01-test.js)             | acme-dns-01-test         |
+| http-01     | [Build your own](https://git.rootprojects.org/root/acme-http-01-test.js)            | acme-http-01-test        |
+| tls-alpn-01 | [Contact us](mailto:support@therootcompany.com)                                     | -                        |
+
+Example Usage:

 ```bash
-# Add a certificate with specific domains
-npx greenlock add --subject example.com --altnames example.com,www.example.com
+npx greenlock defaults --challenge-dns-01 acme-dns-01-ovh --challenge-dns-01-token xxxx
+npx greenlock defaults --challenge-http-01 acme-http-01-s3 --challenge-http-01-bucket my-bucket
 ```

-<!-- todo print where the cert was saved -->
-
-This will update the config file (assuming the default fs-based management plugin):
-
-`~/.config/greenlock/manager.json`:
-
-```json
-{
-	"subscriberEmail": "letsencrypt-test@therootcompany.com",
-	"agreeToTerms": true,
-	"sites": {
-		"example.com": {
-			"subject": "example.com",
-			"altnames": ["example.com", "www.example.com"]
-		}
-	}
-}
-```
-
-Note: **Localhost**, **Wildcard**, and Certificates for Private Networks require
-[**DNS validation**](https://git.rootprojects.org/root/greenlock-exp).
-
- DNS Validation
-  - [**Wildcards**](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/wildcards/README.md)
-  - [**Localhost**](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/localhost/README.md)
-  - [**CI/CD**](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/ci-cd/README.md)
+Search `acme-http-01-` or `acme-dns-01-` on npm to find more.

 # Full Documentation

--- a/WALKTHROUGH.md
+++ b/WALKTHROUGH.md
@ -0,0 +1,256 @@
+# Greenlock Express Walkthrough
+
+This will show you the basics of how to
+
+1. Create a node project
+2. Create an http app (i.e. express)
+3. Serve with Greenlock Express
+4. Manage SSL Certificates and Domains
+
+## 1. Create a node project
+
+Create an empty node project.
+
+Be sure to fill out the package name, version, and an author email.
+
+```bash
+mkdir ~/my-project
+pushd ~/my-project
+npm init
+```
+
+## 2. Create an http app (i.e. express)
+
+This example is shown with Express, but any node app will do. Greenlock
+works with everything.
+(or any node-style http app)
+
+`my-express-app.js`:
+
+```js
+"use strict";
+
+// A plain, node-style app
+
+function myPlainNodeHttpApp(req, res) {
+    res.end("Hello, Encrypted World!");
+}
+
+// Wrap that plain app in express,
+// because that's what you're used to
+
+var express = require("express");
+var app = express();
+app.get("/", myPlainNodeHttpApp);
+
+// export the app normally
+// do not .listen()
+
+module.exports = app;
+```
+
+## 3. Serve with Greenlock Express
+
+Greenlock Express is designed with these goals in mind:
+
+-   Simplicity and ease-of-use
+-   Performance and scalability
+-   Configurability and control
+
+You can start with **near-zero configuration** and
+slowly add options for greater performance and customization
+later, if you need them.
+
+`server.js`:
+
+```js
+"use strict";
+
+//var pkg = require("./package.json");
+var app = require("./app.js");
+
+require("greenlock-express")
+    .init({
+        // where to find .greenlockrc and set default paths
+        packageRoot: __dirname,
+
+        // where config and certificate stuff go
+        configDir: "./greenlock.d",
+
+        // contact for security and critical bug notices
+        maintainerEmail: pkg.author,
+
+        // name & version for ACME client user agent
+        //packageAgent: pkg.name + "/" + pkg.version,
+
+        // whether or not to run at cloudscale
+        cluster: false
+    })
+    .serve(app);
+```
+
+And start your server:
+
+```bash
+# Allow non-root node to use ports 80 (HTTP) and 443 (HTTPS)
+sudo setcap 'cap_net_bind_service=+ep' $(which node)
+```
+
+```bash
+# `npm start` will call `node ./server.js` by default
+npm start
+```
+
+```bash
+# use --staging to use the development API until you're ready to get real certificates
+npm start -- --staging
+```
+
+```txt
+Greenlock v4.0.0
+Greenlock Config Dir/File: ./greenlock.d/config.json
+
+Listening on 0.0.0.0:80 for ACME challenges and HTTPS redirects
+Listening on 0.0.0.0:443 for secure traffic
+```
+
+## 4. Manage SSL Certificates and Domains
+
+The management API is built to work with Databases, S3, etc.
+
+By default, it's just a simple config file and directory.
+
+```bash
+# see which manager and what options are in use
+cat .greenlockrc
+```
+
+<details>
+<summary>Example Output</summary>
+
+```json
+{
+    "manager": {
+        "module": "@greenlock/manager"
+    },
+    "configDir": "./greenlock.d"
+}
+```
+
+</details>
+
+```bash
+# show the global defaults with the CLI
+npx greenlock defaults
+```
+
+```js
+// show the global defaults with the API
+var defaults = await greenlock.defaults();
+```
+
+<details>
+<summary>Example Output</summary>
+
+```json
+{
+    "store": {
+        "module": "greenlock-store-fs",
+        "basePath": "./greenlock.d"
+    },
+    "challenges": {
+        "http-01": {
+            "module": "acme-http-01-standalone"
+        }
+    },
+    "renewOffset": "-45d",
+    "renewStagger": "3d",
+    "accountKeyType": "EC-P256",
+    "serverKeyType": "RSA-2048",
+    "subscriberEmail": "jon@example.com",
+    "agreeToTerms": true
+}
+```
+
+</details>
+
+```bash
+# show per-site configs with the CLI
+npx greenlock config --subject example.com
+```
+
+```js
+// show a site config with the API
+greenlock.sites.get({ subject: "example.com" });
+```
+
+<details>
+<summary>Example Output</summary>
+
+```json
+{
+    "subject": "example.com",
+    "altnames": ["example.com"],
+    "renewAt": 1576638107754,
+    "defaults": {
+        "store": {
+            "module": "greenlock-store-fs",
+            "basePath": "./greenlock.d"
+        },
+        "challenges": {
+            "http-01": {
+                "module": "acme-http-01-standalone"
+            }
+        }
+    }
+}
+```
+
+</details>
+
+Management can be done via the **CLI** or the JavaScript [**API**](https://git.rootprojects.org/root/greenlock.js).
+Since this is the QuickStart, we'll demo the **CLI**:
+
+You need to create a Let's Encrypt _subscriber account_, which can be done globally, or per-site.
+All individuals, and most businesses, should set this globally:
+
+```bash
+# Set a global subscriber account with the CLI
+npx greenlock defaults --subscriber-email 'mycompany@example.com' --agree-to-terms true
+```
+
+```js
+// set a global subscriber account with the API
+greenlock.manager.defaults({
+    subscriberEmail: "mycompany@example.com",
+    agreeToTerms: true
+});
+```
+
+<!-- todo print where the key was saved -->
+
+A Let's Encrypt SSL certificate has a "Subject" (Primary Domain) and up to 100 "Alternative Names"
+(of which the first _must_ be the subject).
+
+```bash
+# Add a certificate with specific domains with the CLI
+npx greenlock add --subject example.com --altnames example.com,www.example.com
+```
+
+```js
+// Add a certificate with specific domains with the API
+greenlock.sites.add({
+    subject: "example.com",
+    altnames: ["example.com"]
+});
+```
+
+<!-- todo print where the cert was saved -->
+
+Note: **Localhost**, **Wildcard**, and Certificates for Private Networks require
+[**DNS validation**](https://git.rootprojects.org/root/greenlock-exp).
+
+-   DNS Validation
+    -   [**Wildcards**](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/wildcards/) (coming soon)
+    -   [**Localhost**](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/localhost/) (coming soon)
+    -   [**CI/CD**](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/ci-cd/) (coming soon)
--- a/demo.js
+++ b/demo.js
@ -10,18 +10,16 @@ require("./")
 function initialize() {
    var pkg = require("./package.json");
    var config = {
-		package: pkg,
+        package: {
+            name: "Greenlock_Express_Demo",
+            version: pkg.version,
+            author: pkg.author
+        },
        staging: true,
        cluster: true,

-		challenges: {
-			"dns-01": {
-				module: "acme-dns-01-digitalocean"
-			}
-		},
-
        notify: function(ev, params) {
-			console.log(ev, params);
+            console.info(ev, params);
        }
    };
    return config;
--- a/examples/cluster/package.json
+++ b/examples/cluster/package.json
@ -0,0 +1,12 @@
+{
+  "name": "cluster-example",
+  "version": "1.0.0",
+  "description": "",
+  "main": "server.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node server.js"
+  },
+  "author": "John Doe <j.doe@example.com> (https://example.com/)",
+  "license": "ISC"
+}
--- a/examples/cluster/server.js
+++ b/examples/cluster/server.js
@ -0,0 +1,41 @@
+"use strict";
+
+//require("greenlock-express")
+require("../../")
+    .init({
+        packageRoot: __dirname,
+        configDir: "./greenlock.d",
+
+        maintainerEmail: "jon@example.com",
+
+        // When you're ready to go full cloud scale, you just change this to true:
+        // Note: in cluster you CANNOT use in-memory state (see below)
+        cluster: true,
+
+        // This will default to the number of workers being equal to
+        // n-1 cpus, with a minimum of 2
+        workers: 4
+    })
+    // ready is only executed by workers (no-op in master)
+    .ready(httpsWorker)
+    // master is only executed by master (no-op in a worker)
+    .master(function() {
+        console.info("I'm the master");
+    });
+
+function httpsWorker(glx) {
+    // WRONG
+    // This won't work like you
+    // think because EACH worker
+    // has ITS OWN `count`.
+    var count = 0;
+
+    var app = function(req, res) {
+        res.end("Hello... how many times now? Oh, " + count + " times");
+        count += 1;
+    };
+
+    // Serves on 80 and 443... for each worker
+    // Get's SSL certificates magically!
+    glx.serveApp(app);
+}
--- a/examples/demo.js
+++ b/examples/demo.js
@ -1,75 +0,0 @@
-"use strict";
-
-// npm install spdy@3.x
-
-//var Greenlock = require('greenlock-express')
-var Greenlock = require("../");
-
-var greenlock = Greenlock.create({
-	// Let's Encrypt v2 is ACME draft 11
-	version: "draft-11",
-
-	server: "https://acme-v02.api.letsencrypt.org/directory",
-	// Note: If at first you don't succeed, stop and switch to staging
-	// https://acme-staging-v02.api.letsencrypt.org/directory
-
-	// You MUST change this to a valid email address
-	email: "jon@example.com",
-
-	// You MUST NOT build clients that accept the ToS without asking the user
-	agreeTos: true,
-
-	// You MUST change these to valid domains
-	// NOTE: all domains will validated and listed on the certificate
-	approvedDomains: ["example.com", "www.example.com"],
-
-	// You MUST have access to write to directory where certs are saved
-	// ex: /home/foouser/acme/etc
-	configDir: "~/.config/acme/",
-
-	// Get notified of important updates and help me make greenlock better
-	communityMember: true
-
-	//, debug: true
-});
-
-////////////////////////
-// http-01 Challenges //
-////////////////////////
-
-// http-01 challenge happens over http/1.1, not http2
-var redirectHttps = require("redirect-https")();
-var acmeChallengeHandler = greenlock.middleware(function(req, res) {
-	res.setHeader("Content-Type", "text/html; charset=utf-8");
-	res.end(
-		"<h1>Hello, ⚠️ Insecure World!</h1><a>Visit Secure Site</a>" +
-			'<script>document.querySelector("a").href=window.location.href.replace(/^http/i, "https");</script>'
-	);
-});
-require("http")
-	.createServer(acmeChallengeHandler)
-	.listen(80, function() {
-		console.log("Listening for ACME http-01 challenges on", this.address());
-	});
-
-////////////////////////
-// http2 via SPDY h2  //
-////////////////////////
-
-// spdy is a drop-in replacement for the https API
-var spdyOptions = Object.assign({}, greenlock.tlsOptions);
-spdyOptions.spdy = { protocols: ["h2", "http/1.1"], plain: false };
-var server = require("spdy").createServer(
-	spdyOptions,
-	require("express")().use("/", function(req, res) {
-		res.setHeader("Content-Type", "text/html; charset=utf-8");
-		res.end("<h1>Hello, 🔐 Secure World!</h1>");
-	})
-);
-server.on("error", function(err) {
-	console.error(err);
-});
-server.on("listening", function() {
-	console.log("Listening for SPDY/http2/https requests on", this.address());
-});
-server.listen(443);
--- a/examples/express/my-express-app.js
+++ b/examples/express/my-express-app.js
--- a/examples/express/package.json
+++ b/examples/express/package.json
@ -0,0 +1,12 @@
+{
+  "name": "express-example",
+  "version": "1.0.0",
+  "description": "",
+  "main": "server.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node server.js"
+  },
+  "author": "John Doe <j.doe@example.com> (https://example.com/)",
+  "license": "ISC"
+}
--- a/examples/express/server.js
+++ b/examples/express/server.js
@ -0,0 +1,22 @@
+"use strict";
+
+var app = require("./my-express-app.js");
+
+app.get("/hello", function(req, res) {
+    res.end("Hello, Encrypted World!");
+});
+
+//require("greenlock-express")
+require("../../")
+    .init({
+        packageRoot: __dirname,
+        configDir: "./greenlock.d",
+
+        maintainerEmail: "jon@example.com",
+
+        cluster: false
+    })
+
+    // Serves on 80 and 443
+    // Get's SSL certificates magically!
+    .serve(app);
--- a/examples/force-renew.js
+++ b/examples/force-renew.js
@ -1,30 +0,0 @@
-"use strict";
-
-//require('greenlock-express')
-require("../")
-	.create({
-		// Let's Encrypt v2 is ACME draft 11
-		version: "draft-11",
-
-		server: "https://acme-v02.api.letsencrypt.org/directory",
-		// Note: If at first you don't succeed, stop and switch to staging
-		// https://acme-staging-v02.api.letsencrypt.org/directory
-
-		email: "john.doe@example.com",
-
-		agreeTos: true,
-
-		approvedDomains: ["example.com", "www.example.com"],
-
-		app: require("express")().use("/", function(req, res) {
-			res.end("Hello, World!");
-		}),
-
-		renewWithin: 91 * 24 * 60 * 60 * 1000,
-		renewBy: 90 * 24 * 60 * 60 * 1000,
-
-		// Get notified of important updates and help me make greenlock better
-		communityMember: true,
-		debug: true
-	})
-	.listen(80, 443);
--- a/examples/http-proxy/package.json
+++ b/examples/http-proxy/package.json
@ -0,0 +1,12 @@
+{
+  "name": "http-proxy-example",
+  "version": "1.0.0",
+  "description": "",
+  "main": "server.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node server.js"
+  },
+  "author": "John Doe <j.doe@example.com> (https://example.com/)",
+  "license": "ISC"
+}
--- a/examples/http-proxy/server.js
+++ b/examples/http-proxy/server.js
@ -0,0 +1,46 @@
+"use strict";
+
+//require("greenlock-express")
+require("../../")
+    .init(function getConfig() {
+        // Greenlock Config
+
+        return {
+            packageRoot: __dirname,
+            configDir: "./greenlock.d",
+
+            maintainerEmail: "jon@example.com",
+
+            cluster: false
+        };
+    })
+    .ready(httpsWorker);
+
+function httpsWorker(glx) {
+    // we need the raw https server
+    var server = glx.httpsServer();
+    var proxy = require("http-proxy").createProxyServer({ xfwd: true });
+
+    // catches error events during proxying
+    proxy.on("error", function(err, req, res) {
+        console.error(err);
+        res.statusCode = 500;
+        res.end();
+        return;
+    });
+
+    // We'll proxy websockets too
+    server.on("upgrade", function(req, socket, head) {
+        proxy.ws(req, socket, head, {
+            ws: true,
+            target: "ws://localhost:3000"
+        });
+    });
+
+    // servers a node app that proxies requests to a localhost
+    glx.serveApp(function(req, res) {
+        proxy.web(req, res, {
+            target: "http://localhost:3000"
+        });
+    });
+}
--- a/examples/http/package.json
+++ b/examples/http/package.json
@ -0,0 +1,12 @@
+{
+  "name": "http-example",
+  "version": "1.0.0",
+  "description": "",
+  "main": "server.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node server.js"
+  },
+  "author": "John Doe <j.doe@example.com> (https://example.com/)",
+  "license": "ISC"
+}
--- a/examples/http/server.js
+++ b/examples/http/server.js
@ -0,0 +1,38 @@
+"use strict";
+
+// The WRONG way:
+//var http = require('http');
+//var httpServer = http.createServer(redirectToHttps);
+//
+// Why is that wrong?
+// Greenlock needs to change some low-level http and https options.
+// Use glx.httpServer(redirectToHttps) instead.
+
+//require("greenlock-express")
+require("../../")
+    .init({
+        packageRoot: __dirname,
+        configDir: "./greenlock.d",
+
+        maintainerEmail: "jon@example.com",
+        cluster: false
+    })
+    .ready(httpsWorker);
+
+function httpsWorker(glx) {
+    //
+    // HTTP can only be used for ACME HTTP-01 Challenges
+    // (and it is not required for DNS-01 challenges)
+    //
+
+    // Get the raw http server:
+    var httpServer = glx.httpServer(function(req, res) {
+        res.statusCode = 301;
+        res.setHeader("Location", "https://" + req.headers.host + req.path);
+        res.end("Insecure connections are not allowed. Redirecting...");
+    });
+
+    httpServer.listen(80, "0.0.0.0", function() {
+        console.info("Listening on ", httpServer.address());
+    });
+}
--- a/examples/http2.js
+++ b/examples/http2.js
@ -1,70 +0,0 @@
-"use strict";
-
-//var Greenlock = require('greenlock-express')
-var Greenlock = require("../");
-
-var greenlock = Greenlock.create({
-	// Let's Encrypt v2 is ACME draft 11
-	version: "draft-11",
-
-	server: "https://acme-v02.api.letsencrypt.org/directory",
-	// Note: If at first you don't succeed, stop and switch to staging
-	// https://acme-staging-v02.api.letsencrypt.org/directory
-
-	// You MUST change this to a valid email address
-	email: "jon@example.com",
-
-	// You MUST NOT build clients that accept the ToS without asking the user
-	agreeTos: true,
-
-	// You MUST change these to valid domains
-	// NOTE: all domains will validated and listed on the certificate
-	approvedDomains: ["example.com", "www.example.com"],
-
-	// You MUST have access to write to directory where certs are saved
-	// ex: /home/foouser/acme/etc
-	configDir: "~/.config/acme/",
-
-	// Get notified of important updates and help me make greenlock better
-	communityMember: true
-
-	//, debug: true
-});
-
-////////////////////////
-// http-01 Challenges //
-////////////////////////
-
-// http-01 challenge happens over http/1.1, not http2
-var redirectHttps = require("redirect-https")();
-var acmeChallengeHandler = greenlock.middleware(redirectHttps);
-require("http")
-	.createServer(acmeChallengeHandler)
-	.listen(80, function() {
-		console.log("Listening for ACME http-01 challenges on", this.address());
-	});
-
-////////////////////////
-// node.js' http2 api //
-////////////////////////
-
-// http2 is a new API with which you would use hapi or koa, not express
-var server = require("http2").createSecureServer(greenlock.tlsOptions);
-server.on("error", function(err) {
-	console.error(err);
-});
-// WARNING: Because the middleware don't handle this API style,
-// the Host headers are unmodified and potentially dangerous
-// (ex: Host: Robert'); DROP TABLE Students;)
-server.on("stream", function(stream, headers) {
-	console.log(headers);
-	stream.respond({
-		"content-type": "text/html",
-		":status": 200
-	});
-	stream.end("Hello, HTTP2 World!");
-});
-server.on("listening", function() {
-	console.log("Listening for http2 requests on", this.address());
-});
-server.listen(443);
--- a/examples/http2/package.json
+++ b/examples/http2/package.json
@ -0,0 +1,12 @@
+{
+  "name": "http2-example",
+  "version": "1.0.0",
+  "description": "",
+  "main": "server.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node server.js"
+  },
+  "author": "John Doe <j.doe@example.com> (https://example.com/)",
+  "license": "ISC"
+}
--- a/examples/http2/server.js
+++ b/examples/http2/server.js
@ -0,0 +1,46 @@
+"use strict";
+
+// The WRONG way:
+//var http2 = require('http2');
+//var http2Server = https.createSecureServer(tlsOptions, app);
+//
+// Why is that wrong?
+// Greenlock needs to change some low-level http and https options.
+// Use glx.httpsServer(tlsOptions, app) instead.
+
+//require("greenlock-express")
+require("../../")
+    .init({
+        packageRoot: __dirname,
+        configDir: "./greenlock.d",
+
+        maintainerEmail: "jon@example.com",
+        cluster: false
+    })
+    .ready(httpsWorker);
+
+function httpsWorker(glx) {
+    //
+    // HTTP2 would have been the default httpsServer for node v12+
+    // However... https://github.com/expressjs/express/issues/3388
+    //
+
+    // Get the raw http2 server:
+    var tlsOptions = null;
+    var http2Server = glx.http2Server(tlsOptions, function(req, res) {
+        res.end("Hello, Encrypted World!");
+    });
+
+    http2Server.listen(443, "0.0.0.0", function() {
+        console.info("Listening on ", http2Server.address());
+    });
+
+    // Note:
+    // You must ALSO listen on port 80 for ACME HTTP-01 Challenges
+    // (the ACME and http->https middleware are loaded by glx.httpServer)
+    var httpServer = glx.httpServer();
+
+    httpServer.listen(80, "0.0.0.0", function() {
+        console.info("Listening on ", httpServer.address());
+    });
+}
--- a/examples/https/package.json
+++ b/examples/https/package.json
@ -0,0 +1,12 @@
+{
+  "name": "https1-example",
+  "version": "1.0.0",
+  "description": "",
+  "main": "server.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node server.js"
+  },
+  "author": "John Doe <j.doe@example.com> (https://example.com/)",
+  "license": "ISC"
+}
--- a/examples/https/server.js
+++ b/examples/https/server.js
@ -0,0 +1,45 @@
+"use strict";
+
+// The WRONG way:
+//var https = require('https');
+//var httpsServer = https.createServer(tlsOptions, app);
+//
+// Why is that wrong?
+// Greenlock needs to change some low-level http and https options.
+// Use glx.httpsServer(tlsOptions, app) instead.
+
+//require("greenlock-express")
+require("../../")
+    .init({
+        packageRoot: __dirname,
+        configDir: "./greenlock.d",
+
+        maintainerEmail: "jon@example.com",
+        cluster: false
+    })
+    .ready(httpsWorker);
+
+function httpsWorker(glx) {
+    //
+    // HTTPS 1.1 is the default
+    // (HTTP2 would be the default but... https://github.com/expressjs/express/issues/3388)
+    //
+
+    // Get the raw https server:
+    var httpsServer = glx.httpsServer(null, function(req, res) {
+        res.end("Hello, Encrypted World!");
+    });
+
+    httpsServer.listen(443, "0.0.0.0", function() {
+        console.info("Listening on ", httpsServer.address());
+    });
+
+    // Note:
+    // You must ALSO listen on port 80 for ACME HTTP-01 Challenges
+    // (the ACME and http->https middleware are loaded by glx.httpServer)
+    var httpServer = glx.httpServer();
+
+    httpServer.listen(80, "0.0.0.0", function() {
+        console.info("Listening on ", httpServer.address());
+    });
+}
--- a/examples/production.js
+++ b/examples/production.js
@ -1,88 +0,0 @@
-"use strict";
-
-//
-// My Secure Server
-//
-//var greenlock = require('greenlock-express')
-var greenlock = require("../").create({
-	// Let's Encrypt v2 is ACME draft 11
-	// Note: If at first you don't succeed, stop and switch to staging
-	// https://acme-staging-v02.api.letsencrypt.org/directory
-	server: "https://acme-v02.api.letsencrypt.org/directory",
-	version: "draft-11",
-	// You MUST have write access to save certs
-	configDir: "~/.config/acme/",
-
-	// The previous 'simple' example set these values statically,
-	// but this example uses approveDomains() to set them dynamically
-	//, email: 'none@see.note.above'
-	//, agreeTos: false
-
-	// approveDomains is the right place to check a database for
-	// email addresses with domains and agreements and such
-	approveDomains: approveDomains,
-
-	app: require("./my-express-app.js"),
-
-	// Get notified of important updates and help me make greenlock better
-	communityMember: true
-
-	//, debug: true
-});
-
-var server = greenlock.listen(80, 443);
-
-//
-// My Secure Database Check
-//
-function approveDomains(opts, certs, cb) {
-	// Only one domain is listed with *automatic* registration via SNI
-	// (it's an array because managed registration allows for multiple domains,
-	//                                which was the case in the simple example)
-	console.log(opts.domains);
-
-	// The domains being approved for the first time are listed in opts.domains
-	// Certs being renewed are listed in certs.altnames
-	if (certs) {
-		opts.domains = [certs.subject].concat(certs.altnames);
-	}
-
-	fooCheckDb(opts.domains, function(err, agree, email) {
-		if (err) {
-			cb(err);
-			return;
-		}
-
-		// Services SHOULD automatically accept the ToS and use YOUR email
-		// Clients MUST NOT accept the ToS without asking the user
-		opts.agreeTos = agree;
-		opts.email = email;
-
-		// NOTE: you can also change other options such as `challengeType` and `challenge`
-		// (this would be helpful if you decided you wanted wildcard support as a domain altname)
-		// opts.challengeType = 'http-01';
-		// opts.challenge = require('le-challenge-fs').create({});
-
-		cb(null, { options: opts, certs: certs });
-	});
-}
-
-//
-// My User / Domain Database
-//
-function fooCheckDb(domains, cb) {
-	// This is an oversimplified example of how we might implement a check in
-	// our database if we have different rules for different users and domains
-	var domains = ["example.com", "www.example.com"];
-	var userEmail = "john.doe@example.com";
-	var userAgrees = true;
-	var passCheck = opts.domains.every(function(domain) {
-		return -1 !== domains.indexOf(domain);
-	});
-
-	if (!passCheck) {
-		cb(new Error("domain not allowed"));
-	} else {
-		cb(null, userAgrees, userEmail);
-	}
-}
--- a/examples/quickstart.js
+++ b/examples/quickstart.js
@ -1,38 +0,0 @@
-"use strict";
-
-//require('greenlock-express')
-require("../")
-	.create({
-		// Let's Encrypt v2 is ACME draft 11
-		version: "draft-11",
-
-		server: "https://acme-v02.api.letsencrypt.org/directory",
-		// Note: If at first you don't succeed, stop and switch to staging
-		// https://acme-staging-v02.api.letsencrypt.org/directory
-
-		// You MUST change this to a valid email address
-		email: "john.doe@example.com",
-
-		// You MUST NOT build clients that accept the ToS without asking the user
-		agreeTos: true,
-
-		// You MUST change these to valid domains
-		// NOTE: all domains will validated and listed on the certificate
-		approvedDomains: ["example.com", "www.example.com"],
-
-		// You MUST have access to write to directory where certs are saved
-		// ex: /home/foouser/acme/etc
-		configDir: "~/.config/acme/",
-		store: require("greenlock-store-fs"),
-
-		app: require("express")().use("/", function(req, res) {
-			res.setHeader("Content-Type", "text/html; charset=utf-8");
-			res.end("Hello, World!\n\n💚 🔒.js");
-		}),
-
-		// Get notified of important updates and help me make greenlock better
-		communityMember: true
-
-		//, debug: true
-	})
-	.listen(80, 443);
--- a/examples/quickstart/README.md
+++ b/examples/quickstart/README.md
@ -0,0 +1,22 @@
+# Quick Start for Let's Encrypt with Node.js
+
+```js
+npm install --save greenlock-express
+```
+
+Manage via API or the config file:
+
+`~/.config/greenlock/manage.json`: (default filesystem config)
+
+```json
+{
+    "subscriberEmail": "letsencrypt-test@therootcompany.com",
+    "agreeToTerms": true,
+    "sites": {
+        "example.com": {
+            "subject": "example.com",
+            "altnames": ["example.com", "www.example.com"]
+        }
+    }
+}
+```
--- a/examples/quickstart/package.json
+++ b/examples/quickstart/package.json
@ -0,0 +1,12 @@
+{
+  "name": "quickstart-example",
+  "version": "1.0.0",
+  "description": "",
+  "main": "server.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node server.js"
+  },
+  "author": "John Doe <j.doe@example.com> (https://example.com/)",
+  "license": "ISC"
+}
--- a/examples/quickstart/server.js
+++ b/examples/quickstart/server.js
@ -0,0 +1,27 @@
+"use strict";
+
+// This can be a node http app (shown),
+// an Express app, or Hapi, Koa, Rill, etc
+var app = function(req, res) {
+    res.end("Hello, Encrypted World!");
+};
+
+//require("greenlock-express")
+require("../../")
+    .init({
+        // Package name+version are taken from <packageRoot>/package.json and used for ACME client user agent
+        packageRoot: __dirname,
+        // configDir is relative to packageRoot, not _this_ file
+        configDir: "./greenlock.d",
+
+        // Maintainer email is the contact for critical bug and security notices
+        // by default package.json.author.email will be used
+        //maintainerEmail: "jon@example.com",
+
+        // Change to true when you're ready to make your app cloud-scale
+        cluster: false
+    })
+
+    // Serves on 80 and 443
+    // Get's SSL certificates magically!
+    .serve(app);
--- a/examples/remote-access.js
+++ b/examples/remote-access.js
@ -1,104 +0,0 @@
-"use strict";
-
-//
-// WARNING: Not for noobs
-// Try the simple example first
-//
-
-//
-// This demo is used with tunnel-server.js and tunnel-client.js
-//
-
-var email = "john.doe@gmail.com";
-var domains = ["example.com"];
-var agreeLeTos = true;
-//var secret = "My Little Brony";
-var secret = require("crypto")
-	.randomBytes(16)
-	.toString("hex");
-
-require("../")
-	.create({
-		version: "draft-11",
-
-		server: "https://acme-v02.api.letsencrypt.org/directory",
-		// Note: If at first you don't succeed, stop and switch to staging
-		// https://acme-staging-v02.api.letsencrypt.org/directory
-
-		email: email,
-		agreeTos: agreeLeTos,
-		approveDomains: domains,
-		configDir: "~/.config/acme/",
-		app: remoteAccess(secret),
-		// Get notified of important updates and help me make greenlock better
-		communityMember: true
-		//, debug: true
-	})
-	.listen(3000, 8443);
-
-function remoteAccess(secret) {
-	var express = require("express");
-	var basicAuth = require("express-basic-auth");
-	var serveIndex = require("serve-index");
-
-	var rootIndex = serveIndex("/", { hidden: true, icons: true, view: "details" });
-	var rootFs = express.static("/", { dotfiles: "allow", redirect: true, index: false });
-
-	var userIndex = serveIndex(require("os").homedir(), { hidden: true, icons: true, view: "details" });
-	var userFs = express.static(require("os").homedir(), { dotfiles: "allow", redirect: true, index: false });
-
-	var app = express();
-	var realm = "Login Required";
-
-	var myAuth = basicAuth({
-		users: { root: secret, user: secret },
-		challenge: true,
-		realm: realm,
-		unauthorizedResponse: function(/*req*/) {
-			return 'Unauthorized <a href="/">Home</a>';
-		}
-	});
-
-	app.get("/", function(req, res) {
-		res.setHeader("Content-Type", "text/html; charset=utf-8");
-		res.end('<a href="/browse/">View Files</a>' + "&nbsp; | &nbsp;" + '<a href="/logout/">Logout</a>');
-	});
-	app.use("/logout", function(req, res) {
-		res.setHeader("Content-Type", "text/html; charset=utf-8");
-		res.setHeader("WWW-Authenticate", 'Basic realm="' + realm + '"');
-		res.statusCode = 401;
-		//res.setHeader('Location', '/');
-		res.end('Logged out &nbsp; | &nbsp; <a href="/">Home</a>');
-	});
-	app.use("/browse", myAuth);
-	app.use("/browse", function(req, res, next) {
-		if ("root" === req.auth.user) {
-			rootFs(req, res, function() {
-				rootIndex(req, res, next);
-			});
-			return;
-		}
-		if ("user" === req.auth.user) {
-			userFs(req, res, function() {
-				userIndex(req, res, next);
-			});
-			return;
-		}
-		res.end("Sad Panda");
-	});
-
-	console.log("");
-	console.log("");
-	console.log("Usernames are\n");
-	console.log("\troot");
-	console.log("\tuser");
-	console.log("");
-	console.log("Password (for both) is\n");
-	console.log("\t" + secret);
-	console.log("");
-	console.log("Shhhh... It's a secret to everybody!");
-	console.log("");
-	console.log("");
-
-	return app;
-}
--- a/examples/socket.io.js
+++ b/examples/socket.io.js
@ -1,32 +0,0 @@
-// First and foremost:
-// I'm not a fan of `socket.io` because it's huge and complex.
-// I much prefer `ws` because it's very simple and easy.
-// That said, it's popular.......
-"use strict";
-
-//var greenlock = require('greenlock-express');
-var greenlock = require("../");
-var options = require("./greenlock-options.js");
-var socketio = require("socket.io");
-var server;
-var io;
-
-// Any node http app will do - whether express, raw http or whatever
-options.app = require("express")().use("/", function(req, res) {
-	res.setHeader("Content-Type", "text/html; charset=utf-8");
-	res.end("Hello, World!\n\n💚 🔒.js");
-});
-
-// The server that's handed back from `listen` is a raw https server
-server = greenlock.create(options).listen(80, 443);
-io = socketio(server);
-
-// Then you do your socket.io stuff
-io.on("connection", function(socket) {
-	console.log("a user connected");
-	socket.emit("Welcome");
-
-	socket.on("chat message", function(msg) {
-		socket.broadcast.emit("chat message", msg);
-	});
-});
--- a/examples/socket.io/package.json
+++ b/examples/socket.io/package.json
@ -0,0 +1,12 @@
+{
+  "name": "socket-io-example",
+  "version": "1.0.0",
+  "description": "",
+  "main": "server.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node server.js"
+  },
+  "author": "John Doe <j.doe@example.com> (https://example.com/)",
+  "license": "ISC"
+}
--- a/examples/socket.io/server.js
+++ b/examples/socket.io/server.js
@ -0,0 +1,46 @@
+// First and foremost:
+// I'm not a fan of `socket.io` because it's huge and complex.
+// I much prefer `ws` because it's very simple and easy.
+// That said, it's popular.......
+"use strict";
+
+// Note: You DO NOT NEED socket.io
+//       You can just use WebSockets
+//       (see the websocket example)
+
+//require("greenlock-express")
+require("../../")
+    .init({
+        packageRoot: __dirname,
+        configDir: "./greenlock.d",
+
+        maintainerEmail: "jon@example.com",
+        cluster: false
+    })
+    .ready(httpsWorker);
+
+function httpsWorker(glx) {
+    var socketio = require("socket.io");
+    var io;
+
+    // we need the raw https server
+    var server = glx.httpsServer();
+
+    io = socketio(server);
+
+    // Then you do your socket.io stuff
+    io.on("connection", function(socket) {
+        console.log("a user connected");
+        socket.emit("Welcome");
+
+        socket.on("chat message", function(msg) {
+            socket.broadcast.emit("chat message", msg);
+        });
+    });
+
+    // servers a node app that proxies requests to a localhost
+    glx.serveApp(function(req, res) {
+        res.setHeader("Content-Type", "text/html; charset=utf-8");
+        res.end("Hello, World!\n\n💚 🔒.js");
+    });
+}
--- a/examples/spdy.js
+++ b/examples/spdy.js
@ -1,64 +0,0 @@
-"use strict";
-
-// npm install spdy@3.x
-
-//var Greenlock = require('greenlock-express')
-var Greenlock = require("../");
-
-var greenlock = Greenlock.create({
-	// Let's Encrypt v2 is ACME draft 11
-	version: "draft-11",
-
-	server: "https://acme-v02.api.letsencrypt.org/directory",
-	// Note: If at first you don't succeed, stop and switch to staging
-	// https://acme-staging-v02.api.letsencrypt.org/directory
-
-	// You MUST change this to a valid email address
-	email: "jon@example.com",
-
-	// You MUST NOT build clients that accept the ToS without asking the user
-	agreeTos: true,
-
-	// You MUST change these to valid domains
-	// NOTE: all domains will validated and listed on the certificate
-	approvedDomains: ["example.com", "www.example.com"],
-
-	// You MUST have access to write to directory where certs are saved
-	// ex: /home/foouser/acme/etc
-	configDir: "~/.config/acme/", // MUST have write access
-
-	// Get notified of important updates and help me make greenlock better
-	communityMember: true
-
-	//, debug: true
-});
-
-////////////////////////
-// http-01 Challenges //
-////////////////////////
-
-// http-01 challenge happens over http/1.1, not http2
-var redirectHttps = require("redirect-https")();
-var acmeChallengeHandler = greenlock.middleware(redirectHttps);
-require("http")
-	.createServer(acmeChallengeHandler)
-	.listen(80, function() {
-		console.log("Listening for ACME http-01 challenges on", this.address());
-	});
-
-////////////////////////
-// http2 via SPDY h2  //
-////////////////////////
-
-// spdy is a drop-in replacement for the https API
-var spdyOptions = Object.assign({}, greenlock.tlsOptions);
-spdyOptions.spdy = { protocols: ["h2", "http/1.1"], plain: false };
-var myApp = require("./my-express-app.js");
-var server = require("spdy").createServer(spdyOptions, myApp);
-server.on("error", function(err) {
-	console.error(err);
-});
-server.on("listening", function() {
-	console.log("Listening for SPDY/http2/https requests on", this.address());
-});
-server.listen(443);
--- a/examples/spdy/server.js
+++ b/examples/spdy/server.js
@ -0,0 +1,3 @@
+// SPDY is dead. It was replaced by HTTP2, which is a native node module
+//
+// Check out the http2 example just up one folder
--- a/examples/vhost.js
+++ b/examples/vhost.js
@ -1,134 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-
-///////////////////
-// vhost example //
-///////////////////
-
-//
-// virtual hosting example
-//
-
-// The prefix where sites go by name.
-// For example: whatever.com may live in /srv/www/whatever.com, thus /srv/www is our path
-var srv = process.argv[3] || "/srv/www/";
-
-var path = require("path");
-var fs = require("fs").promises;
-var finalhandler = require("finalhandler");
-var serveStatic = require("serve-static");
-
-//var glx = require('greenlock-express')
-var glx = require("./").create({
-	version: "draft-11", // Let's Encrypt v2 is ACME draft 11
-
-	server: "https://acme-v02.api.letsencrypt.org/directory", // If at first you don't succeed, stop and switch to staging
-	// https://acme-staging-v02.api.letsencrypt.org/directory
-
-	configDir: process.argv[4] || "~/.config/acme/", // You MUST have access to write to directory where certs
-	// are saved. ex: /home/foouser/.config/acme
-
-	approveDomains: myApproveDomains, // Greenlock's wraps around tls.SNICallback. Check the
-	// domain name here and reject invalid ones
-
-	app: myVhostApp, // Any node-style http app (i.e. express, koa, hapi, rill)
-
-	/* CHANGE TO A VALID EMAIL */
-	email: process.argv[2] || "jon.doe@example.com", // Email for Let's Encrypt account and Greenlock Security
-	agreeTos: true // Accept Let's Encrypt ToS
-	//, communityMember: true                                   // Join Greenlock to get important updates, no spam
-
-	//, debug: true
-});
-
-var server = glx.listen(80, 443);
-server.on("listening", function() {
-	console.info(server.type + " listening on", server.address());
-});
-
-function myApproveDomains(opts, certs, cb) {
-	console.log("sni:", opts.domain);
-	// In this example the filesystem is our "database".
-	// We check in /srv/www for whatever.com and if it exists, it's allowed
-
-	// SECURITY Greenlock validates opts.domains ahead-of-time so you don't have to
-	return checkWwws(opts.domains[0])
-		.then(function() {
-			//opts.email = email;
-			opts.agreeTos = true;
-			cb(null, { options: opts, certs: certs });
-		})
-		.catch(cb);
-}
-
-function checkWwws(_hostname) {
-	if (!_hostname) {
-		// SECURITY, don't allow access to the 'srv' root
-		// (greenlock-express uses middleware to check '..', etc)
-		return "";
-	}
-	var hostname = _hostname;
-	var _hostdir = path.join(srv, hostname);
-	var hostdir = _hostdir;
-	// TODO could test for www/no-www both in directory
-	return fs
-		.readdir(hostdir)
-		.then(function() {
-			// TODO check for some sort of htaccess.json and use email in that
-			// NOTE: you can also change other options such as `challengeType` and `challenge`
-			// opts.challengeType = 'http-01';
-			// opts.challenge = require('le-challenge-fs').create({});
-			return hostname;
-		})
-		.catch(function() {
-			if ("www." === hostname.slice(0, 4)) {
-				// Assume we'll redirect to non-www if it's available.
-				hostname = hostname.slice(4);
-				hostdir = path.join(srv, hostname);
-				return fs.readdir(hostdir).then(function() {
-					// TODO list both domains?
-					return hostname;
-				});
-			} else {
-				// Or check and see if perhaps we should redirect non-www to www
-				hostname = "www." + hostname;
-				hostdir = path.join(srv, hostname);
-				return fs.readdir(hostdir).then(function() {
-					// TODO list both domains?
-					return hostname;
-				});
-			}
-		})
-		.catch(function() {
-			throw new Error("rejecting '" + _hostname + "' because '" + _hostdir + "' could not be read");
-		});
-}
-
-function myVhostApp(req, res) {
-	// SECURITY greenlock pre-sanitizes hostnames to prevent unauthorized fs access so you don't have to
-	// (also: only domains approved above will get here)
-	console.log("vhost:", req.headers.host);
-	if (!req.headers.host) {
-		// SECURITY, don't allow access to the 'srv' root
-		// (greenlock-express uses middleware to check '..', etc)
-		return res.end();
-	}
-
-	// We could cache wether or not a host exists for some amount of time
-	var fin = finalhandler(req, res);
-	return checkWwws(req.headers.host)
-		.then(function(hostname) {
-			if (hostname !== req.headers.host) {
-				res.statusCode = 302;
-				res.setHeader("Location", "https://" + hostname);
-				// SECURITY this is safe only because greenlock disallows invalid hostnames
-				res.end("<!-- redirecting to https://" + hostname + "-->");
-				return;
-			}
-			var serve = serveStatic(path.join(srv, hostname), { redirect: true });
-			serve(req, res, fin);
-		})
-		.catch(function() {
-			fin();
-		});
-}
--- a/examples/websockets.js
+++ b/examples/websockets.js
@ -1,46 +0,0 @@
-"use strict";
-
-////////////////////////
-// Greenlock Setup    //
-////////////////////////
-
-//var Greenlock = require('greenlock-express');
-var Greenlock = require("../");
-var greenlock = Greenlock.create({
-	// Let's Encrypt v2 is ACME draft 11
-	// Note: If at first you don't succeed, stop and switch to staging
-	// https://acme-staging-v02.api.letsencrypt.org/directory
-	server: "https://acme-v02.api.letsencrypt.org/directory",
-	version: "draft-11",
-	configDir: "~/.config/acme/",
-	app: require("./my-express-app.js"),
-
-	// You MUST change these to a valid email and domains
-	email: "john.doe@example.com",
-	approvedDomains: ["example.com", "www.example.com"],
-	agreeTos: true,
-
-	// Get notified of important updates and help me make greenlock better
-	communityMember: true,
-	telemetry: true
-	//, debug: true
-});
-
-var server = greenlock.listen(80, 443);
-
-var WebSocket = require("ws");
-var ws = new WebSocket.Server({ server: server });
-ws.on("connection", function(ws, req) {
-	// inspect req.headers.authorization (or cookies) for session info
-	ws.send(
-		"[Secure Echo Server] Hello!\nAuth: '" +
-			(req.headers.authorization || "none") +
-			"'\n" +
-			"Cookie: '" +
-			(req.headers.cookie || "none") +
-			"'\n"
-	);
-	ws.on("message", function(data) {
-		ws.send(data);
-	});
-});
--- a/examples/websockets/package.json
+++ b/examples/websockets/package.json
@ -0,0 +1,12 @@
+{
+  "name": "websockets-example",
+  "version": "1.0.0",
+  "description": "",
+  "main": "server.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node server.js"
+  },
+  "author": "John Doe <j.doe@example.com> (https://example.com/)",
+  "license": "ISC"
+}
--- a/examples/websockets/server.js
+++ b/examples/websockets/server.js
@ -0,0 +1,39 @@
+"use strict";
+
+//require("greenlock-express")
+require("../../")
+    .init({
+        packageRoot: __dirname,
+        configDir: "./greenlock.d",
+
+        maintainerEmail: "jon@example.com",
+        cluster: false
+    })
+    .ready(httpsWorker);
+
+function httpsWorker(glx) {
+    // we need the raw https server
+    var server = glx.httpsServer();
+    var WebSocket = require("ws");
+    var ws = new WebSocket.Server({ server: server });
+    ws.on("connection", function(ws, req) {
+        // inspect req.headers.authorization (or cookies) for session info
+        ws.send(
+            "[Secure Echo Server] Hello!\nAuth: '" +
+                (req.headers.authorization || "none") +
+                "'\n" +
+                "Cookie: '" +
+                (req.headers.cookie || "none") +
+                "'\n"
+        );
+        ws.on("message", function(data) {
+            ws.send(data);
+        });
+    });
+
+    // servers a node app that proxies requests to a localhost
+    glx.serveApp(function(req, res) {
+        res.setHeader("Content-Type", "text/html; charset=utf-8");
+        res.end("Hello, World!\n\n💚 🔒.js");
+    });
+}
--- a/examples/wildcard.js
+++ b/examples/wildcard.js
@ -1,77 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-/*global Promise*/
-
-///////////////////////
-// wildcard example //
-//////////////////////
-
-//
-// wildcard example
-//
-
-//var glx = require('greenlock-express')
-var glx = require("../").create({
-	version: "draft-11", // Let's Encrypt v2 is ACME draft 11
-
-	server: "https://acme-staging-v02.api.letsencrypt.org/directory",
-	//, server: 'https://acme-v02.api.letsencrypt.org/directory'  // If at first you don't succeed, stop and switch to staging
-	// https://acme-staging-v02.api.letsencrypt.org/directory
-
-	configDir: "~/acme/", // You MUST have access to write to directory where certs
-	// are saved. ex: /home/foouser/.config/acme
-
-	approveDomains: myApproveDomains, // Greenlock's wraps around tls.SNICallback. Check the
-	// domain name here and reject invalid ones
-
-	app: require("./my-express-app.js"), // Any node-style http app (i.e. express, koa, hapi, rill)
-
-	/* CHANGE TO A VALID EMAIL */
-	email: "jon.doe@example.com", // Email for Let's Encrypt account and Greenlock Security
-	agreeTos: true, // Accept Let's Encrypt ToS
-	communityMember: true, // Join Greenlock to (very rarely) get important updates
-
-	//, debug: true
-	store: require("le-store-fs")
-});
-
-var server = glx.listen(80, 443);
-server.on("listening", function() {
-	console.info(server.type + " listening on", server.address());
-});
-
-function myApproveDomains(opts) {
-	console.log("sni:", opts.domain);
-
-	// must be 'example.com' or start with 'example.com'
-	if (
-		"example.com" !== opts.domain &&
-		"example.com" !==
-			opts.domain
-				.split(".")
-				.slice(1)
-				.join(".")
-	) {
-		return Promise.reject(new Error("we don't serve your kind here: " + opts.domain));
-	}
-
-	// the primary domain for the cert
-	opts.subject = "example.com";
-	// the altnames (including the primary)
-	opts.domains = [opts.subject, "*.example.com"];
-
-	if (!opts.challenges) {
-		opts.challenges = {};
-	}
-	opts.challenges["http-01"] = require("le-challenge-fs").create({});
-	// Note: When implementing a dns-01 plugin you should make it check in a loop
-	// until it can positively confirm that the DNS changes have propagated.
-	// That could take several seconds to a few minutes.
-	opts.challenges["dns-01"] = require("le-challenge-dns").create({});
-
-	// explicitly set account id and certificate.id
-	opts.account = { id: opts.email };
-	opts.certificate = { id: opts.subject };
-
-	return Promise.resolve(opts);
-}
--- a/greenlock-express.js
+++ b/greenlock-express.js
@ -17,16 +17,20 @@ var GLE = module.exports;
 // under the hood. That's the hope, anyway.

 GLE.init = function(fn) {
-	if (cluster.isWorker) {
+    // See https://git.coolaj86.com/coolaj86/greenlock-express.js/issues/80
+    if (fn && false !== fn.cluster && cluster.isWorker) {
        // ignore the init function and launch the worker
        return require("./worker.js").create();
    }

-	var opts = fn();
+    var opts;
+    if ("function" === typeof fn) {
+        opts = fn();
+    } else if ("object" === typeof fn) {
+        opts = fn;
+    }
    if (!opts || "object" !== typeof opts) {
-		throw new Error(
-			"the `Greenlock.init(fn)` function should return an object `{ maintainerEmail, packageAgent, notify }`"
-		);
+        throw new Error("the `Greenlock.init(fn)` function should return an object `{ packageRoot, cluster }`");
    }

    // just for ironic humor
--- a/greenlock-shim.js
+++ b/greenlock-shim.js
@ -0,0 +1,72 @@
+"use strict";
+
+module.exports.create = function(opts) {
+    var Greenlock = require("@root/greenlock");
+    //var Init = require("@root/greenlock/lib/init.js");
+    var greenlock = opts.greenlock;
+
+    /*
+    if (!greenlock && opts.packageRoot) {
+        try {
+            greenlock = require(path.resolve(opts.packageRoot, "greenlock.js"));
+        } catch (e) {
+            if ("MODULE_NOT_FOUND" !== e.code) {
+                throw e;
+            }
+        }
+    }
+    */
+
+    if (!greenlock) {
+        //opts = Init._init(opts);
+        greenlock = Greenlock.create(opts);
+    }
+    opts.packageAgent = addGreenlockAgent(opts);
+
+    try {
+        if (opts.notify) {
+            greenlock._defaults.notify = opts.notify;
+        }
+    } catch (e) {
+        console.error("Developer Error: notify not attached correctly");
+    }
+
+    // re-export as top-level function to simplify rpc with workers
+    greenlock.getAcmeHttp01ChallengeResponse = function(opts) {
+        return greenlock.challenges.get(opts);
+    };
+
+    greenlock._find({}).then(function(sites) {
+        if (sites.length <= 0) {
+            console.warn("Warning: `find({})` returned 0 sites.");
+            console.warn("         Does `" + greenlock.manager._modulename + "` implement `find({})`?");
+            console.warn("         Did you add sites?");
+            console.warn("         npx greenlock add --subject example.com --altnames example.com");
+            return;
+        }
+        console.info("Ready to Serve:");
+
+        var max = 3;
+        if (sites.length >= 1) {
+            sites.slice(0, max).forEach(function(site) {
+                console.info("\t", site.altnames.join(" "));
+            });
+        }
+        if (sites.length > max) {
+            console.info("and %d others", sites.length - max);
+        }
+    });
+
+    return greenlock;
+};
+
+function addGreenlockAgent(opts) {
+    // Add greenlock as part of Agent, unless this is greenlock
+    var packageAgent = opts.packageAgent || "";
+    if (!/greenlock(-express|-pro)?/i.test(packageAgent)) {
+        var pkg = require("./package.json");
+        packageAgent += " Greenlock_Express/" + pkg.version;
+    }
+
+    return packageAgent.trim();
+}
--- a/greenlock.js
+++ b/greenlock.js
@ -1,86 +0,0 @@
-"use strict";
-
-module.exports.create = function(opts) {
-	opts = parsePackage(opts);
-	opts.packageAgent = addGreenlockAgent(opts);
-
-	var Greenlock = require("@root/greenlock");
-	var greenlock = Greenlock.create(opts);
-
-	// TODO move to greenlock proper
-	greenlock.getAcmeHttp01ChallengeResponse = function(opts) {
-		return greenlock.find({ servername: opts.servername }).then(function(sites) {
-			if (!sites.length) {
-				return null;
-			}
-			var site = sites[0];
-			if (!site.challenges || !site.challenges["http-01"]) {
-				return null;
-			}
-
-			var plugin;
-			try {
-				plugin = require(site.challenges["http-01"].module);
-				plugin = plugin.create(site.challenges["http-01"]);
-			} catch (e) {
-				console.error("error getting acme http-01 plugin");
-				console.error(e);
-				return null;
-			}
-
-			return plugin.get(opts).then(function(result) {
-				// TODO is this the right way?
-				var ch = (result && result.challenge) || result || {};
-				return {
-					keyAuthorization: ch.keyAuthorization
-				};
-			});
-		});
-	};
-
-	return greenlock;
-};
-
-function addGreenlockAgent(opts) {
-	// Add greenlock as part of Agent, unless this is greenlock
-	if (!/^greenlock(-express|-pro)?/.test(opts.packageAgent)) {
-		var pkg = require("./package.json");
-		var packageAgent = pkg.name + "/" + pkg.version;
-		opts.packageAgent += " " + packageAgent;
-	}
-
-	return opts.packageAgent;
-}
-
-// ex: John Doe <john@example.com> (https://john.doe)
-var looseEmailRe = /.* <([^'" <>:;`]+@[^'" <>:;`]+\.[^'" <>:;`]+)> .*/;
-function parsePackage(opts) {
-	// 'package' is sometimes a reserved word
-	var pkg = opts.package || opts.pkg;
-	if (!pkg) {
-		return opts;
-	}
-
-	if (!opts.packageAgent) {
-		var err = "missing `package.THING`, which is used for the ACME client user agent string";
-		if (!pkg.name) {
-			throw new Error(err.replace("THING", "name"));
-		}
-		if (!pkg.version) {
-			throw new Error(err.replace("THING", "version"));
-		}
-		opts.packageAgent = pkg.name + "/" + pkg.version;
-	}
-
-	if (!opts.maintainerEmail) {
-		try {
-			opts.maintainerEmail = pkg.author.email || pkg.author.match(looseEmailRe)[1];
-		} catch (e) {}
-	}
-	if (!opts.maintainerEmail) {
-		throw new Error("missing or malformed `package.author`, which is used as the contact for support notices");
-	}
-	opts.package = undefined;
-
-	return opts;
-}
--- a/http-middleware.js
+++ b/http-middleware.js
@ -16,24 +16,70 @@ HttpMiddleware.create = function(gl, defaultApp) {
            explainError(gl, err, "http_01_middleware_socket", hostname);
        });

-		if (skipIfNeedBe(req, res, next, defaultApp, hostname)) {
+        // Skip unless the path begins with /.well-known/acme-challenge/
+        if (!hostname || 0 !== req.url.indexOf(challengePrefix)) {
+            skipChallenge(req, res, next, defaultApp);
            return;
        }

+        // HEADERS SENT DEBUG NOTE #2
+        // at this point, it's most likely Let's Encrypt server
+        // (or greenlock itself) performing the verification process
+        // Hmmm... perhaps we should change the greenlock prefix to test
+        // Anyway, we just got fast the first place where we could
+        // be sending headers.
+
        var token = req.url.slice(challengePrefix.length);

+        var done = false;
+        var countA = 0;
+        var countB = 0;
        gl.getAcmeHttp01ChallengeResponse({ type: "http-01", servername: hostname, token: token })
+            .catch(function(err) {
+                countA += 1;
+                // HEADERS SENT DEBUG NOTE #3
+                // This is the second possible time we could be sending headers
+                respondToError(gl, res, err, "http_01_middleware_challenge_response", hostname);
+                done = true;
+                return { __done: true };
+            })
            .then(function(result) {
-				respondWithGrace(res, result, hostname, token);
+                countB += 1;
+                if (result && result.__done) {
+                    return;
+                }
+                if (done) {
+                    console.error("Sanity check fail: `done` is in a quantum state of both true and false... huh?");
+                    return;
+                }
+                // HEADERS SENT DEBUG NOTE #4b
+                // This is the third/fourth possible time send headers
+                return respondWithGrace(res, result, hostname, token);
            })
            .catch(function(err) {
-				respondToError(gl, res, err, "http_01_middleware_challenge_response", hostname);
+                // HEADERS SENT DEBUG NOTE #5
+                // I really don't see how this can be possible.
+                // Every case appears to be accounted for
+                console.error();
+                console.error("[warning] Developer Error:" + (err.code || err.context || ""), countA, countB);
+                console.error(err.stack);
+                console.error();
+                console.error(
+                    "This is probably the error that happens routinely on http2 connections, but we're not sure why."
+                );
+                console.error("To track the status or help contribute,");
+                console.error("visit: https://git.rootprojects.org/root/greenlock-express.js/issues/9");
+                console.error();
+                try {
+                    res.end("Internal Server Error [1003]: See logs for details.");
+                } catch (e) {
+                    // ignore
+                }
            });
    };
 };

-function skipIfNeedBe(req, res, next, defaultApp, hostname) {
-	if (!hostname || 0 !== req.url.indexOf(challengePrefix)) {
+function skipChallenge(req, res, next, defaultApp) {
    if ("function" === typeof defaultApp) {
        defaultApp(req, res, next);
    } else if ("function" === typeof next) {
@ -43,10 +89,12 @@ function skipIfNeedBe(req, res, next, defaultApp, hostname) {
        res.end("[500] Developer Error: app.use('/', greenlock.httpMiddleware()) or greenlock.httpMiddleware(app)");
    }
 }
-}

 function respondWithGrace(res, result, hostname, token) {
    var keyAuth = result && result.keyAuthorization;
+
+    // HEADERS SENT DEBUG NOTE #4b
+    // This is (still) the third/fourth possible time we could be sending headers
    if (keyAuth && "string" === typeof keyAuth) {
        res.setHeader("Content-Type", "text/plain; charset=utf-8");
        res.end(keyAuth);
@ -65,14 +113,18 @@ function explainError(gl, err, ctx, hostname) {
    if (!err.context) {
        err.context = ctx;
    }
+    // leaving this in the build for now because it will help with existing error reports
+    console.error("[warning] network connection error:", (err.context || "") + " " + err.message);
    (gl.notify || gl._notify)("error", err);
    return err;
 }

 function respondToError(gl, res, err, ctx, hostname) {
+    // HEADERS SENT DEBUG NOTE #3b
+    // This is (still) the second possible time we could be sending headers
    err = explainError(gl, err, ctx, hostname);
    res.statusCode = 500;
-	res.end("Internal Server Error: See logs for details.");
+    res.end("Internal Server Error [1004]: See logs for details.");
 }

 HttpMiddleware.getHostname = function(req) {
--- a/https-middleware.js
+++ b/https-middleware.js
@ -111,14 +111,20 @@ SanitizeHost._checkServername = function(safeHost, tlsSocket) {
        // TODO optimize / cache?
        // *should* always have a string, right?
        // *should* always be lowercase already, right?
-		if (
-			(cert.subject.CN || "").toLowerCase() !== safeHost &&
-			!(cert.subjectaltname || "").split(/,\s+/).some(function(name) {
+        //console.log(safeHost, cert.subject.CN, cert.subjectaltname);
+        var isSubject = (cert.subject.CN || "").toLowerCase() === safeHost;
+        if (isSubject) {
+            return true;
+        }
+
+        var dnsnames = (cert.subjectaltname || "").split(/,\s+/);
+        var inSanList = dnsnames.some(function(name) {
            // always prefixed with "DNS:"
            return safeHost === name.slice(4).toLowerCase();
-			})
-		) {
-			return false;
+        });
+
+        if (inSanList) {
+            return true;
        }
    } catch (e) {
        // not sure what else to do in this situation...
--- a/main.js
+++ b/main.js
@ -8,12 +8,8 @@ var minor = process.versions.node.split(".")[1];
 var _hasSetSecureContext = false;
 var shouldUpgrade = false;

-// TODO can we trust earlier versions as well?
-if (major >= 12) {
-	_hasSetSecureContext = !!require("http2").createSecureServer({}, function() {}).setSecureContext;
-} else {
+// this applies to http2 as well (should exist in both or neither)
 _hasSetSecureContext = !!require("https").createServer({}, function() {}).setSecureContext;
-}

 // TODO document in issues
 if (!_hasSetSecureContext) {
--- a/master.js
+++ b/master.js
@ -13,7 +13,7 @@ Master.create = function(opts) {
    var _readyCb;
    var _kicked = false;

-	var greenlock = require("./greenlock.js").create(opts);
+    var greenlock = require("./greenlock-shim.js").create(opts);

    var ready = new Promise(function(resolve) {
        resolveCb = resolve;
@ -37,7 +37,7 @@ Master.create = function(opts) {
    }

    var master = {
-		serve: function() {
+        ready: function() {
            kickoff();
            return master;
        },
@ -48,6 +48,10 @@ Master.create = function(opts) {
            kickoff();
            resolveCb(fn);
            return master;
+        },
+        serve: function(fn) {
+            // ignore
+            master.ready(fn);
        }
    };
    return master;
@ -66,7 +70,7 @@ Master._spawnWorkers = function(opts, greenlock) {

    // process rpc messages
    // start when dead
-	var numWorkers = parseInt(opts.numWorkers, 10);
+    var numWorkers = parseInt(opts.workers || opts.numWorkers, 10);
    if (!numWorkers) {
        if (numCpus <= 2) {
            numWorkers = 2;
@ -75,7 +79,7 @@ Master._spawnWorkers = function(opts, greenlock) {
        }
    }

-  cluster.on('exit', function () {
+    cluster.once("exit", function() {
        setTimeout(function() {
            process.exit(3);
        }, 100);
@ -101,7 +105,7 @@ Master._spawnWorkers = function(opts, greenlock) {
 Master._spawnWorker = function(opts, greenlock) {
    var w = cluster.fork();
    // automatically added to master's `cluster.workers`
-	w.on("exit", function(code, signal) {
+    w.once("exit", function(code, signal) {
        // TODO handle failures
        // Should test if the first starts successfully
        // Should exit if failures happen too quickly
--- a/package-lock.json
+++ b/package-lock.json
@ -1,18 +1,27 @@
 {
    "name": "@root/greenlock-express",
-	"version": "3.0.0",
+    "version": "4.0.4",
    "lockfileVersion": 1,
    "requires": true,
    "dependencies": {
-		"@root/acme": {
-			"version": "3.0.6",
-			"resolved": "https://registry.npmjs.org/@root/acme/-/acme-3.0.6.tgz",
-			"integrity": "sha512-KfgwcyWDsT90vz+gmWbCwuOBolwV5Gcg0WHsG8/dznDC7a6QF4AmZsil7mIWKGJxHdi6MElkyrHZyK53OhPnug==",
+        "@greenlock/manager": {
+            "version": "3.1.0",
+            "resolved": "https://registry.npmjs.org/@greenlock/manager/-/manager-3.1.0.tgz",
+            "integrity": "sha512-PBy5CMK+j4oD7sj7hF5qE+xKEOSiiuL2hHd5X5ttEbtnTSDKjNeqbrR5k2ZddwVNdjOVeBIeuqlm81IFZ+Ftew==",
            "requires": {
+                "greenlock-manager-fs": "^3.1.0"
+            }
+        },
+        "@root/acme": {
+            "version": "3.1.0",
+            "resolved": "https://registry.npmjs.org/@root/acme/-/acme-3.1.0.tgz",
+            "integrity": "sha512-GAyaW63cpSYd2KvVp5lHLbCWeEhJPKZK9nsJvZJOKsD9Uv88KEttn4FpDZEJ+2q3Jsey0DWpuQ2I4ft0JV9p2w==",
+            "requires": {
+                "@root/csr": "^0.8.1",
                "@root/encoding": "^1.0.1",
-				"@root/keypairs": "^0.9.0",
+                "@root/keypairs": "^0.10.0",
                "@root/pem": "^1.0.4",
-				"@root/request": "^1.3.11",
+                "@root/request": "^1.6.1",
                "@root/x509": "^0.7.2"
            }
        },
@ -40,26 +49,26 @@
            "integrity": "sha512-OaEub02ufoU038gy6bsNHQOjIn8nUjGiLcaRmJ40IUykneJkIW5fxDqKxQx48cszuNflYldsJLPPXCrGfHs8yQ=="
        },
        "@root/greenlock": {
-			"version": "3.0.1",
-			"resolved": "https://registry.npmjs.org/@root/greenlock/-/greenlock-3.0.1.tgz",
-			"integrity": "sha512-Hyrnw/gXgmM4Ml7l0SAwYQ1FAq685dwRXpp7zmOxZDieUGWwP+GUcXOrEefph/lpELWJ5igcPzdEkIGtjMCTww==",
+            "version": "4.0.5",
+            "resolved": "https://registry.npmjs.org/@root/greenlock/-/greenlock-4.0.5.tgz",
+            "integrity": "sha512-KR9w3mYE9aH33FCibI8oSYBQV+f7lc3MVPdZ9nxY2tqRLmJp05cMOMz340mtG14VnWDuznLj4TbBj3sHIuoQPQ==",
            "requires": {
-				"@root/acme": "^3.0.6",
+                "@greenlock/manager": "^3.1.0",
+                "@root/acme": "^3.1.0",
                "@root/csr": "^0.8.1",
-				"@root/keypairs": "^0.9.0",
+                "@root/keypairs": "^0.10.0",
                "@root/mkdirp": "^1.0.0",
-				"@root/request": "^1.3.10",
-				"acme-http-01-standalone": "^3.0.0",
+                "@root/request": "^1.6.1",
+                "acme-http-01-standalone": "^3.0.5",
                "cert-info": "^1.5.1",
-				"greenlock-manager-fs": "^0.6.0",
-				"greenlock-store-fs": "^3.2.0",
+                "greenlock-store-fs": "^3.2.2",
                "safe-replace": "^1.1.0"
            }
        },
        "@root/keypairs": {
-			"version": "0.9.0",
-			"resolved": "https://registry.npmjs.org/@root/keypairs/-/keypairs-0.9.0.tgz",
-			"integrity": "sha512-NXE2L9Gv7r3iC4kB/gTPZE1vO9Ox/p14zDzAJ5cGpTpytbWOlWF7QoHSJbtVX4H7mRG/Hp7HR3jWdWdb2xaaXg==",
+            "version": "0.10.0",
+            "resolved": "https://registry.npmjs.org/@root/keypairs/-/keypairs-0.10.0.tgz",
+            "integrity": "sha512-t8VocY46Mtb0NTsxzyLLf5tsgfw0BXLYVADAyiRdEdqHcvPFGJdjkXNtHVQuSV/FMaC65iTOHVP4E6X8iT3Ikg==",
            "requires": {
                "@root/encoding": "^1.0.1",
                "@root/pem": "^1.0.4",
@ -77,9 +86,9 @@
            "integrity": "sha512-rEUDiUsHtild8GfIjFE9wXtcVxeS+ehCJQBwbQQ3IVfORKHK93CFnRtkr69R75lZFjcmKYVc+AXDB+AeRFOULA=="
        },
        "@root/request": {
-			"version": "1.3.11",
-			"resolved": "https://registry.npmjs.org/@root/request/-/request-1.3.11.tgz",
-			"integrity": "sha512-3a4Eeghcjsfe6zh7EJ+ni1l8OK9Fz2wL1OjP4UCa0YdvtH39kdXB9RGWuzyNv7dZi0+Ffkc83KfH0WbPMiuJFw=="
+            "version": "1.6.1",
+            "resolved": "https://registry.npmjs.org/@root/request/-/request-1.6.1.tgz",
+            "integrity": "sha512-8wrWyeBLRp7T8J36GkT3RODJ6zYmL0/maWlAUD5LOXT28D3TDquUepyYDKYANNA3Gc8R5ZCgf+AXvSTYpJEWwQ=="
        },
        "@root/x509": {
            "version": "0.7.2",
@ -91,9 +100,9 @@
            }
        },
        "acme-http-01-standalone": {
-			"version": "3.0.0",
-			"resolved": "https://registry.npmjs.org/acme-http-01-standalone/-/acme-http-01-standalone-3.0.0.tgz",
-			"integrity": "sha512-lZqVab2UZ1Dp36HemfhGEvdYOcVNg5wyVXNjtPUqGSAOVUOKqwi3gDrTGwqz+FBrEEEEpTngDPaZn2g3hfmPLA=="
+            "version": "3.0.5",
+            "resolved": "https://registry.npmjs.org/acme-http-01-standalone/-/acme-http-01-standalone-3.0.5.tgz",
+            "integrity": "sha512-W4GfK+39GZ+u0mvxRVUcVFCG6gposfzEnSBF20T/NUwWAKG59wQT1dUbS1NixRIAsRuhpGc4Jx659cErFQH0Pg=="
        },
        "cert-info": {
            "version": "1.5.1",
@ -106,27 +115,27 @@
            "integrity": "sha1-Aljq5NPQwJdN4cFpGI7wBR0dGYg="
        },
        "greenlock-manager-fs": {
-			"version": "0.6.0",
-			"resolved": "https://registry.npmjs.org/greenlock-manager-fs/-/greenlock-manager-fs-0.6.0.tgz",
-			"integrity": "sha512-o5RZ/T4j6eaUXCVnZ2dScE1pAjFuS8/R4ZDn7mCyRkxBjZvXJU7TpYe5Bc/wmN8x+gLHqVUECZWC6VdA/DbShQ==",
+            "version": "3.1.1",
+            "resolved": "https://registry.npmjs.org/greenlock-manager-fs/-/greenlock-manager-fs-3.1.1.tgz",
+            "integrity": "sha512-np6qdnPIOZx40PAcSQcqK1eMPWjTKxsxcgRd/OVg0ai49WC1Ds74CTrwmB84pq2n53ikbnDBQFmKEQ4AC0DK8w==",
            "requires": {
                "@root/mkdirp": "^1.0.0",
                "safe-replace": "^1.1.0"
            }
        },
        "greenlock-store-fs": {
-			"version": "3.2.0",
-			"resolved": "https://registry.npmjs.org/greenlock-store-fs/-/greenlock-store-fs-3.2.0.tgz",
-			"integrity": "sha512-zqcPnF+173oYq5qU7FoGtuqeG8dmmvAiSnz98kEHAHyvgRF9pE1T0MM0AuqDdj45I3kXlCj2gZBwutnRi37J3g==",
+            "version": "3.2.2",
+            "resolved": "https://registry.npmjs.org/greenlock-store-fs/-/greenlock-store-fs-3.2.2.tgz",
+            "integrity": "sha512-92ejLB4DyV4qv/2b6VLGF2nKfYQeIfg3o+e/1cIoYLjlIaUFdbBXkzLTRozFlHsQPZt2ALi5qYrpC9IwH7GK8A==",
            "requires": {
                "@root/mkdirp": "^1.0.0",
                "safe-replace": "^1.1.0"
            }
        },
        "redirect-https": {
-			"version": "1.3.0",
-			"resolved": "https://registry.npmjs.org/redirect-https/-/redirect-https-1.3.0.tgz",
-			"integrity": "sha512-9GzwI/+Cqw3jlSg0CW6TgBQbhiVhkHSDvW8wjgRQ9IK34wtxS71YJiQeazSCSEqbvowHCJuQZgmQFl1xUHKEgg==",
+            "version": "1.3.1",
+            "resolved": "https://registry.npmjs.org/redirect-https/-/redirect-https-1.3.1.tgz",
+            "integrity": "sha512-Stex2nI+tMpZXKvy++32TiBXEy+GdpAfp3EUnl5BqCiJ5f5i6XvUSFrs7TR7IoRSlthM7ZtD89uYGTtJBXlFYg==",
            "requires": {
                "escape-html": "^1.0.3"
            }
--- a/package.json
+++ b/package.json
@ -1,6 +1,6 @@
 {
    "name": "@root/greenlock-express",
-	"version": "3.0.0",
+    "version": "4.0.4",
    "description": "Free SSL and managed or automatic HTTPS for node.js with Express, Koa, Connect, Hapi, and all other middleware systems.",
    "main": "greenlock-express.js",
    "homepage": "https://greenlock.domains",
@ -17,8 +17,8 @@
        "example": "examples"
    },
    "dependencies": {
-		"@root/greenlock": "^3.0.1",
-		"redirect-https": "^1.1.5"
+        "@root/greenlock": "^4.0.5",
+        "redirect-https": "^1.3.1"
    },
    "trulyOptionalDependencies": {
        "http-proxy": "^1.17.0",
--- a/servers.js
+++ b/servers.js
@ -20,9 +20,20 @@ Servers.create = function(greenlock) {

    servers.httpServer = function(defaultApp) {
        if (_httpServer) {
+            if (defaultApp) {
+                console.error("error: can only call httpServer(app) once");
+                process.exit(1);
+            }
            return _httpServer;
        }

+        if (!defaultApp) {
+            defaultApp = require("redirect-https")();
+        }
+        // HEADERS SENT DEBUG NOTE #1
+        // As seen above, it's only possible to create the server once.
+        // It always gets the http middleware, it always gets a single default app
+        // Therefore it seems impossible to be an http.on('connection', app) problem
        _httpServer = http.createServer(HttpMiddleware.create(greenlock, defaultApp));
        _httpServer.once("error", startError);

@ -31,14 +42,25 @@ Servers.create = function(greenlock) {

    var _middlewareApp;

+    servers.http2Server = function(secureOpts, defaultApp) {
+        return servers._httpsServer(secureOpts, defaultApp, function(secureOpts, fn) {
+            secureOpts.allowHTTP1 = true;
+            return require("http2").createSecureServer(secureOpts, fn);
+        });
+    };
    servers.httpsServer = function(secureOpts, defaultApp) {
+        return servers._httpsServer(secureOpts, defaultApp, function(secureOpts, fn) {
+            return require("https").createServer(secureOpts, fn);
+        });
+    };
+    servers._httpsServer = function(secureOpts, defaultApp, createSecureServer) {
        if (defaultApp) {
            // TODO guard against being set twice?
            _middlewareApp = defaultApp;
        }

        if (_httpsServer) {
-			if (secureOpts && Object.keys(secureOpts)) {
+            if (secureOpts && Object.keys(secureOpts).length) {
                throw new Error("Call glx.httpsServer(tlsOptions) before calling glx.serveApp(app)");
            }
            return _httpsServer;
@ -68,13 +90,17 @@ Servers.create = function(greenlock) {
    servers.serveApp = function(app) {
        return new Promise(function(resolve, reject) {
            if ("function" !== typeof app) {
-				reject(new Error("glx.serveApp(app) expects a node/express app in the format `function (req, res) { ... }`"));
+                reject(
+                    new Error(
+                        "glx.serveApp(app) expects a node/express app in the format `function (req, res) { ... }`"
+                    )
+                );
                return;
            }

            var id = cluster.isWorker && cluster.worker.id;
            var idstr = (id && "#" + id + " ") || "";
-			var plainServer = servers.httpServer(require("redirect-https")());
+            var plainServer = servers.httpServer();
            var plainAddr = "0.0.0.0";
            var plainPort = 80;
            plainServer.listen(plainPort, plainAddr, function() {
@ -86,7 +112,7 @@ Servers.create = function(greenlock) {

                // TODO fetch greenlock.servername
                _middlewareApp = app || _middlewareApp;
-				var secureServer = servers.httpsServer({}, app);
+                var secureServer = servers.httpsServer(null, app);
                var secureAddr = "0.0.0.0";
                var securePort = 443;
                secureServer.listen(securePort, secureAddr, function() {
@ -143,15 +169,3 @@ function wrapDefaultSniCallback(greenlock, secureOpts) {
    secureOpts.SNICallback = sni.create(greenlock, secureOpts);
    return secureOpts;
 }
-
-function createSecureServer(secureOpts, fn) {
-	var major = process.versions.node.split(".")[0];
-
-	// TODO can we trust earlier versions as well?
-	if (major >= 12) {
-		secureOpts.allowHTTP1 = true;
-		return require("http2").createSecureServer(secureOpts, fn);
-	} else {
-		return require("https").createServer(secureOpts, fn);
-	}
-}
--- a/single.js
+++ b/single.js
@ -6,12 +6,12 @@ var Single = module.exports;
 var Servers = require("./servers.js");

 Single.create = function(opts) {
-	var greenlock = require("./greenlock.js").create(opts);
+    var greenlock = require("./greenlock-shim.js").create(opts);

    var servers = Servers.create(greenlock);

    var single = {
-		serve: function(fn) {
+        ready: function(fn) {
            fn(servers);
            return single;
        },
@ -19,6 +19,17 @@ Single.create = function(opts) {
            // ignore
            //fn(master);
            return single;
+        },
+        serve: function(fn) {
+            // keeping backwards compat
+            if (1 === fn.length) {
+                single.ready(fn);
+                return;
+            }
+            // serving the app, right away
+            single.ready(function(glx) {
+                glx.serveApp(fn);
+            });
        }
    };
    return single;
--- a/sni.js
+++ b/sni.js
@ -60,9 +60,20 @@ sni.create = function(greenlock, secureOpts) {
                    cb(null, secureContext);
                    return;
                }
+
                // Note: this does not replace tlsSocket.setSecureContext()
                // as it only works when SNI has been sent
                //console.log("debug sni got default context", servername, getCachedMeta(servername));
+                if (!/PROD/.test(process.env.ENV) || /DEV|STAG/.test(process.env.ENV)) {
+                    // Change this once
+                    // A) the 'notify' message passing is verified fixed in cluster mode
+                    // B) we have a good way to let people know their server isn't configured
+                    console.debug("debug: ignoring servername " + JSON.stringify(servername));
+                    console.debug("       (it's probably either missing from your config, or a bot)");
+                    notify("servername_unknown", {
+                        servername: servername
+                    });
+                }
                cb(null, getDefaultContext());
            })
            .catch(function(err) {
@ -110,6 +121,16 @@ sni.create = function(greenlock, secureOpts) {
    function getFreshContext(servername) {
        var meta = getCachedMeta(servername);
        if (!meta && !validServername(servername)) {
+            if ((servername && !/PROD/.test(process.env.ENV)) || /DEV|STAG/.test(process.env.ENV)) {
+                // Change this once
+                // A) the 'notify' message passing is verified fixed in cluster mode
+                // B) we have a good way to let people know their server isn't configured
+                console.debug("debug: invalid servername " + JSON.stringify(servername));
+                console.debug("       (it's probably just a bot trolling for vulnerable servers)");
+                notify("servername_invalid", {
+                    servername: servername
+                });
+            }
            return Promise.resolve(null);
        }

@ -118,26 +139,24 @@ sni.create = function(greenlock, secureOpts) {
            meta.refreshAt = Date.now() + randomRefreshOffset();
        }

-		// TODO greenlock.get({ servername: servername })
        // TODO don't get unknown certs at all, rely on auto-updates from greenlock
-		// Note: greenlock.renew() will return an existing fresh cert or issue a new one
-		return greenlock.renew({ servername: servername }).then(function(matches) {
+        // Note: greenlock.get() will return an existing fresh cert or issue a new one
+        return greenlock.get({ servername: servername }).then(function(result) {
            var meta = getCachedMeta(servername);
            if (!meta) {
-				meta = _cache[servername] = { secureContext: {} };
+                meta = _cache[servername] = { secureContext: { _valid: false } };
            }
            // prevent from being punked by bot trolls
            meta.refreshAt = Date.now() + smallStagger;

            // nothing to do
-			if (!matches.length) {
+            if (!result) {
                return null;
            }

            // we only care about the first one
-			var pems = matches[0].pems;
-			var site = matches[0].site;
-			var match = matches[0];
+            var pems = result.pems;
+            var site = result.site;
            if (!pems || !pems.cert) {
                // nothing to do
                // (and the error should have been reported already)
@ -152,9 +171,10 @@ sni.create = function(greenlock, secureOpts) {
                    cert: pems.cert + "\n" + pems.chain + "\n"
                })
            };
+            meta.secureContext._valid = true;

            // copy this same object into every place
-			[match.altnames || site.altnames || [match.subject || site.subject]].forEach(function(altname) {
+            (result.altnames || site.altnames || [result.subject || site.subject]).forEach(function(altname) {
                _cache[altname] = meta;
            });

--- a/worker.js
+++ b/worker.js
@ -7,14 +7,14 @@ var msgPrefix = "greenlock:";

 Worker.create = function() {
    var greenlock = {};
-	["getAcmeHttp01ChallengeResponse", "renew", "notify"].forEach(function(k) {
+    ["getAcmeHttp01ChallengeResponse", "get", "notify", "_notify"].forEach(function(k) {
        greenlock[k] = function(args) {
            return rpc(k, args);
        };
    });

    var worker = {
-		serve: function(fn) {
+        ready: function(fn) {
            var servers = require("./servers.js").create(greenlock);
            fn(servers);
            return worker;
@ -22,6 +22,17 @@ Worker.create = function() {
        master: function() {
            // ignore
            return worker;
+        },
+        serve: function(fn) {
+            // keeping backwards compat
+            if (1 === fn.length) {
+                worker.ready(fn);
+                return;
+            }
+            // serving the express app, right away
+            worker.ready(function(glx) {
+                glx.serveApp(fn);
+            });
        }
    };
    return worker;
@ -40,10 +51,13 @@ function rpc(funcname, msg) {
            if (msg._id !== id) {
                return;
            }
+            process.removeListener("message", getResponse);
            clearTimeout(timeout);
            resolve(msg._result);
        }

+        // TODO keep a single listener than just responds
+        // via a collection of callbacks? or leave as is?
        process.on("message", getResponse);
        process.send({
            _id: id,
Author	SHA1	Message	Date
AJ ONeal	480352835a	4.0.4	2020-08-03 23:18:26 -06:00
AJ ONeal	ce14a410d7	update deps for #38	2020-08-03 23:18:21 -06:00
AJ ONeal	ca0ba9bc68	Add missing tlsOptions to http2 example	2020-08-03 06:37:24 +00:00
AJ ONeal	2ac272ba9d	update TL;DR	2020-07-29 02:39:47 +00:00
AJ ONeal	374c360967	add TL;DR	2020-07-29 02:38:55 +00:00
AJ ONeal	4b24cc48e9	clarify staging certificates	2020-07-29 02:33:36 +00:00
AJ ONeal	a025022fb2	add more paragraph text to QuickStart	2020-07-29 02:31:25 +00:00
AJ ONeal	f2abc44601	update node installer instructions	2020-07-28 22:39:34 +00:00
AJ ONeal	477e7a07ec	move FAQ	2020-04-30 18:24:29 +00:00
AJ ONeal	657ebe0756	update FAQ	2020-04-30 18:22:50 +00:00
AJ ONeal	aaed863ef8	update FAQ	2020-04-30 18:19:33 +00:00
AJ ONeal	67d6a60a37	add FAQ	2020-04-30 18:17:06 +00:00
AJ ONeal	894e603a64	fix broken link	2020-04-29 16:04:34 +00:00
AJ ONeal	adf0c97301	fix altnames example	2020-04-29 15:29:45 +00:00
AJ ONeal	e8f2c39f79	update altnames example	2020-04-29 15:29:14 +00:00
AJ ONeal	f81d2614f4	fix typo	2020-04-26 23:13:02 +00:00
AJ ONeal	f18eae4073	update docs	2020-01-16 17:16:30 -07:00
AJ ONeal	83d4a9204e	v4.0.3: update deps for bugfixes, better logging	2020-01-13 18:47:01 -07:00
AJ ONeal	e5456249a2	update docs	2020-01-11 17:02:13 -07:00
AJ ONeal	1df2bc0ad4	update docs	2020-01-11 13:36:13 -07:00
AJ ONeal	cf93c77bd5	v4.0.2: update deps	2020-01-11 13:21:31 -07:00
AJ ONeal	c9363bd1a3	update docs	2020-01-11 13:16:48 -07:00
AJ ONeal	99f6ab0c1e	update docs	2020-01-11 13:15:39 -07:00
AJ ONeal	a9feafeab3	update docs	2020-01-10 18:03:59 -07:00
AJ ONeal	bae832d65a	update docs	2020-01-10 18:00:08 -07:00
AJ ONeal	e6a008d498	update docs	2020-01-10 17:51:25 -07:00
AJ ONeal	2d5125821e	v4.0.1: launch v4	2020-01-09 04:29:18 -07:00
AJ ONeal	8e29cafdf5	updates for v4	2020-01-05 17:32:20 -07:00
AJ ONeal	224f258daa	bugfixes	2019-11-19 01:19:27 -07:00
AJ ONeal	375524873d	wip: require correct init file	2019-11-18 22:56:28 -07:00
AJ ONeal	28aad4f29d	wip: simpler config and defaults	2019-11-18 00:53:26 -07:00
AJ ONeal	48b892c323	wip: move to configDir	2019-11-16 16:50:12 -07:00
AJ ONeal	01ff1d7da5	wip: refining API	2019-11-12 01:46:47 -07:00
AJ ONeal	347402a4d4	force cluster false for pre-worker systems (issue #80 )	2019-11-06 18:17:37 -07:00
AJ ONeal	bd5ee84e25	allow without callbacks, issue #9	2019-11-05 11:50:38 -07:00
AJ ONeal	4e9a6c0719	readme typo fix	2019-11-05 04:20:21 -07:00
AJ ONeal	548faed139	v3.1.1: update docs	2019-11-05 04:17:51 -07:00
AJ ONeal	5a7db51a36	update docs	2019-11-05 04:17:31 -07:00
AJ ONeal	654a64d7f4	update docs	2019-11-05 04:15:11 -07:00
AJ ONeal	ec14a224f9	v3.1.0: updates and docs for CLI	2019-11-05 04:01:58 -07:00
AJ ONeal	47140f6296	update docs	2019-11-05 03:30:53 -07:00
AJ ONeal	6296c8a737	update docs	2019-11-05 03:30:07 -07:00
AJ ONeal	e1d5e9a692	update docs	2019-11-05 03:09:42 -07:00
AJ ONeal	6bbb5f78e9	remove cruft	2019-11-04 15:03:24 -07:00
AJ ONeal	a360abda01	serve -> ready	2019-11-03 01:28:37 -07:00
AJ ONeal	5068097090	possible fix for notify bug	2019-11-02 21:01:29 -06:00
AJ ONeal	3994c7fd5c	output invalid and unknown sni	2019-11-02 20:54:09 -06:00
AJ ONeal	4482e97dcb	add debug for headers issue (issue #9 on root git)	2019-11-02 20:39:59 -06:00
AJ ONeal	37c3aee99f	use https-redirect as default app for httpServer	2019-11-01 22:55:39 -06:00
AJ ONeal	1eba51ea22	update deps	2019-11-01 17:18:26 -06:00
AJ ONeal	61fb942dda	whitespace	2019-11-01 15:14:07 -06:00
AJ ONeal	b80537f07b	v3.0.12: from http2 back to old https.. :-/	2019-11-01 15:13:04 -06:00
AJ ONeal	627ad8272e	v3.0.11: bump	2019-11-01 14:32:27 -06:00
AJ ONeal	ce5e31bbf7	moved getAcmeHttp01ChallengeResponse to greenlock proper	2019-11-01 13:45:52 -06:00
ryanburnette	d11b45c409	fix typo	2019-11-01 12:57:32 +00:00
AJ ONeal	36abf769be	v3.0.10: doc updates	2019-11-01 04:30:45 -06:00
AJ ONeal	c93ecf307b	update quickstart	2019-11-01 04:29:49 -06:00
AJ ONeal	3ea7d3e97b	move quickstart, add challenge integrations	2019-11-01 04:26:40 -06:00
AJ ONeal	fff5192fb4	on second thought, just the node app example	2019-11-01 04:19:32 -06:00
AJ ONeal	fceeb8c72c	v3.0.9: add examples	2019-11-01 04:12:47 -06:00
AJ ONeal	a7526ffad8	v3.0.8: update deps, add example	2019-10-31 06:46:35 -06:00
AJ ONeal	d324179cb1	fix maintainerEmail and httpsServer() return	2019-10-31 05:52:30 -06:00
AJ ONeal	18b36d7d23	fix maintainer email	2019-10-30 13:14:26 -06:00
AJ ONeal	7a2de022fa	v3.0.7: bugfixes and update deps	2019-10-30 02:38:31 -06:00
AJ ONeal	e478d27628	v3.0.6: bugfixes and update deps	2019-10-30 02:35:47 -06:00
AJ ONeal	6f2c1ec5ba	bugfix domain fronting check	2019-10-30 08:34:54 +00:00
AJ ONeal	894a01fa4e	more attention on the simple example	2019-10-29 23:04:32 -06:00
AJ ONeal	df1259cd9d	v3.0.5: update deps	2019-10-29 13:57:55 -06:00
AJ ONeal	3f8a54a988	v3.0.4: update deps	2019-10-29 12:50:43 -06:00
AJ ONeal	26adaf2037	bugfix packageAgent	2019-10-29 11:21:36 -06:00
AJ ONeal	2a9b463964	v3.0.3: update deps for bugfixes	2019-10-29 04:27:13 -06:00
AJ ONeal	bc4a5b44ae	v3.0.6: update deps for bugfixes	2019-10-29 03:22:50 -06:00
AJ ONeal	378b9310aa	change demo agent	2019-10-29 06:53:19 +00:00
AJ ONeal	405e98620c	v3.0.1: http-01 and other bugfixes, update deps	2019-10-29 06:48:31 +00:00
AJ ONeal	3f437c6ebb	whitespace	2019-10-28 03:52:38 -06:00