Commit ca238585 authored by Aral Balkan's avatar Aral Balkan
Browse files

Fix npm install hang fix due to npm bug

parent 37bde40a
......@@ -4,6 +4,12 @@ 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).
## [3.0.1] - 2021-03-17
## Fixed
- Hang during npm install due to npm bug in Auto Encrypt Localhost (AEL). Upgraded AEL to version 7.0.4 which includes a graphical sudo prompt workaround.
## [3.0.0] - 2021-03-09
__Breaking change:__ ESM version. Includes Auto Encrypt 3.0.0 and Auto Encrypt Localhost 7.0.2.
......
......@@ -36,6 +36,10 @@ Works on Linux, macOS, and Windows (WSL is not supported for certificates at loc
npm i @small-tech/https
```
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.
![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)
## Examples
### At localhost with automatically-provisioned development certificates via mkcert.
......
{
"name": "@small-tech/https",
"version": "3.0.0",
"version": "3.0.1",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "@small-tech/https",
"version": "3.0.0",
"version": "3.0.1",
"license": "AGPL-3.0-or-later",
"dependencies": {
"@small-tech/auto-encrypt": "^3.0.0",
"@small-tech/auto-encrypt-localhost": "^7.0.2",
"@small-tech/auto-encrypt-localhost": "^7.0.4",
"fs-extra": "^9.0.1"
},
"devDependencies": {
......@@ -104,14 +104,15 @@
}
},
"node_modules/@small-tech/auto-encrypt-localhost": {
"version": "7.0.2",
"resolved": "https://registry.npmjs.org/@small-tech/auto-encrypt-localhost/-/auto-encrypt-localhost-7.0.2.tgz",
"integrity": "sha512-JReaQ/quFv+t//H5IHWCHges2x190bCFGY1OEwJEIUcN3ozHjsZpQ7P/5hip2O1lZnDzEcwYZKXWoROT4e/uHA==",
"version": "7.0.4",
"resolved": "https://registry.npmjs.org/@small-tech/auto-encrypt-localhost/-/auto-encrypt-localhost-7.0.4.tgz",
"integrity": "sha512-GdP1LMpQChMwVbp6Jw4Kgrm5qiaVZufWe/sRgg4fVcmN3jl9vB5lsT45xZbbJDzw+Lm04cdcSGpESOZf2AVFaA==",
"hasInstallScript": true,
"dependencies": {
"encodeurl": "^1.0.2",
"fs-extra": "^8.1.0",
"server-destroy": "^1.0.1",
"sudo-prompt": "^9.2.1",
"syswide-cas": "^5.3.0"
},
"funding": {
......@@ -1925,6 +1926,11 @@
"node": ">=8"
}
},
"node_modules/sudo-prompt": {
"version": "9.2.1",
"resolved": "https://registry.npmjs.org/sudo-prompt/-/sudo-prompt-9.2.1.tgz",
"integrity": "sha512-Mu7R0g4ig9TUuGSxJavny5Rv0egCEtpZRNMrZaYS1vxkiIxGiGUwoezU3LazIQ+KE04hTrTfNPgxU5gzi7F5Pw=="
},
"node_modules/supports-color": {
"version": "7.2.0",
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
......@@ -2272,13 +2278,14 @@
}
},
"@small-tech/auto-encrypt-localhost": {
"version": "7.0.2",
"resolved": "https://registry.npmjs.org/@small-tech/auto-encrypt-localhost/-/auto-encrypt-localhost-7.0.2.tgz",
"integrity": "sha512-JReaQ/quFv+t//H5IHWCHges2x190bCFGY1OEwJEIUcN3ozHjsZpQ7P/5hip2O1lZnDzEcwYZKXWoROT4e/uHA==",
"version": "7.0.4",
"resolved": "https://registry.npmjs.org/@small-tech/auto-encrypt-localhost/-/auto-encrypt-localhost-7.0.4.tgz",
"integrity": "sha512-GdP1LMpQChMwVbp6Jw4Kgrm5qiaVZufWe/sRgg4fVcmN3jl9vB5lsT45xZbbJDzw+Lm04cdcSGpESOZf2AVFaA==",
"requires": {
"encodeurl": "^1.0.2",
"fs-extra": "^8.1.0",
"server-destroy": "^1.0.1",
"sudo-prompt": "^9.2.1",
"syswide-cas": "^5.3.0"
},
"dependencies": {
......@@ -3591,6 +3598,11 @@
"ansi-regex": "^5.0.0"
}
},
"sudo-prompt": {
"version": "9.2.1",
"resolved": "https://registry.npmjs.org/sudo-prompt/-/sudo-prompt-9.2.1.tgz",
"integrity": "sha512-Mu7R0g4ig9TUuGSxJavny5Rv0egCEtpZRNMrZaYS1vxkiIxGiGUwoezU3LazIQ+KE04hTrTfNPgxU5gzi7F5Pw=="
},
"supports-color": {
"version": "7.2.0",
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
......
{
"name": "@small-tech/https",
"version": "3.0.0",
"version": "3.0.1",
"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": [
......@@ -44,7 +44,7 @@
"license": "AGPL-3.0-or-later",
"dependencies": {
"@small-tech/auto-encrypt": "^3.0.0",
"@small-tech/auto-encrypt-localhost": "^7.0.2",
"@small-tech/auto-encrypt-localhost": "^7.0.4",
"fs-extra": "^9.0.1"
},
"devDependencies": {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment