Skip to content

Commit eba96f1

Browse files
committed
Cleanup FAQ
Prominently explain how code-server is different from VS Code Closes #1718
1 parent 8dfac0f commit eba96f1

File tree

4 files changed

+29
-43
lines changed

4 files changed

+29
-43
lines changed

.github/issue_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
<!--
22
Please file all questions and support requests at https://www.reddit.com/r/codeserver/
3-
The issue tracker is only for bugs.
3+
The issue tracker is only for bugs and features.
44
-->

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ If you believe an install script used with `curl | sh` is insecure, please give
4242

4343
Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md).
4444

45+
We also highly recommend reading the [FAQ](./doc/FAQ.md) on the [Differences compared to VS Code](./doc/FAQ.md#differences-compared-to-vs-code).
46+
4547
## FAQ
4648

4749
See [./doc/FAQ.md](./doc/FAQ.md).

ci/build/release-github-assets.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ main() {
1111
source ./ci/lib.sh
1212

1313
download_artifact release-packages ./release-packages
14-
local assets=(./release-packages/code-server*$VERSION*{.tar.gz,.deb,.rpm})
14+
local assets=(./release-packages/code-server*"$VERSION"*{.tar.gz,.deb,.rpm})
1515
for i in "${!assets[@]}"; do
1616
assets[$i]="--attach=${assets[$i]}"
1717
done

doc/FAQ.md

+25-41
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
- [Questions?](#questions)
66
- [How can I reuse my VS Code configuration?](#how-can-i-reuse-my-vs-code-configuration)
7-
- [What's the deal with extensions?](#whats-the-deal-with-extensions)
7+
- [Differences compared to VS Code?](#differences-compared-to-vs-code)
8+
- [How can I request a missing extension?](#how-can-i-request-a-missing-extension)
89
- [Where are extensions stored?](#where-are-extensions-stored)
910
- [How is this different from VS Code Codespaces?](#how-is-this-different-from-vs-code-codespaces)
1011
- [How should I expose code-server to the internet?](#how-should-i-expose-code-server-to-the-internet)
@@ -13,7 +14,6 @@
1314
- [Sub-domains](#sub-domains)
1415
- [Multi-tenancy](#multi-tenancy)
1516
- [Docker in code-server container?](#docker-in-code-server-container)
16-
- [Collaboration](#collaboration)
1717
- [How can I disable telemetry?](#how-can-i-disable-telemetry)
1818
- [How does code-server decide what workspace or folder to open?](#how-does-code-server-decide-what-workspace-or-folder-to-open)
1919
- [How do I debug issues with code-server?](#how-do-i-debug-issues-with-code-server)
@@ -22,8 +22,6 @@
2222
- [Blank screen on iPad?](#blank-screen-on-ipad)
2323
- [Isn't an install script piped into sh insecure?](#isnt-an-install-script-piped-into-sh-insecure)
2424
- [How do I make my keyboard shortcuts work?](#how-do-i-make-my-keyboard-shortcuts-work)
25-
- [Why can't I use VS Code's Remote extensions?](#why-cant-i-use-vs-codes-remote-extensions)
26-
- [Why can't I use VS Code Live Share?](#why-cant-i-use-vs-code-live-share)
2725
- [Enterprise](#enterprise)
2826

2927
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -32,21 +30,26 @@
3230

3331
Please file all questions and support requests at https://www.reddit.com/r/codeserver/.
3432

35-
The issue tracker is **only** for bugs.
33+
The issue tracker is **only** for bugs and features.
3634

3735
## How can I reuse my VS Code configuration?
3836

3937
The very popular [Settings Sync](https://marketplace.visualstudio.com/items?itemName=Shan.code-settings-sync) extension should just work.
4038

41-
To manually reuse, you can just copy `~/.vscode` into `~/.config/code-server`
42-
and `code-server` will reuse your existing extensions and configuration.
39+
You can also pass `--data-dir ~/.vscode` to reuse your existing VS Code extensions and configuration.
4340

44-
## What's the deal with extensions?
41+
Or copy `~/.vscode` into `~/.local/share/code-server`.
4542

46-
Unfortunately, the Microsoft VS Code Marketplace license prohibits use with any non Microsoft
47-
product.
43+
## Differences compared to VS Code?
4844

49-
See https://cdn.vsassets.io/v/M146_20190123.39/_content/Microsoft-Visual-Studio-Marketplace-Terms-of-Use.pdf
45+
`code-server` takes the open source core of VS Code and allows you to run it in the browser.
46+
However, it is not entirely equivalent to Microsoft's VS Code.
47+
48+
While the core of VS Code is open source, the marketplace and many published Microsoft extensions are not.
49+
50+
Not only are they closed source, Microsoft prohibits the use of any non-Microsoft VS Code from accessing their marketplace.
51+
52+
See the [TOS](https://cdn.vsassets.io/v/M146_20190123.39/_content/Microsoft-Visual-Studio-Marketplace-Terms-of-Use.pdf).
5053

5154
> Marketplace Offerings are intended for use only with Visual Studio Products and Services
5255
> and you may only install and use Marketplace Offerings with Visual Studio Products and Services.
@@ -55,12 +58,18 @@ As a result, we have created our own marketplace for open source extensions.
5558
It works by scraping GitHub for VS Code extensions and building them. It's not perfect but getting
5659
better by the day with more and more extensions.
5760

58-
Issue [#1299](https://github.com/cdr/code-server/issues/1299) is a big one in making the experience here
59-
better by allowing the community to submit extensions and repos to avoid waiting until the scraper finds
60-
an extension.
61+
These are the closed source extensions presently unavailable:
62+
63+
1. [Live Share](https://visualstudio.microsoft.com/services/live-share)
64+
- We may implement something similar, see [#33](https://github.com/cdr/code-server/issues/33)
65+
1. [Remote Extensions (SSH, Containers, WSL)](https://github.com/microsoft/vscode-remote-release)
66+
- We may reimplement these at some point, see [#1315](https://github.com/cdr/code-server/issues/1315)
6167

62-
To request an extension for the code-server marketplace, please open a new issue
63-
and select the `Extension request` template.
68+
For more about the closed source parts of VS Code, see [vscodium/vscodium](https://github.com/VSCodium/vscodium#why-does-this-exist).
69+
70+
## How can I request a missing extension?
71+
72+
Please open a new issue and select the `Extension request` template.
6473

6574
If an extension is not available or does not work, you can grab its VSIX from its Github releases or
6675
build it yourself. Then run the `Extensions: Install from VSIX` command in the Command Palette and
@@ -169,12 +178,6 @@ You can even make volume mounts work. Lets say you want to run a container and m
169178
the docker daemon's `/home/coder/myproject` is the same as the one mounted inside the `code-server`
170179
container and the mount will just work.
171180

172-
## Collaboration
173-
174-
We understand the high demand but the team is swamped right now.
175-
176-
You can subscribe to [#33](https://github.com/cdr/code-server/issues/33) for updates.
177-
178181
## How can I disable telemetry?
179182

180183
Use the `--disable-telemetry` flag to completely disable telemetry. We use the
@@ -268,25 +271,6 @@ This will install a Chrome PWA and now all keybindings will work!
268271

269272
For other browsers you'll have to remap keybindings unfortunately.
270273

271-
## Why can't I use VS Code's Remote extensions?
272-
273-
Unfortunately, Microsoft has opted to make [VS Code's Remote SSH and Container
274-
extensions closed source](https://github.com/microsoft/vscode-remote-release) and
275-
it is against their TOS to use the published extensions against anything other
276-
than Microsoft VS Code builds so we are unable to add them to our marketplace.
277-
278-
We may reimplement them at some point.
279-
You can subscribe to [#1315](https://github.com/cdr/code-server/issues/1315) for updates.
280-
281-
## Why can't I use VS Code Live Share?
282-
283-
Unfortunately, Microsoft has opted to make
284-
[VS Code's Live Share extension closed source](https://github.com/microsoft/vscode/issues/38733#issuecomment-388213016) and
285-
it is against their TOS to use the published extension against anything other
286-
than Microsoft VS Code builds so we are unable to add them to our marketplace.
287-
288-
We may implement our own at some point. See [Collaboration](#collaboration).
289-
290274
## Enterprise
291275

292276
Visit [our enterprise page](https://coder.com) for more information about our

0 commit comments

Comments
 (0)