Skip to content

Commit 6f4c180

Browse files
committed
Documentation update
1 parent eb4aa97 commit 6f4c180

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [5.4.1] - 2020-07-11
9+
10+
### Changed
11+
12+
- Make the section on disabling privileged ports on Linux more prominent given that we now start a HTTP server and the tests will fail on Linux otherwise.
13+
814
## [5.4.0] - 2020-07-11
915

1016
### Added

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,16 @@ You can reach your server via the local loopback addresses (localhost, 127.0.0.1
1414
npm i @small-tech/auto-encrypt-localhost
1515
```
1616

17+
### On Linux
18+
19+
Make sure you disable privileged ports:
20+
21+
```
22+
sudo sysctl -w net.ipv4.ip_unprivileged_port_start=0
23+
```
24+
25+
(On Linux, ports 80 and 443 require special privileges. Please see [A note on Linux and the security farce that is “privileged ports”](#a-note-on-linux-and-the-security-farce-that-is-priviliged-ports). If you just need a Node web server that handles all that and more for you – or to see how to implement privilege escalation seamlessly in your own servers – see [Site.js](https://sitejs.org)).
26+
1727
## Usage
1828

1929
### Instructions
@@ -78,9 +88,6 @@ The browser will download the local root certificate authority’s public key an
7888
7989
You can also transfer your key manually. You can find the key at `~/.small-tech/auto-encrypt-localhost/rootCA.pem` after you’ve created at least one server. For more details on transferring your key to other devices, please refer to [the relevant section in the mkcert documentation](https://github.com/FiloSottile/mkcert#mobile-devices).
8090
81-
### A note on privileged ports on Linux
82-
83-
Note that on Linux, ports 80 and 443 require special privileges. Please see [A note on Linux and the security farce that is “privileged ports”](#a-note-on-linux-and-the-security-farce-that-is-priviliged-ports). If you just need a Node web server that handles all that and more for you (or to see how to implement privilege escalation seamlessly in your own servers, see [Site.js](https://sitejs.org)).
8491
8592
## Configuration
8693

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@small-tech/auto-encrypt-localhost",
3-
"version": "5.4.0",
3+
"version": "5.4.1",
44
"description": "Automatically provisions and installs locally-trusted TLS certificates for Node.js https servers (including Express.js, etc.) using mkcert.",
55
"keywords": [
66
"mkcert",

0 commit comments

Comments
 (0)