Skip to content

[Docs] Fix head-node key requirements with the SSH proxy #4457

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

Merged
peterschmidt85 merged 1 commit into from
Nov 3, 2026
Merged

[Docs] Fix head-node key requirements with the SSH proxy #4457

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
11 changes: 7 additions & 4 deletions mkdocs/docs/concepts/fleets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,18 +439,21 @@ If hosts are behind a head node (aka "login node"), configure [`proxy_jump`](../

</div>

To be able to attach to runs, both explicitly with `dstack attach` and implicitly with `dstack apply`, you must either add a front node key (`~/.ssh/head_node_key`) to an SSH agent or configure a key path in `~/.ssh/config`:
!!! info "SSH proxy"
If the server does not use the [SSH proxy](../guides/server-deployment.md#ssh-proxy), attaching to runs with `dstack apply` or `dstack attach` requires the head-node key to be loaded into an SSH agent or configured for the head node in `~/.ssh/config`:

<div editor-title="~/.ssh/config">
<div editor-title="~/.ssh/config">

```
Host 3.255.177.50
IdentityFile ~/.ssh/head_node_key
```

</div>
</div>

`Host` must match `ssh_config.proxy_jump.hostname` or `ssh_config.hosts[n].proxy_jump.hostname` for per-host overrides.

where `Host` must match `ssh_config.proxy_jump.hostname` or `ssh_config.hosts[n].proxy_jump.hostname` if you configure head nodes on a per-worker basis.
With the SSH proxy (recommended), users do not need the head-node key to attach to runs.

### Environment variables

Expand Down
Loading