Skip to content

docs: Add screenshots for SSH connection workflow #474

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
promptless wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add screenshots for SSH connection workflow #474

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
12 changes: 12 additions & 0 deletions pods/configuration/use-ssh.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ You can also SSH into a Pod using a [password-based method](#password-based-ssh)
<Step title="Add the key to your Runpod account">
Copy and paste your public key from the previous step into the **SSH Public Keys** field in your [Runpod user account settings](https://www.console.runpod.io/user/settings).

<Frame alt="SSH Public Keys field in user settings">
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2tHD09rTU0IcE4clVjTuJCTn0an/user-settings-ssh-keys-1764848225.png" />
</Frame>

<Warning>
If you need to add multiple SSH keys to your Runpod account, make sure that each key pair is on its own line in the **SSH Public Keys** field.
</Warning>
Expand All @@ -66,12 +70,20 @@ All Pods provide a basic SSH connection that is proxied through Runpod's systems

<Step title="Open your Pod's connect tab">
Navigate to the [Pods page](https://console.runpod.io/pods) in the Runpod console. Select the Pod you want to connect to from the list to open its connection options.

<Frame alt="Pods list page">
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2tHD09rTU0IcE4clVjTuJCTn0an/pods-list-1764848226.png" />
</Frame>
</Step>

<Step title="Copy the SSH command">

In the Pod's **Connect** tab, copy the command listed under **SSH**. It should look something like this:

<Frame alt="Basic SSH command in Pod Connect tab">
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2tHD09rTU0IcE4clVjTuJCTn0an/pod-connect-ssh-basic-1764848226.png" />
</Frame>

```sh
ssh [email protected] -i ~/.ssh/id_ed25519
```
Expand Down