|
1 | 1 | <!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
2 | 2 | <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
3 |
| - |
4 | 3 | # FAQ
|
5 | 4 |
|
6 |
| -- [FAQ](#faq) |
7 |
| - - [Questions?](#questions) |
8 |
| - - [iPad Status?](#ipad-status) |
9 |
| - - [Community Projects (awesome-code-server)](#community-projects-awesome-code-server) |
10 |
| - - [How can I reuse my VS Code configuration?](#how-can-i-reuse-my-vs-code-configuration) |
11 |
| - - [Differences compared to VS Code?](#differences-compared-to-vs-code) |
12 |
| - - [How can I request a missing extension?](#how-can-i-request-a-missing-extension) |
13 |
| - - [How do I configure the marketplace URL?](#how-do-i-configure-the-marketplace-url) |
14 |
| - - [Where are extensions stored?](#where-are-extensions-stored) |
15 |
| - - [Installing VSIX Extensions via the Command Line](#installing-vsix-extensions-via-the-command-line) |
16 |
| - - [How is this different from VS Code Codespaces?](#how-is-this-different-from-vs-code-codespaces) |
17 |
| - - [How should I expose code-server to the internet?](#how-should-i-expose-code-server-to-the-internet) |
18 |
| - - [Can I store my password hashed?](#can-i-store-my-password-hashed) |
19 |
| - - [How do I securely access web services?](#how-do-i-securely-access-web-services) |
20 |
| - - [Sub-paths](#sub-paths) |
21 |
| - - [Sub-domains](#sub-domains) |
22 |
| - - [Why does the code-server proxy strip `/proxy/<port>` from the request path?](#why-does-the-code-server-proxy-strip-proxyport-from-the-request-path) |
23 |
| - - [Proxying to Create React App](#proxying-to-create-react-app) |
24 |
| - - [Multi-tenancy](#multi-tenancy) |
25 |
| - - [Docker in code-server container?](#docker-in-code-server-container) |
26 |
| - - [How can I disable telemetry?](#how-can-i-disable-telemetry) |
27 |
| - - [How does code-server decide what workspace or folder to open?](#how-does-code-server-decide-what-workspace-or-folder-to-open) |
28 |
| - - [How do I debug issues with code-server?](#how-do-i-debug-issues-with-code-server) |
29 |
| - - [Heartbeat File](#heartbeat-file) |
30 |
| - - [Healthz endpoint](#healthz-endpoint) |
31 |
| - - [How does the config file work?](#how-does-the-config-file-work) |
32 |
| - - [Isn't an install script piped into sh insecure?](#isnt-an-install-script-piped-into-sh-insecure) |
33 |
| - - [How do I make my keyboard shortcuts work?](#how-do-i-make-my-keyboard-shortcuts-work) |
34 |
| - - [Differences compared to Theia?](#differences-compared-to-theia) |
35 |
| - - [`$HTTP_PROXY`, `$HTTPS_PROXY`, `$NO_PROXY`](#http_proxy-https_proxy-no_proxy) |
36 |
| - - [Enterprise](#enterprise) |
| 5 | +- [Questions?](#questions) |
| 6 | +- [iPad Status?](#ipad-status) |
| 7 | +- [Community Projects (awesome-code-server)](#community-projects-awesome-code-server) |
| 8 | +- [How can I reuse my VS Code configuration?](#how-can-i-reuse-my-vs-code-configuration) |
| 9 | +- [Differences compared to VS Code?](#differences-compared-to-vs-code) |
| 10 | + - [Installing an extension](#installing-an-extension) |
| 11 | +- [How can I request a missing extension?](#how-can-i-request-a-missing-extension) |
| 12 | +- [Installing an extension manually](#installing-an-extension-manually) |
| 13 | +- [How do I configure the marketplace URL?](#how-do-i-configure-the-marketplace-url) |
| 14 | +- [Where are extensions stored?](#where-are-extensions-stored) |
| 15 | +- [How is this different from VS Code Codespaces?](#how-is-this-different-from-vs-code-codespaces) |
| 16 | +- [How should I expose code-server to the internet?](#how-should-i-expose-code-server-to-the-internet) |
| 17 | +- [Can I store my password hashed?](#can-i-store-my-password-hashed) |
| 18 | +- [How do I securely access web services?](#how-do-i-securely-access-web-services) |
| 19 | + - [Sub-paths](#sub-paths) |
| 20 | + - [Sub-domains](#sub-domains) |
| 21 | +- [Why does the code-server proxy strip `/proxy/<port>` from the request path?](#why-does-the-code-server-proxy-strip-proxyport-from-the-request-path) |
| 22 | + - [Proxying to Create React App](#proxying-to-create-react-app) |
| 23 | +- [Multi-tenancy](#multi-tenancy) |
| 24 | +- [Docker in code-server container?](#docker-in-code-server-container) |
| 25 | +- [How can I disable telemetry?](#how-can-i-disable-telemetry) |
| 26 | +- [How does code-server decide what workspace or folder to open?](#how-does-code-server-decide-what-workspace-or-folder-to-open) |
| 27 | +- [How do I debug issues with code-server?](#how-do-i-debug-issues-with-code-server) |
| 28 | +- [Heartbeat File](#heartbeat-file) |
| 29 | +- [Healthz endpoint](#healthz-endpoint) |
| 30 | +- [How does the config file work?](#how-does-the-config-file-work) |
| 31 | +- [Isn't an install script piped into sh insecure?](#isnt-an-install-script-piped-into-sh-insecure) |
| 32 | +- [How do I make my keyboard shortcuts work?](#how-do-i-make-my-keyboard-shortcuts-work) |
| 33 | +- [Differences compared to Theia?](#differences-compared-to-theia) |
| 34 | +- [`$HTTP_PROXY`, `$HTTPS_PROXY`, `$NO_PROXY`](#http_proxy-https_proxy-no_proxy) |
| 35 | +- [Enterprise](#enterprise) |
37 | 36 |
|
38 | 37 | <!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
39 | 38 |
|
@@ -85,15 +84,43 @@ These are the closed source extensions presently unavailable:
|
85 | 84 |
|
86 | 85 | For more about the closed source parts of VS Code, see [vscodium/vscodium](https://github.com/VSCodium/vscodium#why-does-this-exist).
|
87 | 86 |
|
| 87 | +### Installing an extension |
| 88 | + |
| 89 | +Extensions can be installed from the marketplace using the extensions sidebar in |
| 90 | +code-server or from the command line: |
| 91 | + |
| 92 | +```shell |
| 93 | +code-server --install-extension <extension id> |
| 94 | +# example: code-server --install-extension wesbos.theme-cobalt2 |
| 95 | +``` |
| 96 | + |
88 | 97 | ## How can I request a missing extension?
|
89 | 98 |
|
90 |
| -Please open a new issue and select the `Extension request` template. |
| 99 | +We are currently in the process of transitioning to [Open VSX](https://open-vsx.org/). |
| 100 | +Once https://github.com/eclipse/openvsx/issues/249 |
| 101 | +is implemented, we can fully make this transition. Therefore, we are no longer |
| 102 | +accepting new requests for extension requests. |
| 103 | + |
| 104 | +Instead, we suggest one of the following: |
| 105 | + |
| 106 | +- [Switch to Open VSX](#how-do-i-configure-the-marketplace-url) now |
| 107 | +- Download and [install the extension manually](#installing-an-extension-manually) |
| 108 | + |
| 109 | +## Installing an extension manually |
91 | 110 |
|
92 |
| -If an extension is not available or does not work, you can grab its VSIX from its Github releases or |
93 |
| -build it yourself. Then run the `Extensions: Install from VSIX` command in the Command Palette and |
94 |
| -point to the .vsix file. |
| 111 | +If an extension is not available from the marketplace or does not work, you can |
| 112 | +grab its VSIX from its GitHub releases or build it yourself. |
95 | 113 |
|
96 |
| -See below for installing an extension from the cli. |
| 114 | +Once you have downloaded the VSIX to the remote machine you can either: |
| 115 | + |
| 116 | +- Run the `Extensions: Install from VSIX` command in the Command Palette. |
| 117 | +- Use `code-server --install-extension <path to vsix>` |
| 118 | + |
| 119 | +If the extension exists on another marketplace, you can also download it from there using the same command. For instance, downloading off OpenVSX can be done like this: |
| 120 | + |
| 121 | +```shell |
| 122 | +SERVICE_URL=https://open-vsx.org/vscode/gallery ITEM_URL=https://open-vsx.org/vscode/item code-server --install-extension <extension id> |
| 123 | +``` |
97 | 124 |
|
98 | 125 | ## How do I configure the marketplace URL?
|
99 | 126 |
|
@@ -135,21 +162,6 @@ code-server --install-extension ms-python.python
|
135 | 162 | code-server --install-extension downloaded-ms-python.python.vsix
|
136 | 163 | ```
|
137 | 164 |
|
138 |
| -### Installing VSIX Extensions via the Command Line |
139 |
| - |
140 |
| -If you're using code-server on a remote machine, it might be easier to install extensions via the command line. Follow these steps: |
141 |
| - |
142 |
| -1. [optional] create a directory to store your extensions: `mkdir plugins` |
143 |
| -2. Find the extension you want i.e. `https://open-vsx.org/extension/stylelint/vscode-stylelint` and grab the name and identifier: `stylelint/vscode-stylelint` |
144 |
| -3. Download extension to directory: |
145 |
| - ```sh |
146 |
| - curl 'https://open-vsx.org/api/stylelint/vscode-stylelint' | jq '.files.download' | xargs curl --compressed -L -o plugins/stylelint.vsix |
147 |
| - ``` |
148 |
| -4. Install in code-server |
149 |
| - ```sh |
150 |
| - code-server --install-extension stylelint.vsix |
151 |
| - ``` |
152 |
| - |
153 | 165 | ## How is this different from VS Code Codespaces?
|
154 | 166 |
|
155 | 167 | VS Code Codespaces is a closed source and paid service by Microsoft. It also allows you to access
|
|
0 commit comments