docs: Properly document runAsNode utility process option #41255
Merged
Conversation
This file contains 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
electron-cation
bot
added
documentation 📓
semver/patch
VerteDinde
approved these changes
Feb 6, 2024
VerteDinde
added
the
target/29-x-y
dsanders11
reviewed
Feb 6, 2024
| @@ -15,7 +15,7 @@ Fuses are the solution to this problem, at a high level they are "magic bits" in | |||
| **Default:** Enabled | |||
| **@electron/fuses:** `FuseV1Options.RunAsNode` | |||
|
|
|||
| The runAsNode fuse toggles whether the `ELECTRON_RUN_AS_NODE` environment variable is respected or not. Please note that if this fuse is disabled then `process.fork` in the main process will not function as expected as it depends on this environment variable to function. | |||
| The runAsNode fuse toggles whether the `ELECTRON_RUN_AS_NODE` environment variable is respected or not. Please note that if this fuse is disabled then `process.fork` in the main process will not function as expected as it depends on this environment variable to function. Instead, we recommend that you use [Utility Processes](../api/utility-process.md), which work for many use cases where you need a standalone Node.js process (like a Sqlite server process or similar scenarios). | |||
There was a problem hiding this comment.
Should this recommendation also be added to docs/tutorial/security.md for higher visibility? As in a new checklist item, vaguely speaking "AvoidELECTRON_RUN_AS_NODE, use Utility Processes instead".
There was a problem hiding this comment.
Good suggestion, I'll add it there, too - probably in a separate PR!
ckerr
approved these changes
Feb 6, 2024
Co-authored-by: Charles Kerr <charles@charleskerr.com>
|
No Release Notes |
|
I have automatically backported this PR to "29-x-y", please check out #41260 |
trop
bot
added
in-flight/29-x-y
merged/29-x-y
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of Change
This PR properly documents (1) that utility processes do not receive an
stdout/stderrpipeby default and (2) that they are excellent alternatives toprocess.forkwhen theRunAsNodefuse is set tofalse.Checklist
npm testpassesRelease Notes
Notes: no-notes