Version 1.0.0
Language EN

Configure

The exec runner is configured using an environment variable file. The location of the environment file may vary depending on the host operating system and the user account.

On Posix (root):

cat /etc/drone-runner-exec/config

On Posix (non-root):

cat ~/.drone-runner-exec/config

On windows:

cat C:\Drone\drone-runner-exec\config

Configuration File

This file should use the syntax <variable>=value which sets the variable to the given value and # for comments. Please note this is not a bash file. Bash syntax and Bash expressions are not supported.

DRONE_RPC_PROTO=https
DRONE_RPC_HOST=drone.company.com
DRONE_RPC_SECRET=super-duper-secret

Configuration Options

DRONE_DEBUG

Optional boolean value. Enables debug level logging.

DRONE_DEBUG=false
DRONE_TRACE

Optional boolean value. Enables trace level logging.

DRONE_TRACE=false
DRONE_RPC_PROTO

Required string value. Defines the protocol used to connect to the Drone server. The value must be either http or https.

DRONE_RPC_PROTO=https
DRONE_RPC_HOST

Required string values. Defines the hostname (and optional port) used to connect to the Drone server.

DRONE_RPC_HOST=drone.company.com
DRONE_RPC_SECRET

Required string value. Provides the shared secret used by the Drone server to authenticate http requests.

DRONE_RPC_SECRET=bea26a2221fd8090ea38720fc445eca6
DRONE_RPC_SKIP_VERIFY

Optional boolean value. Disable SSL verification when making http requests to the Drone server. This is unsafe and is not recommended.

DRONE_RPC_SKIP_VERIFY=false
DRONE_RPC_DUMP_HTTP

Optional boolean value. Enables dumping the http request and response to the logs for debugging purposes. This should only be enabled while debugging connectivity issues between the runner and server.

DRONE_RPC_DUMP_HTTP=true
DRONE_RPC_DUMP_HTTP_BODY

Optional boolean value. Enables dumping the http request and response body to the logs for debugging purposes. This should only be enabled while debugging connectivity issues between the runner and server.

DRONE_RPC_DUMP_HTTP_BODY=true
DRONE_UI_DISABLE

Optional boolean value. Disables the runner’s user interface.

DRONE_UI_DISABLE=true
DRONE_UI_USERNAME

Optional string value. Sets the basic authentication username used to authenticate and access the web dashboard.

DRONE_UI_USERNAME=root
DRONE_UI_PASSWORD

Optional string value. Sets the basic authentication password used to authenticate and access the web dashboard. If no password is provided the web dashboard is disabled.

DRONE_UI_PASSWORD=root
DRONE_UI_REALM

Optional string value. Sets the basic authentication realm used to authenticate and access the web dashboard.

DRONE_UI_PASSWORD=DroneRealm
DRONE_RUNNER_NAME

Optional string value. Sets the name of the runner. The runner name is stored in the server and can be used to trace a build back to a specific runner.

DRONE_RUNNER_NAME=ec2-43-21.us-east-1.compute.amazonaws.com
DRONE_RUNNER_CAPACITY=100

Optional number value. Limits the number of concurrent pipelines that a runner can execute. This does not limit the number of concurrent pipelines that can execute on a single remote instance.

DRONE_RUNNER_CAPACITY=100
DRONE_RUNNER_MAX_PROCS=0

Optional umber value. Limits the number of concurrent steps that a runner can execute for a single pipeline. This is disabled by default. This can be useful if you need to throttle the maximum number of parallel steps to prevent resource exhaustion.

DRONE_RUNNER_MAX_PROCS=10
DRONE_RUNNER_ENVIRON

Optional string map. Provides a set of global environment variables that are injected into every pipeline step.

DRONE_RUNNER_ENVIRON=foo:bar,baz:qux
DRONE_SECRET_PLUGIN_ENDPOINT

Optional string value. Provides the endpoint used to make http requests to an external secret plugin. The external secret plugin (e.g. vault) can be used to source secrets from third party system.

DRONE_SECRET_PLUGIN_ENDPOINT=http://1.2.3.4:3000
DRONE_SECRET_PLUGIN_TOKEN

Optional string value. Provides the secret token used to authenticate http requests to the plugin endpoint.

DRONE_SECRET_PLUGIN_TOKEN=http://1.2.3.4:3000
DRONE_SECRET_PLUGIN_SKIP_VERIFY

Optional boolean value. Disable SSL verification when making http requests to the plugin endpoint. This is unsafe and is not recommended.

DRONE_SECRET_PLUGIN_SKIP_VERIFY=false

On This Page:

Getting Help

Mailing List
Search for information in the mailing list archives, or post a question.
Chat Support
Real-time chat support from maintainers and community members.