Repository navigation
docs: document the --idle-timeout option (v3) - #15
Merged
Merged
Conversation
Add an "Idle Connection Timeout" feature page for the `--idle-timeout` option added in v3.0.0-beta.2: what gets closed, the HTTP/1 header rule, the default and how to disable it, behaviour with downloads, TLS and reverse proxies, and its limitations. Also list it in the CLI, env, TOML and defaults references, the features table, the HTTP/1 and HTTP/2 tips, and the migration guide, since v2 never closed idle connections. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
joseluisq
approved these changes
Oct 31, 2026
joseluisq
left a comment
joseluisq
left a comment
Contributor
There was a problem hiding this comment.
Forgot to merge this.
Thanks!
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
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
v3 docs for the
--idle-timeoutoption (SERVER_IDLE_TIMEOUT,[general] idle-timeout), added in static-web-server/static-web-server@74665fc4 and released in v3.0.0-beta.2.Possible follow-up: the
env.md#server_*links on the v3 pages (e.g.#server_grace_period) don't match the generated anchors (#server-grace-period), so they open the page at the top. The new link here uses the working form. I can fix the others in a separate PR after this one.markdownlint-cli2,prettier --checkandvitepress buildpass.