docs: document plugin properties migrated from env vars
Per-plugin management docs now describe the properties introduced by the env-var-to-property migration in PR #8498, and stale prose and command-output examples that still referenced the old `DOKKU_*` names have been refreshed. The deprecated env vars table moves out of `environment-variables.md` and into the 0.38.0 migration guide, where it functions as a one-time pointer for upgrading users rather than ongoing reference material.
This commit is contained in:
@@ -333,8 +333,8 @@ Unsetting this value is the same as enabling custom nginx config usage.
|
||||
{{ .APP }} Application name
|
||||
{{ .APP_SSL_PATH }} Path to SSL certificate and key
|
||||
{{ .DOKKU_ROOT }} Global Dokku root directory (ex: app dir would be `{{ .DOKKU_ROOT }}/{{ .APP }}`)
|
||||
{{ .PROXY_PORT }} Non-SSL nginx listener port (same as `DOKKU_PROXY_PORT` config var)
|
||||
{{ .PROXY_SSL_PORT }} SSL nginx listener port (same as `DOKKU_PROXY_SSL_PORT` config var)
|
||||
{{ .PROXY_PORT }} Non-SSL nginx listener port (same as the `proxy-port` property)
|
||||
{{ .PROXY_SSL_PORT }} SSL nginx listener port (same as the `proxy-ssl-port` property)
|
||||
{{ .NOSSL_SERVER_NAME }} List of non-SSL VHOSTS
|
||||
{{ .PROXY_PORT_MAP }} List of port mappings (same as the `map` ports property)
|
||||
{{ .PROXY_UPSTREAM_PORTS }} List of configured upstream ports (derived from the `map` ports property)
|
||||
|
||||
@@ -9,7 +9,7 @@ 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>|--global] <proxy-type> # Set proxy type for app
|
||||
proxy:set [<app>|--global] <key> (<value>) # Set or clear a proxy property for an 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. This allows other proxy software - such as HAProxy or Caddy - to be used in place of nginx.
|
||||
@@ -25,8 +25,7 @@ dokku proxy:set node-js-app caddy
|
||||
```
|
||||
|
||||
```
|
||||
-----> Setting config vars
|
||||
DOKKU_APP_PROXY_TYPE: caddy
|
||||
=====> Setting type to caddy
|
||||
```
|
||||
|
||||
The proxy may also be set on a global basis. This is usually preferred as running multiple proxy implementations may cause port collision issues.
|
||||
@@ -36,12 +35,55 @@ dokku proxy:set --global caddy
|
||||
```
|
||||
|
||||
```
|
||||
-----> Setting config vars
|
||||
DOKKU_PROXY_TYPE: caddy
|
||||
=====> Setting type to caddy
|
||||
```
|
||||
|
||||
Changing the proxy does not stop or start any given proxy implementation. Please see the documentation for your proxy implementation for details on how to perform a change.
|
||||
|
||||
### Disabling and enabling the proxy
|
||||
|
||||
The proxy can be disabled on a per-app basis via the `proxy:disable` command. While disabled, no proxy configuration will be generated for the app and incoming requests will not be routed through the configured proxy.
|
||||
|
||||
```shell
|
||||
dokku proxy:disable node-js-app
|
||||
```
|
||||
|
||||
```
|
||||
-----> Disabling proxy for app
|
||||
```
|
||||
|
||||
The proxy can be re-enabled with the `proxy:enable` command:
|
||||
|
||||
```shell
|
||||
dokku proxy:enable node-js-app
|
||||
```
|
||||
|
||||
```
|
||||
-----> Enabling proxy for app
|
||||
```
|
||||
|
||||
### Setting proxy ports
|
||||
|
||||
When an app's domains are disabled (see [domains documentation](/docs/configuration/domains.md)), Dokku still exposes the app on a high port so that internal services can reach it at a stable port across deploys. The non-SSL and SSL ports used for this can be configured via the `proxy:set` command:
|
||||
|
||||
```shell
|
||||
dokku proxy:set node-js-app proxy-port 5000
|
||||
dokku proxy:set node-js-app proxy-ssl-port 5443
|
||||
```
|
||||
|
||||
Either property may also be set globally. Per-app values take precedence over the global value.
|
||||
|
||||
```shell
|
||||
dokku proxy:set --global proxy-port 5000
|
||||
dokku proxy:set --global proxy-ssl-port 5443
|
||||
```
|
||||
|
||||
The default value for either property may be restored by passing an empty value:
|
||||
|
||||
```shell
|
||||
dokku proxy:set node-js-app proxy-port
|
||||
```
|
||||
|
||||
### 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.
|
||||
|
||||
Reference in New Issue
Block a user