Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ListenerWrapper ¶
type ListenerWrapper 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
}
ListenerWrapper provides PROXY protocol support to Caddy by implementing the caddy.ListenerWrapper interface. It must be loaded before the `tls` listener.
Credit goes to https://github.com/mastercactapus/caddy2-proxyprotocol for having initially implemented this as a plugin.
func (ListenerWrapper) CaddyModule ¶
func (ListenerWrapper) CaddyModule() caddy.ModuleInfo
func (*ListenerWrapper) Provision ¶
func (pp *ListenerWrapper) Provision(ctx caddy.Context) error
Provision sets up the listener wrapper.
func (*ListenerWrapper) UnmarshalCaddyfile ¶
func (w *ListenerWrapper) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
UnmarshalCaddyfile sets up the listener Listenerwrapper from Caddyfile tokens. Syntax:
proxy_protocol {
timeout <duration>
allow <IPs...>
}
func (*ListenerWrapper) WrapListener ¶
func (pp *ListenerWrapper) WrapListener(l net.Listener) net.Listener
WrapListener adds PROXY protocol support to the listener.
Source Files
Click to show internal directories.
Click to hide internal directories.