Skip to content

Commit 762b680

Browse files
stirbymatifali
stirby
authored and
matifali
committed
workspace access docs
1 parent 133721a commit 762b680

File tree

9 files changed

+768
-272
lines changed

9 files changed

+768
-272
lines changed

‎docs/manifest.json

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,29 @@
9191
{
9292
"title": "Accessing workspaces",
9393
"description": "Connect to your Coder workspaces",
94-
"path": "./user-guides/workspace-access.md"
94+
"path": "./user-guides/workspace-access/README.md",
95+
"children": [
96+
{
97+
"title": "Web IDEs",
98+
"description": "Connect with web-based IDEs",
99+
"path": "./user-guides/workspace-access/web-ides.md"
100+
},
101+
{
102+
"title": "Jetbrains IDEs",
103+
"description": "Use Jetbrains IDEs with Gateway",
104+
"path": "./user-guides/workspace-access/jetbrains.md"
105+
},
106+
{
107+
"title": "Remote Desktops",
108+
"description": "Use VDI in Coder",
109+
"path": "./user-guides/workspace-access/remote-desktop.md"
110+
},
111+
{
112+
"title": "Emacs Tramp",
113+
"description": "Use VDI in Coder",
114+
"path": "./user-guides/workspace-access/emacs-tramp.md"
115+
}
116+
]
95117
},
96118
{
97119
"title": "Maintaining workspaces",

‎docs/networking/port-forwarding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ to specify an arbitrary port. Coder will also detect if apps inside the
9999
workspace are listening on ports, and list them below the port input (this is
100100
only supported on Windows and Linux workspace agents).
101101

102-
![Port forwarding in the UI](../images/networking/listeningports.png)
102+
![Port forwarding in the UI](../../images/networking/listeningports.png)
103103

104104
### Sharing ports
105105

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

Lines changed: 79 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,65 @@
22

33
There are many ways to connect to your workspace, the options are only limited by the template configuration.
44

5-
> Deployment operators can learn more about different types of workspace connections and performance in our [networking docs](../admin/infrastructure/README.md).
5+
> Deployment operators can learn more about different types of workspace connections and performance in our [networking docs](../../admin/infrastructure/README.md).
66
77
You can see the primary methods of connecting to your workspace in the workspace dashboard.
88

9-
![Workspace View](../images/user-guides/workspace-view-connection-annotated.png)
9+
![Workspace View](../../images/user-guides/workspace-view-connection-annotated.png)
1010

1111
<!-- ## Coder Apps
1212
13+
TODO: Is this relevant?
14+
1315
Coder Apps (from our [`coder_app`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app) resource in terraform) provide IDE connections and the Terminal. Coder Apps can connect you to ports or run commands on the remote workspace. They be shared with other users by copying the URL from the button. Contact your template administrator if you have IDEs or tools you'd like added into your workspace.
1416
1517
, and can be extended with our [Module Registry](https://registry.coder.com/modules). -->
1618

1719
## Terminal
1820

19-
The terminal is enabled by implictily in Coder and allows you to access your workspace through a shell environment.
21+
The terminal is implicitly enabled in Coder and allows you to access your workspace through the shell environment set by your template.
2022

21-
## Jetbrains IDEs
23+
## SSH
2224

23-
We support Jetbrains IDEs using Gateway. Currently the following are supported:
24-
- IntelliJ IDEA
25-
- CLion
26-
- GoLand
27-
- PyCharm
28-
- Rider
29-
- RubyMine
30-
- WebStorm
25+
### Through with the CLI
3126

32-
Read our [docs on Jetbrains Gateway](./jetbrains-gateway.md) for more information on setup.
27+
Coder will use the optimal path for an SSH connection (determined by your deployment's [networking configuration](../../admin/networking.md)) when using the CLI:
3328

29+
```console
30+
coder ssh my-workspace
31+
```
32+
33+
Or, you can configure plain SSH on your client below.
34+
35+
36+
### Configure SSH
37+
38+
Coder generates [SSH key pairs](../../secrets.md#ssh-keys) for each user to simplify the setup process.
39+
40+
> Before proceeding, run `coder login <accessURL>` if you haven't already to
41+
> authenticate the CLI with the web UI and your workspaces.
42+
43+
To access Coder via SSH, run the following in the terminal:
44+
45+
```console
46+
coder config-ssh
47+
```
48+
49+
> Run `coder config-ssh --dry-run` if you'd like to see the changes that will be
50+
> made before proceeding.
51+
52+
Confirm that you want to continue by typing **yes** and pressing enter. If
53+
successful, you'll see the following message:
54+
55+
```console
56+
You should now be able to ssh into your workspace.
57+
For example, try running:
58+
59+
$ ssh coder.<workspaceName>
60+
```
61+
62+
Your workspace is now accessible via `ssh coder.<workspace_name>` (e.g.,
63+
`ssh coder.myEnv` if your workspace is named `myEnv`).
3464

3565
## Visual Studio Code
3666

@@ -47,6 +77,7 @@ on the `coder_agent` resource in your workspace template. See the
4777
> The `VS Code Desktop` button can be hidden by enabling
4878
> [Browser-only connections](./networking/index.md#Browser-only).
4979
80+
5081
### Manual Installation
5182

5283
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press
@@ -59,55 +90,58 @@ ext install coder.coder-remote
5990
Alternatively, manually install the VSIX from the
6091
[latest release](https://github.com/coder/vscode-coder/releases/latest).
6192

62-
### SSH
6393

64-
### Through with the CLI
94+
## Jetbrains IDEs
6595

66-
Coder will use the optimal path for an SSH connection (determined by your deployment's [networking configuration](../admin/networking.md)) when using the CLI:
96+
We support Jetbrains IDEs using [Gateway](https://www.jetbrains.com/remote-development/gateway/). The following IDEs are supported for remote development:
97+
- IntelliJ IDEA
98+
- CLion
99+
- GoLand
100+
- PyCharm
101+
- Rider
102+
- RubyMine
103+
- WebStorm
104+
- [Jetbrains Fleet](./jetbrains.md#jetbrains-fleet)
67105

68-
```console
69-
coder ssh my-workspace
70-
```
106+
Read our [docs on Jetbrains Gateway](./jetbrains.md) for more information on connecting your Jetbrains IDEs.
71107

72-
Or, you can configure plain SSH on your client below.
73108

109+
## code-server
74110

75-
### Configure SSH
111+
[code-server](https://github.com/coder/code-server) is our supported method of running
112+
VS Code in the web browser. You can read more in our [documentation for code-server](https://coder.com/docs/code-server/latest).
76113

77-
Coder generates [SSH key pairs](../secrets.md#ssh-keys) for each user to simplify the setup process.
114+
![code-server in a workspace](../../images/code-server-ide.png)
78115

79-
> Before proceeding, run `coder login <accessURL>` if you haven't already to
80-
> authenticate the CLI with the web UI and your workspaces.
81116

82-
To access Coder via SSH, run the following in the terminal:
117+
## Other Web IDEs
83118

84-
```console
85-
coder config-ssh
86-
```
119+
<!-- TODO: update template guides link -->
87120

88-
> Run `coder config-ssh --dry-run` if you'd like to see the changes that will be
89-
> made before proceeding.
121+
We support a variety of other browser IDEs and tools to interact with your workspace. Each of these can be configured by your template admin using our [Web IDE guides](../../admin/templates/README.md).
90122

91-
Confirm that you want to continue by typing **yes** and pressing enter. If
92-
successful, you'll see the following message:
123+
Supported IDEs:
124+
- VS Code Web
125+
- JupyterLab
126+
- RStudio
127+
- Airflow
128+
- File Browser
93129

94-
```console
95-
You should now be able to ssh into your workspace.
96-
For example, try running:
130+
Our [Module Registry](https://registry.coder.com/modules) also hosts a variety of tools for extending the capability of your workspace. If you have a request for a new IDE or tool, please file an issue in our [Modules repo](https://github.com/coder/modules/issues).
97131

98-
$ ssh coder.<workspaceName>
99-
```
132+
## Ports and Port forwarding
100133

101-
Your workspace is now accessible via `ssh coder.<workspace_name>` (e.g.,
102-
`ssh coder.myEnv` if your workspace is named `myEnv`).
134+
You can manage listening ports on your workspace page through with the listening ports window in the dashboard. These ports are often used to run internal services or preview environments.
103135

136+
You can also [share ports](./port-forwarding.md#sharing-ports) with other users, or [port-forward](./port-forwarding.md#the-coder-port-forward-command) through the CLI with `coder port forward`. Read more in the [docs on workspace ports](./port-forwarding.md).
104137

105-
## code-server
138+
<!-- TODO: Outdated screenshot -->
139+
![Open Ports window](../../images/networking/listeningports.png)
106140

107-
## Other IDEs
108-
- E
109141

110-
## Ports and Port forwarding
142+
## Remote Desktops
143+
144+
Coder can also replace your RDP solution, see our [RDP guide](./remote-desktops.md).
111145

112-
## Other Methods
113-
-
146+
## Next Steps
147+
<!-- TODO: Next steps -->

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

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎docs/user-guides/workspace-access/jetbrains-gateway.md

Whitespace-only changes.

0 commit comments

Comments
 (0)