summaryrefslogtreecommitdiff
path: root/modules/caddyhttp/reverseproxy/caddyfile.go
diff options
context:
space:
mode:
authorFrancis Lavoie <lavofr@gmail.com>2022-03-13 01:38:11 -0500
committerGitHub <noreply@github.com>2022-03-13 01:38:11 -0500
commita9c7e94a38e4f4719a5c1cf7f3e11e8cf427f04e (patch)
treeef09257fc3517682dfe60d20b48d860df7b5bde6 /modules/caddyhttp/reverseproxy/caddyfile.go
parent3d616e8c6d65e5617f5a918d72fb1514c9c7144e (diff)
chore: Comment fixes (#4634)
Diffstat (limited to 'modules/caddyhttp/reverseproxy/caddyfile.go')
-rw-r--r--modules/caddyhttp/reverseproxy/caddyfile.go38
1 files changed, 25 insertions, 13 deletions
diff --git a/modules/caddyhttp/reverseproxy/caddyfile.go b/modules/caddyhttp/reverseproxy/caddyfile.go
index cab0a71..af0c564 100644
--- a/modules/caddyhttp/reverseproxy/caddyfile.go
+++ b/modules/caddyhttp/reverseproxy/caddyfile.go
@@ -53,8 +53,8 @@ func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error)
// UnmarshalCaddyfile sets up the handler from Caddyfile tokens. Syntax:
//
// reverse_proxy [<matcher>] [<upstreams...>] {
-// # upstreams
-// to <upstreams...>
+// # backends
+// to <upstreams...>
// dynamic <name> [...]
//
// # load balancing
@@ -63,26 +63,28 @@ func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error)
// lb_try_interval <interval>
//
// # active health checking
-// health_uri <uri>
-// health_port <port>
+// health_uri <uri>
+// health_port <port>
// health_interval <interval>
-// health_timeout <duration>
-// health_status <status>
-// health_body <regexp>
+// health_timeout <duration>
+// health_status <status>
+// health_body <regexp>
// health_headers {
// <field> [<values...>]
// }
//
// # passive health checking
-// max_fails <num>
-// fail_duration <duration>
-// max_conns <num>
-// unhealthy_status <status>
+// fail_duration <duration>
+// max_fails <num>
+// unhealthy_status <status>
// unhealthy_latency <duration>
+// unhealthy_request_count <num>
//
// # streaming
// flush_interval <duration>
// buffer_requests
+// buffer_responses
+// max_buffer_size <size>
//
// # header manipulation
// trusted_proxies [private_ranges] <ranges...>
@@ -94,14 +96,23 @@ func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error)
// ...
// }
//
-// # intercepting responses
+// # optionally intercept responses from upstream
// @name {
// status <code...>
// header <field> [<value>]
// }
-// replace_status <matcher> <status_code>
+// replace_status [<matcher>] <status_code>
// handle_response [<matcher>] {
// <directives...>
+//
+// # special directives only available in handle_response
+// copy_response [<matcher>] [<status>] {
+// status <status>
+// }
+// copy_response_headers [<matcher>] {
+// include <fields...>
+// exclude <fields...>
+// }
// }
// }
//
@@ -1073,6 +1084,7 @@ func parseCopyResponseHeadersCaddyfile(h httpcaddyfile.Helper) (caddyhttp.Middle
// UnmarshalCaddyfile sets up the handler from Caddyfile tokens. Syntax:
//
// copy_response_headers [<matcher>] {
+// include <fields...>
// exclude <fields...>
// }
//