mirrors/caddy-website
1
0
Fork 0
mirror of https://github.com/caddyserver/website.git synced 2025-06-14 10:14:49 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add documentation for missing directives in active health checks (#470)

Browse source
This commit is contained in:
Jesper Brix Rosenkilde 2025-05-12 22:37:21 +02:00 • committed by GitHub
parent 78b4adfac6
commit 5e618b7677
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 15 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

24
src/docs/markdown/caddyfile/directives/reverse_proxy.md
View file

@ -71,15 +71,17 @@ reverse_proxy [<matcher>] [<upstreams...>] {
lb_retry_match <request-matcher>
# active health checking
health_uri <uri>
health_upstream <ip:port>
health_port <port>
health_interval <interval>
health_passes <num>
health_fails <num>
health_timeout <duration>
health_status <status>
health_body <regexp>
health_uri <uri>
health_upstream <ip:port>
health_port <port>
health_interval <interval>
health_passes <num>
health_fails <num>
health_timeout <duration>
health_method <method>
health_status <status>
health_request_body <body>
health_body <regexp>
health_follow_redirects
health_headers {
<field> [<values...>]
@ -339,8 +341,12 @@ Active health checks perform health checking in the background on a timer. To en
- **health_timeout** <span id="health_timeout"/> is a [duration value](/docs/conventions#durations) that defines how long to wait for a reply before marking the backend as down. Default: `5s`.
- **health_method** <span id="health_method"/> is the HTTP method to use for the active health check. Default: `GET`.
- **health_status** <span id="health_status"/> is the HTTP status code to expect from a healthy backend. Can be a 3-digit status code, or a status code class ending in `xx`. For example: `200` (which is the default), or `2xx`.
- **health_request_body** <span id="health_request_body"/> is a string representing the request body to send with the active health check.
- **health_body** <span id="health_body"/> is a substring or regular expression to match on the response body of an active health check. If the backend does not return a matching body, it will be marked as down.
- **health_follow_redirects** <span id="health_follow_redirects"/> will cause the health check to follow redirects provided by upstream. By default, a redirect response would cause the health check to count as a fail.