Reference

Updated 2 years ago by Admin

Index of server configuration settings:

  • DRONE_BITBUCKET_CLIENT_ID
    String value. Configures the Bitbucket OAuth client id. This is used to authorize access to Bitbucket on behalf of a Drone user.
    DRONE_BITBUCKET_CLIENT_ID=05136e57d80189bef462
  • DRONE_BITBUCKET_CLIENT_SECRET
    String value. Configures the Bitbucket OAuth client secret. This is used to authorize access to Bitbucket on behalf of a Drone user.
    DRONE_BITBUCKET_CLIENT_SECRET=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_BITBUCKET_DEBUG
    Optional boolean value. Configures detailed trace logging for the Bitbucket authentication provide. This should be used to troublshoot problems with login when installing Drone server.
    DRONE_BITBUCKET_DEBUG=false
  • DRONE_CLEANUP_DEADLINE_PENDING
    Optional Optional duration value. Configures the interval after which a pending job will be killed by the reaper. The default value is 24 hours.
    Kill pending jobs older than 24 hours: value. Configures detailed trace logging for the Bitbucket authentication provide. This should be used to troublshoot problems with login when installing Drone server.
    DRONE_CLEANUP_DEADLINE_PENDING=24h
  • DRONE_CLEANUP_DEADLINE_RUNNING
    Optional duration value. Configures the interval after which a running job will be killed by the reaper. The default value is 24 hours.
    Kill running jobs older than 24 hours:
    DRONE_CLEANUP_DEADLINE_RUNNING=24h
  • DRONE_CLEANUP_DISABLED
    Boolean value disables the reaper. The reaper finds and kills zombie jobs that are permanently stuck in a pending or running state. The default value is false.
    DRONE_CLEANUP_DISABLED=true
    DRONE_CLEANUP_DISABLED=false
  • DRONE_CLEANUP_INTERVAL
    Optional duration value. Configures the interval at which the reaper is run. The reaper finds and kills zombie jobs that are permanently stuck in a pending or running state every 24 hours by default.
    Run reaper every 24 hours:
    DRONE_CLEANUP_INTERVAL=24h
    Run reaper every hour:
    DRONE_CLEANUP_INTERVAL=60m
  • DRONE_CONVERT_PLUGIN_ENDPOINT
    String value configures the endpoint for the conversion plugin, used to automatically convert or modify configuration files.
    DRONE_CONVERT_PLUGIN_ENDPOINT=http://hostname.com:3000
  • DRONE_CONVERT_PLUGIN_EXTENSION
    String value configures the file extension that should be used with the conversion plugin. This configuration parameter is used to reduce un-necessary traffic to the conversion plugin for file types that will not otherwise be converted. It is completely optional.
    DRONE_CONVERT_PLUGIN_EXTENSION=.star
  • DRONE_CONVERT_PLUGIN_SECRET
    Shared secret used to create an http-signature. The conversion plugin uses the shared secret to verify request authenticity.
    DRONE_CONVERT_PLUGIN_SECRET=correct-horse-battery-staple
  • DRONE_CONVERT_PLUGIN_SKIP_VERIFY
    Boolean value disables TLS verification when establishing a connection to the remote conversion plugin. The default value is false.
    DRONE_CONVERT_PLUGIN_SKIP_VERIFY=false
  • Optional string value. Configures the secret key used to sign authentication cookies. If unset, a random value is generated each time the server is started.
    DRONE_COOKIE_SECRET=correct-horse-battery-staple
  • Optional duration value. Configures the authentication cookie expiration. This value is optional, with a default value of 72 hours.
    DRONE_COOKIE_TIMEOUT=72h
  • DRONE_CRON_DISABLED
    Boolean value disables the cron scheduler. The default value is false.
    DRONE_CRON_DISABLED=false
  • DRONE_CRON_INTERVAL
    Optional duration value. Configures the interval at which the cron scheduler is run. The cron scheduler is not meant to be accurate and batches pending jobs every hour by default.
    Process pending cron jobs every hour:
    DRONE_CRON_INTERVAL=1h
    Process pending cron jobs every five minutes:
    DRONE_CRON_INTERVAL=5m
    Please note even when you reduce the cron interval, you should not expect high levels of accuracy. Our primary design goal was to create a safe, efficient cron scheduler that prevents users from overloading the system; this comes at the expense of accuracy.

  • DRONE_DATABASE_DATASOURCE
    Optional string value. Configures the database connection string. The default value is the path of the embedded sqlite database file.
    DRONE_DATABASE_DATASOURCE=/data/database.sqlite
    Example mysql connection string (below). See the official driver documentation for more connection string details.
    DRONE_DATABASE_DATASOURCE=root:password@tcp(1.2.3.4:3306)/drone?parseTime=true
    Example postgres connection string (below). See the official driver documentation for more connection string details.
    DRONE_DATABASE_DATASOURCE=postgres://root:password@1.2.3.4:5432/postgres?sslmode=disable
  • DRONE_DATABASE_DRIVER
    Optional String value. Configures the database driver name. The default value is the sqlite3 driver. Alternate drivers are postgres and mysql.
    DRONE_DATABASE_DRIVER=mysql
    DRONE_DATABASE_DRIVER=postgres
    DRONE_DATABASE_DRIVER=sqlite3
  • DRONE_DATABASE_SECRET
    Optional string value. Configures the secret key used to encrypt secrets in the database. Encryption is disabled by default and must be configured before the system is first used.
    DRONE_DATABASE_SECRET=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GIT_ALWAYS_AUTH
    Optional boolean value. Configures Drone to authenticate when cloning public repositories. This is only required when your source code management system (e.g. GitHub Enterprise) has private mode enabled.
    DRONE_GIT_ALWAYS_AUTH=false
  • DRONE_GIT_PASSWORD
    Optional string value. Overrides the default git username and password used to authenticate and clone private repositories.
    DRONE_GIT_USERNAME=x-oauth-token
    DRONE_GIT_PASSWORD=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GIT_USERNAME
    Optional string value. Overrides the default git username and password used to authenticate and clone private repositories.
    DRONE_GIT_USERNAME=x-oauth-token
    DRONE_GIT_PASSWORD=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GITEA_CLIENT_ID
    String value configures the Gitea OAuth client id. This is used to authorize access to Gitea on behalf of a Drone user.
    DRONE_GITEA_CLIENT_ID=05136e57d80189bef462
  • DRONE_GITEA_CLIENT_SECRET
    String value configures the Gitea OAuth client secret. This is used to authorize access to Gitea on behalf of a Drone user.
    DRONE_GITEA_CLIENT_SECRET=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GITEA_SERVER
    String value configures the Gitea server address.
    DRONE_GITEA_SERVER=https://try.gitea.io
  • DRONE_GITEA_SKIP_VERIFY
    Boolean value disables tls verification when establishing a connection to the remote Gitea server. The default value is false.
    DRONE_GITEA_SKIP_VERIFY=false
  • DRONE_GITHUB_CLIENT_ID
    String value configures the GitHub OAuth client id. This is used to authorize access to GitHub on behalf of a Drone user.
    DRONE_GITHUB_CLIENT_ID=05136e57d80189bef462
  • DRONE_GITHUB_CLIENT_SECRET
    String value configures the GitHub oauth client secret. This is used to authorize access to GitHub on behalf of a Drone user.
    DRONE_GITHUB_CLIENT_SECRET=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GITHUB_SCOPE
    String value provides a comma-separated list of OAuth scopes. The default values should not be modified.
    DRONE_GITHUB_SCOPE=repo,repo:status,user:email,read:org
  • DRONE_GITHUB_SERVER
    String value configures the GitHub server address. The default value is https://github.com.
    DRONE_GITHUB_SERVER=https://github.com
  • DRONE_GITHUB_SKIP_VERIFY
    Boolean value disables TLS verification when establishing a connection to the remote GitHub server. The default value is false.
    DRONE_GITHUB_SKIP_VERIFY=false
  • DRONE_GITLAB_CLIENT_ID
    String value configures the GitLab OAuth client id. This is used to authorize access to GitLab on behalf of a Drone user.
    DRONE_GITLAB_CLIENT_ID=05136e57d80189bef462
  • DRONE_GITLAB_CLIENT_SECRET
    String value configures the GitLab OAuth client secret. This is used to authorize access to GitLab on behalf of a Drone user.
    DRONE_GITLAB_CLIENT_SECRET=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GITLAB_SERVER
    String value configures the GitLab server address. The default value is https://gitlab.com
    DRONE_GITLAB_SERVER=https://gitlab.com
  • DRONE_GITLAB_SKIP_VERIFY
    Boolean value disables TLS verification when establishing a connection to the remote GitLab server. The default value is false.
    DRONE_GITLAB_SKIP_VERIFY=false
  • DRONE_GOGS_SERVER
    String value configures the Gogs server address.
    DRONE_GOGS_SERVER=https://try.gogs.io
  • DRONE_GOGS_SKIP_VERIFY
    Boolean value configures TLS verification when establishing a connection to the remote Gogs server. The default value is false.
    DRONE_GOGS_SKIP_VERIFY=false
  • DRONE_JSONNET_ENABLED
    Boolean value configures Drone to automatically convert configuration files ending in .jsonnet to yaml. This is disabled by default and should only be enabled in trusted environments.
    DRONE_JSONNET_ENABLED=true
  • DRONE_PROMETHEUS_ANONYMOUS_ACCESS
    Boolean value configures the Prometheus metrics endpoint to allow anonymous access. This is disabled by default and requires authentication token to access the metrics endpoint.
    DRONE_PROMETHEUS_ANONYMOUS_ACCESS=false
  • DRONE_REGISTRATION_CLOSED
    Boolean value disables open registration. If enabled, a system administrator must create user accounts before the user can login.
    DRONE_REGISTRATION_CLOSED=false
  • DRONE_REPOSITORY_FILTER
    Optional comma-separated list of accounts, used to limit which repositories are syncronized between your source control management system and Drone. Note that this variable must be set before your first login. Setting this variable after having already authenticated and syncronized your account has no effect.
    DRONE_REPOSITORY_FILTER=octocat,spacheghost
  • DRONE_RPC_SECRET
    Required literal value provides the Drone shared secret. This is used to authenticate the RPC connection to the server. The server and runners must be provided the same secret value.
    DRONE_RPC_SECRET=correct-horse-batter-staple
  • DRONE_S3_BUCKET
    Optional string value configures the S3 bucket name.
    DRONE_S3_BUCKET=my-bucket
  • DRONE_S3_ENDPOINT
    Optional string value configures the S3 endpoint. The is often used with S3-compatible services such as Minio.
    DRONE_S3_ENDPOINT=https://play.min.io
  • DRONE_S3_PATH_STYLE
    Optional boolean value configures the S3 client to use path style. The is often used with S3-compatible services such as Minio.
    DRONE_S3_PATH_STYLE=false
  • DRONE_S3_PREFIX
    Optional string value configures the S3 client to store log files in a bucket subdirectory. If unset log files are stored in the bucket root.
    DRONE_S3_PREFIX=some/path
  • DRONE_SERVER_HOST
    Required string value configures the user-facing hostname. This value is used to create webhooks and redirect urls. It has no actual impact on serving traffic.
    DRONE_SERVER_HOST=drone.company.com
  • DRONE_SERVER_PROTO
    Required string value configures the user-facing protocol. This value is used to create webhooks and redirect urls. It has no actual impact on serving traffic.
    DRONE_SERVER_PROTO=https
  • DRONE_SERVER_PROXY_HOST
    Optional string value used to create webhooks that are routed through an alternate proxy server. The target use case for this setting is when your server is behind a firewall and you need GitHub webhooks to route through a public proxy.
    DRONE_SERVER_PROXY_HOST=external.drone.company.com
  • DRONE_SERVER_PROXY_PROTO
    Optional string value used to create webhooks that are routed through an alternate proxy server. The target use case for this setting is when your server is behind a firewall and you need GitHub webhooks to route through a public proxy.
    DRONE_SERVER_PROXY_PROTO=https
  • DRONE_STARLARK_ENABLED
    Boolean value configures Drone to automatically execute files ending in .star to provide your pipeline configurations. This is disabled by default. This feature requires Drone server version 1.10.0 or higher.
    DRONE_STARLARK_ENABLED=true
  • DRONE_STASH_CONSUMER_KEY
    String value configures your Bitbucket Server consumer key.
    DRONE_STASH_CONSUMER_KEY=OauthKey
  • DRONE_STASH_PRIVATE_KEY
    String value configures the path to your Bitbucket Server private key file. Note that this file needs to also be mounted into the Drone server container as a volume.
    DRONE_STASH_PRIVATE_KEY=/etc/bitbucket/key.pem
  • DRONE_STASH_SERVER
    String value configures the Bitbucket Server address.
    DRONE_STASH_SERVER=https://bitbucket.company.com
  • DRONE_STASH_SKIP_VERIFY
    Boolean value disables TLS verification when establishing a connection to the remote Bitbucket server. The default value is false.
    DRONE_STASH_SKIP_VERIFY=false
  • DRONE_STATUS_DISABLED
    Boolean value disables the system from using the status API to communicate build state to the source control management system. The default value is false.
    DRONE_STATUS_DISABLED=true
  • DRONE_STATUS_NAME
    String value configures the status name used to communicate build state to the source control management system. The default value is continuous-integration/drone.
    DRONE_STATUS_NAME=continuous-integration/drone
  • DRONE_TLS_AUTOCERT
    Automatically generates an SSL certificate using Lets Encrypt, and configures the server to accept HTTPS requests. This configuration parameter is of type boolean and is optional, and is disabled by default.
    DRONE_TLS_AUTOCERT=true
  • DRONE_TLS_CERT
    Path to an SSL certificate used by the server to accept HTTPS requests. This configuration parameter is of type string and is optional.
    Please note that the cert file should be the concatenation of the server’s certificate, any intermediates, and the certificate authority’s certificate.
    DRONE_TLS_CERT=/path/to/cert.pem
  • DRONE_TLS_KEY
    Path to an SSL certificate key used by the server to accept HTTPS requests. This configuration parameter is of type string and is optional.
    DRONE_TLS_KEY=/path/to/key.pem
  • DRONE_USER_CREATE
    Optional user account that should be created on startup. This should be used to seed the system with an administrative account. It can be a real account (i.e. a real GitHub user) or it can be a machine account.
    DRONE_USER_CREATE=username:octocat,machine:false,admin:true,token:55f24eb3d61ef6ac5e83d550178638dc
    Providing a token is required for machine accounts, and must be 32 bytes. You can generate a random 32-byte token with the following command:
    $ openssl rand -hex 16
    55f24eb3d61ef6ac5e83d550178638dc
  • DRONE_USER_FILTER
    Optional comma-separated list of accounts. Registration is limited to users in this list, or users that are members of organizations included in this list.
    DRONE_USER_FILTER=octocat,spacheghost,github
    If a user attempts to register and they are not a named user and not a member of a named organization, they will receive the following error:
    Login Failed. User must be a member of an approved organization.
  • DRONE_VALIDATE_PLUGIN_ENDPOINT
    String value configures the endpoint for the validation plugin, used to enforce custom linting rules for your pipeline configuration.
    DRONE_VALIDATE_PLUGIN_ENDPOINT=http://hostname.com:3000
  • DRONE_VALIDATE_PLUGIN_SECRET
    Shared secret used to create an http-signature. The validation plugin uses the shared secret to verify request authenticity.
    DRONE_VALIDATE__PLUGIN_SECRET=correct-horse-battery-staple
  • DRONE_VALIDATE_PLUGIN_SKIP_VERIFY
    Boolean value disables TLS verification when establishing a connection to the remote validation plugin. The default value is false.
    DRONE_VALIDATE_PLUGIN_SKIP_VERIFY=false
  • DRONE_WEBHOOK_ENDPOINT
    String value configures a comma-separated list of webhook endpoints, to which global system events are delivered.
    DRONE_WEBHOOK_ENDPOINT=http://postb.in/b/cajf7cIU
  • DRONE_WEBHOOK_EVENTS
    Optional string value provides a comma-separated list of events and actions that trigger webhooks. If unset all events and actions trigger webhooks.
    Limit by event type:
    DRONE_WEBHOOK_EVENTS=user,build
    Limit by event type and action:
    DRONE_WEBHOOK_EVENTS=user:created,repo
    List of available events:
    user:created
    user:updated
    user:deleted
    repo:enabled
    repo:disabled
    repo:updated
    build:created
    build:updated
  • DRONE_WEBHOOK_SECRET
    Shared secret used to create an http-signature. The webhook recipient can use the shared secret to verify request authenticity.
    DRONE_WEBHOOK_SECRET=correct-horse-battery-staple
  • DRONE_WEBHOOK_SKIP_VERIFY
    Boolean value disables TLS verification when establishing a connection to the remote webhook address. The default value is false.
    DRONE_WEBHOOK_SKIP_VERIFY=false

How did we do?