You are viewing a previous version of KrakenD Community Edition (v2.5), go to the
latest version
Document updated on Feb 16, 2022
HTTP Server Settings
KrakenD starts an HTTP server to offer the API Gateway server. You can personalize some of the settings used to start the service and also override the default settings of the underlying Go standard library.
If you want to customize any of the settings below, they must be written at the top level of the configuration.
Fields of "false"
* required fields
cache_ttlstring- Sets a default
Cache-Control: public, max-age=%dheader to all endpoints where%dis the conversion to seconds of any duration you write, indicating for how long the client (or CDN) can cache the content of the request. You can override this value per endpoint, but setting an endpoint to 0 will use the default value instead. Notice that KrakenD does not cache the content with this parameter, but tells the client how to do it. Defaults to0s(no cache). For KrakenD cache, see backend caching.Specify units usingns(nanoseconds),usorµs(microseconds),ms(milliseconds),s(seconds),m(minutes), orh(hours).Defaults to"0s" idle_timeoutstring- The maximum amount of time to wait for the next request when keep-alives are enabled. If
idle_timeoutis zero, the value ofread_timeoutis used. If both are zero, there is no timeout.Specify units usingns(nanoseconds),usorµs(microseconds),ms(milliseconds),s(seconds),m(minutes), orh(hours).Defaults to"0s" listen_ipstring- The IP address that KrakenD listens to in IPv4 or IPv6. An empty string, or no declaration at all means listening on all interfaces. The inclusion of
::is meant for IPv6 format only (this is not the port). Examples of valid addresses are192.0.2.1(IPv4),2001:db8::68(IPv6). The values::and0.0.0.0listen to all addresses and both are valid for IPv4 and IPv6 simultaneously.Examples:"172.12.1.1","::1"Defaults to"0.0.0.0" portinteger- The TCP port where KrakenD is listening to. Recommended value is in the range 1024-65535 to run as an unpriviliged userDefaults to
8080 read_header_timeoutstring- The amount of time allowed to read request headers. The connection’s read deadline is reset after reading the headers and the Handler can decide what is considered too slow for the body.Specify units using
ns(nanoseconds),usorµs(microseconds),ms(milliseconds),s(seconds),m(minutes), orh(hours).Defaults to"0s" read_timeoutstring- Is the maximum duration for reading the entire request, including the body. Because
read_timeoutdoes not let Handlers make per-request decisions on each request body’s acceptable deadline or upload rate, most users will prefer to useread_header_timeout. It is valid to use them both.Specify units usingns(nanoseconds),usorµs(microseconds),ms(milliseconds),s(seconds),m(minutes), orh(hours).Defaults to"0s" sequential_startboolean- A sequential start registers all async agents in order, allowing you to have the starting logs in sequential order. A non-sequential start is much faster, but logs are harder to follow.Defaults to
false use_h2cboolean- Enable the support for HTTP/2 with no TLS (clear text). This option is less secure and less performant, use with caution.Defaults to
false write_timeoutstring- Maximum duration before timing out writes of the response.Specify units using
ns(nanoseconds),usorµs(microseconds),ms(milliseconds),s(seconds),m(minutes), orh(hours).Defaults to"0s"
Override settings using environment vars
When you declare in the configuration file any of the HTTP server settings declared above, you can override its value through environment variables when starting the server.
All the environment variables have the same name are the same settings above in uppercase and with the KRAKEND_ preffix. For instance, looking at the list of settings above, you could override:
KRAKEND_PORTKRAKEND_READ_TIMEOUTKRAKEND_READ_HEADER_TIMEOUTKRAKEND_WRITE_TIMEOUTKRAKEND_IDLE_TIMEOUTKRAKEND_USE_H2C- etc…
You can start KrakenD with the desired variables to override what you have in the configuration:
Term
$KRAKEND_PORT=8000 KRAKEND_READ_TIMEOUT="1s" krakend run -c krakend.json
