Directive reference
Reference pages for the configuration surface implemented by the public beta. This index grows from the facade and its executable tests.
31 detailed entries are published today. The compatibility summary lists additional implemented directive families while their individual reference pages are being filled in.
main
events
any
server
listenSelects the address, port and protocol for a server. locationSelects configuration by request URI. returnStops processing and returns a status, redirect or response body. rewriteMatches and rewrites a URI using a regular expression. server_nameNames the virtual hosts handled by a server block. try_filesTests candidate files and falls back to a URI, named location or status. http
access_logSelects the access-log destination and format. auth_basicProtects a scope with HTTP Basic authentication. client_body_timeoutSets the maximum gap between reads of a client request body. client_max_body_sizeLimits the size of a client request body. gzipEnables gzip response compression. indexDefines files tried for a directory request. keepalive_requestsLimits requests served on one client connection. keepalive_timeoutControls how long an idle client connection remains open. limit_reqApplies a request-rate zone to a context. proxy_http_versionSelects the HTTP version used to an upstream. proxy_set_headerAdds, replaces or suppresses a request header sent upstream. rootBuilds a filesystem path by appending the request URI. ssl_certificateLoads the PEM certificate chain for a TLS server. ssl_protocolsEnables TLS protocol versions. upstreamDeclares a named pool of backend servers. location
aliasReplaces the matched location with a filesystem path. fastcgi_passSends a request to a FastCGI responder. grpc_passProxies a request to a gRPC backend. proxy_passForwards a request to an HTTP or HTTPS upstream. scgi_passSends a request to an SCGI application. uwsgi_passSends a request to a uwsgi-protocol application.