Uses Openresty - an nginx-compatible server distribution - to proxy requests to other Docker containers based on configured labels.
default:
com.dokku.app-name
An docker label to group server blocks by.
default: `` (none)
Set to true to enable debugging comments in the generated config files.
default:
true
When true, all requests to a domain where there is a port listener will be ignored. Set to false to allow openresty to handle the default domain normally.
default:
openresty.
The default prefix to use when looking up labels. All examples below assume the default label prefix.
default:
return true
The body of a function that returns whether or not the variable domain containing a domain name is allowed to have a letsencrypt ssl certificate provisioned.
default: `` (none)
The email to use for enabling letsencrypt (required).
default:
https://acme-v02.api.letsencrypt.org/directory
The certificate authority to use
default:
com.dokku.process-type
A secondary docker label to group process types within servers by.
default:
web
The value of the OPENRESTY_PROCESS_LABEL that denotes the primary web process to proxy.
default:
bridge
The default network to proxy requests to.
default: computed on container start
The default os page size to base default proxy values on.
The format of the openresty access log for the app.
The path - in the container - where the access logs will be written.
The IPv4 address - in the container - openresty will bind to when proxying requests.
The IPv6 address - in the container - openresty will bind to when proxying requests.
The value of client_max_body_size, used for limiting file upload size.
A space-delimited set of domains to proxy.
The path - in the container - where the error logs will be written.
Port treated as https when parsing port mappings.
The network name to use when proxying requests to the app container.
When set to true, this enables dynamic SSL certificate provisioning via Let's Encrypt for any https:443 port mappings. Note that the corresponding http:80 port mapping must exist in order for this to succeed.
Holds a space-delimited set of port mappings, where the port mapping is of the format $scheme:$host_port:$container_port. Supported schemes:
- grpc/grpcs: For grpc(s) proxying. Only labels that are explicitely called out are supported.
- tcp/udp: For stream proxying. Only labels that are explicitely called out are supported.
- http/https: For normal request proxying. Supports most labels unless otherwise specified.
Sets the size of the buffer proxy_buffer_size used for reading the first part of the response received from the proxied server. By default proxy buffer size is set as the pagesize.
Enable or disable proxy buffering proxy_buffering. By default proxy buffering is disabled in the NGINX config.
Sets the number of the buffers in proxy_buffers used for reading the first part of the response received from the proxied server. By default proxy buffers number is set as 4
Sets the size of the buffer proxy_busy_buffer_size used for reading the first part of the response received from the proxied server. By default proxy busy buffer size is set as twice the pagesize.
Defines a timeout for connect to a proxied server.
Defines a timeout for reading a response from the proxied server.
Defines a timeout for sending a request to the proxied server.
Defines a timeout for sending a response to the client.
- Add documentation for all labels
- Skip apps without domain
- Skip apps without proxy port mapping
