This article explains how to install the ssh runner on Linux using Docker. The ssh runner is packaged as a minimal Docker image distributed on DockerHub.

Download

Install Docker and pull the public image:

$ docker pull drone/drone-runner-ssh

Configuration

The ssh 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 a container and starts the ssh runner. Remember to replace the environment variables below with your Drone server details.

1
2
3
4
5
6
7
8

docker run --detach \
  --env=DRONE_RPC_PROTO=https \
  --env=DRONE_RPC_HOST=drone.company.com \
  --env=DRONE_RPC_SECRET=super-duper-secret \
  --publish=3000:3000 \
  --restart always \
  --name runner \
  drone/drone-runner-ssh

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