@small-tech/https 5.2.0 → 5.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -15
- package/package.json +5 -2
package/README.md
CHANGED
|
@@ -23,13 +23,39 @@ ___Note:__ This is a standard ECMAScript Modules (ESM; es6 modules) project. If
|
|
|
23
23
|
__Tested and supported on:__
|
|
24
24
|
|
|
25
25
|
- Linux (tested on Fedora Silverblue 37 and Ubuntu 22.04)
|
|
26
|
-
- macOS (tested on Intel: Monterey, M1: Ventura)
|
|
26
|
+
- macOS (tested on Intel: Monterey, M1: Ventura, M4: Sequoia)
|
|
27
27
|
- Windows (10 and 11 under Windows Terminal and with Windows PowerShell)
|
|
28
28
|
|
|
29
29
|
> 💡 On macOS, if you’re using a third-party terminal application like iTerm, you must give it Full Disk Access rights or @small-tech/https will fail to install the policy file inside Firefox when creating local development servers. You can do this on the latest version of the operating system by adding iTerm to the list at System Settings → Privacy & Security → Full Disk Access.
|
|
30
30
|
|
|
31
31
|
> 💡 On Windows, @small-tech/https will also run under WSL 2 but this is not recommended when creating local development servers as local development certificates will not be automatically installed in your Windows browsers for you since your guest Linux system knows nothing about and cannot configure your host Windows environment.
|
|
32
32
|
|
|
33
|
+
## Testing
|
|
34
|
+
|
|
35
|
+
To run the unit tests:
|
|
36
|
+
|
|
37
|
+
1. Install dependencies:
|
|
38
|
+
|
|
39
|
+
```shell
|
|
40
|
+
npm install
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
2. Ensure your computer is reachable from the Internet via its hostname.
|
|
44
|
+
|
|
45
|
+
> 💡The global tests provision Let’s Encrypt certificates using [Auto Encrypt](https://codeberg.org/small-tech/auto-encrypt)). For details on how to set up your machine for this, please see the [Tests section of the Auto Encrypt Developer Documentation](https://codeberg.org/small-tech/auto-encrypt/src/branch/main/developer-documentation.md#tests).
|
|
46
|
+
|
|
47
|
+
3. Run:
|
|
48
|
+
|
|
49
|
+
```shell
|
|
50
|
+
npm test
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
> 💡 To run tests with debug output, use the following command instead:
|
|
54
|
+
>
|
|
55
|
+
> ```shell
|
|
56
|
+
> npm run test-debug
|
|
57
|
+
> ```
|
|
58
|
+
|
|
33
59
|
## Like this? Fund us!
|
|
34
60
|
|
|
35
61
|
[Small Technology Foundation](https://small-tech.org) is a tiny, independent not-for-profit.
|
|
@@ -135,33 +161,27 @@ Lower-level:
|
|
|
135
161
|
- Source: https://codeberg.org/small-tech/auto-encrypt
|
|
136
162
|
- Package: [@small-tech/auto-encrypt](https://www.npmjs.com/package/@small-tech/auto-encrypt)
|
|
137
163
|
|
|
138
|
-
|
|
164
|
+
Automatically provisions and renews [Let’s Encrypt](https://letsencrypt.org) TLS certificates for [Node.js](https://nodejs.org) [https](https://nodejs.org/docs/latest-v22.x/api/https.html) servers (including [Kitten](https://kitten.small-web.org), Polka, Express.js, etc.)
|
|
139
165
|
|
|
140
166
|
### Auto Encrypt Localhost
|
|
141
167
|
|
|
142
168
|
- Source: https://codeberg.org/small-tech/auto-encrypt-localhost
|
|
143
169
|
- Package: [@small-tech/auto-encrypt-localhost](https://www.npmjs.com/package/@small-tech/auto-encrypt-localhost)
|
|
144
170
|
|
|
145
|
-
Automatically provisions and installs locally-trusted TLS certificates for Node.js https servers (including Polka, Express.js, etc.).
|
|
171
|
+
Automatically provisions and installs locally-trusted TLS certificates for Node.js https servers (including [Kitten](https://kitten.small-web.org), Polka, Express.js, etc.) in 100% JavaScript (without any native dependencies like mkcert and certutil).
|
|
146
172
|
|
|
147
173
|
Higher level:
|
|
148
174
|
|
|
149
|
-
### Site.js
|
|
150
|
-
|
|
151
|
-
- Web site: https://sitejs.org
|
|
152
|
-
- Source: https://codeberg.org/site.js/app
|
|
153
|
-
|
|
154
|
-
A tool for developing, testing, and deploying a secure static or dynamic personal web site or app with zero configuration.
|
|
155
|
-
|
|
156
|
-
Note: **Deprecated.** Site.js is being used to serve a number of our own web sites and isn’t going away anytime soon but all new development work is on Kitten.
|
|
157
|
-
|
|
158
175
|
### Kitten
|
|
159
176
|
|
|
160
|
-
-
|
|
177
|
+
- Site: https://kitten.small-web.org
|
|
178
|
+
- Source code: https://codeberg.org/kitten/app
|
|
161
179
|
|
|
162
|
-
A [Small Web](https://
|
|
180
|
+
A [Small Web](https://ar.al/2024/06/24/small-web-computer-science-colloquium-at-university-of-groningen/) development kit.
|
|
163
181
|
|
|
164
|
-
|
|
182
|
+
- Build using HTML, CSS, and JavaScript.
|
|
183
|
+
- Progressively enhance with [Streaming HTML](https://kitten.small-web.org/tutorials/streaming-html).
|
|
184
|
+
- Go beyond traditional web apps to create peer-to-peer 💕 Small Web apps.
|
|
165
185
|
|
|
166
186
|
## Copyright
|
|
167
187
|
|
package/package.json
CHANGED
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@small-tech/https",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.3.1",
|
|
4
4
|
"description": "A drop-in standard Node.js HTTPS module replacement with both automatic development-time (localhost) certificates via Auto Encrypt Localhost and automatic production certificates via Auto Encrypt.",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"files": [
|
|
7
7
|
"lib"
|
|
8
8
|
],
|
|
9
9
|
"type": "module",
|
|
10
|
+
"engines": {
|
|
11
|
+
"node": ">=18.20.0"
|
|
12
|
+
},
|
|
10
13
|
"keywords": [
|
|
11
14
|
"let's encrypt",
|
|
12
15
|
"acme",
|
|
@@ -46,7 +49,7 @@
|
|
|
46
49
|
},
|
|
47
50
|
"license": "AGPL-3.0",
|
|
48
51
|
"dependencies": {
|
|
49
|
-
"@small-tech/auto-encrypt": "^4.
|
|
52
|
+
"@small-tech/auto-encrypt": "^4.1.2",
|
|
50
53
|
"@small-tech/auto-encrypt-localhost": "^8.3.2"
|
|
51
54
|
},
|
|
52
55
|
"devDependencies": {
|