docs: document unix socket listening for node and bun presets
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 73/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- bun, node.js, typescript
- Domain
- documentation
Research direction
Read docs/2.deploy/10.runtimes/1.node.md, docs/2.deploy/10.runtimes/bun.md, and the Server options section in docs/1.docs/6.server-entry.md; check src/runtime/internal/serve.ts for the current node socket behavior. Update the node documentation to match the shipped preset behavior, document bun runtime options and show a socket example. Done when the v3 docs describe working unix socket configuration for both runtimes.
Written by the indexing model from the issue text.
Description
The v3 docs don't explain how to listen on a unix socket, and one page documents a variable that no longer works.
docs/2.deploy/10.runtimes/1.node.mdlistsNITRO_UNIX_SOCKET, but v3 doesn't read it (src/runtime/internal/serve.tshas it as a TODO). A fix for the node presets is in progress; this line should match whatever ships.docs/2.deploy/10.runtimes/bun.mdhas no section on runtime options. On bun a socket already works from the server entry:export default { bun: { unix: "./app.sock" }, fetch() {} }(tested on main).docs/1.docs/6.server-entry.md(Server options) could show a unix socket example using the runtime-specificbun/nodesettings.
Context: #1740
Triaged with AI assistance.
- Dominant language
- TypeScript
- Stars
- 11.3k
- Forks
- 923
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 96
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from nitrojs/nitro
-
bug externals nuxt v2 windows
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
nitrojs/nitro#4761 · 1 comment ·
Maintainers usually reply within 1 day
-
documentation v3
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Github Pages workflow is outdatedMay be free again A pull request for this issue was closed without being merged. Opendocumentation preset:github-pages v2 v3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
nitrojs/nitro#4682 · 1 comment ·
Maintainers usually reply within 1 day
-
bug v2
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
nitrojs/nitro#4555 · 5 comments ·
Maintainers usually reply within 1 day
-
fix(task): add per-request timeout to `devFetch` http.request() call to prevent indefinite hangPossibly taken @spokodev claimed this 127 days ago. Openv3
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
nitrojs/nitro#4292 · 1 comment ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 83/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
ranxianglei/billion-context#3583 ·
Maintainers usually reply within 1 day
-
bug:new
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
callstackincubator/simlock#673 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
anomalyco/opencode#56380 · 1 comment ·
Maintainers usually reply within 1 day
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
NIAEFEUP/website-niaefeup-frontend#489 ·
Maintainers usually reply within 2 days