@@ -19,6 +19,9 @@ support should work:
19
19
20
20
## SSH configuration
21
21
22
+ > Before proceeding, run ` coder login <accessURL> ` if you haven't already to
23
+ > authenticate the CLI with the web UI and your workspaces.
24
+
22
25
To access Coder via SSH, run the following in the terminal:
23
26
24
27
``` console
@@ -28,7 +31,7 @@ coder config-ssh
28
31
> Run ` coder config-ssh --diff ` if you'd like to see the changes that will be
29
32
> made before proceeding.
30
33
31
- Confirm that you would like to continue by typing ** yes** and pressing enter. If
34
+ Confirm that you want to continue by typing ** yes** and pressing enter. If
32
35
successful, you'll see the following message:
33
36
34
37
``` console
@@ -75,7 +78,7 @@ To use:
75
78
coder templates init
76
79
```
77
80
78
- 1 . When prompted, select the ** Develop code-server in Docker** option.
81
+ 1 . Select the ** Develop code-server in Docker** option when prompted .
79
82
80
83
1 . Navigate into your new folder and create your sample template:
81
84
@@ -93,3 +96,49 @@ To use:
93
96
94
97
1 . Log into Coder's Web UI, and open your workspace. Then,
95
98
click ** code-server** to launch VS Code in a new browser window.
99
+
100
+ ## JetBrains Gateway with SSH
101
+
102
+ If your image
103
+ [ includes a JetBrains IDE] ( ../admin/workspace-management/installing-jetbrains.md )
104
+ and you've [ set up SSH access to Coder] ( ./ssh.md ) , you can use JetBrains Gateway
105
+ to run a local JetBrains IDE connected to your Coder workspace.
106
+
107
+ > See the [ Docker sample template] ( ../examples/templates/docker/main.tf ) for an
108
+ > example of how to refer to images in your template.
109
+
110
+ Please note that:
111
+
112
+ - Your Coder workspace must be running, and Gateway needs compute resources, so
113
+ monitor your resource usage on the Coder dashboard and adjust accordingly.
114
+ - If you use a premium JetBrains IDE (e.g., GoLand, IntelliJ IDEA Ultimate), you
115
+ will still need a license to use it remotely with Coder.
116
+
117
+ 1 . [ Download and install JetBrains Toolbox] ( https://www.jetbrains.com/toolbox-app/ ) .
118
+ Locate JetBrains Gateway in the Toolbox list and click ** Install** .
119
+
120
+ 1 . Open JetBrains Gateway and click ** Connect via SSH** within the ** Run the IDE
121
+ Remotely** section.
122
+
123
+ 1 . Click the small ** gear icon** to the right of the ** Connection** field, then
124
+ the ** +** button on the next screen to create a new configuration.
125
+
126
+ 1 . Enter your Coder workspace alias target in ** Host** (e.g.,
127
+ ` coder.<yourWorkspaceName> ` ), ` 22 ` in ** Port** , ` coder ` in ** User name** , and change
128
+ ** Authentication Type** to ** OpenSSH config and authentication agent** . Leave
129
+ the local port field blank. Click ** Test Connection** . If the test is
130
+ successful, click ** Ok** at the bottom to proceed.
131
+
132
+ 1 . With your created configuration in the ** Connection** chosen in the drop-down
133
+ field, click ** Check Connection and Continue** .
134
+
135
+ 1 . Select a JetBrains IDE from the ** IDE version** drop-down (make sure that you
136
+ choose the IDE included in your image), then click the folder icon and select the
137
+ ` /home/coder ` directory in your Coder workspace. Click ** Download and Start
138
+ IDE** to proceed.
139
+
140
+ 1 . During this installation step, Gateway downloads the IDE and a JetBrains
141
+ client. This may take a couple of minutes.
142
+
143
+ 1 . When your IDE download is complete, JetBrains will prompt you for your
144
+ license. When done, you'll be able to use your IDE.
0 commit comments