Site Tools


techsupport:guides:vscodessh

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
techsupport:guides:vscodessh [2024/04/10 18:57] – created tshinintechsupport:guides:vscodessh [2024/04/10 19:31] (current) – [Troubleshooting] tshinin
Line 6: Line 6:
 ===== Prerequisites ===== ===== Prerequisites =====
   * The "Remote-SSH" extension must be installed in your VS Code instance. This can be done by navigating to the "Extensions" menu item on the left bar on VS Code, searching for the "Remote - SSH" extension, and installing it.    * The "Remote-SSH" extension must be installed in your VS Code instance. This can be done by navigating to the "Extensions" menu item on the left bar on VS Code, searching for the "Remote - SSH" extension, and installing it. 
-  * The Cisco AnyConnect VPN used by the University must be installed on your main device if you are planning to develop off campus. Do not attempt to download this tool from third party links. It can be downloaded directly from the university's servers at "vpn.uoguelph.ca". Please follow the documentation on the link for your platform+  * The Cisco AnyConnect VPN used by the University must be installed on your main device if you are planning to develop off campus. Do not attempt to download this tool from third party links. It can be downloaded directly from the university's servers at "vpn.uoguelph.ca". Please follow the [[https://uoguelphca.sharepoint.com/sites/ccs/SitePages/anyconnect-vpn-user-guide.aspx|official documentation]] (you will need to login with your University Single Sign On credentials).
  
 ===== Workflow =====  ===== Workflow ===== 
Line 20: Line 20:
   - Navigate to the "Remote Explorer" menu item from the left bar.    - Navigate to the "Remote Explorer" menu item from the left bar. 
   - Right click on the "SSH" folder and choose "New Remote".   - Right click on the "SSH" folder and choose "New Remote".
-  - A prompt will show up at the top of VS Code, enter "ssh [username]@linux.socs.uoguelph.ca"+  - A prompt will show up at the top of VS Code, enter "ssh [username]@linux.socs.uoguelph.ca", where [username] is your university username.
   - A second prompt will ask you for your password. Enter your University single sign on credentials. As of writing, you will not require MFA to authenticate to the SoCS Linux servers.    - A second prompt will ask you for your password. Enter your University single sign on credentials. As of writing, you will not require MFA to authenticate to the SoCS Linux servers. 
   - First time setup will require 1-2 minutes. Following that, you can connect to the linux servers simply by choosing "linux.socs.uoguelph.ca" in the SSH folder and connect.    - First time setup will require 1-2 minutes. Following that, you can connect to the linux servers simply by choosing "linux.socs.uoguelph.ca" in the SSH folder and connect. 
Line 28: Line 28:
 ===== Troubleshooting ===== ===== Troubleshooting =====
 Please note that every time you wish to use Remote-SSH to develop on the SoCS Linux servers from off campus, you will need to connect to the VPN first. Otherwise your credentials in the authentication step will be rejected by the firewall. If you run into any other issues, please reach out to the SoCS IT Team at "help@socs.uoguelph.ca" Please note that every time you wish to use Remote-SSH to develop on the SoCS Linux servers from off campus, you will need to connect to the VPN first. Otherwise your credentials in the authentication step will be rejected by the firewall. If you run into any other issues, please reach out to the SoCS IT Team at "help@socs.uoguelph.ca"
 +
 +=== Git Errors ===
 +A common error that students may run into when developing on the SoCS Linux servers using VS Code is not being able to authenticate on git when cloning or pushing (with a "missing or invalid credentials" error). This error occurs when using git through a terminal opened within VS Code due to a conflict between the git package on the server and the authentication handler of VS Code's Git extension. To resolve this:
 +  - Open VS Code.
 +  - Click on "File" on the top left, then "Preferences", and "Settings".
 +  - Using the search bar, find "git.terminalAuthentication"
 +  - Uncheck the checkbox. 
 +  - Git commands should now authenticate correctly. If they do not, reconnect to the server using Remote-SSH. 
  
  
  
  
techsupport/guides/vscodessh.1712775474.txt.gz · Last modified: 2024/04/10 18:57 by tshinin