Skip to content

Commit 3a891ef

Browse files
authored
[Docs] Add dstack-sshproxy deployment guide (#3720)
1 parent affb2cd commit 3a891ef

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/docs/guides/server-deployment.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,22 @@ The bucket must be created beforehand. `dstack` won't try to create it.
354354
storage.objects.update
355355
```
356356

357+
## SSH proxy
358+
359+
[`dstack-sshproxy`](https://github.com/dstackai/sshproxy) is an optional component that provides direct SSH access to workloads.
360+
361+
Without SSH proxy, in order to connect to a job via SSH or use an IDE URL, the `dstack attach` CLI command must be used, which configures user's SSH client in a backend-specific way for each job.
362+
363+
When SSH proxy is deployed, there is one well-known entry point – a proxy address – for all `dstack` jobs, which can be used for SSH access without any additional steps on the user's side (such as installing `dstack` and executing `dstack attach` each time). All the user has to do is to upload their public key to the `dstack` server once – there is a dedicated “SSH keys” tab on the user's page of the control plane UI.
364+
365+
366+
To deploy SSH proxy, see `dstack-sshproxy` [Deployment guide](https://github.com/dstackai/sshproxy/blob/main/DEPLOYMENT.md).
367+
368+
To enable SSH proxy integration on the `dstack` server side, set the following environment variables:
369+
370+
* `DSTACK_SSHPROXY_API_TOKEN` – a token used to authenticate SSH proxy API requests, must be the same value as when deploying `dstack-sshproxy`.
371+
* `DSTACK_SERVER_SSHPROXY_ADDRESS` – an address where SSH proxy is available to `dstack` users, in the `HOSTNAME[:PORT]` form, where `HOSTNAME` is a domain name or an IP address, and `PORT`, if not specified, defaults to 22.
372+
357373
## Encryption
358374

359375
By default, `dstack` stores data in plaintext. To enforce encryption, you

0 commit comments

Comments
 (0)