Documentation
¶
Overview ¶
Package fastcgi has middleware that acts as a FastCGI client. Requests that get forwarded to FastCGI stop the middleware execution chain. The most common use for this package is to serve PHP websites via php-fpm.
Index ¶
- Constants
- Variables
- type FCGIClient
- func (c *FCGIClient) Close()
- func (c *FCGIClient) Do(p map[string]string, req io.Reader) (r io.Reader, err error)
- func (c *FCGIClient) Get(p map[string]string) (resp *http.Response, err error)
- func (c *FCGIClient) Head(p map[string]string) (resp *http.Response, err error)
- func (c *FCGIClient) Options(p map[string]string) (resp *http.Response, err error)
- func (c *FCGIClient) Post(p map[string]string, method string, bodyType string, body io.Reader, l int) (resp *http.Response, err error)
- func (c *FCGIClient) PostFile(p map[string]string, data url.Values, file map[string]string) (resp *http.Response, err error)
- func (c *FCGIClient) PostForm(p map[string]string, data url.Values) (resp *http.Response, err error)
- func (c *FCGIClient) Request(p map[string]string, req io.Reader) (resp *http.Response, err error)
- type Handler
- type LogError
- type Rule
Constants ¶
const ( // BeginRequest is the begin request flag. BeginRequest uint8 = iota + 1 // AbortRequest is the abort request flag. AbortRequest // EndRequest is the end request flag. EndRequest // Params is the parameters flag. Params // Stdin is the standard input flag. Stdin // Stdout is the standard output flag. Stdout // Stderr is the standard error flag. Stderr // Data is the data flag. Data // GetValues is the get values flag. GetValues // GetValuesResult is the get values result flag. GetValuesResult // UnknownType is the unknown type flag. UnknownType // MaxType is the maximum type flag. MaxType = UnknownType )
const ( // Responder is the responder flag. Responder uint8 = iota + 1 // Authorizer is the authorizer flag. Authorizer // Filter is the filter flag. Filter )
const ( // RequestComplete is the completed request flag. RequestComplete uint8 = iota // CantMultiplexConns is the multiplexed connections flag. CantMultiplexConns // Overloaded is the overloaded flag. Overloaded // UnknownRole is the unknown role flag. UnknownRole )
const ( // MaxConns is the maximum connections flag. MaxConns string = "MAX_CONNS" // MaxRequests is the maximum requests flag. MaxRequests string = "MAX_REQS" // MultiplexConns is the multiplex connections flag. MultiplexConns string = "MPXS_CONNS" )
const FCGIHeaderLen uint8 = 8
FCGIHeaderLen describes header length.
const FCGIKeepConn uint8 = 1
FCGIKeepConn describes keep connection mode.
const FCGIListenSockFileno uint8 = 0
FCGIListenSockFileno describes listen socket file number.
const FCGINullRequestID uint8 = 0
FCGINullRequestID describes the null request ID.
const Version1 uint8 = 1
Version1 describes the version.
Variables ¶
var ( // ErrIndexMissingSplit describes an index configuration error. ErrIndexMissingSplit = errors.New("configured index file(s) must include split value") )
var UsePersistentFcgiConnections = true
UsePersistentFcgiConnections TODO: add an option in Caddyfile and pass it down to here
Functions ¶
This section is empty.
Types ¶
type FCGIClient ¶
type FCGIClient struct {
// contains filtered or unexported fields
}
FCGIClient implements a FastCGI client, which is a standard for interfacing external applications with Web servers.
func Dial ¶
func Dial(network, address string) (fcgi *FCGIClient, err error)
Dial connects to the fcgi responder at the specified network address, using default net.Dialer. See func net.Dial for a description of the network and address parameters.
func DialWithDialer ¶
func DialWithDialer(network, address string, dialer net.Dialer) (fcgi *FCGIClient, err error)
DialWithDialer connects to the fcgi responder at the specified network address, using custom net.Dialer. See func net.Dial for a description of the network and address parameters.
func (*FCGIClient) Do ¶
Do made the request and returns a io.Reader that translates the data read from fcgi responder out of fcgi packet before returning it.
func (*FCGIClient) Post ¶
func (c *FCGIClient) Post(p map[string]string, method string, bodyType string, body io.Reader, l int) (resp *http.Response, err error)
Post issues a POST request to the fcgi responder. with request body in the format that bodyType specified
func (*FCGIClient) PostFile ¶
func (c *FCGIClient) PostFile(p map[string]string, data url.Values, file map[string]string) (resp *http.Response, err error)
PostFile issues a POST to the fcgi responder in multipart(RFC 2046) standard, with form as a string key to a list values (url.Values), and/or with file as a string key to a list file path.
type Handler ¶
type Handler struct {
Next httpserver.Handler
Rules []Rule
Root string
AbsRoot string // same as root, but absolute path
FileSys http.FileSystem
// These are sent to CGI scripts in env variables
SoftwareName string
SoftwareVersion string
ServerName string
ServerPort string
}
Handler is a middleware type that can handle requests as a FastCGI client.
type LogError ¶
type LogError string
LogError is a non fatal error that allows requests to go through.
type Rule ¶
type Rule struct {
// The base path to match. Required.
Path string
// The address of the FastCGI server. Required.
Address string
// Always process files with this extension with fastcgi.
Ext string
// The path in the URL will be split into two, with the first piece ending
// with the value of SplitPath. The first piece will be assumed as the
// actual resource (CGI script) name, and the second piece will be set to
// PATH_INFO for the CGI script to use.
SplitPath string
// If the URL ends with '/' (which indicates a directory), these index
// files will be tried instead.
IndexFiles []string
// Environment Variables
EnvVars [][2]string
// Ignored paths
IgnoredSubPaths []string
}
Rule represents a FastCGI handling rule.
func (Rule) AllowedPath ¶
AllowedPath checks if requestPath is not an ignored path.
Source Files