CHANGELOG.md 2.82 KB
Newer Older
1
2
3
4
5
6
7
8
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

Aral Balkan's avatar
Aral Balkan committed
9
10
Nothing yet.

11
12
13
14
15
16
17
18
19
20
21
22
23
24
## [5.0.0] - 2019-03-09

### Changed

  - __Privacy and usability__: Now using [ACME TLS](https://source.ind.ie/hypha/tools/acme-tls/) (fork of Greenlock.js) for Let’s Encrypt certificate provisioning. This removes the artificial and privacy-eroding Greenlock.js requirement to specify an email address for Let’s Encrypt certificates.

  - __API:__ The `serve()` method now accepts a single parameter object (`options`).

## [4.0.0] - 2019-03-08

### Added

  - Add support for globally-trusted Let’s Encrypt TLS certificates.

Aral Balkan's avatar
Aral Balkan committed
25
26
27
28
## [3.0.0] - 2019-03-05

### Removed

29
30
31
  - HTTP2 support

    HTTP2 is not useful for [Small Tech](https://ar.al/2019/03/04/small-technology/) as it simply further privileges centralised servers. If you need HTTP2, use [https-server version 2.0.1](https://source.ind.ie/hypha/tools/https-server/tags/2.0.1).
Aral Balkan's avatar
Aral Balkan committed
32

33
34
35
36
37
38
## [2.0.1] - 2019-03-01

### Fixed

  - Remove erroneously-added console log message.

Aral Balkan's avatar
Aral Balkan committed
39
40
41
42
## [2.0.0] - 2019-02-28

### Added

43
  - HTTP2 support (API-only)
Aral Balkan's avatar
Aral Balkan committed
44
45
46

### Changed

47
48
49
50
51
  - Command-line arguments: specify port using `--port N`
  - Update `serve` method signature: `serve (pathToServe = '.', callback = null, port = 443)`

### Fixed

Aral Balkan's avatar
Aral Balkan committed
52
53
  - Start using [semver](https://semver.org/) properly (most of the previous releases should have been minor version bumps.) This is a major bump as there is a backwards-incompatible API change to the serve() method.

54
55
## [1.0.7] - 2019-02-28

56
### Fixed
57
58
59

  - Fix regression with automatic privileged port binding on Linux.

Aral Balkan's avatar
Aral Balkan committed
60
61
62
## [1.0.6] - 2019-02-28

### Changed
63
64
65

  - Uses nodecert v1.0.5: certificates now work in Node.js (e.g., via https.get(), etc.).

Aral Balkan's avatar
Aral Balkan committed
66
### Added
67
68

  - Unit tests.
69

70
71
## [1.0.5] - 2019-02-27

Aral Balkan's avatar
Aral Balkan committed
72
### Added
73
74
75

  - API: you can now use https-server programmatically from your own Node.js apps. It exposes a `createServer` method that’s polymorphic with its namesake from the base `https` module and it provides a `serve` convenience method that uses Express to serve a static site at the passed directory and port (or the current directory at port 443 by default).

76
77
## [1.0.4] - 2019-02-26

Aral Balkan's avatar
Aral Balkan committed
78
### Changed
79

80
  - Uses nodecert v1.0.4 (with progress indication).
81

82
83
## [1.0.3] - 2019-02-26

Aral Balkan's avatar
Aral Balkan committed
84
### Added
85
86
87

  - Node.js is automatically privileged to bind to ports < 1024 (including the default TLS port of 443).

88
89
## [1.0.2] - 2019-02-25

Aral Balkan's avatar
Aral Balkan committed
90
### Changed
91
92
93

  - Uses nodecert v1.0.3 with seamless install on macOS as well as Linux.

94
95
96
97
98
99
100
101
## [1.0.1] - 2019-02-25

### Fixed

  - Actually serves the requested folder instead of a hardcoded one 🤦

### Added

102
  - Support for manually-specifying the port.
103
104
105
106

## [1.0.0] - 2019-02-25

Initial release.