Skip to content

Commit d809bf2

Browse files
author
Akash Satheesan
authored
docs: update FAQ with extension gallery info (#2672)
1 parent aa59bc4 commit d809bf2

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

docs/FAQ.md

+24-20
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,11 @@ See the [TOS](https://cdn.vsassets.io/v/M146_20190123.39/_content/Microsoft-Visu
6464
> and you may only install and use Marketplace Offerings with Visual Studio Products and Services.
6565
6666
As a result, we cannot offer any extensions on the Microsoft marketplace. Instead,
67-
we have created our own marketplace for open source extensions.
68-
It works by scraping GitHub for VS Code extensions and building them. It's not perfect but getting
69-
better by the day with more and more extensions.
67+
we use the [Open-VSX extension gallery](https://open-vsx.org), which is also used by various other forks.
68+
It isn't perfect, but its getting better by the day with more and more extensions.
69+
70+
We also offer our own marketplace for open source extensions, but plan to
71+
deprecate it at a future date and completely migrate to Open-VSX.
7072

7173
These are the closed source extensions presently unavailable:
7274

@@ -79,25 +81,37 @@ For more about the closed source parts of VS Code, see [vscodium/vscodium](https
7981

8082
## How can I request a missing extension?
8183

82-
Please open a new issue and select the `Extension request` template.
84+
To add an extension to Open-VSX, please see [open-vsx/publish-extensions](https://github.com/open-vsx/publish-extensions).
85+
We no longer plan to add new extensions to our legacy extension gallery.
8386

8487
If an extension is not available or does not work, you can grab its VSIX from its Github releases or
8588
build it yourself. Then run the `Extensions: Install from VSIX` command in the Command Palette and
8689
point to the .vsix file.
8790

88-
See below for installing an extension from the cli.
91+
You can install an extension on the CLI with:
92+
93+
```bash
94+
# From the configured extension marketplace
95+
code-server --install-extension ms-python.python
96+
97+
# From a downloaded VSIX on the file system
98+
# For example, downloading an extension from the MS store:
99+
# https://marketplace.visualstudio.com/items?itemName=ms-python.python -> 'Download Extension' on sidebar
100+
code-server --install-extension /path/to/downloaded-ms-python.python.vsix
101+
```
89102

90103
## How do I configure the marketplace URL?
91104

92-
If you have your own marketplace that implements the VS Code Extension Gallery API, it is possible to
93-
point code-server to it by setting `$SERVICE_URL` and `$ITEM_URL`. These correspond directly
105+
If you have your own marketplace that implements the VS Code Extension Gallery API or
106+
if you want to switch to our legacy gallery, it is possible to point code-server to it
107+
by setting `$SERVICE_URL` and `$ITEM_URL`. These correspond directly
94108
to `serviceUrl` and `itemUrl` in VS Code's `product.json`.
95109

96-
e.g. to use [open-vsx.org](https://open-vsx.org):
110+
e.g. to use our [legacy extension gallery](https://xextensions.coder.com):
97111

98112
```bash
99-
export SERVICE_URL=https://open-vsx.org/vscode/gallery
100-
export ITEM_URL=https://open-vsx.org/vscode/item
113+
export SERVICE_URL=https://extensions.coder.com/api
114+
export ITEM_URL="" # intentionally blank
101115
```
102116

103117
While you can technically use Microsoft's marketplace with these, please do not do so as it
@@ -117,16 +131,6 @@ Defaults to `~/.local/share/code-server/extensions`.
117131
If the `XDG_DATA_HOME` environment variable is set the data directory will be
118132
`$XDG_DATA_HOME/code-server/extensions`. In general we try to follow the XDG directory spec.
119133

120-
You can install an extension on the CLI with:
121-
122-
```bash
123-
# From the Coder extension marketplace
124-
code-server --install-extension ms-python.python
125-
126-
# From a downloaded VSIX on the file system
127-
code-server --install-extension downloaded-ms-python.python.vsix
128-
```
129-
130134
## How is this different from VS Code Codespaces?
131135

132136
VS Code Codespaces is a closed source and paid service by Microsoft. It also allows you to access

0 commit comments

Comments
 (0)