diff --git a/docs/deployment/one-off-processes.md b/docs/deployment/one-off-processes.md index 5e591353e20..e9965ec3c6a 100644 --- a/docs/deployment/one-off-processes.md +++ b/docs/deployment/one-off-processes.md @@ -15,6 +15,17 @@ The `run` command can be used to run a one-off process for a specific command. T dokku run node-js-app ls -lah ``` +The `run` command can also be used to run a command defined in your Procfile: + +``` +console: bundle exec racksh +``` + +```shell +# runs `bundle exec racksh` in the `/app` directory of the application `my-app` +dokku run my-app console +``` + If you want to remove the container after a command has started, you can run the following command: ```shell diff --git a/plugins/00_dokku-standard/subcommands/run b/plugins/00_dokku-standard/subcommands/run index ff2ca1588da..ddfdcb2a358 100755 --- a/plugins/00_dokku-standard/subcommands/run +++ b/plugins/00_dokku-standard/subcommands/run @@ -1,6 +1,7 @@ #!/usr/bin/env bash set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions" +source "$PLUGIN_CORE_AVAILABLE_PATH/ps/functions" source "$PLUGIN_AVAILABLE_PATH/config/functions" dokku_run_cmd() { @@ -23,6 +24,18 @@ dokku_run_cmd() { [[ "$DOKKU_RM_CONTAINER" ]] && local DOKKU_RUN_OPTS="--rm" has_tty && local DOKKU_RUN_OPTS+=" -i -t" is_image_herokuish_based "$IMAGE" && local EXEC_CMD="/exec" + + DOKKU_QUIET_OUTPUT=1 extract_procfile "$APP" + + POTENTIAL_PROCFILE_KEY="$1" + PROC_CMD=$(get_cmd_from_procfile "$APP" "$POTENTIAL_PROCFILE_KEY" || echo '') + remove_procfile "$APP" + + if [ ! -z "$PROC_CMD" ]; then + dokku_log_info1 "Found '$POTENTIAL_PROCFILE_KEY' in Procfile, running that command" + set -- "$PROC_CMD" "${@:2}" + fi + # shellcheck disable=SC2086 docker run $DOKKU_GLOBAL_RUN_ARGS $DOKKU_RUN_OPTS $DOCKER_ARGS $IMAGE $EXEC_CMD "$@" } diff --git a/tests/apps/nodejs-express/Procfile b/tests/apps/nodejs-express/Procfile index 312461ac929..6d278657f2e 100644 --- a/tests/apps/nodejs-express/Procfile +++ b/tests/apps/nodejs-express/Procfile @@ -6,6 +6,7 @@ cron: node worker.js web: node web.js worker: node worker.js +custom: echo -n # Old version with separate processes (use this if you have issues with the threaded version) diff --git a/tests/unit/30_core_1.bats b/tests/unit/30_core_1.bats index 42f6e01221f..c6f2bb79431 100644 --- a/tests/unit/30_core_1.bats +++ b/tests/unit/30_core_1.bats @@ -128,6 +128,16 @@ build_nginx_config() { assert_success } +@test "(core) run command from Procfile" { + deploy_app + run /bin/bash -c "dokku run $TEST_APP custom 'hi dokku' | tail -n 1" + echo "output: "$output + echo "status: "$status + + assert_success + assert_output 'hi dokku' +} + @test "(core) port exposure (dockerfile raw port)" { source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions" cat< $DOCKERFILE