README.md 5.3 KB
Newer Older
1
# HTTPS Server
Aral Balkan's avatar
Aral Balkan committed
2

3
HTTPS Server is a secure [Small Tech](https://ar.al/2019/03/04/small-technology/) personal web server for seamless development and live use.
Aral Balkan's avatar
Aral Balkan committed
4

5
HTTP Server uses [nodecert](https://source.ind.ie/hypha/tools/nodecert) for seamless locally-trusted TLS certificate provisioning and use during development and [Greenlock](https://git.coolaj86.com/coolaj86/greenlock.js) for seamless globally-trusted [Let’s Encrypt](https://letsencrypt.org/) TLS certificate provisioning and use on live environments.
Aral Balkan's avatar
Aral Balkan committed
6

7 8

## Install
Aral Balkan's avatar
Aral Balkan committed
9 10 11 12 13

```sh
npm i -g @ind.ie/https-server
```

14

15
## Use
16

17
### Command-line
Aral Balkan's avatar
Aral Balkan committed
18

Aral Balkan's avatar
Aral Balkan committed
19
```sh
20
https-server [folder-to-serve] [--port N] [--global <email address>] [--version]
Aral Balkan's avatar
Aral Balkan committed
21
```
22

23
All command-line arguments are optional. By default, an HTTPS server with locally-trusted certificates will be created for you to serve the current folder over port 443.
Aral Balkan's avatar
Aral Balkan committed
24

25
If you do not already have TLS certificates, they will be created for you automatically using [nodecert](https://source.ind.ie/hypha/tools/nodecert).
26

27
All dependencies are installed automatically for you if they do not exist if you have apt, pacman, or yum (untested) on Linux or if you have [Homebrew](https://brew.sh/) or [MacPorts](https://www.macports.org/) (untested) on macOS.
28

29 30 31
If you specify the `--global` flag and provide an email address, globally-trusted Let’s Encrypt TLS certificates are automatically provisioned for you using Greenlock the first time you hit your hostname. The hostname for the certificates is automatically set from the hostname of your system (and the _www._ subdomain is also automatically provisioned). The email address is a requirement of Let’s Encrypt.

__Note:__ the telemetry and “community member” “features” in Greenlock are, of course, disabled in HTTPS Server.
32

33 34
### API

35
HTTPS Server’s `createServer` method behaves like the built-in _https_ module’s `createServer` function. Anywhere you use `https.createServer`, you can simply replace it with `httpsServer.createServer`.
36

37

38
#### createServer([options], [requestListener])
39

40
  - __options__ _(object)___:__ see [https.createServer](https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener). Populates the `cert` and `key` properties from the automatically-created [nodecert](https://source.ind.ie/hypha/tools/nodecert/) or Let’s Encrypt certificates and will overwrite them if they exist in the options object you pass in. If you pass in an email address (`options.email`), globally-trusted TLS certificates are obtained from Let’s Encrypt.
41

42
  - __requestListener__ _(function)___:__ see [https.createServer](https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener). If you don’t pass a request listener, HTTPS Server will use its default one.
43

44
    __Returns:__ [https.Server](https://nodejs.org/api/https.html#https_class_https_server) instance, configured with either locally-trusted certificates via nodecert or globally-trusted ones via Greenlock/Let’s Encrypt.
45

46
##### Example
47 48 49 50 51 52 53 54

```js
const httpsServer = require('https-server')
const express = require('express')

const app = express()
app.use(express.static('.'))

Aral Balkan's avatar
Aral Balkan committed
55
const options = {} // (optional) customise your server
56 57 58 59 60
const server = httpsServer.createServer(options, app).listen(443, () => {
  console.log(` 🎉 Serving on https://localhost\n`)
})
```

61
#### serve([pathToServe], [callback], [port], [email])
62

63
  - __pathToServe__ _(string)___:__ the directory to serve using [Express](http://expressjs.com/).static.
64

65 66 67 68
  - __callback__ _(function)___:__ a function to be called when the server is ready. If you do not specify a callback, you can specify the port as the second argument.

  - __port__ _(number)___:__ the port to serve on. Defaults to 443. (On Linux, privileges to bind to the port are automatically obtained for you.)

69 70 71
  - __email__ _(string)___:__ the email address to use for globally-trusted Let’s Encrypt certificates. If provided, globally-trusted certificates will be provisioned and used. (If absent, locally-trusted certificates will be provisioned using nodecert.)

    __Returns:__ [https.Server](https://nodejs.org/api/https.html#https_class_https_server) instance, configured with either locally or globally-trusted certificates.
72 73 74


##### Example
75 76 77 78 79 80 81 82

```js
const httpsServer = require('https-server')

// Serve the current directory over https://localhost
const server = httpsServer.serve()
```

83 84
## Help wanted

85
I can use your help to test HTTPS Server on the following platform/package manager combinations:
86

87 88
  - Linux with yum
  - macOS with MacPorts
89

90
Please [let me know how/if it works](https://github.com/indie-mirror/https-server/issues). Thank you!
91

92

93 94 95
## Thanks

  * [thagoat](https://github.com/thagoat) for confirming that [installation works on Arch Linux with Pacman](https://github.com/indie-mirror/https-server/issues/1).
96 97 98 99

  * [Tim Knip](https://github.com/timknip) for confirming that [the module works with 64-bit Windows](https://github.com/indie-mirror/https-server/issues/2) with the following behaviour: “Install pops up a windows dialog to allow adding the cert.”

  * [Run Rabbit Run](https://hackers.town/@nobody) for [the following information](https://hackers.town/@nobody/101670447262172957) on 64-bit Windows: “Win64: works with the windows cert install popup on server launch. Chrome and ie are ok with the site then. FF 65 still throws the cert warning even after restarting.”