README
¶
Add PROXY protocol support to Caddy 2
proxy_protocol is a listener wrapper for Caddy 2 that adds support for PROXY headers on new connections.
Configuration
Options
| Name | Type | Default | Description |
|---|---|---|---|
timeout |
duration | 5s |
Specifies the maximum time for the PROXY header to be received. If zero, timeout is disabled. |
allow |
[]string | 0.0.0.0\0 |
A list of CIDR ranges to allow/require PROXY headers from. |
JSON
The wrapper needs to be loaded BEFORE the tls wrapper.
{
"apps": {
"http": {
"servers": {
"myserver": {
// ...
"listener_wrappers":[
{"wrapper": "proxy_protocol", "timeout": "5s", "allow": ["192.168.86/24"]},
{"wrapper":"tls"}
]
// ...
}
}
}
}
}
Caddyfile
The wrapper may be configured via global options in the Caddyfile.
{
servers {
listener_wrappers {
proxy_protocol {
timeout <duration>
allow <cidrs...>
}
tls
}
}
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Wrapper ¶
type Wrapper struct {
// Timeout specifies an optional maximum time for the PROXY header to be received. If zero, timeout is disabled. Default is 5s.
Timeout caddy.Duration `json:"timeout,omitempty"`
// Allow is an optional list of CIDR ranges to allow/require PROXY headers from.
Allow []string `json:"allow,omitempty"`
// contains filtered or unexported fields
}
Wrapper provides PROXY protocol support to Caddy by implementing the caddy.ListenerWrapper interface. It must be loaded before the `tls` listener.
func (Wrapper) CaddyModule ¶
func (Wrapper) CaddyModule() caddy.ModuleInfo
func (*Wrapper) UnmarshalCaddyfile ¶
UnmarshalCaddyfile sets up the listener wrapper from Caddyfile tokens. Syntax:
proxy_protocol {
timeout <duration>
allow <IPs...>
}
Source Files
Click to show internal directories.
Click to hide internal directories.