Skip to content

Using SSH in Visual Studio Code (VS Code) to Connect to HiPerGator

To remotely connect to HiPerGator using an SSH key with Visual Studio Code (VS Code), follow the steps below:

Step 1: Install the Remote Development extension

  1. Install the "Remote Development" extension in VS Code by visiting here.
  2. Reload VS Code if necessary after the installation is complete.

Step 2: Configure the SSH key

To configure the SSH key, complete the following steps:

  1. In VS Code, press Ctrl + Shift + P (Windows) or Command + Shift + P (Mac) to open the command palette.
  2. Type "Remote-SSH: Open Configuration File..." and select it from the list.
  3. If you haven't used the Remote Development extension before, you will be prompted to choose a "Connection Type". Select "SSH".
  4. This will open a file called "ssh_config". Scroll down to the "Host" section and add the lines mentioned in SSH Configuration if you haven't already.
  5. Save the file and close it.

Step 3: Connect to the remote server

VSCode SSH Connection Details

To connect to HPG using VS Code, follow these steps:

  1. Press Ctrl + Shift + P (Windows) or Command + Shift + P (Mac) to open the command palette.
  2. Type "Remote-SSH: Connect to Host..." and select it from the list.
  3. Select hpg from the list of hosts (the name you specified in the "Host" section of your ssh_config file).
  4. If this is the first time you're connecting to the server, you'll be prompted to confirm the server's fingerprint. Select "Yes" to continue.
  5. If prompted, enter your SSH key passphrase.
  6. You will need to select the "Details" button in the bottom right. This will let you authenticate with Duo.
  7. Wait for the connection to be established. This may take a few seconds.
  8. Visual Studio Code will connect to the remote server via SSH and open a new window in which you can edit files and run commands on the server.

Step 4: Open a Remote Workspace

Once connected to the remote machine, you can open a remote workspace by clicking on the "Open Folder" button in the Remote Explorer panel and selecting a folder on the remote machine.

Step 5: Submit your jobs

While VSCode can be very convenient for viewing and editing files, the login node you are automatically connected to is not built for running jobs. Make sure you instead submit your jobs and connect to them.