Windows Powershell

Modern versions of Windows support running CLI ssh commands in PowerShell. We recommemnd you use the CLI wherever possible.
This guide will focus only on Windows GUI tools. If you would like to proceed with the CLI, please navigate to the full SSH guide for setup information.

Jupyter Terminal - SSH Alternative

As a simple alternative to SSH, you might like to consider Jupyter Terminal instead. All instances started in Jupyter launch mode will have this enabled. It is a very straightforward web-based terminal with session persistence. It’s great for a quick CLI session. Access the terminal from the SSH connections interface
Jupyter Terminal

Jupyter Terminal

GUI Setup Guide (Windows)

Several GUI tools are available to help with SSH connectivity. While it is often most straightforward to use the terminal we will cover some of the popular options here. For each application we will assume the following:
  • IP address: 142.114.29.158
  • Port: 46230
  • Username: root
To find your own connection details you can click the SSH button on your instance card.
SSH Button

SSH Button


Example SSH Details

Example SSH Details

PuTTY

PuTTY consists of two important components - PuTTY for making connections and PuTTYGen for creating SSH keys. First, we will generate a public and private key pair. PuTTy uses its own .ppk private key type. Open PuTTYGen and click the ‘Generate’ button. You will be asked to move your mouse around until the green bar is full.
Key generation interface

PuTTYgen Key Generation

Once the key generation has completed, save both your public and private key somewhere safe such as in your Documents folder. Optionally you can enter a passphrase for your private key for added security. Next, copy the full public key to the clipboard and add it to your account at https://cloud.vast.ai/manage-keys/ Any keys stored at the account level will automatically be added to new instances as they are created. If you have an existing instance you can add keys to it from the instance card.
Save keys interface

Save Keys

Now that we have a suitable key to use, close PuTTYGen and open the main PuTTY application. In the ‘Session’ tab, enter the IP address and the port
PuTTY session tab

PuTTY session tab

Next, move to the ‘Connection -> Data` tab and set the Auto-login username to ‘root’
Connection data tab

Connection data tab

Now navigate to ‘Connection -> SSH -> Auth -> Credentials’ and browse for the private key (.ppk) that you saved earlier.
SSH credentials tab

SSH credentials tab

Finally navigate back to the ‘Sessions’ tab to save the connection details. Here I have saved the session with the instance ID so that I can access it again later.
Save connection

Save connection

Finally, Click the ‘Open’ button to be connected to your instance. PuTTY has many additional features to explore. Find the full documentation here.

MobaXterm

First, we need to create a public and private key pair. MobaXterm uses puTTY style .ppk keys. Open the application and navigate to Tools -> MobaKeyGen (SSH Key Generator) Glick the ‘Generate’ button. You will be asked to move your mouse around until the green bar is full.
Key generation interface

Generate Key

Once the key generation has completed, save both your public and private key somewhere safe such as in your Documents folder. Optionally you can enter a passphrase for your private key for added security. Next, copy the full public key to the clipboard and add it to your account at https://cloud.vast.ai/manage-keys/ Any keys stored at the account level will automatically be added to new instances as they are created. If you have an existing instance you can add keys to it from the instance card.
Save keys interface

Save Keys


Now you can close the key generation interface. We will create a new session. Navigate to Sessions -> New Session -> SSH
Sesison interface

Create a Session

Important details to complete:
  • Remote Host
  • Specify Username (root)
  • Port
  • Use private key
Click ‘OK’ and you will be connected to the instance.
SSH terminal

Successful Connection

You can find the documentation for MobaXterm here.

Other GUI Clients

Many GUI clients are available for Windows and other operating systems, and although it is not possible to cover all of these here, the key things to remember when setting up are:
  • Create a public and private key pair
  • Add the public key to your vast account and any running instances
  • Keep the private key safe
  • Ensure you are connecting to the correct IP address and port as user root