Skip to content

Commit a5a98c5

Browse files
docs: mark unimplemented env vars on node server page
The `NITRO_SHUTDOWN_*` env vars and `NITRO_UNIX_SOCKET` are documented but not implemented in the production node server runtime. Add "Not yet implemented" badges so users are aware. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent e102ff6 commit a5a98c5

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

docs/2.deploy/10.runtimes/1.node.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ You can customize server behavior using following environment variables:
3131

3232
- `NITRO_PORT` or `PORT` (defaults to `3000`)
3333
- `NITRO_HOST` or `HOST`
34-
- `NITRO_UNIX_SOCKET` - if provided (a path to the desired socket file) the service will be served over the provided UNIX socket.
34+
- `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"}
3535
- `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.
36-
- `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'`.
37-
- `NITRO_SHUTDOWN_SIGNALS` - Allows you to specify which signals should be handled. Each signal should be separated with a space. Defaults to `'SIGINT SIGTERM'`.
38-
- `NITRO_SHUTDOWN_TIMEOUT` - Sets the amount of time (in milliseconds) before a forced shutdown occurs. Defaults to `'30000'` milliseconds.
39-
- `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'`.
36+
- `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"}
37+
- `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"}
38+
- `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"}
39+
- `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"}
4040

4141
## Cluster mode
4242

0 commit comments

Comments
 (0)