Repository navigation
Replace /health with /livez and /readyz probes (v3) - #19
Merged
Merged
Conversation
Document the Kubernetes-style `/livez` (liveness) and `/readyz` (readiness) health endpoints that replace `/health` in v3, and add the change to the v2 to v3 migration guide. 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 | 66bf88b | Commit Preview URL Branch Preview URL |
Oct 31 2026, 12:58 PM |
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
joseluisq
changed the title
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 health endpoints change from static-web-server/static-web-server#751. With
--health, SWS now serves the Kubernetes-style/livez(liveness) and/readyz(readiness) probes, and no longer serves/health.features/health-endpoint.md: rewritten. Covers both paths, CLI/env/TOML forms,GET/HEADbehavior (text/plainOKbody), query string handling, exact path matching, other methods,debug-level logging, acurl -iexample, interactions with CORS, Basic auth, maintenance mode, redirects, rewrites and custom headersscope = "all", and a Kubernetes example with both probes. A warning box links to the migration guide.features/health-endpoint.md,features/graceful-shutdown.md:/readyzreturns503during the grace period; a "With TLS" section (probe the TLS port withscheme: HTTPS, not the--https-redirectport).migration-guide.md: new breaking change "10. Health endpoint replaced by/livezand/readyz" and a checklist item.features/docker.md: Kubernetes example uses/livezand/readyz(and names thehttpport the probes reference).configuration/cli.md,configuration/env.md,configuration/file.md,defaults.md,index.md,features/logging.md,features/custom-http-headers.md:/healthreplaced with the new paths;--healthhelp text matches the binary.Merge only together with (or after) static-web-server/static-web-server#751.
yarn format:check(markdownlint-cli2andprettier --check) passes locally.🤖 Generated with Claude Code