Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit6c1a111

Browse files
author
Katie Horne
authored
chore: add IDEs page (#2388)
1 parenta82c0eb commit6c1a111

File tree

3 files changed

+159
-55
lines changed

3 files changed

+159
-55
lines changed

‎docs/ides.md

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
#IDEs
2+
3+
The following desktop IDEs have been tested with Coder, though any IDE with SSH
4+
support should work:
5+
6+
- VS Code (with[Remote -
7+
SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
8+
extension)
9+
- JetBrains (with
10+
[Gateway](https://www.jetbrains.com/help/idea/remote-development-a.html#launch_gateway)
11+
installed)
12+
- IntelliJ IDEA
13+
- CLion
14+
- GoLand
15+
- PyCharm
16+
- Rider
17+
- RubyMine
18+
- WebStorm
19+
20+
##SSH configuration
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+
25+
To access Coder via SSH, run the following in the terminal:
26+
27+
```console
28+
coder config-ssh
29+
```
30+
31+
>Run`coder config-ssh --diff` if you'd like to see the changes that will be
32+
>made before proceeding.
33+
34+
Confirm that you want to continue by typing**yes** and pressing enter. If
35+
successful, you'll see the following message:
36+
37+
```console
38+
You should now be able to ssh into your workspace.
39+
For example, try running:
40+
41+
$ssh coder.<workspaceName>
42+
```
43+
44+
Your workspace is now accessible via`ssh coder.<workspace_name>` (e.g.,
45+
`ssh coder.myEnv` if your workspace is named`myEnv`).
46+
47+
##VS Code Remote
48+
49+
Once you've configured SSH, you can work on projects from your local copy of VS
50+
Code, connected to your Coder workspace for compute, etc.
51+
52+
1. Open VS Code locally.
53+
54+
1. Install the[Remote - SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
55+
extension.
56+
57+
1. In VS Code's left-hand nav bar, click**Remote Explorer** and right-click on
58+
a workspace to connect.
59+
60+
##VS Code in the browser
61+
62+
>You must have Docker Desktop running for this template to work.
63+
64+
Coder offers a[sample template that includes
65+
code-server](../examples/templates/docker-code-server/README.md).
66+
67+
To use:
68+
69+
1. Start Coder:
70+
71+
```console
72+
coder server --dev
73+
```
74+
75+
1. Open a new terminal and run:
76+
77+
```console
78+
coder templates init
79+
```
80+
81+
1. Select the**Develop code-server in Docker** option when prompted.
82+
83+
1. Navigate into your new folder and create your sample template:
84+
85+
```console
86+
cd code-server-docker && coder templates create
87+
```
88+
89+
Follow the prompts that appear in the terminal.
90+
91+
1. Create your workspace:
92+
93+
```console
94+
coder create --template="docker-code-server" [workspace name]
95+
```
96+
97+
1. Log into Coder's Web UI, and open your workspace. Then,
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.

‎docs/templates.md

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,6 @@ vim <template-name>/main.tf
2323
coder templates<create/update><template-name>
2424
```
2525

26-
##Persistent and ephemeral resources
27-
28-
Coder supports both ephemeral and persistent resources in workspaces. Ephemeral
29-
resources are destroyed when a workspace is not in use (e.g., when it is
30-
stopped). Persistent resources remain. See how this works for a sample front-end
31-
template:
32-
33-
| Resource| Type|
34-
| :---------------------------| :---------|
35-
| google_compute_disk.home_dir| persistent|
36-
| kubernetes_pod.dev| ephemeral|
37-
| └─ nodejs (linux, amd64)||
38-
| api_token.backend| ephemeral|
39-
40-
When a workspace is deleted, all resources are destroyed.
41-
4226
##Parameters
4327

4428
Templates often contain*parameters*. In Coder, there are two types of parameters:
@@ -47,10 +31,9 @@ Templates often contain *parameters*. In Coder, there are two types of parameter
4731
are often cloud secrets, such as a`ServiceAccount` token, and are annotated
4832
with`sensitive = true` in the template code.
4933

50-
-**User parameters** are set when a user creates a workspace. They are unique to
51-
each workspace, often personalization settings such as "preferred
52-
region" or "workspace image".
53-
34+
-**User parameters** are set when a user creates a workspace. They are unique
35+
to each workspace, often personalization settings such as "preferred region"
36+
or "workspace image".
5437

5538
##Best Practices
5639

@@ -70,12 +53,12 @@ provider credentials out of Coder's database (making it a less valuable target f
7053
and is compatible with agent-based authentication schemes (that handle credential rotation
7154
and/or ensure the credentials are not written to disk).
7255

73-
Cloud providers for which the Terraform provider supports authenticated environments include
56+
Cloud providers for which the Terraform provider supports authenticated environments include:
7457

75-
*[Google Cloud](https://registry.terraform.io/providers/hashicorp/google/latest/docs)
76-
*[Amazon Web Services](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)
77-
*[Microsoft Azure](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs)
78-
*[Kubernetes](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs)
58+
-[Google Cloud](https://registry.terraform.io/providers/hashicorp/google/latest/docs)
59+
-[Amazon Web Services](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)
60+
-[Microsoft Azure](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs)
61+
-[Kubernetes](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs)
7962

8063
Additional providers may be supported; check the
8164
[documentation of the Terraform provider](https://registry.terraform.io/browse/providers) for

‎docs/workspaces.md

Lines changed: 7 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,40 +10,15 @@ templates](./templates.md):
1010

1111
```sh
1212
# create a workspace from the template; specify any variables
13-
codercreate<workspace-name>
13+
create--template="<templateName>"<workspaceName>
1414

1515
# show the resources behind the workspace and how to connect
1616
coder show<workspace-name>
1717
```
1818

19-
##Connect with SSH
19+
##IDEs
2020

21-
Once you've added your workspaces to your SSH hosts, you can connect from any
22-
IDE with remote development support:
23-
24-
```sh
25-
coder config-ssh
26-
coder ssh<workspaceName>
27-
```
28-
29-
##Editors and IDEs
30-
31-
The following desktop IDEs have been tested with Coder, though any IDE with SSH
32-
support should work!
33-
34-
- VS Code (with[Remote -
35-
SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
36-
extension)
37-
- JetBrains (with
38-
[Gateway](https://www.jetbrains.com/help/idea/remote-development-a.html#launch_gateway)
39-
installed)
40-
- IntelliJ IDEA
41-
- CLion
42-
- GoLand
43-
- PyCharm
44-
- Rider
45-
- RubyMine
46-
- WebStorm
21+
Coder[supports multiple IDEs](ides.md) for use with your workspaces.
4722

4823
##Workspace lifecycle
4924

@@ -67,8 +42,10 @@ When a workspace is deleted, all of the workspace's resources are deleted.
6742

6843
##Dotfiles
6944

70-
Users can install configuration from a personal[dotfiles repository](https://dotfiles.github.io) with the`coder dotfiles <repo>`
71-
command in their workspace. Templates can also prompt users for their dotfiles repo[(example)](../examples/templates/docker-with-dotfiles/README.md#how-it-works).
45+
Users can install configuration from a personal[dotfiles
46+
repository](https://dotfiles.github.io) with the`coder dotfiles <repo>` command
47+
in their workspace. Templates can also prompt users for their dotfiles repo
48+
[(example)](../examples/templates/docker-with-dotfiles/README.md#how-it-works).
7249

7350
##Updating workspaces
7451

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp