doc: update npm install steps - #484
Merged
Merged
Conversation
With npm v12. `npm install` will no longer automatically run scripts from your package dependencies, but instead must be explicitly marked as allowed/trusted. This is to reduce the potential for malware and the effect of other recent supply chain attacks to be performed. node-odbc uses node-pre-gyp to automatically install a pre-built node binding from the corresponding GitHub release or fall back to building it from source if a pre-built is not available. Starting with npm v12, the node-pre-gyp install script will no longer be run unless explicitly allowed using `npm approve-scripts odbc`. Fixes #478
Member
|
I really think we need to add a section to the readme towards the top which has the text from the PR description and some kind of warning logo. Existing users are not likely to look at the installation instructions. Also, the installation instructions as given do not explain what the user is approving. |
kadler
reviewed
Sep 23, 2026
| ``` | ||
|
|
||
| We use [node-pre-gyp](https://github.com/mapbox/node-pre-gyp) to build and install a prebuilt binary with the package. | ||
| For the prebuilt binary to get installed you need to approve the install script and re-trigger the install script. |
Member
There was a problem hiding this comment.
This isn't quite right.
For the prebuilt binary to get installed
This doesn't just affect the prebuilt binary, but even building from source if there's no prebuilt binary.
and re-trigger the install script.
This only needs to be done once. Maybe we should mention this. And say that once it's been approved and package.json updated, then they won't need to do anything else.
kadler
reviewed
Sep 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
With npm v12,
npm installwill no longer automatically run scripts from your package dependencies, but instead must be explicitly marked as allowed/trusted. This is to reduce the potential for malware and the effect of other recent supply chain attacks to be performed.node-odbc uses node-pre-gyp to automatically install a pre-built node binding from the corresponding GitHub release or fall back to building it from source if a pre-built is not available. Starting with npm v12, the node-pre-gyp install script will no longer be run unless explicitly allowed using
npm approve-scripts odbc.Fixes #478