Update broken links and tune for A11y
This commit is contained in:
Greg Van Liew
Родитель
d511fc5bc6
Коммит
40b58fcab8
|
|
@ -191,3 +191,22 @@ function fancyAlert(arg) {
|
|||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Gotchas
|
||||
|
||||
### Double opening curly braces break generated handlebar files
|
||||
|
||||
Escape double opening curly braces in code blocks.
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Hello, Flask</title>
|
||||
</head>
|
||||
<body>
|
||||
<strong>Hello there, \{{ name }}!</strong> It's \{{ date.strftime("%A, %d %B, %Y at %X") }}.
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
|
@ -27,7 +27,7 @@ VS Code APIs are designed to automatically run on the correct machine (either lo
|
|||
|
||||
## Testing and debugging your extension
|
||||
|
||||
This section explains how to test and debug a development version of your extension in remote workspaces. Specifically, we will look at how to test an extension using a local [dev container](/docs/remote/containers). Dev containers are cross-platform, easy to set up, and restrict port and file system access. Combined with a very thin OS footprint, dev containers provide the environment where your extension is most likely to hit a problem (if it has one at all). WSL, on the other hand, is typically the least restrictive, with SSH being somewhere in the middle. In most cases, only small adjustments are needed to resolve issues. See [common problems](#common-problems) for more information.
|
||||
This section explains how to test and debug a development version of your extension in remote workspaces. Specifically, we will look at how to test an extension using a local [dev container](/docs/remote/containers). Dev containers are cross-platform, easy to set up, and restrict port and file system access. Combined with a thin OS footprint, dev containers provide the environment where your extension is most likely to hit a problem (if it has one at all). WSL, on the other hand, is typically the least restrictive, with SSH being somewhere in the middle. In most cases, only small adjustments are needed to resolve issues. See [common problems](#common-problems) for more information.
|
||||
|
||||
### Installing a development version of your extension
|
||||
|
||||
|
|
@ -96,7 +96,7 @@ VS Code's APIs are designed to automatically run in the right location regardles
|
|||
|
||||
### Incorrect execution location
|
||||
|
||||
If your extension is not functioning as expected, it may be running in the wrong location. Most commonly, this shows up as an extension running remotely when you expect it to only be run locally. You can use the **Developer: Show Running Extensions** command from the command palette (`kbstyle(F1)`) to see where an extension is running.
|
||||
If your extension is not functioning as expected, it may be running in the wrong location. Most commonly, this shows up as an extension running remotely when you expect it to only be run locally. You can use the **Developer: Show Running Extensions** command from the Command Palette (`kbstyle(F1)`) to see where an extension is running.
|
||||
|
||||
If the **Developer: Show Running Extensions** command shows that a UI extension is incorrectly being treated as a workspace extension or vice versa, try setting the `extensionKind` property in your extension's [`package.json`](/api/get-started/extension-anatomy#extension-manifest):
|
||||
|
||||
|
|
@ -268,11 +268,11 @@ export async function activate(context: vscode.ExtensionContext) {
|
|||
|
||||
### Communicating between extensions using commands
|
||||
|
||||
Some extensions return APIs as a part of their activation that are intended for other extensions to use (via `vscode.extension.getExtension(extensionName).exports`). While these will work if all extensions involved are on the same side (either all UI Extensions or all Workspace Extensions), these will not work between UI and Workspace Extensions.
|
||||
Some extensions return APIs as a part of their activation that are intended for use by other extensions (via `vscode.extension.getExtension(extensionName).exports`). While these will work if all extensions involved are on the same side (either all UI Extensions or all Workspace Extensions), these will not work between UI and Workspace Extensions.
|
||||
|
||||
Fortunately, VS Code automatically routes any executed commands to the correct extension regardless of its location. You can freely invoke any command (including those provided by other extensions) without worrying about impacts.
|
||||
|
||||
If you have a set of extensions that need to interact with one another, exposing functionality using a private command can help you avoid unexpected impacts. However, note that any objects you pass in as parameters will be "stringified" (`JSON.stringify`) before being transmitted, so the object cannot have cyclic references and will end up as a "plain old javascript object" on the other side.
|
||||
If you have a set of extensions that need to interact with one another, exposing functionality using a private command can help you avoid unexpected impacts. However, any objects you pass in as parameters will be "stringified" (`JSON.stringify`) before being transmitted, so the object cannot have cyclic references and will end up as a "plain old javascript object" on the other side.
|
||||
|
||||
For example:
|
||||
|
||||
|
|
@ -355,7 +355,7 @@ To solve this problem:
|
|||
|
||||
1. Include (or dynamically acquire) both sets of binaries (Electron and standard Node.js) for the "modules" version in Node.js that VS Code ships.
|
||||
2. Check to see if `context.executionContext === vscode.ExtensionExecutionContext.Remote` in your activation function to set up the correct binaries based on whether the extension is running remotely or locally.
|
||||
3. You may also want to add support for non-x86_64 targets and Alpine Linux at the same time by [following similar logic](#supporting-non-x8664-hosts-or-alpine-linux-containers)
|
||||
3. You may also want to add support for non-x86_64 targets and Alpine Linux at the same time by [following similar logic](#supporting-nonx8664-hosts-or-alpine-linux-containers)
|
||||
|
||||
You can find the "modules" version VS Code uses by going to **Help > Developer Tools** and typing `process.versions.modules` in the console. However, to make sure native modules work seamlessly in different Node.js environments, you may want to compile the native modules against all possible Node.js "modules" versions and platforms you want support (Electron Node.js, official Node.js Windows/Darwin/Linux, all versions). The [node-tree-sitter](https://github.com/tree-sitter/node-tree-sitter/releases/tag/v0.14.0) module is a good example of a module that does this well.
|
||||
|
||||
|
|
@ -363,7 +363,7 @@ You can find the "modules" version VS Code uses by going to **Help > Developer T
|
|||
|
||||
If your extension is purely written in JavaScript/TypeScript, you may not need to do anything to add support for other processor architectures or the `musl` based Alpine Linux to your extension.
|
||||
|
||||
However, if your extension works on Debian 9+, Ubuntu 16.04+, or RHEL / CentOS 7+ remote SSH hosts, containers, or WSL, but fails on supported non-x86_64 hosts (e.g. ARMv7l) or Alpine Linux containers, the extension may include x86_64 `glibc` specific native code or runtimes that will fail on these architectures/operating systems.
|
||||
However, if your extension works on Debian 9+, Ubuntu 16.04+, or RHEL / CentOS 7+ remote SSH hosts, containers, or WSL, but fails on supported non-x86_64 hosts (for example ARMv7l) or Alpine Linux containers, the extension may include x86_64 `glibc` specific native code or runtimes that will fail on these architectures/operating systems.
|
||||
|
||||
For example, your extension may only include x86_64 compiled versions of native modules or runtimes. For Alpine Linux, the included native code or runtimes may not work due to [fundamental differences](https://wiki.musl-libc.org/functional-differences-from-glibc.html) between how `libc` is implemented in Alpine Linux (`musl`) and other distributions (`glibc`).
|
||||
|
||||
|
|
@ -375,13 +375,13 @@ To resolve this problem:
|
|||
|
||||
3. If you'd prefer not to support these platforms, you can use the same logic to provide a good error message instead.
|
||||
|
||||
It is important to note that some 3rd party npm modules include native code that can cause this problem. So, in some cases you may need to work with the npm module author to add additional compilation targets.
|
||||
It is important to note that some third-party npm modules include native code that can cause this problem. So, in some cases you may need to work with the npm module author to add additional compilation targets.
|
||||
|
||||
## Avoid using Electron modules
|
||||
|
||||
While it can be convenient to rely on built-in Electron or VS Code modules not exposed by the extension API, it's important to note that VS Code Server runs a standard (non-Electron) version of Node.js. These modules will be missing when running remotely. There are a few exceptions, [like `keytar`](#persisting-secrets), where there is specific code in place to make them work.
|
||||
|
||||
You should use base Node.js modules or modules in your extension VSIX to avoid these problems. If you absolutely have to use an Electron module, be sure to have a fallback if the module is missing.
|
||||
Use base Node.js modules or modules in your extension VSIX to avoid these problems. If you absolutely have to use an Electron module, be sure to have a fallback if the module is missing.
|
||||
|
||||
The example below will use the Electron `original-fs` node module if found, and fall back to the base Node.js `fs` module if not.
|
||||
|
||||
|
|
@ -405,7 +405,7 @@ There are a few extension problems that could be resolved with some added functi
|
|||
|
||||
| Problem | Description |
|
||||
|---------|-------------|
|
||||
| **Blocked ports** | When working inside a Docker container or SSH server, ports are not automatically forwarded and there currently is no API to programmatically forward a port from an extension. Webviews can be adapted as [described above](#using-the-webview-api), but other scenarios currently require users to manually forward or expose ports. |
|
||||
| **Blocked ports** | When working inside a Docker container or SSH server, ports are not automatically forwarded and there currently is no API to programmatically forward a port from an extension. Webviews can be adapted as described in [Using the Webview API](#using-the-webview-api), but other scenarios currently require users to manually forward or expose ports. |
|
||||
| **Cannot access / transfer remote workspace files to local machine** | Extensions that open workspace files in external applications may encounter errors because the external application cannot directly access the remote files. We are investigating options for how extensions might be able to transfer files from the remote workspace to solve this problem. |
|
||||
| **Cannot access attached devices from Workspace extension** | Extensions that access locally attached devices will be unable to connect to them when running remotely. We are investigating the best approach to solve this problem. |
|
||||
|
||||
|
|
@ -413,7 +413,7 @@ There are a few extension problems that could be resolved with some added functi
|
|||
|
||||
- See [Tips and Tricks](/docs/remote/troubleshooting) or the [FAQ](/docs/remote/faq).
|
||||
- Search for answers on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode-remote).
|
||||
- [Upvote a feature or request a new one](https://aka.ms/vscode-remote/feature-requests), search [existing issues](https://aka.ms/vscode-remote/issues), or [report a problem](https://aka.ms/vscode-remote/issues/new)
|
||||
- [Upvote a feature or request a new one](https://aka.ms/vscode-remote/feature-requests), search [existing issues](https://aka.ms/vscode-remote/issues), or [report a problem](https://aka.ms/vscode-remote/issues/new).
|
||||
- Contribute a [development container definition](https://aka.ms/vscode-dev-containers) for others to use.
|
||||
- Contribute to [our documentation](https://github.com/Microsoft/vscode-docs) or [VS Code itself](https://github.com/Microsoft/vscode).
|
||||
- ...and more. See our [CONTRIBUTING](https://aka.ms/vscode-remote/contributing) guide for details.
|
||||
- See our [CONTRIBUTING](https://aka.ms/vscode-remote/contributing) guide for details.
|
||||
|
|
|
|||
|
|
@ -202,8 +202,8 @@ Now the `myExtension.sayHello` command will only show up in the Command Palette
|
|||
|
||||
### Enablement of commands
|
||||
|
||||
Commands support enablement via an `enablement`-property - its value is a when clause [when-clause](/docs/getstarted/keybindings#_when-clause-contexts). Enablement applies to all menus and to registered keybinding.
|
||||
Commands support enablement via an `enablement` property - its value is a [when-clause](/docs/getstarted/keybindings#_when-clause-contexts). Enablement applies to all menus and to registered keybindings.
|
||||
|
||||
> **Note** that there is semantic overlap between `enablement` and the `when` condition of menu items. The latter is used to prevent menus full of disabled items, e.g a command that anaylzes a JavaScript regular expression should show *when* the file is JavaScript and be *enablement* when the cursor is over a regular expression. In that sample, the `when`-clause prevents clutter by not showing the command for all other files. Preventing cluttered menus is highly recommended.
|
||||
> **Note**: There is semantic overlap between `enablement` and the `when` condition of menu items. The latter is used to prevent menus full of disabled items. For example, a command that analyzes a JavaScript regular expression should show **when** the file is JavaScript and be **enabled** only when the cursor is over a regular expression. The `when` clause prevents clutter, by not showing the command for all other language files. Preventing cluttered menus is highly recommended.
|
||||
|
||||
Last, menus showing commands, like the command palette or context menus, implement different ways of dealing with enablement. Editor and explorer context menus render enablement/disablement items while the command palette filters them.
|
||||
Last, menus showing commands, like the Command Palette or context menus, implement different ways of dealing with enablement. Editor and explorer context menus render enablement/disablement items while the Command Palette filters them.
|
||||
|
|
|
|||
|
|
@ -206,7 +206,7 @@ $ npx js-yaml syntaxes/abc.tmLanguage.yaml > syntaxes/abc.tmLanguage.json
|
|||
|
||||
VS Code's built-in scope inspector tool helps debug grammars. It displays the scopes for the token at the current position in a file, along with metadata about which theme rules apply to that token.
|
||||
|
||||
Trigger the scope inspector from the command palette with the `Developer: Inspect TM Scopes` command or [create a keybinding](/docs/getstarted/keybindings) for it:
|
||||
Trigger the scope inspector from the Command Palette with the `Developer: Inspect TM Scopes` command or [create a keybinding](/docs/getstarted/keybindings) for it:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
|||
|
|
@ -470,11 +470,6 @@
|
|||
<changefreq>weekly</changefreq>
|
||||
<priority>0.8</priority>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://code.visualstudio.com/docs/python/tutorial-azure-functions</loc>
|
||||
<changefreq>weekly</changefreq>
|
||||
<priority>0.8</priority>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://code.visualstudio.com/docs/python/testing</loc>
|
||||
<changefreq>weekly</changefreq>
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ The shell used defaults to `$SHELL` on Linux and macOS, PowerShell on Windows 10
|
|||
|
||||
### Windows
|
||||
|
||||
For Windows there is a convenient shell selector located inside the terminal dropdown that lets you choose between several detected shells including Command Prompt, PowerShell, PowerShell Core, Git Bash and WSL Bash. The **Terminal: Select Default Shell** command is also available through the command palette if you prefer to access it there.
|
||||
For Windows there is a convenient shell selector located inside the terminal dropdown that lets you choose between several detected shells including Command Prompt, PowerShell, PowerShell Core, Git Bash and WSL Bash. The **Terminal: Select Default Shell** command is also available through the Command Palette if you prefer to access it there.
|
||||
|
||||
Just like on other platforms you can fine tune the exact executable used in your settings file, for example:
|
||||
|
||||
|
|
|
|||
|
|
@ -212,7 +212,7 @@ You can also see the three **Add Config** commands for the folders, `tslint`, `t
|
|||
|
||||
### Workspace launch configurations
|
||||
|
||||
Workspace scoped launch configurations live in the `"launch"` section of the workspace configuration file (**Workspaces: Open Workspace Configuration File** in the command palette):
|
||||
Workspace scoped launch configurations live in the `"launch"` section of the workspace configuration file (**Workspaces: Open Workspace Configuration File** in the Command Palette):
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ You can update environment variables in your container without altering the cont
|
|||
"runArgs": ["-e","YOUR_ENV_VAR_NAME=your-value-goes-here"]
|
||||
```
|
||||
|
||||
* When a **Docker Compose** file is referenced, update ([or extend](/docs/remote/containers/containers.md#extending-your-docker-compose-file-for-development)) your `docker-compose.yml` with the following for the appropriate service:
|
||||
* When a **Docker Compose** file is referenced, update (or [extend](/docs/remote/containers.md#extending-your-docker-compose-file-for-development)) your `docker-compose.yml` with the following for the appropriate service:
|
||||
|
||||
```yml
|
||||
version: '3'
|
||||
|
|
@ -50,7 +50,7 @@ You can add a volume bound to any local folder using these steps:
|
|||
"runArgs": ["-v", "${env:HOME}${env:USERPROFILE}:/host-home-folder"]
|
||||
```
|
||||
|
||||
* When a **Docker Compose** file is referenced, update ([or extend](/docs/remote/containers/containers.md#extending-your-docker-compose-file-for-development)) your `docker-compose.yml` with the following for the appropriate service:
|
||||
* When a **Docker Compose** file is referenced, update (or [extend](/docs/remote/containers.md#extending-your-docker-compose-file-for-development)) your `docker-compose.yml` with the following for the appropriate service:
|
||||
|
||||
```yml
|
||||
version: '3'
|
||||
|
|
@ -128,7 +128,7 @@ You can set this up by taking an existing `devcontainer.json` configuration and
|
|||
"workspaceMount": "src=your-volume-name-here,dst=/workspace,type=volume,volume-driver=local"
|
||||
```
|
||||
|
||||
* When a **Docker Compose** file is referenced, update ([or extend](/docs/remote/containers/containers.md#extending-your-docker-compose-file-for-development)) your `docker-compose.yml` with the following for the appropriate service(s):
|
||||
* When a **Docker Compose** file is referenced, update (or [extend](/docs/remote/containers.md#extending-your-docker-compose-file-for-development)) your `docker-compose.yml` with the following for the appropriate service(s):
|
||||
|
||||
```yml
|
||||
version: '3'
|
||||
|
|
@ -173,7 +173,7 @@ Replace `your-volume-name-goes-here` with a unique volume name for the container
|
|||
|
||||
**Docker Compose**:
|
||||
|
||||
Update ([or extend](/docs/remote/containers/containers.md#extending-your-docker-compose-file-for-development)) your `docker-compose.yml` with the following. Replace `your-volume-name-goes-here` with a unique volume name for the container.
|
||||
Update (or [extend](/docs/remote/containers.md#extending-your-docker-compose-file-for-development)) your `docker-compose.yml` with the following. Replace `your-volume-name-goes-here` with a unique volume name for the container.
|
||||
|
||||
```yml
|
||||
services:
|
||||
|
|
@ -337,10 +337,10 @@ The `"shutdownAction":"none"` in the `devcontainer.json` files is optional, but
|
|||
|
||||
To connect to both:
|
||||
|
||||
1. `kbstyle(F1)` > **Remote-Containers: Open Folder in Container...** and select the `container1-src` folder.
|
||||
1. Run **Remote-Containers: Open Folder in Container...** from the Command Palette (`kbstyle(F1)`) and select the `container1-src` folder.
|
||||
2. VS Code will then start up both containers, connect this window to service `container-1`, and install the Go extension.
|
||||
3. Next, start up a new window using **File > New Window**.
|
||||
4. In the new window, `kbstyle(F1)` > **Remote-Containers: Open Folder in Container...** and select the `container2-src` folder.
|
||||
4. In the new window, run **Remote-Containers: Open Folder in Container...** from the Command Palette (`kbstyle(F1)`) and select the `container2-src` folder.
|
||||
5. Since the services are already running, VS Code will then connect to `container-2` and install the ESLint extension.
|
||||
|
||||
You can now interact with both containers at once from separate windows.
|
||||
|
|
@ -375,7 +375,7 @@ The second is to **(bind) mount a folder on the remote machine** into your conta
|
|||
|
||||
To try it out, connect to the remote Docker host using [Docker Machine](#option-1-connect-using-docker-machine-or-by-setting-local-environment-variables) or [SSH](#option-2-connect-using-an-ssh-tunnel), start VS Code, run **Remote-Containers: Open Folder in Container...**, and select the local folder with the `.devcontainer.json` file in it.
|
||||
|
||||
You can learn more about [converting an existing or pre-defined devcontainer.json](#converting-an-existing-or-pre-defined-devcontainerjson) for remote use later in this section, but first we'll discuss how to connect to your remote Docker host.
|
||||
You can learn more about [converting an existing or pre-defined devcontainer.json](#converting-an-existing-or-predefined-devcontainerjson) for remote use later in this section, but first we'll discuss how to connect to your remote Docker host.
|
||||
|
||||
### Option 1: Connect using Docker Machine or by setting local environment variables
|
||||
|
||||
|
|
@ -437,7 +437,7 @@ Just follow these steps:
|
|||
ssh -NL localhost:23750:/var/run/docker.sock user@hostname
|
||||
```
|
||||
|
||||
VS Code will now be able to [attach to any running container](/docs/remote/containers.md#attaching-to-running-containers) on the remote host. You can also [use specialized, local `devcontainer.json` files to create / connect to a remote dev container](#converting-an-existing-or-pre-defined-devcontainerjson).
|
||||
VS Code will now be able to [attach to any running container](/docs/remote/containers.md#attaching-to-running-containers) on the remote host. You can also [use specialized, local `devcontainer.json` files to create / connect to a remote dev container](#converting-an-existing-or-predefined-devcontainerjson).
|
||||
|
||||
Once you are done, press `kbstyle(Ctrl+C)` in the terminal / command prompt to close the tunnel.
|
||||
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ This lets VS Code provide a **local-quality development experience** — includi
|
|||
|
||||
Other `glibc` based Linux containers may work if they have [needed prerequisites](/docs/remote/linux.md).
|
||||
|
||||
While experimental `musl` based Alpine Linux support is available in [VS Code - Insiders](https://code.visualstudio.com/insiders/), some extensions installed in the container may not work due to `glibc` dependencies in native code inside the extension. See the [Remote Development and Linux](/docs/remote/linux.md) article for details.
|
||||
While experimental `musl` based Alpine Linux support is available in [VS Code Insiders](https://code.visualstudio.com/insiders/), some extensions installed in the container may not work due to `glibc` dependencies in native code inside the extension. See the [Remote Development with Linux](/docs/remote/linux.md) article for details.
|
||||
|
||||
### Installation
|
||||
|
||||
|
|
@ -45,11 +45,11 @@ To get started, follow these steps:
|
|||
|
||||
2. Right-click on the Docker taskbar item and update **Settings / Preferences > Shared Drives / File Sharing** with any source code locations you want to open in a container. If you run into trouble, see [Docker Desktop for Windows tips](/docs/remote/troubleshooting.md#docker-desktop-for-windows-tips) on avoiding common problems with sharing.
|
||||
|
||||
3. **Windows**: Consider adding a `.gitattributes` file to your repos or disabling automatic line ending conversion for Git on the **Windows side** by using a command prompt to run: `git config --global core.autocrlf input` If left enabled, this setting can cause files that you have not edited to appear modified due to line ending differences. See [tips and tricks](/docs/remote/troubleshooting.md#resolving-git-line-ending-issues-in-containers-resulting-in-many-modified-files) for details.
|
||||
3. **Windows**: Consider adding a `.gitattributes` file to your repos or disabling automatic line ending conversion for Git on the **Windows side** by using a command prompt to run: `git config --global core.autocrlf input` If left enabled, this setting can cause files that you have not edited to appear modified due to line ending differences. See [Tips and Tricks](/docs/remote/troubleshooting.md#resolving-git-line-ending-issues-in-containers-resulting-in-many-modified-files) for details.
|
||||
|
||||
**Linux**:
|
||||
|
||||
1. Follow the [official install instructions for Docker CE/EE for your distribution](https://docs.docker.com/install/#supported-platforms). If you are using Docker Compose, [follow those directions as well](https://docs.docker.com/compose/install/). (Note that the Ubuntu Snap package is not supported and packages in distributions may be out of date.)
|
||||
1. Follow the [official install instructions for Docker CE/EE for your distribution](https://docs.docker.com/install/#supported-platforms). If you are using Docker Compose, follow the [Install Docker Compose directions](https://docs.docker.com/compose/install/) as well. (Note that the Ubuntu Snap package is not supported and packages in distributions may be out of date.)
|
||||
|
||||
2. Add your user to the `docker` group by using a terminal to run: `sudo usermod -aG docker $USER`
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ To get started, follow these steps:
|
|||
|
||||
2. Install [Visual Studio Code](https://code.visualstudio.com/) or [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/).
|
||||
|
||||
3. Install the [Remote Development](https://aka.ms/vscode-remote/download/extension) extension pack.
|
||||
3. Install the [Remote Development extension pack](https://aka.ms/vscode-remote/download/extension).
|
||||
|
||||
The Remote - Containers extension supports two primary operating models:
|
||||
|
||||
|
|
@ -138,7 +138,7 @@ The [vscode-dev-containers repository](https://aka.ms/vscode-dev-containers) has
|
|||
* Expose additional ports.
|
||||
* Set runtime arguments.
|
||||
* Reuse or [extend your existing Docker Compose setup](https://aka.ms/vscode-remote/containers/docker-compose/extend).
|
||||
* [And more](/docs/remote/containers-advanced.md).
|
||||
* And more [advanced container configurations](/docs/remote/containers-advanced.md).
|
||||
|
||||
Note that, if `devcontainer.json`'s supported workflows supports do not meet your needs, you can also [attach to an already running container instead](#attaching-to-running-containers).
|
||||
|
||||
|
|
@ -148,17 +148,17 @@ Editing your container configuration is easy. Since rebuilding a container will
|
|||
|
||||
Here is the typical edit loop using these commands:
|
||||
|
||||
1. Start with `kbstyle(F1)` > **Remote-Containers: Add Development Container Configuration Files...**
|
||||
1. Start with **Remote-Containers: Add Development Container Configuration Files...** in the Command Palette (`kbstyle(F1)`).
|
||||
2. Edit the contents of the `.devcontainer` folder as required.
|
||||
3. Try it with `kbstyle(F1)` > **Remote-Containers: Reopen Folder in Container**.
|
||||
3. Try it with **Remote-Containers: Reopen Folder in Container**.
|
||||
4. On failure:
|
||||
1. `kbstyle(F1)` > **Remote-Containers: Reopen Folder Locally**, which will open a new local window.
|
||||
1. **Remote-Containers: Reopen Folder Locally**, which will open a new local window.
|
||||
2. In this local window: Edit the contents of the `.devcontainer` folder as required.
|
||||
3. Try it again: Go back to the container window, `kbstyle(F1)` > **Developer: Reload Window**.
|
||||
3. Try it again: Go back to the container window, **Developer: Reload Window** from the Command Palette (`kbstyle(F1)`)
|
||||
4. Repeat as needed.
|
||||
5. If the build was successful, but you want to make more changes:
|
||||
1. Edit the contents of the `.devcontainer` folder as required when connected to the container.
|
||||
2. `kbstyle(F1)` > **Remote-Containers: Rebuild Container**.
|
||||
2. **Remote-Containers: Rebuild Container**.
|
||||
3. On failure: Follow the same workflow above.
|
||||
|
||||
### Adding configuration files to public or private repositories
|
||||
|
|
@ -232,7 +232,7 @@ docker ps -a --filter="label=vsch.quality" --format "table \{{.ID}}\t\{{.Status}
|
|||
4. Type `docker-compose stop` to stop the containers. If you have more than one Docker Compose file, you can specify additional Docker Compose files with the `-f` argument.
|
||||
5. If you would like to delete the containers, type `docker-compose down` to both stop and delete them.
|
||||
|
||||
If you want to clean out images or mass-delete containers, [see here](/docs/remote/troubleshooting.md#cleaning-out-unused-containers-and-images) for different options.
|
||||
If you want to clean out images or mass-delete containers, see [Cleaning out unused containers and images](/docs/remote/troubleshooting.md#cleaning-out-unused-containers-and-images) for different options.
|
||||
|
||||
## Managing extensions
|
||||
|
||||
|
|
@ -246,7 +246,7 @@ If you install an extension from the Extensions view, it will automatically be i
|
|||
|
||||
> **Note:** If you are an extension author and your extension is not working properly or installs in the wrong place, see [Supporting Remote Development](/api/advanced-topics/remote-extensions.md) for details.
|
||||
|
||||
Local extensions that actually need to run remotely will appear **Disabled** in the **Local - Installed** category. You can click the **Install** button to install an extension on your remote host.
|
||||
Local extensions that actually need to run remotely will appear **Disabled** in the **Local - Installed** category. Select **Install** to install an extension on your remote host.
|
||||
|
||||
|
||||
|
||||
|
|
@ -373,7 +373,7 @@ However, there is a cross-platform way of copying the contents of the `.ssh` fol
|
|||
"postCreateCommand": "mkdir -p ~/.ssh && cp -r ~/.ssh-localhost/* ~/.ssh && chmod 700 ~/.ssh && chmod 600 ~/.ssh/*"
|
||||
```
|
||||
|
||||
* When a **Docker Compose** file is referenced, first update ([or extend](/docs/remote/containers/containers.md#extending-your-docker-compose-file-for-development)) your `docker-compose.yml` with the following for the appropriate service:
|
||||
* When a **Docker Compose** file is referenced, first update (or [extend](/docs/remote/containers.md#extending-your-docker-compose-file-for-development)) your `docker-compose.yml` with the following for the appropriate service:
|
||||
|
||||
```yml
|
||||
version: '3'
|
||||
|
|
@ -633,7 +633,7 @@ For example:
|
|||
|
||||
* Docker Compose will shut down a container if its entry point shuts down. This is problematic for situations where you are debugging and need to restart your app on a repeated basis.
|
||||
* You also may not be mapping the local filesystem into the container or exposing ports to other resources like databases you want to access.
|
||||
* You may want to copy the contents of your local `.ssh` folder into the container or set the ptrace options [described above](#using-docker-compose).
|
||||
* You may want to copy the contents of your local `.ssh` folder into the container or set the ptrace options described above in [Using Docker Compose](#using-docker-compose).
|
||||
|
||||
You can solve these and other issues like them by extending your entire Docker Compose configuration with [multiple `docker-compose.yml` files](https://docs.docker.com/compose/extends/#multiple-compose-files) that override or supplement your primary one.
|
||||
|
||||
|
|
@ -740,7 +740,7 @@ See the [Advanced Container Configuration](/docs/remote/containers-advanced.md)
|
|||
|----------|------|-------------|
|
||||
|**Dockerfile or image**|||
|
||||
| `image` | string | **Required** when [using an image](#using-an-image-or-dockerfile). The name of an image in a container registry ([DockerHub](https://hub.docker.com), [Azure Container Registry](https://azure.microsoft.com/services/container-registry/)) that VS Code should use to create the dev container. |
|
||||
| `dockerFile` | string |**Required** when [using a Dockerfile](#using-an-image-or-dockerfile). The location of a [Dockerfile](https://docs.docker.com/engine/reference/builder/) that defines the contents of the container. The path is relative to the `devcontainer.json` file. You can find a number of sample Dockerfiles for different runtimes [in this repository](https://github.com/Microsoft/vscode-dev-containers/tree/master/containers). |
|
||||
| `dockerFile` | string |**Required** when [using a Dockerfile](#using-an-image-or-dockerfile). The location of a [Dockerfile](https://docs.docker.com/engine/reference/builder/) that defines the contents of the container. The path is relative to the `devcontainer.json` file. You can find a number of sample Dockerfiles for different runtimes in the [vscode-dev-containers repository](https://github.com/Microsoft/vscode-dev-containers/tree/master/containers). |
|
||||
| `context` | string | Path that the Docker build should be run from relative to `devcontainer.json`. For example, a value of `".."` would allow you to reference content in sibling directories. Defaults to `"."`. |
|
||||
| `appPort` | integer, string, or array | A port or array of ports that should be made available locally when the container is running. Defaults to `[]`. |
|
||||
| `workspaceMount` | string | Overrides the default local mount point for the workspace. Supports the same values as the [Docker CLI `--mount` flag](https://docs.docker.com/engine/reference/commandline/run/#add-bind-mounts-or-volumes-using-the---mount-flag). Primarily useful for [configuring remote containers](/docs/remote/containers-advanced.md#developing-inside-a-container-on-a-remote-docker-host) or [improving disk performance](/docs/remote/containers-advanced.md#improving-container-disk-performance). |
|
||||
|
|
@ -767,12 +767,12 @@ If you've already built the container and connected to it, be sure to run **Remo
|
|||
### Remote - Containers limitations
|
||||
|
||||
* Windows container images are **not** yet supported.
|
||||
* Experimental Alpine container support is available in [VS Code - Insiders](https://code.visualstudio.com/insiders/) only.
|
||||
* Using a remote Docker Host is possible, but requires [additional setup steps](/docs/remote/containers-advanced.md#/docs/remote/containers-advanced.md#developing-inside-a-container-on-a-remote-docker-host).
|
||||
* Experimental Alpine container support is available in [VS Code Insiders](https://code.visualstudio.com/insiders/) only.
|
||||
* Using a remote Docker Host is possible, but requires [additional setup steps](/docs/remote/containers-advanced.md#developing-inside-a-container-on-a-remote-docker-host).
|
||||
* 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.
|
||||
* 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).
|
||||
* Docker Toolbox on Windows is not supported.
|
||||
* Docker variants or alternate containerization tool kits like [podman.io](https://podman.io) are not supported.
|
||||
* Docker variants or alternate containerization tool kits like [Podman](https://podman.io) are not supported.
|
||||
* 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 an SSH key without a passphrase, clone using HTTPS, or run `git push` from the command line to work around the issue.
|
||||
* 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).
|
||||
|
||||
|
|
@ -781,7 +781,7 @@ See [here for a list of active issues](https://aka.ms/vscode-remote/containers/i
|
|||
### Docker limitations
|
||||
|
||||
* First-time installs of Docker Desktop for Windows will require an additional "sharing" step to give your container access to local source code. However, this step may not work with certain AAD (email-based) identities. See [Docker Desktop for Windows tips](/docs/remote/troubleshooting.md#docker-desktop-for-windows-tips) and [Enabling file sharing in Docker Desktop](/docs/remote/troubleshooting.md#enabling-file-sharing-in-docker-desktop) for details and workarounds.
|
||||
* You may see errors if you sign into Docker with your email address instead of your Docker ID. This is a known issue and can be resolved by signing in with your Docker ID instead. See Docker issue [#935](https://github.com/docker/hub-feedback/issues/935#issuecomment-300361781) for details.
|
||||
* You may see errors if you sign into Docker with your email address instead of your Docker ID. This is a known issue and can be resolved by signing in with your Docker ID instead. See Docker [issue #935](https://github.com/docker/hub-feedback/issues/935#issuecomment-300361781) for details.
|
||||
* If you see high CPU spikes for `com.docker.hyperkit` on macOS, this may be due to a [known issue with Docker for Mac](https://github.com/docker/for-mac/issues/1759). See the Docker issue for details.
|
||||
* If you see either of these messages building a Dockerfile, you may be hitting a known Docker issue with Debian 8 (Jessie):
|
||||
|
||||
|
|
@ -790,7 +790,7 @@ See [here for a list of active issues](https://aka.ms/vscode-remote/containers/i
|
|||
E: Some index files failed to download. They have been ignored, or old ones used instead
|
||||
```
|
||||
|
||||
See [here for a workaround](/docs/remote/troubleshooting.md#resolving-dockerfile-build-failures-for-images-using-debian-8).
|
||||
See [Resolving Dockerfile build failures](/docs/remote/troubleshooting.md#resolving-dockerfile-build-failures-for-images-using-debian-8) for a workaround.
|
||||
|
||||
See the Docker troubleshooting guide for [Windows](https://docs.docker.com/docker-for-windows/troubleshoot) or [Mac](https://docs.docker.com/docker-for-mac/troubleshoot), consult [Docker Support Resources](https://success.docker.com/article/best-support-resources) for more information.
|
||||
|
||||
|
|
@ -800,9 +800,9 @@ Some Docker commands invoked from the Docker extension can fail when invoked fro
|
|||
|
||||
### Extension limitations
|
||||
|
||||
Many extensions will work inside dev containers without modification. However, in some cases, certain features may require changes. If you run into an extension issue, [see here for a summary of common problems and solutions](/docs/remote/troubleshooting.md#extension-tips) that you can mention to the extension author when reporting the issue.
|
||||
Many extensions will work inside dev containers without modification. However, in some cases, certain features may require changes. If you run into an extension issue, see [here for a summary of common problems and solutions](/docs/remote/troubleshooting.md#extension-tips) that you can mention to the extension author when reporting the issue.
|
||||
|
||||
In addition, while experimental Alpine support is available in [VS Code - Insiders](https://code.visualstudio.com/insiders/), some extensions installed in the container may not work due to `glibc` dependencies in native code inside the extension. See the [Remote Development and Linux](/docs/remote/linux.md) article for details.
|
||||
In addition, while experimental Alpine support is available in [VS Code Insiders](https://code.visualstudio.com/insiders/), some extensions installed in the container may not work due to `glibc` dependencies in native code inside the extension. See the [Remote Development with Linux](/docs/remote/linux.md) article for details.
|
||||
|
||||
## Common questions
|
||||
|
||||
|
|
@ -814,11 +814,11 @@ See [Docker Desktop for Windows tips](/docs/remote/troubleshooting.md#docker-des
|
|||
|
||||
### I am seeing "W: Failed to fetch ..." when building a Dockerfile
|
||||
|
||||
If you see "W: Failed to fetch http://deb.debian.org/debian/dists/jessie-updates/InRelease" when building a Dockerfile, you may be hitting a known Docker issue with Debian 8 (Jessie). See [here for a workaround](/docs/remote/troubleshooting.md#resolving-dockerfile-build-failures-for-images-using-debian-8).
|
||||
If you see "W: Failed to fetch http://deb.debian.org/debian/dists/jessie-updates/InRelease" when building a Dockerfile, you may be hitting a known Docker issue with Debian 8 (Jessie). See [Resolving Dockerfile build failures](/docs/remote/troubleshooting.md#resolving-dockerfile-build-failures-for-images-using-debian-8) for a workaround.
|
||||
|
||||
### I'm seeing an error about a missing library or dependency
|
||||
|
||||
Some extensions rely on libraries not found in the certain Docker images. See [above](#installing-additional-software-in-the-sandbox) for help with resolving the problem.
|
||||
Some extensions rely on libraries not found in the certain Docker images. See [Installing additional software](#installing-additional-software-in-the-sandbox) for help with resolving the problem.
|
||||
|
||||
### Can I connect to multiple containers at once?
|
||||
|
||||
|
|
@ -842,9 +842,9 @@ The VS Code Server requires outbound HTTPS (port 443) connectivity to:
|
|||
* `*.vo.msecnd.net` (Azure CDN)
|
||||
* `*.gallerycdn.vsassets.io` (Azure CDN)
|
||||
|
||||
All other communication between the server and the VS Code client is accomplished through an authenticated, random, TCP port automatically exposed via the Docker CLI. You can find a list of locations VS Code itself needs access to [in the network connections article](/docs/setup/network.md#common-hostnames).
|
||||
All other communication between the server and the VS Code client is accomplished through an authenticated, random, TCP port automatically exposed via the Docker CLI. You can find a list of locations VS Code itself needs access to in the [network connections article](/docs/setup/network.md#common-hostnames).
|
||||
|
||||
Finally, some extensions (like C#) download secondary dependencies from `download.microsoft.com` or `download.visualstudio.microsoft.com`. Others (like [VS Live Share](https://docs.microsoft.com/en-us/visualstudio/liveshare/reference/connectivity#requirements-for-connection-modes)) may have additional connectivity requirements. Consult the extension's documentation for details if you run into trouble.
|
||||
Finally, some extensions (like C#) download secondary dependencies from `download.microsoft.com` or `download.visualstudio.microsoft.com`. Others (like [Visual Studio Live Share](https://docs.microsoft.com/visualstudio/liveshare/reference/connectivity#requirements-for-connection-modes)) may have additional connectivity requirements. Consult the extension's documentation for details if you run into trouble.
|
||||
|
||||
### As an extension author, what do I need to do to make sure my extension works?
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ This article covers frequently asked questions for each of the **Visual Studio C
|
|||
|
||||
### What is Visual Studio Code Remote Development?
|
||||
|
||||
The Visual Studio Code [Remote Development](https://aka.ms/vscode-remote/download/extension) extension pack allows you to open any folder in a container, on a remote machine (via SSH), or in the Windows Subsystem for Linux and take advantage of VS Code's full feature set. This means that VS Code can provide a local-quality development experience — including full IntelliSense (completions), debugging, and more — regardless of where your code is located or hosted.
|
||||
The Visual Studio Code [Remote Development extension pack](https://aka.ms/vscode-remote/download/extension) allows you to open any folder in a container, on a remote machine (via SSH), or in the Windows Subsystem for Linux and take advantage of VS Code's full feature set. This means that VS Code can provide a local-quality development experience — including full IntelliSense (completions), debugging, and more — regardless of where your code is located or hosted.
|
||||
|
||||
### What advantages does VS Code Remote Development provide over local editing?
|
||||
|
||||
|
|
@ -71,9 +71,9 @@ All other communication between the server and the VS Code client is accomplishe
|
|||
* Containers: An authenticated, random port automatically exposed via the Docker CLI.
|
||||
* WSL: An authenticated, random local TCP port.
|
||||
|
||||
You can find a list of locations VS Code itself needs access to [in the network connections article](/docs/setup/network.md#common-hostnames).
|
||||
You can find a list of locations VS Code itself needs access to in the [network connections article](/docs/setup/network.md#common-hostnames).
|
||||
|
||||
Finally, some extensions (like C#) download secondary dependencies from `download.microsoft.com` or `download.visualstudio.microsoft.com`. Others (like [VS Live Share](https://docs.microsoft.com/en-us/visualstudio/liveshare/reference/connectivity#requirements-for-connection-modes)) may have additional connectivity requirements. Consult the extension's documentation for details if you run into trouble.
|
||||
Finally, some extensions (like C#) download secondary dependencies from `download.microsoft.com` or `download.visualstudio.microsoft.com`. Others (like [Visual Studio Live Share](https://docs.microsoft.com/visualstudio/liveshare/reference/connectivity#requirements-for-connection-modes)) may have additional connectivity requirements. Consult the extension's documentation for details if you run into trouble.
|
||||
|
||||
### What Linux packages or libraries need to be installed on a host to use Remote Development?
|
||||
|
||||
|
|
@ -93,7 +93,7 @@ The Docker extension is configured to run as a local "UI" extension by default.
|
|||
|
||||
### Can I install individual extensions instead of the extension pack?
|
||||
|
||||
Yes. The [Remote Development](https://aka.ms/vscode-remote/download/extension) extension pack provides a convenient way for you to access all of the latest remote capabilities as they are released. However, you can always install the individual extensions from the Marketplace or VS Code Extensions view.
|
||||
Yes. The [Remote Development extension pack](https://aka.ms/vscode-remote/download/extension) provides a convenient way for you to access all of the latest remote capabilities as they are released. However, you can always install the individual extensions from the Marketplace or VS Code Extensions view.
|
||||
|
||||
* [Remote - SSH](https://aka.ms/vscode-remote/download/ssh)
|
||||
* [Remote - Containers](https://aka.ms/vscode-remote/download/containers)
|
||||
|
|
@ -105,7 +105,7 @@ Yes. The [Remote Development](https://aka.ms/vscode-remote/download/extension) e
|
|||
|
||||
No. A development container defines an environment in which you develop your application before you are ready to deploy. While deployment and development containers may resemble one another, you may not want to include tools in a deployment image that you use during development.
|
||||
|
||||
The [vscode-dev-containers repo](https://aka.ms/vscode-dev-containers) includes a set of dev container definitions for some common development environments. You can also [attach to a running container](/docs/remote/containers.md#attaching-to-running-containers) without setting up a dev container definition, if you prefer to use an alternate container build or deployment workflow.
|
||||
The [vscode-dev-containers repository](https://aka.ms/vscode-dev-containers) includes a set of dev container definitions for some common development environments. You can also [attach to a running container](/docs/remote/containers.md#attaching-to-running-containers) without setting up a dev container definition, if you prefer to use an alternate container build or deployment workflow.
|
||||
|
||||
### Do "dev containers definitions" define how an application is built? Like Buildpacks?
|
||||
|
||||
|
|
|
|||
|
|
@ -35,11 +35,11 @@ If you are running Linux locally, the [VS Code prerequisites](/docs/supporting/r
|
|||
In addition, specific Remote Development extensions have further requirements:
|
||||
|
||||
* **Remote - SSH:** `ssh` needs to be in the path. The shell binary is typically in the `openssh-client` package.
|
||||
* **Remote - Containers**: Docker CE/EE 18.06+ and Docker Compose 1.21+. Follow the [official install instructions for Docker CE/EE for your distribution](https://docs.docker.com/install/#supported-platforms). If you are using Docker Compose, [follow those directions as well](https://docs.docker.com/compose/install/). (Note that the Ubuntu Snap package is not supported and packages in distributions may be out of date.) `docker` and `docker-compose` must also be in the path.
|
||||
* **Remote - Containers**: Docker CE/EE 18.06+ and Docker Compose 1.21+. Follow the [official install instructions for Docker CE/EE for your distribution](https://docs.docker.com/install/#supported-platforms). If you are using Docker Compose, follow the [Install Docker Compose directions](https://docs.docker.com/compose/install/) as well. (Note that the Ubuntu Snap package is not supported and packages in distributions may be out of date.) `docker` and `docker-compose` must also be in the path.
|
||||
|
||||
## Remote host / container / WSL Linux prerequisites
|
||||
|
||||
Platform prerequisites are primarily driven by the version of the [Node.js](https://nodejs.org/en/docs/meta/topics/dependencies/) runtime (and by extension [V8](https://v8docs.nodesource.com)) shipped in the server component automatically installed on each remote endpoint. This server also has a set of related native node modules that need to be compiled and tested for each target. **64-bit x86 glibc-based** Linux distributions currently provide the best support given these requirements.
|
||||
Platform prerequisites are primarily driven by the version of the [Node.js](https://nodejs.org/en/docs/meta/topics/dependencies/) runtime (and by extension the [V8 JavaScript engine](https://v8docs.nodesource.com)) shipped in the server component automatically installed on each remote endpoint. This server also has a set of related native node modules that need to be compiled and tested for each target. **64-bit x86 glibc-based** Linux distributions currently provide the best support given these requirements.
|
||||
|
||||
**32-bit ARMv7l glibc-based** Linux SSH host support and **64-bit x86 musl-based Alpine Linux** container support in [VS Code Insiders](https://code.visualstudio.com/insiders/) is experimental because of some fundamental platform differences that can affect native binaries in extensions in the broader VS Code extension ecosystem. For ARMv7l, extensions may only include x86_64 versions of native modules or runtimes in the extension. For Alpine Linux, included native code or runtimes may not work due to [fundamental differences](https://wiki.musl-libc.org/functional-differences-from-glibc.html) between how `libc` is implemented in Alpine Linux (`musl`) and other distributions (`glibc`). In both these cases, extensions will need to opt-in to supporting these platforms by compiling / including binaries for these additional targets. We want to give the community the opportunity to opt-in or out of this support before we add it to stable.
|
||||
|
||||
|
|
@ -80,7 +80,7 @@ The following is a list of distributions and any base requirements that may be m
|
|||
|
||||
RHEL / CentOS 6 ships with glibc 2.12 and libstdc++ 3.4.13. Unfortunately, this does not meet the requirements for Remote Development. RHEL / CentOS 6 goes out of support [in 2020](https://endoflife.software/operating-systems/linux/centos), so we strongly recommend **upgrading to RHEL / CentOS 7** or higher.
|
||||
|
||||
However, as a workaround, you can either build glibc manually or use the following script to install updated binaries. The bash script below will upgrade these libraries without having to build them. It is adapted from information in [this article](https://serverkurma.com/linux/how-to-update-glibc-newer-version-on-centos-6-x/), [this gist](https://gist.github.com/harv/f86690fcad94f655906ee9e37c85b174), and this [Fedora copr project](https://copr.fedorainfracloud.org/coprs/mosquito/myrepo-el6/). The article also includes instructions for manually building glibc if you would prefer not to use the binaries from the article.
|
||||
However, as a workaround, you can either build glibc manually or use the following script to install updated binaries. The bash script below will upgrade these libraries without having to build them. It is adapted from information in this [article](https://serverkurma.com/linux/how-to-update-glibc-newer-version-on-centos-6-x/), this [gist](https://gist.github.com/harv/f86690fcad94f655906ee9e37c85b174), and this [Fedora copr project](https://copr.fedorainfracloud.org/coprs/mosquito/myrepo-el6/). The article also includes instructions for manually building glibc if you would prefer not to use the binaries from the article.
|
||||
|
||||
Do not run this script on anything mission critical **without a rollback strategy** since it does update libraries that other applications depend on.
|
||||
|
||||
|
|
|
|||
|
|
@ -29,9 +29,9 @@ This lets VS Code provide a **local-quality development experience** — includi
|
|||
|
||||
- **Experimental support:** ARMv7l Raspbian 8+ (32-bit) in [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/) only.
|
||||
|
||||
Other `glibc` based Linux distributions for x86_64 and ARMv7l (in VS Code Insiders) should work if they have the needed prerequisites. See the [Remote Development and Linux](/docs/remote/linux.md) article for information prerequisites and tips for getting community supported distributions up and running.
|
||||
Other `glibc` based Linux distributions for x86_64 and ARMv7l (in VS Code Insiders) should work if they have the needed prerequisites. See the [Remote Development with Linux](/docs/remote/linux.md) article for information prerequisites and tips for getting community supported distributions up and running.
|
||||
|
||||
While experimental ARMv7l support is available in [VS Code - Insiders](https://code.visualstudio.com/insiders/), some extensions installed on ARMv7l devices may not work due to the use of x86 native code in the extension.
|
||||
While experimental ARMv7l support is available in [VS Code Insiders](https://code.visualstudio.com/insiders/), some extensions installed on ARMv7l devices may not work due to the use of x86 native code in the extension.
|
||||
|
||||
### Installation
|
||||
|
||||
|
|
@ -41,7 +41,7 @@ To get started, you need to:
|
|||
|
||||
2. Install [Visual Studio Code](https://code.visualstudio.com/) or [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/).
|
||||
|
||||
3. Install the [Remote Development](https://aka.ms/vscode-remote/download/extension) extension pack.
|
||||
3. Install the [Remote Development extension pack](https://aka.ms/vscode-remote/download/extension).
|
||||
|
||||
4. [Optional] If you are on macOS or Linux and need to enter a token or password when connecting to your host, [you can enable `ControlMaster` in your SSH config](/docs/remote/troubleshooting.md#enabling-alternate-ssh-authentication-methods) to prevent you from having to enter it multiple times.
|
||||
|
||||
|
|
@ -53,7 +53,7 @@ Visual Studio Code uses [SSH configuration files](https://linux.die.net/man/5/ss
|
|||
|
||||
To get started, follow these steps:
|
||||
|
||||
1. First, **configure key based authentication** on the host you plan to connect to by adding your local public SSH key to `~/.ssh/authorized_keys` on the host. If you are new to SSH or are running into trouble, see [here for additional information](/docs/remote/troubleshooting.md#configuring-key-based-authentication) on setting this up. If you followed the Azure VM tutorial, you can skip this step.
|
||||
1. First, **configure key based authentication** on the host you plan to connect to by adding your local public SSH key to `~/.ssh/authorized_keys` on the host. If you are new to SSH or are running into trouble, see [Configuring key based authentication](/docs/remote/troubleshooting.md#configuring-key-based-authentication) for additional information on setting this up. If you followed the Azure VM tutorial, you can skip this step.
|
||||
|
||||
> **Note:** If you skip this step, you will end up needing to enter your password twice due to [vscode-remote-release#642](https://github.com/microsoft/vscode-remote-release/issues/642). Also note that PuTTY for Windows is not a [supported client](/docs/remote/troubleshooting.md#installing-a-supported-ssh-client), but you can [convert your PuTTYGen keys](/docs/remote/troubleshooting.md#reusing-a-key-generated-in-puttygen).
|
||||
|
||||
|
|
@ -61,11 +61,11 @@ To get started, follow these steps:
|
|||
|
||||
|
||||
|
||||
> **Note:** If you see errors about bad SSH file permissions when connecting, [see here for details](/docs/remote/troubleshooting.md#fixing-ssh-file-permission-errors) on the correct settings.
|
||||
> **Note:** If you see errors about bad SSH file permissions when connecting, see [Fixing SSH file permission errors](/docs/remote/troubleshooting.md#fixing-ssh-file-permission-errors) for details on the correct settings.
|
||||
|
||||
3. After a moment, VS Code will connect to the SSH server and set itself up. VS Code will keep you up-to-date using a progress notification and you can see a detailed log in the `Remote - SSH` output channel.
|
||||
|
||||
> **Note:** If your connection is hanging, you may need to enable TCP forwarding or respond to a server prompt. See [tips and tricks](/docs/remote/troubleshooting.md#troubleshooting-hanging-or-failing-connections) for details.
|
||||
> **Note:** If your connection is hanging, you may need to enable TCP forwarding or respond to a server prompt. See [Tips and Tricks](/docs/remote/troubleshooting.md#troubleshooting-hanging-or-failing-connections) for details.
|
||||
|
||||
4. After you are connected, you'll be in an empty window. You can then open a folder or workspace on the remote machine using **File > Open...** or **File > Open Workspace...**
|
||||
|
||||
|
|
@ -88,7 +88,7 @@ Host example-remote-linux-machine-with-identity-file
|
|||
IdentityFile ~/.ssh/id_rsa-remote-ssh
|
||||
```
|
||||
|
||||
The second example uses an alternate location for your SSH key if you want to use more than one. See [tips and tricks](/docs/remote/troubleshooting.md#improving-your-security-with-a-dedicated-key) for details. You can also set the `"remote.SSH.configFile"` property in `settings.json` if you want to use a different config file than those listed.
|
||||
The second example uses an alternate location for your SSH key if you want to use more than one. See [Tips and Tricks](/docs/remote/troubleshooting.md#improving-your-security-with-a-dedicated-key) for details. You can also set the `"remote.SSH.configFile"` property in `settings.json` if you want to use a different config file than those listed.
|
||||
|
||||
## Managing extensions
|
||||
|
||||
|
|
@ -102,7 +102,7 @@ If you install an extension from the Extensions view, it will automatically be i
|
|||
|
||||
> **Note:** If you are an extension author and find that your extension is not working properly or installs in the wrong place, see [Supporting Remote Development](/api/advanced-topics/remote-extensions.md) for details.
|
||||
|
||||
Local extensions that actually need to run remotely will appear **Disabled** in the **Local - Installed** category. You can click the **Install** button to install an extension on your remote host.
|
||||
Local extensions that actually need to run remotely will appear **Disabled** in the **Local - Installed** category. Select **Install** to install an extension on your remote host.
|
||||
|
||||
|
||||
|
||||
|
|
@ -252,9 +252,9 @@ The VS Code Server requires outbound HTTPS (port 443) connectivity to:
|
|||
- `*.vo.msecnd.net` (Azure CDN)
|
||||
- `*.gallerycdn.vsassets.io` (Azure CDN)
|
||||
|
||||
All other communication between the server and the VS Code client is accomplished through an authenticated, secure, SSH tunnel. You can find a list of locations VS Code itself needs access to [in the network connections article](/docs/setup/network.md#common-hostnames).
|
||||
All other communication between the server and the VS Code client is accomplished through an authenticated, secure, SSH tunnel. You can find a list of locations VS Code itself needs access to in the [network connections article](/docs/setup/network.md#common-hostnames).
|
||||
|
||||
Finally, some extensions (like C#) download secondary dependencies from `download.microsoft.com` or `download.visualstudio.microsoft.com`. Others (like [VS Live Share](https://docs.microsoft.com/en-us/visualstudio/liveshare/reference/connectivity#requirements-for-connection-modes)) may have additional connectivity requirements. Consult the extension's documentation for details if you run into trouble.
|
||||
Finally, some extensions (like C#) download secondary dependencies from `download.microsoft.com` or `download.visualstudio.microsoft.com`. Others (like [Visual Studio Live Share](https://docs.microsoft.com/visualstudio/liveshare/reference/connectivity#requirements-for-connection-modes)) may have additional connectivity requirements. Consult the extension's documentation for details if you run into trouble.
|
||||
|
||||
### Can I use local tools on source code sitting on the remote SSH host?
|
||||
|
||||
|
|
|
|||
|
|
@ -136,11 +136,11 @@ If you do see that message, follow these steps to update your SSH server's [sshd
|
|||
|
||||
**Set the ProxyCommand parameter in your SSH config file**
|
||||
|
||||
If you are behind a proxy and are unable to connect to your SSH host, you may need to use the `ProxyCommand` parameter for your host in a **local** [SSH config file](https://linux.die.net/man/5/ssh_config). You can [read this article](https://www.cyberciti.biz/faq/linux-unix-ssh-proxycommand-passing-through-one-host-gateway-server/) for an example of its use.
|
||||
If you are behind a proxy and are unable to connect to your SSH host, you may need to use the `ProxyCommand` parameter for your host in a **local** [SSH config file](https://linux.die.net/man/5/ssh_config). You can read this [SSH ProxyCommand article](https://www.cyberciti.biz/faq/linux-unix-ssh-proxycommand-passing-through-one-host-gateway-server/) for an example of its use.
|
||||
|
||||
**Ensure the remote machine has internet access**
|
||||
|
||||
The remote machine must have internet access to be able to download the VS Code Server and extensions from the Marketplace. See [the FAQ for details](/docs/remote/faq.md##what-are-the-connectivity-requirements-for-vs-code-server) on connectivity requirements.
|
||||
The remote machine must have internet access to be able to download the VS Code Server and extensions from the Marketplace. See [the FAQ for details](/docs/remote/faq.md#what-are-the-connectivity-requirements-for-vs-code-server) on connectivity requirements.
|
||||
|
||||
**Set HTTP_PROXY / HTTPS_PROXY on the remote host**
|
||||
|
||||
|
|
@ -167,7 +167,7 @@ Some users launch a different shell from their `.bash_profile` or other startup
|
|||
|
||||
Some systems will dynamically route an SSH connection to one node from a cluster each time an SSH connection is made. This is an issue for VS Code because it makes two connections to open a remote window: the first to install or start the VS Code Server (or find an already running instance) and the second to create the SSH port tunnel that VS Code uses to talk to the server. If VS Code is routed to a different machine when it creates the second connection, it won't be able to talk to the VS Code server.
|
||||
|
||||
One workaround for this is to use the `ControlMaster` option in OpenSSH (macOS/Linux clients only), described [above](#enabling-alternate-ssh-authentication-methods), so that VS Code's two connections will be multiplexed through a single SSH connection to the same node.
|
||||
One workaround for this is to use the `ControlMaster` option in OpenSSH (macOS/Linux clients only), described in [Enabling alternate SSH authentication methods](#enabling-alternate-ssh-authentication-methods), so that VS Code's two connections will be multiplexed through a single SSH connection to the same node.
|
||||
|
||||
**Contact your system administrator for configuration help**
|
||||
|
||||
|
|
@ -358,13 +358,13 @@ umount "$HOME/sshfs/$USER_AT_HOST"
|
|||
|
||||
Follow these steps:
|
||||
|
||||
1. On Linux, add `.gitattributes` file to your project to **force consistent line endings** between Linux and Windows to avoid unexpected issues due to CRLF/LF differences between the two operating systems. [See below](#resolving-git-line-ending-issues-in-wsl-resulting-in-many-modified-files) for details.
|
||||
1. On Linux, add `.gitattributes` file to your project to **force consistent line endings** between Linux and Windows to avoid unexpected issues due to CRLF/LF differences between the two operating systems. See [Resolving Git line ending issues](#resolving-git-line-ending-issues-in-wsl-resulting-in-many-modified-files) for details.
|
||||
|
||||
2. Next, install [SSHFS-Win](https://github.com/billziss-gh/sshfs-win) on using [Chocolatey](https://chocolatey.org/): `choco install sshfs`
|
||||
2. Next, install [SSHFS-Win](https://github.com/billziss-gh/sshfs-win) using [Chocolatey](https://chocolatey.org/): `choco install sshfs`
|
||||
|
||||
3. Once you've installed SSHFS for Windows, you can use the File Explorer's **Map Network Drive...** option with the path `\\sshfs\user@hostname`, where `user@hostname` is your remote user and hostname / IP. You can script this using the command prompt as follows: `net use /PERSISTENT:NO X: \\sshfs\user@hostname`
|
||||
|
||||
4. Once done, disconnect by right-clicking on the drive in the File Explorer and clicking **Disconnect**.
|
||||
4. Once done, disconnect by right-clicking on the drive in the File Explorer and selecting **Disconnect**.
|
||||
|
||||
### Using rsync to maintain a local copy of your source code
|
||||
|
||||
|
|
@ -388,7 +388,7 @@ wsl rsync -rlptzv --progress --delete --exclude=.git "user@hostname:/remote/sour
|
|||
|
||||
You can rerun this command each time you want to get the latest copy of your files and only updates will be transferred. The `.git` folder is intentionally excluded both for performance reasons and so you can use local Git tools without worrying about the state on the remote host.
|
||||
|
||||
To push content, reverse the source and target parameters in the command. However, **on Windows** you should add a `.gitattributes` file to your project to **force consistent line endings** before doing so. [See below](#resolving-git-line-ending-issues-in-wsl-resulting-in-many-modified-files) for details.
|
||||
To push content, reverse the source and target parameters in the command. However, **on Windows** you should add a `.gitattributes` file to your project to **force consistent line endings** before doing so. See [Resolving Git line ending issues](#resolving-git-line-ending-issues-in-wsl-resulting-in-many-modified-files) for details.
|
||||
|
||||
```bash
|
||||
rsync -rlptzv --progress --delete --exclude=.git . "user@hostname:/remote/source/code/path"
|
||||
|
|
@ -414,11 +414,11 @@ The VS Code Server was previously installed under `~/.vscode-remote` so you can
|
|||
|
||||
[Docker Desktop](https://www.docker.com/products/docker-desktop) for Windows works well in most setups, but there are a few "gotchas" that can cause problems. Here are some tips on avoiding them:
|
||||
|
||||
1. **Use an AD domain account or local administrator account when sharing drives. Do not use an AAD (email-based) account.** AAD (email-based) accounts have well known issues, as documented in Docker issues [#132](https://github.com/docker/for-win/issues/132) and [#1352](https://github.com/docker/for-win/issues/1352). If you must use an AAD account, create a separate local administrator account on your machine that you use purely for the purpose of sharing drives. Follow the [steps in this blog post](https://blogs.msdn.microsoft.com/stevelasker/2016/06/14/configuring-docker-for-windows-volumes/) to get everything set up.
|
||||
1. **Use an AD domain account or local administrator account when sharing drives. Do not use an AAD (email-based) account.** AAD (email-based) accounts have well known issues, as documented in Docker [issue #132](https://github.com/docker/for-win/issues/132) and [issue #1352](https://github.com/docker/for-win/issues/1352). If you must use an AAD account, create a separate local administrator account on your machine that you use purely for the purpose of sharing drives. Follow the [steps in this blog post](https://blogs.msdn.microsoft.com/stevelasker/2016/06/14/configuring-docker-for-windows-volumes/) to get everything set up.
|
||||
|
||||
2. **Stick with alphanumeric passwords to avoid drive sharing problems.** When asked to share your drives on Windows, you will be prompted for the username and password of an account with admin privileges on the machine. If you are warned about an incorrect username or password, this may be due to special characters in the password. For example, `!`, `[` and `]` are known to cause issues. Change your password to alphanumeric characters to resolve. See this issue about [Docker volume mounting problems](https://github.com/moby/moby/issues/23992#issuecomment-234979036) for details.
|
||||
|
||||
3. **Use your Docker ID to sign into Docker (not your email).** The Docker CLI only supports using your Docker ID, so using your email can cause problems. See Docker issue [#935](https://github.com/docker/hub-feedback/issues/935#issuecomment-300361781) for details.
|
||||
3. **Use your Docker ID to sign into Docker (not your email).** The Docker CLI only supports using your Docker ID, so using your email can cause problems. See Docker [issue #935](https://github.com/docker/hub-feedback/issues/935#issuecomment-300361781) for details.
|
||||
|
||||
If you are still having trouble, see the [Docker Desktop for Windows troubleshooting guide](https://docs.docker.com/docker-for-windows/troubleshoot/#volumes).
|
||||
|
||||
|
|
@ -570,7 +570,7 @@ There are two ways to resolve this error:
|
|||
|
||||
### Resolving Docker Hub sign in errors when an email is used
|
||||
|
||||
The Docker CLI only supports using your Docker ID, so using your email to sign in can cause problems. See Docker issue [#935](https://github.com/docker/hub-feedback/issues/935#issuecomment-300361781) for details.
|
||||
The Docker CLI only supports using your Docker ID, so using your email to sign in can cause problems. See Docker [issue #935](https://github.com/docker/hub-feedback/issues/935#issuecomment-300361781) for details.
|
||||
|
||||
As a workaround, use your Docker ID to sign into Docker rather than your email.
|
||||
|
||||
|
|
@ -705,7 +705,7 @@ While many extensions will work unmodified, there are a few issues that can prev
|
|||
|
||||
VS Code's local user settings are reused when you connect to a remote endpoint. While this keeps your user experience consistent, you may need to vary absolute path settings between your local machine and each host / container / WSL since the target locations are different.
|
||||
|
||||
**Resolution:** You can set endpoint-specific settings after you connect to a remote endpoint by running the **Preferences: Open Remote Settings** command from the Command Palette (`kbstyle(F1)`) or by clicking on the **Remote** tab in the settings editor. These settings will override any local settings you have in place whenever you connect.
|
||||
**Resolution:** You can set endpoint-specific settings after you connect to a remote endpoint by running the **Preferences: Open Remote Settings** command from the Command Palette (`kbstyle(F1)`) or by selecting the **Remote** tab in the settings editor. These settings will override any local settings you have in place whenever you connect.
|
||||
|
||||
### Need to install local VSIX on remote endpoint
|
||||
|
||||
|
|
@ -717,25 +717,25 @@ Sometimes you want to install a local VSIX on a remote machine, either during de
|
|||
|
||||
Some extensions use external node modules or custom code to launch a browser window. Unfortunately, this may cause the extension to launch the browser remotely instead of locally.
|
||||
|
||||
**Resolution:** The extension can switch to using the `vscode.env.openExternal` API to resolve this problem. See the [extension guide](/api/advanced-topics/remote-extensions#opening-something-in-a-local-browser-or-application) for details.
|
||||
**Resolution:** The extension can switch to using the `vscode.env.openExternal` API to resolve this problem. See the [extension author's guide](/api/advanced-topics/remote-extensions#opening-something-in-a-local-browser-or-application) for details.
|
||||
|
||||
### Clipboard does not work
|
||||
|
||||
Some extensions use node modules like `clipboardy` to integrate with the clipboard. Unfortunately, this may cause the extension to incorrectly integrate with the clipboard on the remote side.
|
||||
|
||||
**Resolution:** The extension can switch to the VS Code clipboard API to resolve the problem. See the [extension guide](/api/advanced-topics/remote-extensions#using-the-clipboard) for details.
|
||||
**Resolution:** The extension can switch to the VS Code clipboard API to resolve the problem. See the [extension author's guide](/api/advanced-topics/remote-extensions#using-the-clipboard) for details.
|
||||
|
||||
### Cannot access local web server from browser or application
|
||||
|
||||
When working inside a container or SSH host, the port the browser is connecting to may be blocked.
|
||||
|
||||
**Resolution:** The extension can switch to the `vscode.env.openExternal` API (which automatically forwards localhost ports) to resolve this problem. See the [extension guide](/api/advanced-topics/remote-extensions#opening-something-in-a-local-browser-or-application) for details.
|
||||
**Resolution:** The extension can switch to the `vscode.env.openExternal` API (which automatically forwards localhost ports) to resolve this problem. See the [extension author's guide](/api/advanced-topics/remote-extensions#opening-something-in-a-local-browser-or-application) for details.
|
||||
|
||||
### WebView contents do not appear
|
||||
|
||||
If the extension's WebView content uses an iframe to connect to a local web server, the port the WebView is connecting to may be blocked.
|
||||
|
||||
**Resolution:** The WebView API now includes a `portMapping` property that the extension can use to solve this problem. See the [extension guide](/api/advanced-topics/remote-extensions#accessing-localhost) for details.
|
||||
**Resolution:** The WebView API now includes a `portMapping` property that the extension can use to solve this problem. See the [extension author's guide](/api/advanced-topics/remote-extensions#accessing-localhost) for details.
|
||||
|
||||
### Blocked localhost ports
|
||||
|
||||
|
|
@ -747,13 +747,13 @@ If you are trying to connect to a localhost port from an external application, t
|
|||
|
||||
Extensions may try to persist global data by looking for the `~/.config/Code` folder on Linux. This folder may not exist, which can cause the extension to throw errors like `ENOENT: no such file or directory, open '/root/.config/Code/User/filename-goes-here`.
|
||||
|
||||
**Resolution:** Extensions can use the `context.globalStoragePath` or `context.storagePath` property to resolve this problem. See the [extension guide](/api/advanced-topics/remote-extensions#persisting-extension-data-or-state) for details.
|
||||
**Resolution:** Extensions can use the `context.globalStoragePath` or `context.storagePath` property to resolve this problem. See the [extension author's guide](/api/advanced-topics/remote-extensions#persisting-extension-data-or-state) for details.
|
||||
|
||||
### Cannot sign in / have to sign in each time I connect to a new endpoint
|
||||
|
||||
Extensions that require sign in may persist secrets using their own code. This code can fail due to missing dependencies. Even if it succeeds, the secrets will be stored remotely, which means you have to sign in for every new endpoint.
|
||||
|
||||
**Resolution:** Extensions can use the `keytar` node module to solve this problem. See the [extension guide](/api/advanced-topics/remote-extensions#persisting-secrets) for details.
|
||||
**Resolution:** Extensions can use the `keytar` node module to solve this problem. See the [extension author's guide](/api/advanced-topics/remote-extensions#persisting-secrets) for details.
|
||||
|
||||
### An incompatible extension prevents VS Code from connecting
|
||||
|
||||
|
|
@ -774,20 +774,20 @@ If an incompatible extension has been installed on a remote host, container, or
|
|||
|
||||
Native modules bundled with (or dynamically acquired for) a VS Code extension must be recompiled [using Electron's `electron-rebuild`](https://electronjs.org/docs/tutorial/using-native-node-modules). However, VS Code Server runs a standard (non-Electron) version of Node.js, which can cause binaries to fail when used remotely.
|
||||
|
||||
**Resolution:** Extensions need to be modified to solve this problem. They will need to include (or dynamically acquire) both sets of binaries (Electron and standard Node.js) for the "modules" version in Node.js that VS Code ships and then check to see if `context.executionContext === vscode.ExtensionExecutionContext.Remote` in their activation function to set up the correct binaries. See the [extension guide](/api/advanced-topics/remote-extensions#using-native-node.js-modules) for details.
|
||||
**Resolution:** Extensions need to be modified to solve this problem. They will need to include (or dynamically acquire) both sets of binaries (Electron and standard Node.js) for the "modules" version in Node.js that VS Code ships and then check to see if `context.executionContext === vscode.ExtensionExecutionContext.Remote` in their activation function to set up the correct binaries. See the [extension author's guide](/api/advanced-topics/remote-extensions#using-native-node.js-modules) for details.
|
||||
|
||||
### Extension only fails on non-x86_64 hosts or Alpine Linux
|
||||
|
||||
If an extension works on Debian 9+, Ubuntu 16.04+, or RHEL / CentOS 7+ remote SSH hosts, containers, or WSL, but fails on supported non-x86_64 hosts (for example, ARMv7l) or Alpine Linux containers, the extension may only include native code or runtimes that do not support these platforms. For example, the extensions may only include x86_64 compiled versions of native modules or runtimes. For Alpine Linux, the included native code or runtimes may not work due to [fundamental differences](https://wiki.musl-libc.org/functional-differences-from-glibc.html) between how `libc` is implemented in Alpine Linux (`musl`) and other distributions (`glibc`).
|
||||
|
||||
**Resolution:**
|
||||
Extensions will need to opt-in to supporting these platforms by compiling / including binaries for these additional targets. It is important to note that some third-party npm modules may also include native code that can cause this problem. So, in some cases you may need to work with the npm module author to add additional compilation targets. See the [extension guide](api/advanced-topics/remote-extensions#supporting-non-x8664-hosts-or-alpine-linux-containers) for details.
|
||||
Extensions will need to opt-in to supporting these platforms by compiling / including binaries for these additional targets. It is important to note that some third-party npm modules may also include native code that can cause this problem. So, in some cases you may need to work with the npm module author to add additional compilation targets. See the [extension author's guide](api/advanced-topics/remote-extensions#supporting-nonx8664-hosts-or-alpine-linux-containers) for details.
|
||||
|
||||
### Extensions fail due to missing modules
|
||||
|
||||
Extensions that rely on Electron or VS Code base modules (not exposed by the extension API) without providing a fallback can fail when running remotely. You may see errors in the Developer Tools console like `original-fs` not being found.
|
||||
|
||||
**Resolution:** Remove the dependency on an Electron module or provide a fallback. See the [extension guide](/api/advanced-topics/remote-extensions#avoid-using-electron-modules) for details.
|
||||
**Resolution:** Remove the dependency on an Electron module or provide a fallback. See the [extension author's guide](/api/advanced-topics/remote-extensions#avoid-using-electron-modules) for details.
|
||||
|
||||
### Cannot access / transfer remote workspace files to local machines
|
||||
|
||||
|
|
|
|||
|
|
@ -31,9 +31,9 @@ To get started you need to:
|
|||
|
||||
> **Note:** When prompted to **Select Additional Tasks** during installation, be sure to check the **Add to PATH** option so you can easily open a folder in WSL using the `code` command.
|
||||
|
||||
3. Install the [Remote Development](https://aka.ms/vscode-remote/download/extension) extension pack.
|
||||
3. Install the [Remote Development extension pack](https://aka.ms/vscode-remote/download/extension).
|
||||
|
||||
4. Consider adding a `.gitattributes` file to your repos or disabling automatic line ending conversion for Git on the **Windows side** by using a command prompt to run: `git config --global core.autocrlf input` If left enabled, this setting can cause files that you have not edited to appear modified due to line ending differences. See [tips and tricks](/docs/remote/troubleshooting.md#resolving-git-line-ending-issues-in-containers-resulting-in-many-modified-files) for details.
|
||||
4. Consider adding a `.gitattributes` file to your repos or disabling automatic line ending conversion for Git on the **Windows side** by using a command prompt to run: `git config --global core.autocrlf input` If left enabled, this setting can cause files that you have not edited to appear modified due to line ending differences. See [Tips and Tricks](/docs/remote/troubleshooting.md#resolving-git-line-ending-issues-in-containers-resulting-in-many-modified-files) for details.
|
||||
|
||||
### Open a folder in WSL
|
||||
|
||||
|
|
@ -82,7 +82,7 @@ If you install an extension from the Extensions view, it will automatically be i
|
|||
|
||||
> **Note:** If you are an extension author and your extension is not working properly or installs in the wrong place, see [Supporting Remote Development](/api/advanced-topics/remote-extensions.md) for details.
|
||||
|
||||
Local extensions that actually need to run remotely will appear **Disabled** in the **Local - Installed** category. You can click the **Install** button to install an extension on your remote host.
|
||||
Local extensions that actually need to run remotely will appear **Disabled** in the **Local - Installed** category. Select **Install** to install an extension on your remote host.
|
||||
|
||||
|
||||
|
||||
|
|
@ -163,7 +163,7 @@ Fortunately, if you've [installed the Docker CLI in WSL and configured it to wor
|
|||
|
||||
### Extension limitations
|
||||
|
||||
Many extensions will work in WSL without modification. However, in some cases, certain features may require changes. If you run into an extension issue, [see here for a summary of common problems and solutions](/docs/remote/troubleshooting.md#extension-tips) that you can mention to the extension author when reporting the issue.
|
||||
Many extensions will work in WSL without modification. However, in some cases, certain features may require changes. If you run into an extension issue, see [here for a summary of common problems and solutions](/docs/remote/troubleshooting.md#extension-tips) that you can mention to the extension author when reporting the issue.
|
||||
|
||||
## Common questions
|
||||
|
||||
|
|
@ -207,9 +207,9 @@ The VS Code Server requires outbound HTTPS (port 443) connectivity to:
|
|||
- `*.vo.msecnd.net` (Azure CDN)
|
||||
- `*.gallerycdn.vsassets.io` (Azure CDN)
|
||||
|
||||
All other communication between the server and the VS Code client is accomplished through an authenticated, random, local TCP port. You can find a list of locations VS Code itself needs access to [in the network connections article](/docs/setup/network.md#common-hostnames).
|
||||
All other communication between the server and the VS Code client is accomplished through an authenticated, random, local TCP port. You can find a list of locations VS Code itself needs access to in the [network connections article](/docs/setup/network.md#common-hostnames).
|
||||
|
||||
Finally, some extensions (like C#) download secondary dependencies from `download.microsoft.com` or `download.visualstudio.microsoft.com`. Others (like [VS Live Share](https://docs.microsoft.com/en-us/visualstudio/liveshare/reference/connectivity#requirements-for-connection-modes)) may have additional connectivity requirements. Consult the extension's documentation for details if you run into trouble.
|
||||
Finally, some extensions (like C#) download secondary dependencies from `download.microsoft.com` or `download.visualstudio.microsoft.com`. Others (like [Visual Studio Live Share](https://docs.microsoft.com/visualstudio/liveshare/reference/connectivity#requirements-for-connection-modes)) may have additional connectivity requirements. Consult the extension's documentation for details if you run into trouble.
|
||||
|
||||
### As an extension author, what do I need to do?
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче