@small-tech/https 5.1.1 → 5.3.0

package/README.md

@@ -23,13 +23,39 @@ ___Note:__ This is a standard ECMAScript Modules (ESM; es6 modules) project. If
 __Tested and supported on:__
 
 - Linux (tested on Fedora Silverblue 37 and Ubuntu 22.04)
-- macOS (tested on Intel: Monterey, M1: Ventura)
+- macOS (tested on Intel: Monterey, M1: Ventura, M4: Sequoia)
 - Windows (10 and 11 under Windows Terminal and with Windows PowerShell)
 
 > 💡 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.
 
 >  💡 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.
 
+## Testing
+
+To run the unit tests:
+
+1. Install dependencies:
+
+    ```shell
+    npm install
+    ```
+
+2. Ensure your computer is reachable from the Internet via its hostname.
+
+    > 💡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).
+
+3. Run:
+
+    ```shell
+    npm test
+    ```
+
+    > 💡 To run tests with debug output, use the following command instead:
+    >
+    > ```shell
+    > npm run test-debug
+    > ```
+
 ## Like this? Fund us!
 
 [Small Technology Foundation](https://small-tech.org) is a tiny, independent not-for-profit.
@@ -66,6 +92,8 @@ server.listen(443, () => {
 
 Hit `https://localhost` and you should see your site with locally-trusted TLS certificates.
 
+> 💡 As of version 5.2.0, you can also use the localhost aliases _place1.localhost_ - _place4.localhost_ when testing the peer-to-peer features of [Small Web](https://ar.al/2020/08/07/what-is-the-small-web/) apps.
+
 @small-tech/https uses [Auto Encrypt Localhost](https://codeberg.org/small-tech/auto-encrypt-localhost) to create a local Certificate Authority (cA) and add it to the various trust stores. It then uses that CA to create locally-trusted TLS certificates that are automatically used by your server.
 
 ### At hostname with automatically-provisioned Let’s Encrypt certificates.
@@ -94,7 +122,7 @@ You can find a version of this example in the `/example` folder. To download and
 
 ```sh
 # Clone this repository.
-git clone https://source.small-tech.org/site.js/lib/https.git
+git clone https://codeberg.org/small-tech/https.git
 
 # Switch to the directory.
 cd https
@@ -130,36 +158,30 @@ Lower-level:
 
 ### Auto Encrypt
 
-- Source: https://github.com/small-tech/auto-encrypt
+- Source: https://codeberg.org/small-tech/auto-encrypt
 - Package: [@small-tech/auto-encrypt](https://www.npmjs.com/package/@small-tech/auto-encrypt)
 
-Adds automatic provisioning and renewal of [Let’s Encrypt](https://letsencrypt.org) TLS certificates with [OCSP Stapling](https://letsencrypt.org/docs/integration-guide/#implement-ocsp-stapling) to [Node.js](https://nodejs.org) [https](https://nodejs.org/dist/latest-v12.x/docs/api/https.html) servers (including Polka, Express.js, etc.)
+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.)
 
 ### Auto Encrypt Localhost
 
 - Source: https://codeberg.org/small-tech/auto-encrypt-localhost
 - Package: [@small-tech/auto-encrypt-localhost](https://www.npmjs.com/package/@small-tech/auto-encrypt-localhost)
 
-Automatically provisions and installs locally-trusted TLS certificates for Node.js https servers (including Polka, Express.js, etc.).
+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).
 
 Higher level:
 
-### Site.js
-
-- Web site: https://sitejs.org
-- Source: https://github.com/small-tech/site.js
-
-A tool for developing, testing, and deploying a secure static or dynamic personal web site or app with zero configuration.
-
-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.
-
 ### Kitten
 
-- Web site/source code: https://codeberg.org/kitten/app
+- Site: https://kitten.small-web.org
+- Source code: https://codeberg.org/kitten/app
 
-A [Small Web](https://small-tech.org/research-and-development/) development kit.
+A [Small Web](https://ar.al/2024/06/24/small-web-computer-science-colloquium-at-university-of-groningen/) development kit.
 
-Create your Small Web site using plain HTML, CSS, and JavaScript then enhance it with [htmx](https://htmx.org/) and [Alpine.js](https://alpinejs.dev), if you like.
+- Build using HTML, CSS, and JavaScript.
+- Progressively enhance with [Streaming HTML](https://kitten.small-web.org/tutorials/streaming-html).
+- Go beyond traditional web apps to create peer-to-peer 💕 Small Web apps.
 
 ## Copyright
 

package/index.js

@@ -36,7 +36,9 @@ smallTechHttps.createServer = function (options, listener) {
       options = {}
     }
 
-    const serverScope = options.domains == undefined || options.domains.includes('localhost') ? 'local' : 'global'
+    const localDomains = ['localhost', 'place1.localhost', 'place2.localhost', 'place3.localhost', 'place4.localhost']
+    const isLocal = options.domains == undefined || options.domains.some(domain => localDomains.includes(domain))
+    const serverScope =  isLocal ? 'local' : 'global'
     const settingsPath = options.settingsPath ? path.join(path.resolve(options.settingsPath), serverScope) : path.join(DEFAULT_SETTINGS_PATH, serverScope)
     options.settingsPath = settingsPath
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@small-tech/https",
-  "version": "5.1.1",
+  "version": "5.3.0",
   "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.",
   "main": "index.js",
   "files": [
@@ -46,7 +46,7 @@
   },
   "license": "AGPL-3.0",
   "dependencies": {
-    "@small-tech/auto-encrypt": "^4.0.0",
+    "@small-tech/auto-encrypt": "^4.1.1",
     "@small-tech/auto-encrypt-localhost": "^8.3.2"
   },
   "devDependencies": {