dokku_proxy_toggle.md

dokku_proxy_toggle

Synopsis

Enables or disables the proxy plugin for a given dokku application

Requirements

• Dokku >= 0.38.31

Export support

Supported.

Probe support

Supported.

Lifecycle

Applied with state present and torn down with state absent. See Applying and tearing down a task.

Identity

Keyed by app.

Objects

• The app named by app. Can restart or redeploy it.

Tasks applied at once on the same object take turns; see Running tasks concurrently.

Parameters

Parameter	Type	Required	Default	Choices	Description
app	string	yes			Name of the app
state	string	no	present	present, absent	Desired state of the plugin for the app

Examples

Enable the proxy for an app

Requires these tasks, applied first:

- dokku_app:
      app: node-js-app

dokku_proxy_toggle:
    app: node-js-app

Disable the proxy for an app

Requires these tasks, applied first:

- dokku_app:
      app: node-js-app

dokku_proxy_toggle:
    app: node-js-app
    state: absent

Return Values

Available after the task runs when captured with register:, referenced as result.<Key> (or registered.<name>.<Key>).

Key	Returned	Type	Description
Changed	always	bool	Whether the task changed server state.
State	always	string	Resulting state of the resource.
DesiredState	always	string	The state the task targeted.
Message	always	string	Human-readable result message (may be empty).
Commands	when a subprocess ran	list	Resolved dokku command lines executed.
Stdout	when a subprocess ran	string	Captured stdout of the final command.
Stderr	when a subprocess ran	string	Captured stderr of the final command.
ExitCode	when a subprocess ran	int	Exit code of the final command.