Skip to content

docs: document the --idle-timeout option (v3) - #15

Open
spantaleev wants to merge 1 commit into
static-web-server:masterfrom
spantaleev:idle-timeout
Open

spantaleev wants to merge 1 commit into
static-web-server:masterfrom
spantaleev:idle-timeout

Conversation

@spantaleev

Copy link
Copy Markdown

Description

v3 docs for the --idle-timeout option (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 --check and vitepress build pass.

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>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant