From d00641234fe2d528e1388b20210129bf7f389de8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mat=C3=ADas=20A=2E=20Bellone?= Date: Mon, 19 Sep 2022 20:20:04 -0300 Subject: [PATCH] Add clarification about SSH agent option (closes #112) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 48bb402..54d787e 100644 --- a/README.md +++ b/README.md @@ -233,6 +233,8 @@ Whether to automatically mount the ssh-agent socket from the host agent machine Default: `false` +**Important**: note that for this to work you will need the agent itself to have access to an ssh agent that is: up and running, listening on the appropriate socket, with the appropriate credentials loaded (or to be loaded). Please refer to the [agent's documentation on using SSH agent](https://buildkite.com/docs/agent/v3/ssh-keys#using-multiple-keys-with-ssh-agent) for more information + ### `network` (optional, string) Join the container to the docker network specified. The network will be created if it does not already exist. See https://docs.docker.com/engine/reference/run/#network-settings for more details.