Couper Documentation

edge

Settings

The settings block lets you configure the more basic and global behavior of your gateway instance.

Attributes

NameTypeDefaultDescription
accept_forwarded_url
tuple (string)
[]

Which X-Forwarded-* request HTTP header fields should be accepted to change the request variables url, origin, protocol, host, port. Valid values: "proto", "host" and "port". The port in a X-Forwarded-Port header takes precedence over a port in X-Forwarded-Host. Affects relative URL values for sp_acs_url attribute and redirect_uri attribute within beta_oauth2 and oidc.

beta_metrics
bool
false

Enables the Prometheus metrics exporter.

beta_metrics_port
number
9090

Prometheus exporter listen port.

beta_service_name
string
"couper"

Service name which applies to the service_name metric labels.

bind_address
string
"*"

A comma-separated list of addresses to bind.

ca_file
string
-

Adds the given PEM encoded CA certificate to the existing system certificate pool for all outgoing connections.

default_port
number
8080

Port which will be used if not explicitly specified per host within the hosts attribute.

environment
string
-

The environment Couper is to run in.

health_path
string
"/healthz"

Health path for all configured servers and ports.

https_dev_proxy
tuple (string)
[]

TLS port mappings to define the TLS listen port and the target one. Self-signed certificates will be generated on the fly based on the given hostname. Certificates will be held in memory.

log_format
string
"common"

Tab/field based colored logs or JSON logs: "common" or "json".

log_level
string
"info"

Sets the log level: "panic", "fatal", "error", "warn", "info", "debug", "trace".

log_pretty
bool
false

Global option for json log format which pretty prints with basic key coloring.

no_proxy_from_env
bool
false

Disables the connect hop to configured proxy via environment.

pprof
bool
false

Enables profiling.

pprof_port
number
6060

Port for profiling interface.

request_id_accept_from_header
string
-

Client request HTTP header field that transports the request.id which Couper takes for logging and transport to the backend (if configured).

request_id_backend_header
string
"Couper-Request-ID"

HTTP header field which Couper uses to transport the request.id to the backend.

request_id_client_header
string
"Couper-Request-ID"

HTTP header field which Couper uses to transport the request.id to the client.

request_id_format
string
"common"

If set to "uuid4" an RFC 4122 UUID is used for request.id and related log fields. Valid values: "common" or "uuid4".

secure_cookies
string
"‌"

If set to "strip", the Secure flag is removed from all Set-Cookie HTTP header fields. Valid values: "" or "strip".

server_timing_header
bool
false

If enabled, Couper includes an additional Server-Timing HTTP response header field detailing connection and transport relevant metrics for each backend request.

xfh
bool
false

Whether to use the X-Forwarded-Host header as the request host.