Skip to content

docs: add VS Code Web to web-ides #9591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 10, 2023
Merged

docs: add VS Code Web to web-ides #9591

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
be074b3
docs: add VS Code Web to web-ides.md
matifali Sep 7, 2023
228fe48
make gmt
matifali Sep 7, 2023
577d11d
fix version to 1.82.0
matifali Sep 10, 2023
b2dded2
Merge branch 'main' into vscode-web-docs
matifali Sep 10, 2023
939d75f
fmt
matifali Sep 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/ides/web-ides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,33 @@ resource "coder_app" "code-server" {
}
```

## VS Code Web

VS Code supports launching a local web client using the `code serve-web`
command. To add VS COde web as a web IDE, Install and start this in your
`startup_script` and create a corresponding `coder_app`

```hcl
resource "coder_agent" "main" {
arch = "amd64"
os = "linux"
startup_script = <<EOF
#!/bin/sh
# install VS Code
curl -L "https://update.code.visualstudio.com/latest/linux-deb-x64/stable" -o /tmp/code.deb
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thoughts on us hardcoding a version here?

sudo dpkg -i /tmp/code.deb && sudo apt-get install -f -y
# start the web server on a specific port
code serve-web --port 13338 --without-connection-token --accept-server-license-terms >/tmp/vscode-web.log 2>&1 &
EOF
}
```

You also need to add a `coder_app` resource for this,

resource "coder_app" "vscode-web" { agent_id = coder_agent.coder.id slug =
"vscode-web" display_name = "VS Code Web" url = "http://localhost:13338" icon =
"/icon/code.svg" share = "owner" subdomain = true }

## JupyterLab

Configure your agent and `coder_app` like so to use Jupyter. Notice the
Expand Down