Install On Windows

Support for Docker pipelines on Windows is experimental and is not recommended for production use at this time.

This article explains how to install the Docker runner on Windows. The Docker runner is packaged as a minimal Docker image distributed on DockerHub, and is available for the following kernel versions:

  • 1809
  • 1903

Download

Install Docker and pull the public image:

$ docker pull drone/drone-runner-docker:1

Configuration

The Docker runner is configured using environment variables. This article references the below configuration options. See Configuration for a complete list of configuration options.

  • DRONE_RPC_HOST
    provides the hostname (and optional port) of your Drone server. The runner connects to the server at the host address to receive pipelines for execution.
  • DRONE_RPC_PROTO
    provides the protocol used to connect to your Drone server. The value must be either http or https.
  • DRONE_RPC_SECRET
    provides the shared secret used to authenticate with your Drone server. This must match the secret defined in your Drone server configuration.

Installation

The below command creates the a container and start the Docker runner. Remember to replace the environment variables below with your Drone server details.

$ docker run -d \
  -v //./pipe/docker_engine://./pipe/docker_engine \
  -e DRONE_RPC_PROTO=https \
  -e DRONE_RPC_HOST=drone.company.com \
  -e DRONE_RPC_SECRET=super-duper-secret \
  -e DRONE_RUNNER_CAPACITY=2 \
  -e DRONE_RUNNER_NAME=${HOSTNAME} \
  -p 3000:3000 \
  --restart always \
  --name runner \
  drone/drone-runner-docker:1

Verification

Use the docker logs command to view the logs and verify the runner successfully established a connection with the Drone server.

$ docker logs runner

INFO[0000] starting the server
INFO[0000] successfully pinged the remote server