Skip to content

Commit 428ec35

Browse files
EdwardAngertEdwardAngert
authored
docs: add code-server/vs code web comparison table (#19104)
closes #18815 adds a doc with comparison table and links to main documentation for code-server [preview](https://coder.com/docs/@18815-code-server-vs/user-guides/workspace-access/code-server) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent f256a23 commit 428ec35

File tree

4 files changed

+46
-9
lines changed

4 files changed

+46
-9
lines changed

‎docs/manifest.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,11 @@
251251
"description": "Access your workspace with IDEs in the browser",
252252
"path": "./user-guides/workspace-access/web-ides.md"
253253
},
254+
{
255+
"title": "code-server",
256+
"description": "Access your workspace with code-server",
257+
"path": "./user-guides/workspace-access/code-server.md"
258+
},
254259
{
255260
"title": "Zed",
256261
"description": "Access your workspace with Zed",

‎docs/user-guides/workspace-access/code-server.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# code-server
2+
3+
[code-server](https://github.com/coder/code-server) is our supported method of running VS Code in the web browser.
4+
5+
![code-server in a workspace](../../images/code-server-ide.png)
6+
7+
## Differences between code-server and VS Code Web
8+
9+
Some of the key differences between code-server and VS Code Web are:
10+
11+
| Feature | code-server | VS Code Web |
12+
|--------------------------|-----------------------------------------------------------------------------|-------------------------------------------------------------------|
13+
| Authentication | Optional login form | No built-in auth |
14+
| Built-in proxy | Includes development proxy (not needed with Coder) | No built-in development proxy |
15+
| Clipboard integration | Supports piping text from terminal (similar to `xclip`) | More limited |
16+
| Display languages | Supports language pack extensions | Limited language support |
17+
| File operations | Options to disable downloads and uploads | No built-in restrictions |
18+
| Health endpoint | Provides `/healthz` endpoint | Limited health monitoring |
19+
| Marketplace | Open VSX by default, configurable via flags/env vars | Uses Microsoft marketplace; modify `product.json` to use your own |
20+
| Path-based routing | Has fixes for state collisions when used path-based | May have issues with path-based routing in certain configurations |
21+
| Proposed API | Always enabled for all extensions | Only Microsoft extensions without configuration |
22+
| Proxy integration | Integrates with Coder's proxy for ports panel | Integration is more limited |
23+
| Sourcemaps | Loads locally | Uses CDN |
24+
| Telemetry | Configurable endpoint | Does not allow a configurable endpoint |
25+
| Terminal access to files | You can use a terminal outside of the integrated one to interact with files | Limited to integrated terminal access |
26+
| User settings | Stored on remote disk | Stored in browser |
27+
| Web views | Self-contained | Uses Microsoft CDN |
28+
29+
For more information about code-server, visit the [code-server FAQ](https://coder.com/docs/code-server/FAQ).

‎docs/user-guides/workspace-access/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,12 @@ Your workspace is now accessible via `ssh coder.<workspace_name>`
7878
## Visual Studio Code
7979

8080
You can develop in your Coder workspace remotely with
81-
[VSCode](https://code.visualstudio.com/download). We support connecting with the
82-
desktop client and VSCode in the browser with [code-server](#code-server).
81+
[VS Code](https://code.visualstudio.com/download).
82+
We support connecting with the desktop client and VS Code in the browser with [code-server](#code-server).
8383

8484
![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true)
8585

86-
Read more details on [using VSCode in your workspace](./vscode.md).
86+
Read more details on [using VS Code in your workspace](./vscode.md).
8787

8888
## Cursor
8989

@@ -118,7 +118,8 @@ on connecting your JetBrains IDEs.
118118
## code-server
119119

120120
[code-server](https://github.com/coder/code-server) is our supported method of
121-
running VS Code in the web browser. You can read more in our
121+
running VS Code in the web browser.
122+
Learn more about [what makes code-server different from VS Code web](./code-server.md) or visit the
122123
[documentation for code-server](https://coder.com/docs/code-server/latest).
123124

124125
![code-server in a workspace](../../images/code-server-ide.png)

‎docs/user-guides/workspace-access/vscode.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# Visual Studio Code
22

33
You can develop in your Coder workspace remotely with
4-
[VSCode](https://code.visualstudio.com/download). We support connecting with the
5-
desktop client and VSCode in the browser with
4+
[VS Code](https://code.visualstudio.com/download).
5+
We support connecting with the desktop client and VS Code in the browser with
66
[code-server](https://github.com/coder/code-server).
7+
Learn more about how VS Code Web and code-server compare in the
8+
[code-server doc](./code-server.md).
79

8-
## VSCode Desktop
10+
## VS Code Desktop
911

10-
VSCode desktop is a default app for workspaces.
12+
VS Code desktop is a default app for workspaces.
1113

1214
Click `VS Code Desktop` in the dashboard to one-click enter a workspace. This
1315
automatically installs the [Coder Remote](https://github.com/coder/vscode-coder)
@@ -21,7 +23,7 @@ extension, authenticates with Coder, and connects to the workspace.
2123
2224
### Manual Installation
2325

24-
You can install our extension manually in VSCode using the command palette.
26+
You can install our extension manually in VS Code using the command palette.
2527
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press
2628
enter.
2729

0 commit comments

Comments
 (0)