Plugin triggers¶

Plugin triggers (formerly pluginhooks) are a good way to jack into existing Dokku infrastructure. You can use them to modify the output of various Dokku commands or override internal configuration.

Plugin triggers are simply scripts that are executed by the system. You can use any language you want, so long as the script:

Is executable
Has the proper language requirements installed

For instance, if you wanted to write a plugin trigger in PHP, you would need to have php installed and available on the CLI prior to plugin trigger invocation.

The following is an example for the nginx-hostname plugin trigger. It reverses the hostname that is provided to nginx during deploys. If you created an executable file named nginx-hostname with the following code in your plugin trigger, it would be invoked by Dokku during the normal app deployment process:

#!/usr/bin/env bash
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

APP="$1"; SUBDOMAIN="$2"; VHOST="$3"

NEW_SUBDOMAIN=`echo $SUBDOMAIN | rev`
echo "$NEW_SUBDOMAIN.$VHOST"

Available plugin triggers¶

There are a number of plugin-related triggers. These can be optionally implemented by plugins and allow integration into the standard Dokku setup/teardown process.

The following plugin triggers describe those available to a Dokku installation. As well, there is an example for each trigger that you can use as templates for your own plugin development.

Info

The example plugin trigger code is not guaranteed to be implemented as in within dokku, and are merely simplified examples. Please look at the Dokku source for larger, more in-depth examples.

`app-create`¶

Description: Creates an app
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`app-destroy`¶

Description: Destroys an app (with confirmation if force isn't specified)
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`app-exists`¶

Description: Checks if an app exists
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`app-list`¶

Description: Lists all apps in available to the currently logged in user. Optionally disables filtering by user if the first argument is false.
Invoked by:
Arguments: $FILTER
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`app-json-process-deploy-parallelism`¶

Description: Decides the parallelism to use when deploying a given process type. The default is 1 process entry at a type.
Invoked by: dokku deploy
Arguments: $APP $PROCESS_TYPE
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`app-json-get-content`¶

Description: Outputs the contents of the app-json file, if any
Invoked by: Deployment checks
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`app-maybe-create`¶

Description: Creates an app (gated by whether this is globally enabled or not)
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`app-restart`¶

Description: Triggers an app restart
Invoked by: dokku config:clear, dokku config:set, dokku config:unset
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`app-urls`¶

Description: Allows you to change the urls Dokku reports for an application. Will override any auto-detected urls.
Invoked by: dokku deploy, dokku url, and dokku urls
Arguments: $APP $URL_TYPE
Example:

#!/usr/bin/env bash
# Sets the domain to `internal.tld`
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

APP="$1"; URL_TYPE="$2"
case "$URL_TYPE" in
  url)
    echo "https://internal.tld/${APP}/"
    ;;
  urls)
    echo "https://internal.tld/${APP}/"
    echo "http://internal.tld/${APP}/"
    ;;
esac

`builder-build`¶

Description: Triggers the artifact build process
Invoked by: dokku deploy
Arguments: $BUILDER_TYPE $APP $SOURCECODE_WORK_DIR
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`builder-create-dokku-image`¶

Description: Allows modification of the configured dokku-image
Invoked by: dokku deploy
Arguments: $BUILDER_TYPE $APP $SOURCECODE_WORK_DIR $DOKKU_IMAGE
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`builder-detect`¶

Description: Allows overriding the auto-detected herokuish builder in favor of a custom one. Dockerfile gets lowest builder precedence.
Invoked by: dokku deploy
Arguments: $APP $SOURCECODE_WORK_DIR
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
APP="$1"; SOURCECODE_WORK_DIR="$2"

if [[ -f "$SOURCECODE_WORK_DIR/project.toml" ]]; then
  echo -n "pack"
fi

`builder-dokku-image`¶

Description: Allows modification of the used dokku-image.
Invoked by: dokku deploy
Arguments: $BUILDER_TYPE $APP $SOURCECODE_WORK_DIR $DOKKU_IMAGE
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`builder-get-property`¶

Description: Return the value for an app's builder property
Invoked by:
Arguments: $APP $KEY
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
APP="$1"; PROPERTY="$2"

# TODO

`builder-herokuish-allowed`¶

Description: Checks if herokuish is allowed to run on non-amd64 hosts
Invoked by: unit tests
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`builder-image-is-cnb`¶

Description: Checks if an image is cnb-based
Invoked by: unit tests
Arguments: $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`builder-image-is-herokuish`¶

Description: Checks if an image is herokuish-based
Invoked by: unit tests
Arguments: $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`builder-release`¶

Description: Triggers the artifact release process
Invoked by: dokku deploy
Arguments: $BUILDER_TYPE $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`buildpack-stack-name`¶

Description: Retrieves the configured buildpack stack for the pack and herokuish builders
Invoked by: builder-herokuish and builder-pack
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`caddy-template-source`¶

Description: Retrieves an alternative template for the caddy compose config
Invoked by: caddy-vhosts
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`certs-exists`¶

Description: Echos true if certs exists for the app, false otherwise
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`certs-force`¶

Description: Echos true if a cert should be simulated for the app, no output otherwise
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`check-deploy`¶

Description: Allows you to run checks on a deploy before Dokku allows the container to handle requests.
Invoked by: dokku deploy
Arguments: $APP $CONTAINER_ID $PROC_TYPE $PORT $IP
Example:

#!/usr/bin/env bash
# Disables deploys of containers based on whether the
# `DOKKU_DISABLE_DEPLOY` env var is set to `true` for an app

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_AVAILABLE_PATH/config/functions"

APP="$1"; CONTAINER_ID="$2"; PROC_TYPE="$3"; PORT="$4" ; IP="$5"

eval "$(config_export app $APP)"
DOKKU_DISABLE_DEPLOY="${DOKKU_DISABLE_DEPLOY:-false}"

if [[ "$DOKKU_DISABLE_DEPLOY" = "true" ]]; then
  echo -e "\033[31m\033[1mDeploys disabled, sorry.\033[0m"
  exit 1
fi

`checks-get-property`¶

Description: Return the value for an app's checks property
Invoked by:
Arguments: $APP $KEY
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
APP="$1"; PROPERTY="$2"

# TODO

`commands help` and `commands <PLUGIN_NAME>:help`¶

Description: Your plugin should implement a help command in your commands file to take advantage of this plugin trigger. commands help is used by dokku help to aggregate all plugins abbreviated help output. Implementing <PLUGIN_NAME>:help in your commands file gives users looking for help, a more detailed output. 'commands help' must be implemented inside the commands plugin file. It's recommended that PLUGIN_NAME:help be added to the commands file to ensure consistency among community plugins and give you a new avenue to share rich help content with your user.
Invoked by: dokku help and commands <PLUGIN_NAME>:help
Arguments: None
Example:

#!/usr/bin/env bash
# Outputs help for the derp plugin

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

case "$1" in
  help | hello:help)
    help_content_func () {
      declare desc="return help_content string"
      cat<<help_content
    hello <app>, Says "Hello <app>"
    hello:world, Says "Hello world"
help_content
    }

    if [[ $1 = "hello:help" ]] ; then
        echo -e 'Usage: dokku hello[:world] [<app>]'
        echo ''
        echo 'Say Hello World.'
        echo ''
        echo 'Example:'
        echo ''
        echo '$ dokku hello:world'
        echo 'Hello world'
        echo ''
        echo 'Additional commands:'
        help_content_func | sort | column -c2 -t -s,
    else
        help_content_func
    fi
    ;;

  *)
    exit $DOKKU_NOT_IMPLEMENTED_EXIT
    ;;

esac

`config-export`¶

Description: Returns the environment variables in a specified format
Invoked by: app-json plugin
Arguments: $APP $GLOBAL $MERGED $FORMAT
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`config-get`¶

Description: Fetches the app config value for a key
Invoked by:
Arguments: $APP $KEY
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`config-get-global`¶

Description: Fetches the global config value for a key
Invoked by:
Arguments: $KEY
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`core-post-deploy`¶

Info

To avoid issues with community plugins, this plugin trigger should be used only for core plugins. Please avoid using this trigger in your own plugins.

Description: Allows running of commands after an app's processes have been scaled up, but before old containers are torn down. Dokku core currently uses this to switch traffic on nginx.
Invoked by: dokku deploy
Arguments: $APP $INTERNAL_PORT $INTERNAL_IP_ADDRESS $IMAGE_TAG
Example:

#!/usr/bin/env bash
# Notify an external service that a successful deploy has occurred.

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

curl "http://httpstat.us/200"

`core-post-extract`¶

Info

To avoid issues with community plugins, this plugin trigger should be used only for core plugins. Please avoid using this trigger in your own plugins.

Description: Allows you to modify the contents of an app after it has been extracted from git but before the image source type is detected.
Invoked by: The receive-app plugin trigger
Arguments: $APP $TMP_WORK_DIR $REV
Example:

#!/usr/bin/env bash
# Adds a clock process to an app's Procfile

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"
TMP_WORK_DIR="$2"
REV="$3" # optional, may not be sent for tar-based builds

pushd "$TMP_WORK_DIR" >/dev/null
touch Procfile
echo "clock: some-command" >> Procfile
popd &>/dev/null

`cron-get-property`¶

Description: Return the value for an app's cron property
Invoked by:
Arguments: $APP $KEY
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
APP="$1"; PROPERTY="$2"

# TODO

`cron-entries`¶

Description: Allows injecting cron entries into the written out scheduled cron task list. Each entry is newline delimited, and individual entries come in the form $SCHEDULE;$FULL_COMMAND;$ARBITRARY_DATA. Individual implementations of cron writing can decide whether and how to include these cron entries. The ARBITRARY_DATA includes the log file path for the basic docker-local cron implementation.
Invoked by:
Arguments: $DOKKU_SCHEDULER
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"

DOKKU_SCHEDULER="$1"

# TODO

`cron-write`¶

Description: Force triggers writing out cron entries
Invoked by:
Arguments:
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"

# TODO

`dependencies`¶

Description: Used to install system-level dependencies.
Invoked by: dokku plugin:install-dependencies
Arguments: None
Example:

#!/usr/bin/env bash
# Installs nginx for the current plugin

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

export DEBIAN_FRONTEND=noninteractive

case "$DOKKU_DISTRO" in
  debian|raspbian|ubuntu)
    apt-get -qq -y --no-install-recommends install nginx
    ;;
  *)
    echo "Installation on $DOKKU_DISTRO not supported" 1>&2
    ;;
esac

`deploy`¶

Description: Triggers a deploy for the given app. Can override the image tag to deploy, as well as specify a single process type to deploy.
Invoked by: dokku deploy
Arguments: $APP [$IMAGE_TAG] [$PROC_TYPE]
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"

APP="$1" IMAGE_TAG="$2" PROC_TYPE="$3"

# TODO

`deployed-app-image-repo`¶

Description: Used to manage the full repo of the image being deployed. Useful for deploying from an external registry where the repository name is not dokku/$APP
Invoked by: internal function dokku_deploy_cmd() (deploy phase)
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

APP="$1"
# change the repo from dokku/APP to dokkupaas/APP
echo "dokkupaas/$APP"

`deployed-app-image-tag`¶

Description: Used to manage the tag of the image being deployed. Useful for deploying a specific version of an image, or when deploying from an external registry
Invoked by: internal function dokku_deploy_cmd() (deploy phase)
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# customize the tag version
echo 'not-latest'

`deployed-app-repository`¶

Description: Used to manage the remote repository of the image being deployed.
Invoked by: internal function dokku_deploy_cmd() (deploy phase)
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

echo 'derp.dkr.ecr.us-east-1.amazonaws.com'

`deploy-source-set`¶

Description: Used to set metadata about how the app is being deployed
Invoked by: git:from-archive, git:from-image, git:load-image, git:sync, and all git push commands
Arguments: $APP $SOURCE_TYPE $METADATA
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`docker-args-build`¶

Warning

Deprecated, please use docker-args-process-build instead

Description:
Invoked by: internal function dokku_build() (build phase)
Arguments: $APP $IMAGE_SOURCE_TYPE
Example:

#!/usr/bin/env bash
# Sets a docker build-arg called CACHEBUST which can be used
# to bust cache at any arbitrary point in a Dockerfile build
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

STDIN=$(cat)
APP="$1"; IMAGE_SOURCE_TYPE="$2"
output=""

if [[ "$IMAGE_SOURCE_TYPE" == "dockerfile" ]]; then
  output=" --build-arg CACHEBUST=$(date +%s)"
fi
echo -n "$STDIN$output"

`docker-args-deploy`¶

Warning

Deprecated, please use docker-args-process-deploy instead

Description:
Invoked by: dokku deploy
Arguments: $APP $IMAGE_TAG [$PROC_TYPE $CONTAINER_INDEX]
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)

# TODO

`docker-args-process-build`¶

Description: $PROC_TYPE may be set to magic _all_ process type to signify global docker deploy options.
Invoked by: dokku ps:rebuild
Arguments: $APP $IMAGE_SOURCE_TYPE
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"

APP="$1"; IMAGE_SOURCE_TYPE="$2"

# TODO

`docker-args-process-deploy`¶

Description: $PROC_TYPE may be set to magic _all_ process type to signify global docker deploy options.
Invoked by: dokku deploy
Arguments: $APP $IMAGE_SOURCE_TYPE $IMAGE_TAG [$PROC_TYPE $CONTAINER_INDEX]
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"; $IMAGE_SOURCE_TYPE="$2" IMAGE_TAG="$3"; PROC_TYPE="$4"; CONTAINER_INDEX="$5"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)

# TODO

`docker-args-process-run`¶

Description: $PROC_TYPE may be set to magic _all_ process type to signify global docker run options.
Invoked by: dokku run
Arguments: $APP $IMAGE_SOURCE_TYPE $IMAGE_TAG
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"; IMAGE_SOURCE_TYPE="$3"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)

# TODO

`docker-args-run`¶

Warning

Deprecated, please use docker-args-process-run instead

Description:
Invoked by: dokku run
Arguments: $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)

# TODO

`domains-add`¶

Description: Adds a domain to an app
Invoked by:
Arguments: $APP $DOMAIN
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`domains-disable`¶

Description: Disables domains for an app
Invoked by:
Arguments: $APP $RESTART_APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`domains-enable`¶

Description: Enables domains for an app
Invoked by:
Arguments: $APP $RESTART_APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`domains-list`¶

Description: Lists all domains for an app
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`domains-urls`¶

Description: Gets an app's url(s)
Invoked by:
Arguments: $APP $URL_TYPE
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`domains-vhost-enabled`¶

Description: Checks if a virtual hosts are enabled for an app
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`git-deploy-branch`¶

Description: Outputs the deploy branch for an app, inherited or not
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`git-get-property`¶

Description: Return the value for an app's git property
Invoked by:
Arguments: $APP $KEY
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
APP="$1"; PROPERTY="$2"

# TODO

`git-from-archive`¶

Description: Updates an app's git repository from an archive and then triggers a build
Invoked by: git:from-archive
Arguments: $APP $ARCHIVE_URL $ARCHIVE_TYPE $USER_NAME $USER_EMAIL
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`git-from-directory`¶

Description: Updates an app's git repository from a source directory and then triggers a build
Invoked by: git:from-image and git:from-archive
Arguments: $APP $SOURCECODE_WORK_DIR $USER_NAME $USER_EMAIL
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`git-from-image`¶

Description: Updates an app's git repository from a docker image and then triggers a build as necessary
Invoked by: git:from-image
Arguments: $APP $DOCKER_IMAGE $BUILD_DIR $USER_NAME $USER_EMAIL
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`git-has-code`¶

Description: Checks to see if there is code at the specified branch
Arguments: $APP $BRANCH_NAME
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`git-post-pull`¶

Description:
Invoked by: dokku git-upload-pack
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`git-pre-pull`¶

Description:
Invoked by: dokku git-upload-pack
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

Warning

The git-pre-pull trigger should not be used for authentication since it does not get called for commands that use git-upload-archive such as git archive. Instead, use the user-auth trigger.

`git-revision`¶

Description: Allows you to fetch the current git revision for a given application
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`install`¶

Description: Used to setup any files/configuration for a plugin.
Invoked by: dokku plugin:install.
Arguments: None
Example:

#!/usr/bin/env bash
# Sets the hostname of the Dokku server
# based on the output of `hostname -f`

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

if [[ ! -f  "$DOKKU_ROOT/VHOST" ]]; then
  hostname -f > $DOKKU_ROOT/VHOST
fi

`haproxy-template-source`¶

Description: Retrieves an alternative template for the haproxy compose config
Invoked by: haproxy-vhosts
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`logs-get-property`¶

Description: Return the value for an app's log property
Invoked by:
Arguments: $APP $KEY
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
APP="$1"; PROPERTY="$2"

# TODO

`network-build-config`¶

Description: Rebuilds network configuration
Invoked by: internally triggered by proxy-build-config within proxy implementations
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`network-clear-config`¶

Description: Clears network configuration
Invoked by: internally triggered within proxy implementations
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`network-config-exists`¶

Description: Returns whether the network configuration for a given app exists
Invoked by: internally triggered by core-post-deploy within proxy implementations
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`network-get-ipaddr`¶

Description: Return the ipaddr for a given app container
Invoked by: internally triggered by a deploy
Arguments: $APP $PROC_TYPE $CONTAINER_ID
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`network-get-listeners`¶

Description: Return the listeners (host:port combinations) for a given app container
Invoked by: internally triggered by a deploy
Arguments: $APP $PROCESS_TYPE
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`network-get-property`¶

Description: Return the value for an app's network property
Invoked by: internally triggered by a deploy
Arguments: $APP $KEY
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`network-get-static-listeners`¶

Description: Return the network value for an app's property
Invoked by: internally triggered by proxy-build-config
Arguments: $APP $PROCESS_TYPE
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`network-write-ipaddr`¶

Description: Write the ipaddr for a given app index
Invoked by: internally triggered by a deploy
Arguments: $APP $PROC_TYPE $CONTAINER_INDEX $IP_ADDRESS
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`network-write-port`¶

Description: Write the port for a given app index
Invoked by: internally triggered by a deploy
Arguments: $APP $PROC_TYPE $CONTAINER_INDEX $PORT
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`nginx-app-template-source`¶

Description: Return the path to a sigil template that should be used to generate a given nginx configuration file.
Invoked by: nginx-vhosts#build-config
Arguments: $APP $TEMPLATE_TYPE
- The TEMPLATE_TYPE argument can be one of: [app-config, hsts-config, validate-config]
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"

APP="$1"
TEMPLATE_TYPE="$2"
case "$TEMPLATE_TYPE" in
  app-config)
    echo "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/app.conf.sigil";;
  hsts-config)
    echo "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/hsts.conf.sigil";;
  validate-config)
    echo "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/validate.conf.sigil";;
  *)
    dokku_log_fail "Invalid template type: ${TEMPLATE_TYPE}"
esac

The default templates are viewable here: plugins/nginx-vhosts/templates/

`nginx-dokku-template-source`¶

Description: Return the path to a sigil template that should be used to generate the dokku.conf nginx configuration file.
Invoked by: nginx-vhosts#install
Arguments: None, however the sigil template can make use of the following variables: $.DOKKU_ROOT $.NGINX_ROOT
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

echo "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/dokku.conf.sigil"

The default template is viewable here: plugins/nginx-vhosts/templates/dokku.conf.sigil

`nginx-hostname`¶

Description: Allows you to customize the hostname for a given app
Invoked by: dokku domains:setup
Arguments: $APP $SUBDOMAIN $VHOST
Example:

#!/usr/bin/env bash
# Reverses the hostname for the app

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

APP="$1"; SUBDOMAIN="$2"; VHOST="$3"

NEW_SUBDOMAIN=`echo $SUBDOMAIN | rev`
echo "$NEW_SUBDOMAIN.$VHOST"

`nginx-pre-reload`¶

Warning

The arguments INTERNAL_PORT and INTERNAL_IP_ADDRESS are no longer sufficient to retrieve all app listeners. Please run plugn trigger network-get-listeners APP within any implementation of nginx-pre-reload in order to retrieve all application listeners.

Description: Run before nginx reloads hosts
Invoked by: dokku proxy:build-config
Arguments: $APP $INTERNAL_PORT $INTERNAL_IP_ADDRESS
Example:

#!/usr/bin/env bash
# Runs a check against all nginx conf files
# to ensure they are valid

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

nginx -t

`openresty-template-source`¶

Description: Retrieves an alternative template for the openresty compose config
Invoked by: openresty-vhosts
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`ports-clear`¶

Description: Clears the ports for a given app without triggering further restarts or rebuilds
Invoked by: internally
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`ports-configure`¶

Description: Configures the initial proxy ports
Invoked by: internally triggered by proxy plugins
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`ports-get`¶

Description: Returns a list of port mappings, newline delimited
Invoked by: Various networking plugins
Arguments: $APP $FORMAT
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`ports-get-available`¶

Description: Prints out an available port greater than 1024
Invoked by: Various networking plugins
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`ports-get-property`¶

Description: Return the value for an app's ports property
Invoked by:
Arguments: $APP $KEY
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
APP="$1"; PROPERTY="$2"

# TODO

`ports-set-detected`¶

Description: Allows builders to specify detected port mappings for a given app
Invoked by: Builder plugins
Arguments: $APP [$PORT_MAPPING...]
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-app-clone`¶

Description: Allows you to run commands after an app was cloned.
Invoked by: dokku apps:clone
Arguments: $OLD_APP_NAME $NEW_APP_NAME
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-app-clone-setup`¶

Description: Allows you to run commands after an app is setup, and before it is rebuild. This is useful for cleaning up tasks, or ensuring configuration from an old app is copied to the new app
Invoked by: dokku apps:clone
Arguments: $OLD_APP_NAME $NEW_APP_NAME
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-app-rename`¶

Description: Allows you to run commands after an app was renamed.
Invoked by: dokku apps:rename
Arguments: $OLD_APP_NAME $NEW_APP_NAME
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-app-rename-setup`¶

Description: Allows you to run commands after an app is setup, and before it is rebuild. This is useful for cleaning up tasks, or ensuring configuration from an old app is copied to the new app
Invoked by: dokku apps:rename
Arguments: $OLD_APP_NAME $NEW_APP_NAME
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-build`¶

Description: Allows you to run commands after the build image is create for a given app.
Invoked by: internal function dokku_build() (build phase)
Arguments: $BUILDER_TYPE $APP $SOURCECODE_WORK_DIR
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-build-buildpack`¶

Warning

Deprecated, please use post-build instead

Description: Allows you to run commands after the build image is create for a given app. Only applies to apps using buildpacks.
Invoked by: internal function dokku_build() (build phase)
Arguments: $APP $SOURCECODE_WORK_DIR
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-build-dockerfile`¶

Warning

Deprecated, please use post-build instead

Description: Allows you to run commands after the build image is create for a given app. Only applies to apps using a dockerfile.
Invoked by: internal function dokku_build() (build phase)
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-build-lambda`¶

Warning

Deprecated, please use post-build instead

Description: Allows you to run commands after the build image is create for a given app. Only applies to apps using lambda.
Invoked by: internal function dokku_build() (build phase)
Arguments: $APP $SOURCECODE_WORK_DIR
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-build-pack`¶

Warning

Deprecated, please use post-build instead

Description: Allows you to run commands after the build image is create for a given app. Only applies to apps using pack.
Invoked by: internal function dokku_build() (build phase)
Arguments: $APP $SOURCECODE_WORK_DIR
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-certs-remove`¶

Description: Allows you to run commands after a cert is removed
Invoked by: dokku certs:remove
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"

# TODO

`post-certs-update`¶

Description: Allows you to run commands after a cert is added/updated
Invoked by: dokku certs:add, dokku certs:update
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"

# TODO

`post-config-update`¶

Description: Allows you to get notified when one or more configs is added or removed. Action can be set or unset.
Invoked by: dokku config:set, dokku config:unset
Arguments: $APP set|unset key1=VALUE1 key2=VALUE2
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-container-create`¶

Description: This trigger should be used to do stuff to containers after they are created but before they are started. They are explicitly for commands that may involve network traffic, and not for commands that are self-contained, such as chown or tar.
Invoked by: dokku run, dokku ps:rebuild, dokku deploy
Arguments: "app|service" "$CONTAINER_ID" "$APP|$SERVICE" "$PHASE"

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-create`¶

Description: Can be used to run commands after an app is created.
Invoked by: dokku apps:create
Arguments: $APP
Example:

#!/usr/bin/env bash
# Runs a command to ensure that an app
# has a postgres database when it is starting

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

APP="$1";
POSTGRES="$1"

dokku postgres:create $POSTGRES
dokku postgres:link $POSTGRES $APP

`post-delete`¶

Description: Can be used to run commands after an app is deleted.
Invoked by: dokku apps:destroy
Arguments: $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash
# Runs a command to ensure that an app's
# postgres installation is removed

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

APP="$1";

dokku postgres:destroy $APP

`post-deploy`¶

Info

Please see core-post-deploy if contributing a core plugin with the post-deploy hook.

Description: Allows running of commands after an app's processes have been scaled up, but before old containers are torn down. Dokku calls this after core-post-deploy. Deployment Tasks are also invoked by this plugin trigger.
Invoked by: dokku deploy
Arguments: $APP $INTERNAL_PORT $INTERNAL_IP_ADDRESS $IMAGE_TAG
Example:

#!/usr/bin/env bash
# Notify an external service that a successful deploy has occurred.

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

curl "http://httpstat.us/200"

`post-domains-update`¶

Description: Allows you to run commands once the domain for an app has been updated. It also sends in the command that has been used. This can be "add", "clear" or "remove". The third argument will be the optional list of domains
Invoked by: dokku domains:add, dokku domains:clear, dokku domains:remove, dokku domains:set
Arguments: $APP action name domains
Example:

#!/usr/bin/env bash
# Reloads haproxy for our imaginary haproxy plugin
# that replaces the nginx-vhosts plugin

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

sudo service haproxy reload

`post-extract`¶

Description: Allows you to modify the contents of an app after it has been extracted from git but before the image source type is detected.
Invoked by: The receive-app plugin trigger
Arguments: $APP $TMP_WORK_DIR $REV
Example:

#!/usr/bin/env bash
# Adds a clock process to an app's Procfile

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"
TMP_WORK_DIR="$2"
REV="$3" # optional, may not be sent for tar-based builds

pushd "$TMP_WORK_DIR" >/dev/null
touch Procfile
echo "clock: some-command" >> Procfile
popd &>/dev/null

`post-proxy-ports-update`¶

Description: Allows you to run commands once the port mappings for an app have been updated. It also sends the invoking command. This can be "add", "clear" or "remove".
Invoked by: dokku ports:add, dokku ports:clear, dokku ports:remove
Arguments: $APP action name
Example:

#!/usr/bin/env bash
# Rebuilds haproxy config for our imaginary haproxy plugin
# that replaces the nginx-vhosts plugin

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$PLUGIN_AVAILABLE_PATH/haproxy/functions"
APP="$1"

haproxy-build-config "$APP"

`post-registry-login`¶

Description: Allows running a command after the a registry has been logged into
Invoked by: dokku registry:login
Arguments: $DOCKER_REGISTRY_SERVER $DOCKER_REGISTRY_USER
Example:

#!/usr/bin/env bash

# the DOCKER_REGISTRY_PASS env var is also set
echo "$DOCKER_REGISTRY_PASS"

`post-release-builder`¶

Warning

Image mutation in this trigger may result in an invalid run state, and is heavily discouraged.

Description: Invokes a command after the build process is complete.
Invoked by: builder plugins
Arguments: $BUILDER_TYPE $APP $IMAGE
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
BUILDER_TYPE="$1"; APP="$2"; IMAGE=$3

# TODO

`post-stack-set` TODO¶

Description: Allows you to run commands after changing the stack
Invoked by: buildpacks plugin
Arguments: $APP $VALUE
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`post-stop`¶

Description: Can be used to run commands after an app is manually stopped
Invoked by: dokku ps:stop
Arguments: $APP
Example:

#!/usr/bin/env bash
# Marks an app as manually stopped

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

APP="$1";

dokku config:set --no-restart $APP MANUALLY_STOPPED=1

`pre-build`¶

Description: Allows you to run commands before the build image is created for a given app. For instance, this can be useful to add env vars to your container.
Invoked by: internal function dokku_build() (build phase)
Arguments: $BUILDER_TYPE $APP $SOURCECODE_WORK_DIR
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`pre-build-buildpack`¶

Warning

Deprecated, please use pre-build instead

Description: Allows you to run commands before the build image is created for a given app. For instance, this can be useful to add env vars to your container. Only applies to apps using buildpacks.
Invoked by: internal function dokku_build() (build phase)
Arguments: $APP $SOURCECODE_WORK_DIR
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`pre-build-dockerfile`¶

Warning

Deprecated, please use pre-build instead

Description: Allows you to run commands before the build image is created for a given app. For instance, this can be useful to add env vars to your container. Only applies to apps using a dockerfile.
Invoked by: internal function dokku_build() (build phase)
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`pre-build-lambda`¶

Warning

Deprecated, please use pre-build instead

Description: Allows you to run commands before the build image is created for a given app. For instance, this can be useful to add env vars to your container. Only applies to apps using lambda.
Invoked by: internal function dokku_build() (build phase)
Arguments: $APP $SOURCECODE_WORK_DIR
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`pre-build-pack`¶

Warning

Deprecated, please use pre-build instead

Description: Allows you to run commands before the build image is created for a given app. For instance, this can be useful to add env vars to your container. Only applies to apps using pack.
Invoked by: internal function dokku_build() (build phase)
Arguments: $APP $SOURCECODE_WORK_DIR
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`pre-delete`¶

Description: Can be used to run commands before an app is deleted.
Invoked by: dokku apps:destroy
Arguments: $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash
# Clears out the gulp asset build cache for apps

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"

APP="$1"; GULP_CACHE_DIR="$DOKKU_ROOT/$APP/gulp"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)

if [[ -d $GULP_CACHE_DIR ]]; then
  docker run "${DOCKER_COMMIT_LABEL_ARGS[@]}" --rm -v "$GULP_CACHE_DIR:/gulp" "$IMAGE" find /gulp -depth -mindepth 1 -maxdepth 1 -exec rm -Rf {} \; || true
fi

`pre-deploy`¶

Warning

Deprecated, please use pre-release-builder instead

Description: Allows the running of code before the app's processes are scaled up and after the docker images are prepared.
Invoked by: dokku deploy
Arguments: $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash
# Runs gulp in our container

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)

dokku_log_info1 "Running gulp"
CID=$(docker run "${DOCKER_COMMIT_LABEL_ARGS[@]}" -d $IMAGE /bin/bash -c "cd /app && gulp default")
test $(docker wait $CID) -eq 0
DOCKER_COMMIT_LABEL_ARGS=("--change" "LABEL org.label-schema.schema-version=1.0" "--change" "LABEL org.label-schema.vendor=dokku" "--change" "LABEL com.dokku.app-name=$APP")
docker commit "${DOCKER_COMMIT_LABEL_ARGS[@]}" $CID $IMAGE >/dev/null

`pre-disable-vhost`¶

Description: Allows you to run commands before the VHOST feature is disabled
Invoked by: dokku domains:disable
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"

# TODO

`pre-enable-vhost`¶

Description: Allows you to run commands before the VHOST feature is enabled
Invoked by: dokku domains:enable
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"

# TODO

`pre-receive-app`¶

Description: Allows you to customize the contents of an app directory before they are processed for deployment. The IMAGE_SOURCE_TYPE can be any of [herokuish, dockerfile]
Invoked by: dokku git-hook, dokku tar-build-locked
Arguments: $APP $IMAGE_SOURCE_TYPE $TMP_WORK_DIR $REV
Example:

#!/usr/bin/env bash
# Adds a file called `dokku-is-awesome` to the repository
# the contents will be the app name

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

APP="$1"; IMAGE_SOURCE_TYPE="$2"; TMP_WORK_DIR="$3"; REV="$4"

echo "$APP" > "$TMP_WORK_DIR/dokku-is-awesome"

`pre-release-builder`¶

Description: Allows you to run commands before environment variables are set for the release step of the deploy.
Invoked by: internal function dokku_release() (release phase)
Arguments: $BUILDER_TYPE $APP $IMAGE
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
BUILDER_TYPE="$1"; APP="$2"; IMAGE_TAG="$3";

# TODO

`pre-release-buildpack`¶

Warning

Deprecated, please use pre-release-builder instead

Description: Allows you to run commands before environment variables are set for the release step of the deploy. Only applies to apps using buildpacks.
Invoked by: internal function dokku_release() (release phase)
Arguments: $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash
# Installs the graphicsmagick package into the container

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)

dokku_log_info1 "Installing GraphicsMagick..."

CMD="cat > gm && \
  dpkg -s graphicsmagick &>/dev/null || \
  (apt-get update -qq && apt-get -qq -y --no-install-recommends install graphicsmagick && apt-get clean)"

CID=$(docker run $DOKKU_GLOBAL_RUN_ARGS -i -a stdin $IMAGE /bin/bash -c "$CMD")
test $(docker wait $CID) -eq 0
DOCKER_COMMIT_LABEL_ARGS=("--change" "LABEL org.label-schema.schema-version=1.0" "--change" "LABEL org.label-schema.vendor=dokku" "--change" "LABEL com.dokku.app-name=$APP")
docker commit "${DOCKER_COMMIT_LABEL_ARGS[@]}" $CID $IMAGE >/dev/null

`pre-release-lambda`¶

Warning

Deprecated, please use pre-release-builder instead

Description: Allows you to run commands before environment variables are set for the release step of the deploy. Only applies to apps using lambda.
Invoked by: internal function dokku_release() (release phase)
Arguments: $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"; IMAGE_TAG="$2";

# TODO

`pre-release-pack`¶

Warning

Deprecated, please use pre-release-builder instead

Description: Allows you to run commands before environment variables are set for the release step of the deploy. Only applies to apps using pack.
Invoked by: internal function dokku_release() (release phase)
Arguments: $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"; IMAGE_TAG="$2";

# TODO

`pre-release-dockerfile`¶

Warning

Deprecated, please use pre-release-builder instead

Description: Allows you to run commands before environment variables are set for the release step of the deploy. Only applies to apps using a dockerfile.
Invoked by: internal function dokku_release() (release phase)
Arguments: $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)

# TODO

`pre-restore`¶

Description: Allows you to run commands before all containers are restored
Invoked by: dokku ps:restore
Arguments:
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
DOKKU_SCHEDULER="$1"

# TODO

`pre-start`¶

Description: Can be used to run commands before an app is started
Invoked by: dokku ps:start
Arguments: $APP
Example:

#!/usr/bin/env bash
# Notifies an example url that an app is starting

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

APP="$1";

curl "https://dokku.me/starting/${APP}" || true

`procfile-get-command`¶

Description: Fetches the command for a specific process type
Invoked by: internally
Arguments: $APP $PROCESS_TYPE $PORT
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`procfile-exists`¶

Description: Checks if a procfile exists for the specified app
Invoked by: internally
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`proxy-build-config`¶

Description: Builds the proxy implementation configuration for a given app
Invoked by: internally triggered by ps:restore
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`proxy-clear-config`¶

Description: Clears the proxy implementation configuration for a given app
Invoked by: internally triggered by apps:rename
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`proxy-disable`¶

Description: Disables the configured proxy implementation for an app
Invoked by: internally triggered by ps:restore
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`proxy-enable`¶

Description: Enables the configured proxy implementation for an app
Invoked by: internally triggered by ps:restore
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`proxy-is-enabled`¶

Description: Checks if there is a proxy enabled for the app
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`proxy-type`¶

Description: Returns the proxy type for an app
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`ps-can-scale`¶

Description: Sets whether or not a user can scale an app with ps:scale
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`ps-current-scale`¶

Description: Prints out the current scale contents (process-type=quantity) delimited by newlines.
Invoked by:
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`ps-set-scale`¶

Description: Sets the scale for an app based on a specified formation (process-type=quantity). Any unspecified process types will be left as is.
Invoked by:
Arguments: $APP $SKIP_DEPLOY $CLEAR_EXISTING [$PROCESS_TUPLE...]
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

# TODO

`receive-app`¶

Description: Allows you to customize what occurs when an app is received. Normally just triggers an app build.
Invoked by: dokku git-hook, dokku ps:rebuild
Arguments: $APP $REV ($REV may not be included in cases where a repository is not pushed)
Example:

#!/usr/bin/env bash
# For our imaginary mercurial plugin, triggers a rebuild

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x

APP="$1"; REV="$2"

dokku hg-build $APP $REV

`receive-branch`¶

Description: Allows you to customize what occurs when a specific branch is received. Can be used to add support for specific branch names
Invoked by: dokku git-hook, dokku ps:rebuild
Arguments: $APP $REV $REFNAME
Example:

#!/bin/bash
# Gives Dokku the ability to support multiple branches for a given service
# Allowing you to have multiple staging environments on a per-branch basis

reference_app=$1
refname=$3
newrev=$2
APP=${refname/*\//}.$reference_app

if [[ ! -d "$DOKKU_ROOT/$APP" ]]; then
  REFERENCE_REPO="$DOKKU_ROOT/$reference_app"
  git clone --bare --shared --reference "$REFERENCE_REPO" "$REFERENCE_REPO" "$DOKKU_ROOT/$APP" >/dev/null
fi
plugn trigger receive-app $APP $newrev

`release-and-deploy`¶

Description: Triggers a release of the image tag and a subsequent deploy
Invoked by:
Arguments: $APP $IMAGE_TAG
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
APP="$1";

# TODO

`report`¶

Description: Allows you to report on any custom configuration in use by your application
Invoked by: dokku report
Arguments: $APP
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
APP="$1";

# TODO

`resource-get-property`¶

Description: Fetches a given resource property value
Invoked by:
Arguments: $APP $PROC_TYPE $RESOURCE_TYPE $PROPERTY
Example:

#!/usr/bin/env bash

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
APP="$1"; PROC_TYPE="$2" RESOURCE_TYPE="$3" PROPERTY="$4"

# TODO

`retire-container-failed`¶

Description: Allows you to run commands if/when retiring old containers has failed
Invoked by: dokku deploy
Arguments: $APP
Example:

#!/usr/bin/env bash
# Send an email when a container failed to retire

set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
APP="$1"; HOSTNAME=$(hostname -s)

mail -s "$APP containers on $HOSTNAME failed to retire" ops@dokku.me