Introduced in 0.5.0, Enhanced in 0.6.0
proxy:build-config [--parallel count] [--all|<app>] # (Re)builds config for given app proxy:clear-config [--all|<app>] # Clears config for given app proxy:disable [--parallel count] [--all|<app>] # Disable proxy for app proxy:enable [--parallel count] [--all|<app>] # Enable proxy for app proxy:report [<app>] [<flag>] # Displays a proxy report for one or more apps proxy:set <app> <proxy-type> # Set proxy type for app
In Dokku 0.5.0, port proxying was decoupled from the
nginx-vhosts plugin into the proxy plugin. Dokku 0.6.0 introduced the ability to map host ports to specific container ports. In the future this will allow other proxy software - such as HAProxy or Caddy - to be used in place of nginx.
Regenerating proxy config
In certain cases, your app proxy configs may drift from the correct config for your app. You may regenerate the config at any point via the
proxy:build-config command. This command will trigger a rebuild for the configured proxy implementation (default: nginx) for a given app. The command may fail if there are no current web listeners for your app.
All apps may have their proxy config rebuilt by using the
By default, rebuilding proxy configs for all apps happens serially. The parallelism may be controlled by the
Finally, the number of parallel workers may be automatically set to the number of CPUs available by setting the
--parallel flag to
Clearing the generated proxy config
Introduced in 0.27.0
Generated proxy configurations can also be cleared using the
All apps may have their proxy config cleared by using the
Clearing a proxy configuration has different effects depending on the proxy plugin in use. Consul the documentation for your proxy implementation for further details.
Displaying proxy reports for an app
Introduced in 0.8.1
You can get a report about the app's proxy status using the
=====> node-js-app proxy information Proxy enabled: true Proxy type: nginx Proxy port map: http:80:5000 https:443:5000 =====> python-sample proxy information Proxy enabled: true Proxy type: nginx Proxy port map: http:80:5000 =====> ruby-sample proxy information Proxy enabled: true Proxy type: nginx Proxy port map: http:80:5000
You can run the command for a specific app also.
You can pass flags which will output only the value of the specific information you want. For example:
Proxy Port Scheme
The proxy port scheme is as follows:
The scheme metadata can be used by proxy implementations in order to properly handle proxying of requests. For example, the built-in
nginx-vhosts proxy implementation supports the
grpcs see nginx blog post on grpc.
Developers of proxy implementations are encouraged to use whatever schemes make the most sense, and ignore configurations which they do not support. For instance, a
udp proxy implementation can safely ignore
https port mappings.
To change the proxy implementation in use for an application, use the
Proxy port mapping
See the port management documentation for more information on how port mappings are managed for an application.
Container network interface binding
Changed as of 0.11.0
From Dokku versions
0.11.0, enabling or disabling an application's proxy would also control whether or not the application was bound to all interfaces - e.g.
0.0.0.0. As of
0.11.0, this is now controlled by the network plugin. Please see the network documentation for more information.