mirror of
https://github.com/caddyserver/website.git
synced 2025-04-22 21:16:15 -04:00
docs: status
option for file_server
, health_uri
for reverse_proxy
(#156)
This commit is contained in:
parent
452537adea
commit
c1383e7981
2 changed files with 9 additions and 7 deletions
|
@ -17,6 +17,7 @@ file_server [<matcher>] [browse] {
|
||||||
index <filenames...>
|
index <filenames...>
|
||||||
browse [<template_file>]
|
browse [<template_file>]
|
||||||
precompressed <formats...>
|
precompressed <formats...>
|
||||||
|
status <status>
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -27,6 +28,7 @@ file_server [<matcher>] [browse] {
|
||||||
- **<template_file>** is an optional custom template file to use for directory listings. Defaults to the template that can be found [here in the source code ](https://github.com/caddyserver/caddy/blob/master/modules/caddyhttp/fileserver/browsetpl.go).
|
- **<template_file>** is an optional custom template file to use for directory listings. Defaults to the template that can be found [here in the source code ](https://github.com/caddyserver/caddy/blob/master/modules/caddyhttp/fileserver/browsetpl.go).
|
||||||
- **precompressed** is the list of encoding formats to search for precompressed sidecar files.
|
- **precompressed** is the list of encoding formats to search for precompressed sidecar files.
|
||||||
- **<formats...>** is the ordered list of encoding formats to search for precompressed sidecar files. Supported formats are `gzip`, `zstd` and `br`.
|
- **<formats...>** is the ordered list of encoding formats to search for precompressed sidecar files. Supported formats are `gzip`, `zstd` and `br`.
|
||||||
|
- **status** is an optional status code override to be used when writing the response. Particularly useful when responding to a request with a custom error page. Can be a 3-digit status code, For example: `404`. Placeholders are supported. By default, the written status code will typically be `200`, or `206` for partial content.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -34,7 +34,7 @@ reverse_proxy [<matcher>] [<upstreams...>] {
|
||||||
lb_try_interval <interval>
|
lb_try_interval <interval>
|
||||||
|
|
||||||
# active health checking
|
# active health checking
|
||||||
health_path <path>
|
health_uri <uri>
|
||||||
health_port <port>
|
health_port <port>
|
||||||
health_interval <interval>
|
health_interval <interval>
|
||||||
health_timeout <duration>
|
health_timeout <duration>
|
||||||
|
@ -119,11 +119,11 @@ Load balancing is used whenever more than one upstream is defined.
|
||||||
|
|
||||||
Active health checks perform health checking in the background on a timer:
|
Active health checks perform health checking in the background on a timer:
|
||||||
|
|
||||||
- **health_path** is the URI path for active health checks.
|
- **health_uri** is the URI path (and optional query) for active health checks.
|
||||||
- **health_port** is the port to use for active health checks, if different from the upstream's port.
|
- **health_port** is the port to use for active health checks, if different from the upstream's port.
|
||||||
- **health_interval** is a [duration value](/docs/conventions#durations) that defines how often to perform active health checks.
|
- **health_interval** is a [duration value](/docs/conventions#durations) that defines how often to perform active health checks.
|
||||||
- **health_timeout** is a [duration value](/docs/conventions#durations) that defines how long to wait for a reply before marking the backend as down.
|
- **health_timeout** is a [duration value](/docs/conventions#durations) that defines how long to wait for a reply before marking the backend as down.
|
||||||
- **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` (default) or `2xx`.
|
- **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_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_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_headers** allows specifying headers to set on the active health check requests. This is useful if you need to change the `Host` header, or if you need to provide some authentication to your backend as part of your health checks.
|
- **health_headers** allows specifying headers to set on the active health check requests. This is useful if you need to change the `Host` header, or if you need to provide some authentication to your backend as part of your health checks.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue