Installation Reference

by bradrydzewski

Drone configuration options are set using environment variables. This reference document provides a list of all configuration options.

Server Options

DRONE_SECRET
Shared secret. Your Drone Agents must match this value.
DRONE_DEBUG=false
Set to true to see verbose debugging log output.
DRONE_SERVER_CERT
Optional. Full path to SSL certificate for HTTPS.
DRONE_SERVER_KEY
Optional. Full path to private key for HTTPS.
DRONE_ADMIN
Comma-separated list of admin users.
DRONE_ORGS
Comma-separated list of authorized organizations.
DRONE_OPEN=false
Set to true if registration is open
DRONE_YAML=.drone.yml
Build configuration file name.
DRONE_CACHE_TTY=15m
Duration for caching remote repository data.
DRONE_DATABASE_DRIVER=sqlite3
Database driver name.
DRONE_DATABASE_DATASOURCE=drone.sqlite
Database connection string.
DRONE_GITHUB=false
Set to true to enable the GitHub driver.
DRONE_GITHUB_URL=https://github.com
GitHub server address.
DRONE_GITHUB_CLIENT
Github oauth2 client id.
DRONE_GITHUB_SECRET
Github oauth2 client secret.
DRONE_GITHUB_SCOPE=repo,repo:status,user:email,read:org
Comma-separated Github oauth scope.
DRONE_GITHUB_GIT_USERNAME
Optional. Use a single machine account username to clone all repositories.
DRONE_GITHUB_GIT_PASSWORD
Optional. Use a single machine account password to clone all repositories.
DRONE_GITHUB_PRIVATE_MODE=false
Set to true if Github is running in private mode.
DRONE_GITHUB_MERGE_REF=true
Set to true to use the refs/pulls/%d/merge vs refs/pulls/%d/head
DRONE_GITHUB_CONTEXT=continuous-integration/drone
Customize the GitHub status message context
DRONE_GITHUB_SKIP_VERIFY=false
Set to true to disable SSL verification.
DRONE_GOGS=false
Set to true to enable the Gogs driver.
DRONE_GOGS_URL
Gogs server address.
DRONE_GOGS_GIT_USERNAME
Optional. Use a single machine account username to clone all repositories.
DRONE_GOGS_GIT_PASSWORD
Optional. Use a single machine account password to clone all repositories.
DRONE_GOGS_PRIVATE_MODE=false
Set to true if Gogs is running in private mode.
DRONE_GOGS_SKIP_VERIFY=false
Set to true to disable SSL verification.
DRONE_BITBUCKET=false
Set to true to enable the Bitbucket driver.
DRONE_BITBUCKET_CLIENT
Bitbucket oauth2 client id
DRONE_BITBUCKET_SECRET
Bitbucket oauth2 client secre
DRONE_STASH=false
Set to true to enable the Bitbucket Server (Stash) driver.
DRONE_STASH_URL
Bitbucket Server address.
DRONE_STASH_CONSUMER_KEY
Bitbucket Server oauth1 consumer key
DRONE_STASH_CONSUMER_RSA
Bitbucket Server oauth1 private key file
DRONE_STASH_GIT_USERNAME
Machine account username used to clone repositories.
DRONE_STASH_GIT_PASSWORD
Machine account password used to clone repositories.
DRONE_GOGS_PRIVATE_MODE=false
Set to true if Gogs is running in private mode.
DRONE_GITLAB=false
Set to true to enable the GitLab driver.
DRONE_GITLAB_URL=https://gitlab.com
GitLab Server address.
DRONE_GITLAB_CLIENT
GitLab oauth2 client id.
DRONE_GITLAB_SECRET
GitLab oauth2 client secret.
DRONE_GITLAB_GIT_USERNAME
Optional. Use a single machine account username to clone all repositories.
DRONE_GITLAB_GIT_PASSWORD
Optional. Use a single machine account password to clone all repositories.
DRONE_GITLAB_SKIP_VERIFY=false
Set to true to disable SSL verification.
DRONE_GITLAB_PRIVATE_MODE=false
Set to true if GitLab is running in private mode.

Agent Options

DRONE_SERVER
Full URL (with protocol) to the Drone Server.
DRONE_SECRET
Shared secret. Must match the value on Drone Server.
DRONE_DEBUG
Set to true to see verbose debugging log output.
DRONE_BACKOFF=15s
Drone Server reconnect backoff duration.
DRONE_TIMEOUT=5m
Build timeout duration for console inactivity.
DRONE_MAX_LOGS=5
Build log size limit, in megabytes
DRONE_PLUGIN_PULL=true
If true, plugin updates are pulled automatically.
DRONE_PLUGIN_PRIVILEGED
Comma-separated list of plugins automatically granted privileged mode.
DOCKER_HOST
Docker host address.
DOCKER_TLS_VERIFY
Docker requires tls verification.
DOCKER_CERT_PATH
Docker certificate path.
DOCKER_MAX_PROCS=2
Docker concurrent build processes.
DOCKER_OS=linux
Docker operating system.
DOCKER_ARCH=amd64
Docker architecture.
HTTP_PROXY
HTTP proxy server.
HTTPS_PROXY
HTTPS proxy server.
NO_PROXY
Proxy server exceptions.