Skip to content

Commit f857809

Browse files
committed
Update readme
1 parent 479bcd9 commit f857809

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ A drop-in standard Node.js HTTPS module replacement with both automatic developm
44

55
Simply replace Node’s `https` module with `@small-tech/https` and get:
66

7-
- Automatically-provisioned TLS certificates at localhost with no browser warnings.
8-
- Automatically-provisioned TLS certificates at hostname via Let’s Encrypt.
7+
- Automatically-provisioned TLS certificates at localhost with no browser warnings via [mkcert](https://github.com/FiloSottile/mkcert).
8+
- Automatically-provisioned TLS certificates at hostname via [Let’s Encrypt](https://letsencrypt.org/).
99
- Automatic HTTP to HTTPS forwarding at hostname.
1010

1111
That’s it.
@@ -30,7 +30,7 @@ If you’re evaluating this for a “startup” or an enterprise, let us save yo
3030

3131
Tested and supported on:
3232

33-
- Linux (tested with elementary OS Hera)
33+
- Linux (tested with elementary OS 5.x/Hera)
3434
- macOS (tested on Big Sur)
3535
- Windows 10 (tested in Windows Terminal with PowerShell)
3636

@@ -42,11 +42,7 @@ Tested and supported on:
4242
npm i @small-tech/https
4343
```
4444

45-
Note that during installation, this module’s Auto Encrypt Localhost dependency will create your local certificate authority and install it in the system root store and generate locally-trusted certificates. These actions require elevated privileges (`sudo`). Since [npm does not handle sudo prompts correctly in lifecycle scripts](https://github.com/npm/cli/issues/2887), you will see a graphical sudo prompt pop up to ask you for your adminstrator password. Once you’ve provided it, installation will proceed as normal.
46-
47-
![Screenshot of graphical sudo prompt “Authentication required: Authentication is needed to run /bin/bash as the super user”](https://small-tech.org/images/graphical-sudo-prompt.png)
48-
49-
On Windows, you will also be prompted separately to allow the installation of the certificates.
45+
Note that during installation, this module’s Auto Encrypt Localhost dependency will download the correct mkcert binary to your machine.
5046

5147
## Examples
5248

@@ -66,6 +62,8 @@ server.listen(443, () => {
6662

6763
Hit `https://localhost` and you should see your site with locally-trusted TLS certificates.
6864

65+
@small-tech/https uses mkcert to create a local certificate authority and add it to the various trust stores. It then uses it to create locally-trusted TLS certificates that are automatically used by your server.
66+
6967
### At hostname with automatically-provisioned Let’s Encrypt certificates.
7068

7169
```js
@@ -86,6 +84,8 @@ server.listen(443, () => {
8684

8785
To provision globally-trusted Let’s Encrypt certificates, we additionally create an `options` object containing the domain(s) we want to support, and pass it as the first argument in the `createServer()` method.
8886

87+
@small-tech/https automatically provisions Let’s Encrypt certificates for you the first time your server is hit (this first load will take longer than future ones). During this initial load, other requests are ignored. This module will also automatically renew your certificates as necessary in plenty of time before they expire.
88+
8989
You can find a version of this example in the `/example` folder. To download and run that version:
9090

9191
```sh
@@ -149,7 +149,7 @@ A complete [small technology](https://small-tech.org/about/#small-technology) to
149149

150150
## Copyright
151151

152-
© 2020 [Aral Balkan](https://ar.al), [Small Technology Foundation](https://small-tech.org).
152+
© 2020-2021 [Aral Balkan](https://ar.al), [Small Technology Foundation](https://small-tech.org).
153153

154154
Let’s Encrypt is a trademark of the Internet Security Research Group (ISRG). All rights reserved. Node.js is a trademark of Joyent, Inc. and is used with its permission. We are not endorsed by or affiliated with Joyent or ISRG.
155155

0 commit comments

Comments
 (0)