http

Documentation

Index

• type Header
• type Location
• type Map
• type MapParameter
• type ProxySSLVerify
• type Return
• type SSL
• type Server
• type SplitClient
• type SplitClientDistribution
• type StatusCode
• type Upstream
• type UpstreamServer

Types

type Header

type Header struct {
	Name  string
	Value string
}

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

type Location

type Location struct {
	Return          *Return
	ProxySSLVerify  *ProxySSLVerify
	Path            string
	ProxyPass       string
	HTTPMatchVar    string
	Rewrites        []string
	ProxySetHeaders []Header
}

Location holds all configuration for an HTTP location.

type Map

type Map struct {
	Source     string
	Variable   string
	Parameters []MapParameter
}

Map defines an NGINX map.

type MapParameter

type MapParameter struct {
	Value  string
	Result string
}

Parameter defines a Value and Result pair in a Map.

type ProxySSLVerify

type ProxySSLVerify struct {
	TrustedCertificate string
	Name               string
}

ProxySSLVerify holds the proxied HTTPS server verification configuration.

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
	Locations     []Location
	IsDefaultHTTP bool
	IsDefaultSSL  bool
	Port          int32
}

Server holds all configuration for an HTTP server.

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.