Repository navigation
Conversation
Bring the v3 docs in line with static-web-server master (v3.0.0-beta.2 plus unreleased changes): - New defaults: port 8080, root `.`, HTTPS redirect port 8080, and the dual-stack `::` host - Document `--open`/`--open-path` and `--directory-listing-format=auto` - Trusted proxies trust no one by default; metrics labels are bounded and exclude probes; `/readyz` fails while the root is missing - Basic auth only skips CORS preflights; `Vary: Accept` for markdown negotiation; when compression is skipped; pre-compression is on by default; symlink checks apply to the file actually served - Rebuild the TOML manifest with every current key and default - Extend the migration guide with the missing breaking changes - Fix the `env#server_*` anchors, which never matched VitePress slugs Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
static-web-server-docs | 316da6d | Commit Preview URL Branch Preview URL |
Nov 09 2026, 01:15 AM |
This branch has not been deployed
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.
Syncs the v3 docs with static-web-server
master(v3.0.0-beta.2 plus unreleased changes up to static-web-server/static-web-server#804). It covers what earlier docs PRs (#15–#21) did not.Changes
New defaults (static-web-server/static-web-server#733, #804)
8080, root.and HTTPS redirect port8080across the CLI, env, TOML, defaults, quick start and examples. Docker tags bumped to3.0.0-beta.2.::host accepts IPv6 and IPv4 (dual-stack).Features not yet documented
--open,--open-path, #747), added to the sidebar and the features index.--directory-listing-format=auto, which negotiates the format with theAcceptheader and addsVary: Accept(#738).Behavior changes from recent fixes
--trusted-proxiesnow trusts no one, IPv4-mapped addresses match, and proxy headers are never logged over a UDS.GET/HEAD/OPTIONS/other, and the virtual-host name orother)./metricsand health probes are not counted (#792)./readyzreturns503while the root directory is missing (#793).Vary: Accepton HTML and markdown responses (#789, #798).< 200bytes,206, no content), theq=0handling andHEADparity. Pre-compression page: it is enabled by default (the page said disabled), and.gzis served only forgzip..htmlsibling).GET/HEADuse the cache.Configuration reference
cli.rs. A script checked every description and default against upstream.[general]key and default. It used to show v2 keys such ashttp2-tls-cert, plus port80and root./public. Added astatus/scopeheader example.unix-socket-modeTOML examples now use0o660: a bare660is read as decimal.Migration guide
8080,.) and the security-headers/HSTS wording.Cache-Controlfor HTML, the fallback page keeping404for assets, and dual-stack binding.Links
env#server_*links that never resolved: VitePress slugs these headings with hyphens (#server-health).Checks
yarn format:check(markdownlint + prettier) passes.yarn docs:buildpasses, and all new and fixed anchors are present in the built HTML.Notes for review
static-web-server -hcomparison is worth doing.--cors-expose-headershelp still says it requires--cors-expose-origins(should be--cors-allow-origins). The docs keep the help output verbatim.., no Dockerfile setsSERVER_ROOT. The images may serve their working directory (/home/sws, or/for scratch) rather than/public. The Docker page still describes/public.🤖 Generated with Claude Code