http

Documentation

Index

• Constants
• type Header
• type Location
• type LocationType
• type ProxySSLVerify
• type ResponseHeaders
• type Return
• type SSL
• type Server
• type ServerConfig
• type SplitClient
• type SplitClientDistribution
• type StatusCode
• type Upstream
• type UpstreamServer

Constants

const (
	InternalRoutePathPrefix = "/_ngf-internal"
	HTTPSScheme             = "https"
)

Types

type Header

type Header struct {
	Name  string
	Value string
}

Header defines an HTTP header to be passed to the proxied server.

type Location

type Location struct {
	Path            string
	ProxyPass       string
	HTTPMatchKey    string
	Type            LocationType
	ProxySetHeaders []Header
	ProxySSLVerify  *ProxySSLVerify
	Return          *Return
	ResponseHeaders ResponseHeaders
	Rewrites        []string
	Includes        []shared.Include
	GRPC            bool
}

Location holds all configuration for an HTTP location.

type LocationType

type LocationType string

const (
	InternalLocationType LocationType = "internal"
	ExternalLocationType LocationType = "external"
	RedirectLocationType LocationType = "redirect"
)

type ProxySSLVerify

type ProxySSLVerify struct {
	TrustedCertificate string
	Name               string
}

ProxySSLVerify holds the proxied HTTPS server verification configuration.

type ResponseHeaders

type ResponseHeaders struct {
	Add    []Header
	Set    []Header
	Remove []string
}

ResponseHeaders holds all response headers to be added, set, or removed.

type Return

type Return struct {
	Body string
	Code StatusCode
}

Return represents an HTTP return.

type SSL

type SSL struct {
	Certificate    string
	CertificateKey string
}

SSL holds all SSL related configuration.

type Server

type Server struct {
	SSL           *SSL
	ServerName    string
	Listen        string
	Locations     []Location
	Includes      []shared.Include
	IsDefaultHTTP bool
	IsDefaultSSL  bool
	GRPC          bool
	IsSocket      bool
}

Server holds all configuration for an HTTP server.

type ServerConfig

type ServerConfig struct {
	Servers         []Server
	RewriteClientIP shared.RewriteClientIPSettings
	IPFamily        shared.IPFamily
	Plus            bool
}

ServerConfig holds configuration for an HTTP server and IP family to be used by NGINX.

type SplitClient

type SplitClient struct {
	VariableName  string
	Distributions []SplitClientDistribution
}

SplitClient holds all configuration for an HTTP split client.

type SplitClientDistribution

type SplitClientDistribution struct {
	Percent string
	Value   string
}

SplitClientDistribution maps Percentage to Value in a SplitClient.

type StatusCode

type StatusCode int

StatusCode is an HTTP status code.

const (
	// StatusFound is the HTTP 302 status code.
	StatusFound StatusCode = 302
	// StatusNotFound is the HTTP 404 status code.
	StatusNotFound StatusCode = 404
	// StatusInternalServerError is the HTTP 500 status code.
	StatusInternalServerError StatusCode = 500
)

type Upstream

type Upstream struct {
	Name     string
	ZoneSize string // format: 512k, 1m
	Servers  []UpstreamServer
}

Upstream holds all configuration for an HTTP upstream.

type UpstreamServer

type UpstreamServer struct {
	Address string
}

UpstreamServer holds all configuration for an HTTP upstream server.