latest--schema
shared| Type | object |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/roadrunner/_shared/latest--schema.json |
| Parent schema | roadrunner |
All the valid configuration parameters for the http plugin for RoadRunner.
Properties
Host and/or port to listen on for HTTP traffic. If omitted, RoadRunner will not listen for HTTP requests.
HTTP status code to use for internal RoadRunner errors. Defaults to 500 if omitted.
Maximum request size in MB. Defaults to 1 GB if zero or omitted.
Whether to send the raw, encoded body for application/x-www-form-urlencoded content. Defaults to sending decoded content to PHP workers.
Whether to enable HTTP access logs.
List of middleware to load for the HTTP plugin, executed in the specified order.
List of subnets from which incoming requests are allowed. Defaults to typical private network ranges (192.168., 10.0., and 172.16.) and local/loopback interfaces (127.).
[
"10.0.0.0/8",
"127.0.0.0/8",
"172.16.0.0/12",
"192.168.0.0/16",
"::1/128",
"fc00::/7",
"fe80::/10"
]File upload configuration.
3 nested properties
Directory for file uploads. Empty/undefined value means the OS default temporary directory ($TEMP) will be used, i.e. /tmp.
Disallow upload of files with the provided extensions.
Allow only upload of files with the provided extensions. Empty/undefined value means all files except explicitly disallowed (forbid) files are allowed.
[]HTTP header configuration.
3 nested properties
Controls which CORS headers are returned. Additional headers Vary: Origin, Vary: Access-Control-Request-Method and Vary: Access-Control-Request-Headers will be added to responses. Omit this section to disable CORS headers.
7 nested properties
Controls the value of 'Access-Control-Allow-Origin'.
Controls the value of 'Access-Control-Allow-Origin' header value, but evaluated as regex.
Controls the value of 'Access-Control-Allow-Headers'.
Controls the value of 'Access-Control-Allow-Methods'. Provide a comma-separated string of HTTP verbs.
Controls the value of 'Access-Control-Allow-Credentials'.
Controls the value of 'Access-Control-Expose-Headers'. Provide a comma-separated list of HTTP headers.
Controls the value of 'Access-Control-Max-Age' (in seconds).
Configuration options for serving static files.
7 nested properties
Path to the directory with static assets. Defaults to the current working directory. Empty/undefined and . are equal and are both treated as current directory.
File extensions of files that must not be served. Empty/undefined disallows no files. If files are specified in both forbid and allow, they will be disallowed. Defaults to an empty array, disallowing no files.
File extensions of files that may be served. Empty/undefined allows all files, except files specified in forbid.
Whether to enable ETag computation for static files.
Whether to use a weak generator (/W), which uses only the filename to generate a CRC32 sum for et ETag. Disable to use the file contents.
Settings required to set up manual or automatic HTTPS for your server. Either key and cert or acme is required, but not both.
7 nested properties
Host address/or port to bind to. Defaults to 127.0.0.1:443.
ACME certificates provider (Let's encrypt). Do not provide this parameter if you use key and cert.
7 nested properties
User email used to create a Let's Encrypt account. This is required.
List of domains to obtain certificates for. At least one domain is required.
Directory to use for certificates, private keys, Let's Encrypt configuration etc.
Alternate port for the HTTP challenge. Challenge traffic should be redirected to this port if overridden. See https://letsencrypt.org/docs/challenge-types/#http-01-challenge
Alternate port for the TLS-ALPN-01 challenge. Challenge traffic should be redirected to this port if overridden. See https://letsencrypt.org/docs/challenge-types/#tls-alpn-01
Challenge types
Whether to use the production endpoint. We recommend you use the staging endpoint to make sure everything works correctly before you deploy your certificate.
Whether to automatically redirect from HTTP to HTTPS.
Path to the private key for the certificate. Must not be provided if acme is set.
Path to the public certificate file. Must not be provided if acme is set.
Path to the CA certificate, if required. Always required for mTLS. Omit this option if unused. Must not be provided if acme is set.
Authorization method for mTLS.
Enables FastCGI support. If omitted, RoadRunner will not listen for FCGI requests.
1 nested properties
Host and/or port to listen on for FCGI requests.
HTTP/2 settings.
2 nested properties
Use HTTP/2 over non-encrypted TCP connection using H2C
Maximum number of concurrent streams. Defaults to 128 if omitted or zero.
HTTP/3 settings. Experimental: Requires that RoadRunner has experimental features enabled. Unless you configured acme, you must provide a key and cert here.
3 nested properties
Definitions
File upload configuration.
Directory for file uploads. Empty/undefined value means the OS default temporary directory ($TEMP) will be used, i.e. /tmp.
Disallow upload of files with the provided extensions.
Allow only upload of files with the provided extensions. Empty/undefined value means all files except explicitly disallowed (forbid) files are allowed.
[]Settings required to set up manual or automatic HTTPS for your server. Either key and cert or acme is required, but not both.
Host address/or port to bind to. Defaults to 127.0.0.1:443.
ACME certificates provider (Let's encrypt). Do not provide this parameter if you use key and cert.
7 nested properties
User email used to create a Let's Encrypt account. This is required.
List of domains to obtain certificates for. At least one domain is required.
Directory to use for certificates, private keys, Let's Encrypt configuration etc.
Alternate port for the HTTP challenge. Challenge traffic should be redirected to this port if overridden. See https://letsencrypt.org/docs/challenge-types/#http-01-challenge
Alternate port for the TLS-ALPN-01 challenge. Challenge traffic should be redirected to this port if overridden. See https://letsencrypt.org/docs/challenge-types/#tls-alpn-01
Challenge types
Whether to use the production endpoint. We recommend you use the staging endpoint to make sure everything works correctly before you deploy your certificate.
Whether to automatically redirect from HTTP to HTTPS.
Path to the private key for the certificate. Must not be provided if acme is set.
Path to the public certificate file. Must not be provided if acme is set.
Path to the CA certificate, if required. Always required for mTLS. Omit this option if unused. Must not be provided if acme is set.
Authorization method for mTLS.
Authorization method for mTLS.
Enables FastCGI support. If omitted, RoadRunner will not listen for FCGI requests.
Host and/or port to listen on for FCGI requests.
HTTP/2 settings.
Use HTTP/2 over non-encrypted TCP connection using H2C
Maximum number of concurrent streams. Defaults to 128 if omitted or zero.
HTTP/3 settings. Experimental: Requires that RoadRunner has experimental features enabled. Unless you configured acme, you must provide a key and cert here.