Skip to content

Commit 142401b

Browse files
committed
chore: document external URLs, refresh web IDE images
1 parent 84ede32 commit 142401b

File tree

6 files changed

+54
-10
lines changed

6 files changed

+54
-10
lines changed

docs/ides/web-ides.md

Lines changed: 54 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ By default, Coder workspaces allow connections via:
55
- Web terminal
66
- SSH (plus any [SSH-compatible IDE](../ides.md))
77

8-
It's common to also let developers to connect via web IDEs.
8+
It's common to also let developers to connect via web IDEs for uses cases like
9+
zero trust networks, data science, contractors, and infrequent code
10+
contributors.
911

1012
![Row of IDEs](../images/ide-row.png)
1113

@@ -32,9 +34,34 @@ resource "coder_app" "portainer" {
3234
}
3335
```
3436

35-
## code-server
37+
## External URLs
3638

37-
![code-server in a workspace](../images/code-server-ide.png)
39+
Any URL external to the Coder deployment is accessible as a `coder_app`. e.g.,
40+
Dropbox, Slack, Discord, GitHub
41+
42+
```hcl
43+
resource "coder_app" "pubslack" {
44+
agent_id = coder_agent.coder.id
45+
display_name = "Coder Public Slack"
46+
slug = "pubslack"
47+
url = "https://coder-com.slack.com/"
48+
icon = "https://cdn2.hubspot.net/hubfs/521324/slack-logo.png"
49+
external = true
50+
}
51+
52+
resource "coder_app" "discord" {
53+
agent_id = coder_agent.coder.id
54+
display_name = "Coder Discord"
55+
slug = "discord"
56+
url = "https://discord.com/invite/coder"
57+
icon = "https://logodix.com/logo/573024.png"
58+
external = true
59+
}
60+
```
61+
62+
![External URLs](../images/external-apps.png)
63+
64+
## code-server
3865

3966
[code-server](https://github.com/coder/coder) is our supported method of running
4067
VS Code in the web browser. A simple way to install code-server in Linux/macOS
@@ -104,7 +131,9 @@ resource "coder_app" "code-server" {
104131
}
105132
```
106133

107-
## VS Code Web
134+
![code-server in a workspace](../images/code-server-ide.png)
135+
136+
## VS Code Server
108137

109138
VS Code supports launching a local web client using the `code serve-web`
110139
command. To add VS COde web as a web IDE, Install and start this in your
@@ -125,13 +154,28 @@ resource "coder_agent" "main" {
125154
}
126155
```
127156

128-
> [!NOTE] > `code serve-web` was introduced in version 1.82.0 (August 2023).
157+
> `code serve-web` was introduced in version 1.82.0 (August 2023).
129158
130-
You also need to add a `coder_app` resource for this,
159+
You also need to add a `coder_app` resource for this.
160+
161+
```hcl
162+
# VS Code Server
163+
resource "coder_app" "vscode-server" {
164+
agent_id = coder_agent.coder.id
165+
slug = "vscode-server"
166+
display_name = "VS Code Server"
167+
icon = "/icon/code.svg"
168+
url = "http://localhost:13338?folder=/home/coder"
169+
subdomain = false
170+
share = "owner"
131171
132-
resource "coder_app" "vscode-web" { agent_id = coder_agent.coder.id slug =
133-
"vscode-web" display_name = "VS Code Web" url = "http://localhost:13338" icon =
134-
"/icon/code.svg" share = "owner" subdomain = true }
172+
healthcheck {
173+
url = "http://localhost:13338/healthz"
174+
interval = 3
175+
threshold = 10
176+
}
177+
}
178+
```
135179

136180
## JupyterLab
137181

@@ -168,7 +212,7 @@ resource "coder_app" "jupyter" {
168212
}
169213
```
170214

171-
![JupyterLab in Coder](../images/jupyter-on-docker.png)
215+
![JupyterLab in Coder](../images/jupyter.png)
172216

173217
## RStudio
174218

docs/images/code-server-ide.png

-196 KB
Loading

docs/images/external-apps.png

93.9 KB
Loading

docs/images/ide-row.png

13.6 KB
Loading

docs/images/jupyter-on-docker.png

-77.6 KB
Binary file not shown.

docs/images/jupyter.png

287 KB
Loading

0 commit comments

Comments
 (0)