Sitelet https://github.com/docker/docs/pull/26295/files
Skip to content

docs: document Windows SSH agent selection #26295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dvdksn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document Windows SSH agent selection #26295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/manuals/ai/sandboxes/configuration/credentials.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ $ sbx settings set ssh.agentSocketPath "$SSH_AUTH_SOCK"
```

An empty [`ssh.agentSocketPath`](settings.md#sshagentsocketpath), which is the
default, uses each client's current `SSH_AUTH_SOCK` instead. Use
default, uses the agent supplied by each client instead. Use
[`ssh.agentForwardingEnabled`](settings.md#sshagentforwardingenabled) to turn
forwarding on or off.

Expand Down
15 changes: 11 additions & 4 deletions content/manuals/ai/sandboxes/configuration/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,10 +214,17 @@ $ sbx daemon restart
```

Run this from a shell whose `SSH_AUTH_SOCK` points to the intended agent. The
command stores that path, not a reference to the variable. With an empty value,
Docker Sandboxes uses the socket supplied by each client instead. Remove the
fixed path with `sbx settings unset ssh.agentSocketPath` and restart the daemon
to update existing forwarders.
command stores that path, not a reference to the variable.

When this setting is empty, Docker Sandboxes uses the `SSH_AUTH_SOCK` value
supplied by each client. On Windows, if `SSH_AUTH_SOCK` is also unset, it uses
the `\\.\pipe\openssh-ssh-agent` named pipe. This works with Windows OpenSSH
and with 1Password's SSH agent when it provides that pipe. The host agent must
be running. Set `SSH_AUTH_SOCK` or configure `ssh.agentSocketPath` to use a
different agent.

Remove the fixed path with `sbx settings unset ssh.agentSocketPath` and restart
the daemon to update existing forwarders.

### Images and storage

Expand Down