Reference

Updated 2 years ago by Admin

Index of all configuration parameters:

  • DRONE_DEBUG
    Optional boolean value. Enables debug level logging.
    DRONE_DEBUG=true
  • DRONE_HTTP_BIND
    Optional string value configures the http listener port. The default value is :3000. Overriding this value is not recommended.
    DRONE_HTTP_BIND=:3000
  • DRONE_HTTP_HOST
    Optional string value that configures the http listener hostname. The default value is an empty string. Setting this value is not recommended.
    DRONE_HTTP_HOST=runner.company.com:3000
  • DRONE_HTTP_PROTO
    Optional string value configures the http listener protocol. The default value is http. Overriding this value is not recommended.
    DRONE_HTTP_PROTO=http
  • DRONE_LIMIT_EVENTS
    Optional comma-separated string value. Provides a white list of build events that can be processed by this runner. This provides an extra layer of security to limit the kind of workloads this runner can process.
    DRONE_LIMIT_EVENTS=push,tag
  • DRONE_LIMIT_REPOS
    Optional comma-separated string value. Configures the runner to only process matching repositories. This provides an extra layer of security and can stop untrusted repositories from executing pipelines with this runner.
    DRONE_LIMIT_REPOS=octocat/hello-world,spaceghost/*
  • DRONE_LIMIT_TRUSTED
    Optional boolean value. Configures the runner to only process trusted repositories. This provides an extra layer of security and can stop untrusted repositories from executing pipelines with this runner.
    DRONE_LIMIT_TRUSTED=true
  • DRONE_LOG_FILE
    Recommended string value. Provides the file location of the runner logs.
    DRONE_LOG_FILE=/var/log/drone-runner-exec/log.txt
  • DRONE_LOG_FILE_MAX_AGE
    Optional integer value. Configures the maximum number of days to retain a backup log file.
    DRONE_LOG_FILE_MAX_AGE=30
  • DRONE_LOG_FILE_MAX_BACKUPS
    Optional integer value. Configures the maximum number of files the system should retain.
    DRONE_LOG_FILE_MAX_BACKUPS=7
  • DRONE_LOG_FILE_MAX_SIZE
    Optional integer value. Configures the maximum file size in megabytes before the log file is rotated.
    DRONE_LOG_FILE_MAX_SIZE=10
  • DRONE_PLATFORM_ARCH
    Optional string value. Configures the host machine architecture. Overriding the default value should never be necessary and may lead to unexpected behavior.
    DRONE_PLATFORM_ARCH=amd64
  • DRONE_PLATFORM_KERNEL
    Optional string value. Configures the host operating system kernel version. The default values is empty. This may be used with windows to differentiate between 1809, 1903 and so on.
    DRONE_PLATFORM_KERNEL=1903
  • DRONE_PLATFORM_OS
    Optional string value. Configures the host machine operating system. Overriding the default value should never be necessary and may lead to unexpected behavior.
    DRONE_PLATFORM_OS=linux
  • DRONE_PLATFORM_VARIANT
    Optional string value. Configures the host operating system variant. The default values is empty. This may be used with arm to differentiate between v7, v8 and so on.
    DRONE_PLATFORM_VARIANT=v7
  • 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_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_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_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_RUNNER_CAPACITY
    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=10
  • DRONE_RUNNER_ENVFILE
    Optional string. Provides a path to an environment file containing global environment variables that are injected into every pipeline step.
    DRONE_RUNNER_ENVFILE=/path/to/file.env
    The environment file is a text file that defines environment variables in key value format. Please see the envfile documentation for more details about the file format.
    S3_BUCKET=YOURS3BUCKET
    SECRET_KEY=YOURSECRETKEYGOESHERE
  • 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_RUNNER_LABELS
    Optional string map. Provides a set of labels used to route a pipeline to a specific machine or set of machines.
    DRONE_RUNNER_LABELS=foo:bar,baz:qux
  • DRONE_RUNNER_MAX_PROCS
    Optional number 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_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_PATH
    Optional string value. Sets the PATH variable for all pipeline steps. This may be required if the pipeline shell cannot find your commands, and you receive command not found errors.
    DRONE_RUNNER_PATH=/usr/local/bin:/usr/bin:/usr/sbin:/sbin
  • DRONE_RUNNER_ROOT
    Optional string value. Sets a custom root build path instead of a folder within the system temp directory.
    DRONE_RUNNER_ROOT=/tmp
  • 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_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
  • DRONE_SECRET_PLUGIN_TOKEN
    DRONE_SECRET_PLUGIN_TOKEN Optional string value. Provides the secret token used to authenticate http requests to the plugin endpoint.
    DRONE_SECRET_PLUGIN_TOKEN=bea26a2221fd8090ea38720fc445eca6
  • DRONE_TRACE
    Optional boolean value. Enables trace level logging.
    DRONE_TRACE=true
  • DRONE_UI_DISABLED
    Optional boolean value. Disables the runner’s user interface.
    DRONE_UI_DISABLE=true
  • 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_REALM=DroneRealm
  • DRONE_UI_USERNAME
    Optional string value. Sets the basic authentication username used to authenticate and access the web dashboard.
    DRONE_UI_USERNAME=root


How did we do?