Skip to content

Commit

Permalink
Add clarification about SSH agent option (closes #112)
Browse files Browse the repository at this point in the history
  • Loading branch information
toote committed Sep 19, 2022
1 parent f38f467 commit d006412
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit d006412

Please sign in to comment.