Skip to content

Commit 0534563

Browse files
committed
SSH passphrase issue
1 parent 653cfa4 commit 0534563

File tree

4 files changed

+25
-0
lines changed

4 files changed

+25
-0
lines changed

docs/remote/containers.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -595,6 +595,7 @@ See the following examples dev containers for additional information:
595595
* Alpine Linux or Windows container images are not yet supported. Most images come with a Debian or Ubuntu based flavor you can use instead. (Typically Alpine variations end in `-alpine`).
596596
* All roots/folders in a multi-root workspace will be opened in the same container, regardless of whether there are configuration files at lower levels.
597597
* The unofficial Ubuntu Docker **snap** package for Linux is **not** supported. Follow the [official Docker install instructions for your distribution](https://docs.docker.com/install/#supported-platforms).
598+
* If you clone a Git repository using SSH and your SSH key has a passphrase, VS Code's pull and sync features may hang when running remotely. Either use a SSH key without a passphrase, clone using HTTPS, or run `git push` from the command line to work around the issue.
598599
* Local proxy settings are not reused inside the container, which can prevent extensions from working unless the appropriate proxy information is configured (for example global `HTTP_PROXY` or `HTTPS_PROXY` environment variables with the appropriate proxy information).
599600
600601
See [here for a list of active issues](https://aka.ms/vscode-remote/containers/issues) related to Containers.

docs/remote/ssh.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ VS Code's local user settings are also reused when you are connected to an SSH h
169169
- Linux hosts must have Bash (`/bin/bash`), `tar`, and either `curl` or `wget` installed.
170170
- PuTTY is not supported on Windows.
171171
- You cannot drag files out of the File Explorer to your local filesystem to copy them.
172+
- If you clone a Git repository using SSH and your SSH key has a passphrase, VS Code's pull and sync features may hang when running remotely. Either use a SSH key without a passphrase, clone using HTTPS, or run `git push` from the command line to work around the issue.
172173
- Local proxy settings are not reused on the remote host, which can prevent extensions from working unless the appropriate proxy information is configured on the remote host (for example global `HTTP_PROXY` or `HTTPS_PROXY` environment variables with the appropriate proxy information).
173174
- See [here for a list of active issues](https://aka.ms/vscode-remote/ssh/issues) related to SSH.
174175

docs/remote/troubleshooting.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,12 @@ icacls "%FILEORFOLDERTOUPDATE%" /c /inheritance:r /grant %USERDOMAIN%\%USERNAME%
238238
| Debian / Ubuntu | Run `sudo apt-get install openssh-server` | See the [Ubuntu SSH](https://help.ubuntu.com/community/SSH?action=show) documentation for additional setup instructions. |
239239
| RHEL / Fedora / CentOS | Run `sudo yum install openssh-server && sudo systemctl start sshd.service && sudo systemctl enable sshd.service` | You may need to omit `sudo` when running in a container. |
240240

241+
### Resolving hangs when doing a Git push or sync on a SSH host
242+
243+
If you clone a Git repository using SSH and your SSH key has a passphrase, VS Code's pull and sync features may hang when running remotely.
244+
245+
Either use a SSH key without a passphrase, clone using HTTPS, or run `git push` from the command line to work around the issue.
246+
241247
## Container tips
242248

243249
### Docker Desktop for Windows tips
@@ -314,6 +320,13 @@ git config --global user.email "your.email@address"
314320

315321
You can also opt to extend your configuration instead to achieve the same thing without modifying your existing Docker Compose file. See [here for additional details](/docs/remote/containers.md#extending-your-docker-compose-file-for-development).
316322

323+
### Resolving hangs when doing a Git push or sync from a Container
324+
325+
If you clone a Git repository using SSH and your SSH key has a passphrase, VS Code's pull and sync features may hang when running remotely.
326+
327+
Either use a SSH key without a passphrase, clone using HTTPS, or run `git push` from the command line to work around the issue.
328+
329+
317330
### Resolving errors about missing Linux dependencies
318331

319332
Some extensions rely on libraries not found in the certain Docker images. See the [primary containers article](/docs/remote/containers.md#installing-additional-software-in-the-sandbox) for a few options on resolving this issue.
@@ -560,6 +573,12 @@ You can add other file types in your repository that require CRLF to this same f
560573

561574
Finally, re-clone the repository for so these setting take effect.
562575

576+
### Resolving hangs when doing a Git push or sync from WSL
577+
578+
If you clone a Git repository using SSH and your SSH key has a passphrase, VS Code's pull and sync features may hang when running remotely.
579+
580+
Either use a SSH key without a passphrase, clone using HTTPS, or run `git push` from the command line to work around the issue.
581+
563582
## Extension tips
564583

565584
While many extensions will work unmodified, there are a few issues that can prevent certain features from working as expected. In some cases, you can use another command to work around the issue, while in others the extension may need to be modified. This section provides a quick reference for common issues and tips on resolving them. You can also refer to the main extension article on [Supporting Remote Development](/api/advanced-topics/remote-extensions) for an in-depth guide on modifying extensions when required.

docs/remote/wsl.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,10 @@ NodeJS Error: spawn EACCES (different variants of this error) | https://github.c
132132
Webpack HMR not working | https://github.com/Microsoft/WSL/issues/2709 |
133133
Firebase via node unusably slow only on WSL | https://github.com/Microsoft/WSL/issues/2657 |
134134

135+
### Git limitations
136+
137+
If you clone a Git repository using SSH and your SSH key has a passphrase, VS Code's pull and sync features may hang when running remotely. Either use a SSH key without a passphrase, clone using HTTPS, or run `git push` from the command line to work around the issue.
138+
135139
### Docker Extension limitations
136140

137141
The Docker extension is configured to run as a local "UI" extension that runs on the Windows side by default. This enables the extension to work with your local Docker installation when you are developing inside a container. However, some Docker commands invoked from the Docker extension can fail from a WSL window. If you want the Docker extension to interact with an installed Docker CLI in WSL instead, add the following to `settings.json`:

0 commit comments

Comments
 (0)