Skip to main content

Use SSH

The basic terminal SSH access that RunPod exposes is not a full SSH connection and, therefore, does not support commands like SCP. If you want to have full SSH capabilities, then you will need to rent an instance that has public IP support and run a full SSH daemon in your Pod.

Setup​

  1. Generate your public/private SSH key pair on your local machine with ssh-keygen -t ed25519 -C "your_email@example.com". This will save your public/private key pair to ~/.ssh/id_ed25519.pub and ~/.ssh/id_ed25519, respectively.\
    note

    if you're using command prompt in Windows rather than the Linux terminal or WSL, your public/private key pair will be saved to C:\users\{yourUserAccount}\.ssh\id_ed25519.pub and C:\users\{yourUserAccount}\.ssh\id_ed25519, respectively.

  1. Add your public key to your RunPod user settings.

  1. Start your Pod. Make sure of the following things:
  • Your Pod supports a public IP, if you're deploying in Community Cloud.
  • An SSH daemon is started. If you're using a RunPod official template such as RunPod Stable Diffusion, you don't need to take any additional steps. If you're using a custom template, make sure your template has TCP port 22 exposed and use the following Docker command. If you have an existing start command, replace sleep infinity at the end with your existing command:
bash -c 'apt update;DEBIAN_FRONTEND=noninteractive apt-get install openssh-server -y;mkdir -p ~/.ssh;cd $_;chmod 700 ~/.ssh;echo "$PUBLIC_KEY" >> authorized_keys;chmod 700 authorized_keys;service ssh start;sleep infinity'

Once your Pod is done initializing, you'll be able to SSH into it by running the SSH over exposed TCP command in the Pod's Connection Options menu on your local machine.

note
  • if you're using the Windows Command Prompt rather than the Linux terminal or WSL, and you've used the default key location when generating your public/private key pair (i.e., you didn't specify a different file path when prompted), you'll need to modify the file path in the provided SSH command after the -i flag to C:\users\{yourUserAccount}\.ssh\id_ed25519.
  • If you've saved your key to a location other than the default, specify that path you chose when generating your key pair after the -i flag instead.

What's the SSH password?​

If you're being prompted for a password when you attempt to connect, something is amiss. We don't require a password for SSH connections. Some common mistakes that cause your SSH client to prompt for a password include:

  • Copying and pasting the key fingerprint (beginning with SHA256:) into your RunPod user settings instead of the public key itself (the contents of the id_ed25519.pub file when viewed from a text editor)
  • Omitting the encryption type from the beginning of the key when copying and pasting into your RunPod user settings (i.e., copying the random text, but not the ssh-ed25519 which precedes it)
  • Not separating different public keys in your RunPod user settings with a newline between each one (this would result in the first public/private key pair functioning as expected, but each subsequent key pair would not work)
  • Specifying an incorrect file path to your private key file:

  • Attempting to use a private key that other users on the machine have permissions for:

  • Incorrect Private Key being used locally in SSH config file. There should be a config file on your local machine in your ~/.ssh folder. You want to ensure that the IdentityFile in the config file points to the private key of the public key you used to make this connection. If you are not pointing to the correct private key in the config file, when you make a connection request using your public key, you will get a mismatch and be prompted for a password. Once the correct private key is set in your config file, you can connect without a password.

private-key-fix