Skip to content

docs(node): mark unimplemented env vars #4012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wadefletch wants to merge 1 commit into from
+5 −5
Closed

docs(node): mark unimplemented env vars #4012

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/2.deploy/10.runtimes/1.node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ You can customize server behavior using following environment variables:

- `NITRO_PORT` or `PORT` (defaults to `3000`)
- `NITRO_HOST` or `HOST`
- `NITRO_UNIX_SOCKET` - if provided (a path to the desired socket file) the service will be served over the provided UNIX socket.
- `NITRO_UNIX_SOCKET` - if provided (a path to the desired socket file) the service will be served over the provided UNIX socket. :badge[Not yet implemented]{type="warning"}
- `NITRO_SSL_CERT` and `NITRO_SSL_KEY` - if both are present, this will launch the server in HTTPS mode. In the vast majority of cases, this should not be used other than for testing, and the Nitro server should be run behind a reverse proxy like nginx or Cloudflare which terminates SSL.
- `NITRO_SHUTDOWN_DISABLED` - Disables the graceful shutdown feature when set to `'true'`. If it's set to `'true'`, the graceful shutdown is bypassed to speed up the development process. Defaults to `'false'`.
- `NITRO_SHUTDOWN_SIGNALS` - Allows you to specify which signals should be handled. Each signal should be separated with a space. Defaults to `'SIGINT SIGTERM'`.
- `NITRO_SHUTDOWN_TIMEOUT` - Sets the amount of time (in milliseconds) before a forced shutdown occurs. Defaults to `'30000'` milliseconds.
- `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`.
- `NITRO_SHUTDOWN_DISABLED` - Disables the graceful shutdown feature when set to `'true'`. If it's set to `'true'`, the graceful shutdown is bypassed to speed up the development process. Defaults to `'false'`. :badge[Not yet implemented]{type="warning"}
- `NITRO_SHUTDOWN_SIGNALS` - Allows you to specify which signals should be handled. Each signal should be separated with a space. Defaults to `'SIGINT SIGTERM'`. :badge[Not yet implemented]{type="warning"}
- `NITRO_SHUTDOWN_TIMEOUT` - Sets the amount of time (in milliseconds) before a forced shutdown occurs. Defaults to `'30000'` milliseconds. :badge[Not yet implemented]{type="warning"}
- `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"}
Comment on lines +36 to +39
Copy link

@coderabbitai coderabbitai bot Feb 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Avoid implying active behavior for “Not yet implemented” vars.
The defaults/behavior text can mislead readers into thinking these options currently work. Consider trimming to a short description (or moving details to a future note) until implementation lands.

✂️ Suggested tweak (example) 
-- `NITRO_SHUTDOWN_TIMEOUT` - Sets the amount of time (in milliseconds) before a forced shutdown occurs. Defaults to `'30000'` milliseconds. :badge[Not yet implemented]{type="warning"}
+- `NITRO_SHUTDOWN_TIMEOUT` - Planned timeout for forced shutdown (milliseconds). :badge[Not yet implemented]{type="warning"}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- `NITRO_SHUTDOWN_DISABLED` - Disables the graceful shutdown feature when set to `'true'`. If it's set to `'true'`, the graceful shutdown is bypassed to speed up the development process. Defaults to `'false'`. :badge[Not yet implemented]{type="warning"}
- `NITRO_SHUTDOWN_SIGNALS` - Allows you to specify which signals should be handled. Each signal should be separated with a space. Defaults to `'SIGINT SIGTERM'`. :badge[Not yet implemented]{type="warning"}
- `NITRO_SHUTDOWN_TIMEOUT` - Sets the amount of time (in milliseconds) before a forced shutdown occurs. Defaults to `'30000'` milliseconds. :badge[Not yet implemented]{type="warning"}
- `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"}
- `NITRO_SHUTDOWN_DISABLED` - Disables the graceful shutdown feature when set to `'true'`. If it's set to `'true'`, the graceful shutdown is bypassed to speed up the development process. Defaults to `'false'`. :badge[Not yet implemented]{type="warning"}
- `NITRO_SHUTDOWN_SIGNALS` - Allows you to specify which signals should be handled. Each signal should be separated with a space. Defaults to `'SIGINT SIGTERM'`. :badge[Not yet implemented]{type="warning"}
- `NITRO_SHUTDOWN_TIMEOUT` - Planned timeout for forced shutdown (milliseconds). :badge[Not yet implemented]{type="warning"}
- `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"}
🧰 Tools
🪛 LanguageTool

[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ..., the graceful shutdown is bypassed to speed up the development process. Defaults to '...

(SPEED_UP_ACCELERATE)

🤖 Prompt for AI Agents 
In `@docs/2.deploy/10.runtimes/1.node.md` around lines 36 - 39, Update the
descriptions for the NITRO_SHUTDOWN_DISABLED, NITRO_SHUTDOWN_SIGNALS,
NITRO_SHUTDOWN_TIMEOUT, and NITRO_SHUTDOWN_FORCE entries so they do not imply
active behavior or concrete defaults while still noting they are not
implemented; replace the current detailed default/behavior sentences with
concise notes like “Flag planned for graceful shutdown controls — not yet
implemented” (or move implementation details to a future/implementation note),
and ensure the :badge[Not yet implemented] tag remains prominent next to each
variable name to avoid misleading readers.

Copy link

@coderabbitai coderabbitai bot Feb 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Make boolean value formatting consistent.
This line uses unquoted true while the surrounding bullets use 'true'. Aligning reduces confusion in docs.

🔧 Suggested tweak 
-- `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"}
+- `NITRO_SHUTDOWN_FORCE` - When set to `'true'`, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"}
- `NITRO_SHUTDOWN_FORCE` - When set to `'true'`, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"}
🤖 Prompt for AI Agents 
In `@docs/2.deploy/10.runtimes/1.node.md` at line 39, Update the documentation
line for the NITRO_SHUTDOWN_FORCE env var so its boolean example matches the
surrounding formatting; change the unquoted true to the same quoted style (use
`'true'` and `'false'`) in the description of how the flag behaves (referencing
NITRO_SHUTDOWN_FORCE).


## Cluster mode

Expand Down
Loading