software:vscode:darwin

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
software:vscode:darwin [2024-04-26 17:35] – [Connect VSCode to compute node] anitasoftware:vscode:darwin [2025-03-13 16:27] (current) – [Setting up remote connections] anita
Line 2: Line 2:
  
 ==== Download and install ==== ==== Download and install ====
-  - Install the [[http://code.visualstudio.com/download|Stable Build VSCode]] on the local machine. **DO NOT** install the VSCode Insiders Build, as it will not work with the proxy.+  - Install the [[http://code.visualstudio.com/download|Stable Build VSCode]] on the local machine. **DO NOT** install the VSCode Insiders Build, as it will not work with the proxy. If the version of VSCode downloaded is newer than version 1.90, please make sure to do these [[software:vscode:darwin#additional-steps-required-for-vscode-newer-than-version-190|additional steps]].
   - Install a [[https://code.visualstudio.com/docs/remote/troubleshooting|supported SSH client]].   - Install a [[https://code.visualstudio.com/docs/remote/troubleshooting|supported SSH client]].
   - In the extensions tab of VSCode, search for [[https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh|Remote - SSH]] and install.   - In the extensions tab of VSCode, search for [[https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh|Remote - SSH]] and install.
Line 45: Line 45:
 {{:software:vscode:vscode-7.png?400|}} {{:software:vscode:vscode-7.png?400|}}
  
-It will open the Config file located in the path specified by ''~/vscode-remote-ssh/config''. You can have multiple configurations used for DARWIN with different Host definitions. For example, in the following Config file, ''Host DARWIN'' starts the interactive job on ''it_css'' partition and requests one CPU for the remote shell to use. ''Host DARWINGPU'' requests to use a GPU and ''Host DARWINMPI'' can be used for MPI. +It will open the Config file located in the path specified by ''~/vscode-remote-ssh/config''. You can have multiple configurations used for DARWIN with different Host definitions. For example, in the following Config file, ''Host DARWIN'' starts the interactive job using ''it_css'' workgroup and ''idle'' partition and requests one CPU for the remote shell to use. ''Host DARWINGPU'' requests to use a GPU and ''Host DARWINMPI'' can be used for MPI. 
  
 For this example,  the Config file ''~/vscode-remote-ssh/config'' contains the following definitions (remember User ''traine'' should be replace with your username as well as possible partition and other options) For this example,  the Config file ''~/vscode-remote-ssh/config'' contains the following definitions (remember User ''traine'' should be replace with your username as well as possible partition and other options)
Line 138: Line 138:
 {{:software:vscode:vscode-9.png?400|}} {{:software:vscode:vscode-9.png?400|}}
  
 +==== Additional Steps required for VSCode newer than version 1.90 ====
 +
 +Recent releases of VSCode require a newer version of ''wget'' than the system's default version on DARWIN. This discrepancy can result in a "connection failed" error as reported and discussed [[https://groups.google.com/a/udel.edu/g/hpc-ask/c/l8jvUHk2bUE/m/mAzWz7k5AAAJ|here]]. To resolve this, wget v1.24.5 has been installed at ''/opt/shared/wget/bin/wget''. 
 +
 +<note important>
 +
 +To ensure the updated version of wget is used by default, you can create a symbolic link in your ''~/bin'' directory by following the steps below:
 +
 +
 +1. Create a bin directory in your home directory (if it doesn't already exist):
 +<code>mkdir ~/bin</code>
 +
 +
 +2. Create a symbolic link for wget v1.24.5 in the ''~/bin'' directory:
 +<code>ln -s /opt/shared/wget/1.24.5/bin/wget ~/bin/wget</code>
 +
 +3. Modify your ''~/.bash_profile'' on DARWIN:
 +
 +Update the PATH variable by changing the line from:
 +<code>PATH=$PATH:$HOME/.local/bin:$HOME/bin</code> 
 +to:
 +<code>PATH=$HOME/.local/bin:$HOME/bin:$PATH</code>
 +
 +4. Apply the changes to your ''~/.bash_profile'':
 +
 +After making the changes, you can apply them by either logging out and back in or by running:
 +<code>source ~/.bash_profile</code>
 +
 +</note>
 ==== Using SSH keys ==== ==== Using SSH keys ====
 SSH public key authentication is a secure way to authenticate with an SSH host by combining a local "private" key with a "public" key associated with your user account. Once you set up the SSH keys, you will not need to enter the password for every login. If you have previously set up your SSH keys (i.e. you can login with SSH to DARWIN without having to enter your password), then you do not need to do this step unless you want to create SSH keys specifically for VSCode.  Please only generate the SSH keys on the trusted computer. For macOS / Linux, you can run the following command in a local terminal: SSH public key authentication is a secure way to authenticate with an SSH host by combining a local "private" key with a "public" key associated with your user account. Once you set up the SSH keys, you will not need to enter the password for every login. If you have previously set up your SSH keys (i.e. you can login with SSH to DARWIN without having to enter your password), then you do not need to do this step unless you want to create SSH keys specifically for VSCode.  Please only generate the SSH keys on the trusted computer. For macOS / Linux, you can run the following command in a local terminal:
  • software/vscode/darwin.1714167322.txt.gz
  • Last modified: 2024-04-26 17:35
  • by anita