Skip to content

Commit b31ddb9

Browse files
authored
[chore] Add missing config option in confighttp documentation (#14285)
1 parent 97fcd3d commit b31ddb9

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

config/confighttp/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ configuration. For more information, see [configtls
1515
README](../configtls/README.md).
1616

1717
- `endpoint`: address:port
18+
- `proxy_url`: Proxy URL to use for HTTP requests
1819
- [`tls`](../configtls/README.md)
1920
- [`headers`](https://pkg.go.dev/net/http#Request): name/value pairs added to the HTTP request headers
2021
- certain headers such as Content-Length and Connection are automatically written when needed and values in Header may be ignored.
@@ -107,8 +108,15 @@ will not be enabled.
107108
not set, browsers use a default of 5 seconds.
108109
- `endpoint`: Valid value syntax available [here](https://github.com/grpc/grpc/blob/master/doc/naming.md)
109110
- `max_request_body_size`: configures the maximum allowed body size in bytes for a single request. Default: `20971520` (20MiB)
111+
- `include_metadata`: propagates the client metadata from the incoming requests to the downstream consumers. Default: `false`
112+
- `response_headers`: Additional headers attached to each HTTP response sent to the client. Header values are opaque since they may be sensitive
110113
- `compression_algorithms`: configures the list of compression algorithms the server can accept. Default: ["", "gzip", "zstd", "zlib", "snappy", "deflate", "lz4"]
111114
- `x-snappy-framed` can be used if feature gate `confighttp.snappyFramed` is enabled.
115+
- `read_timeout`: maximum duration for reading the entire request, including the body. A zero or negative value means there will be no timeout. Default: `0` (no timeout)
116+
- `read_header_timeout`: amount of time allowed to read request headers. If zero, the value of `read_timeout` is used. If both are zero, there is no timeout. Default: `1m`
117+
- `write_timeout`: maximum duration before timing out writes of the response. A zero or negative value means there will be no timeout. Default: `30s`
118+
- `idle_timeout`: maximum amount of time to wait for the next request when keep-alives are enabled. If zero, the value of `read_timeout` is used. If both are zero, there is no timeout. Default: `1m`
119+
- `keep_alives_enabled`: controls whether HTTP keep-alives are enabled. Default: `true`
112120
- [`tls`](../configtls/README.md)
113121
- [`auth`](../configauth/README.md)
114122
- `request_params`: a list of query parameter names to add to the auth context, along with the HTTP headers

0 commit comments

Comments
 (0)