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

Commitf82df1b

Browse files
authored
docs: clean up English (#3324)
Fix issues from#3319 and#3320
1 parent70bf66e commitf82df1b

File tree

5 files changed

+51
-69
lines changed

5 files changed

+51
-69
lines changed

‎docs/ides.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ The following desktop IDEs have been tested with Coder, though any IDE with SSH
44
support should work:
55

66
-[VS Code Remote SSH](#vs-code-remote)
7-
extension)
87
-[JetBrains with Gateway](./ides/configuring-gateway.md)
9-
installed)
108
- IntelliJ IDEA
119
- CLion
1210
- GoLand

‎docs/ides/configuring-gateway.md

Lines changed: 30 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,36 @@
11
#Configuring JetBrains Gateway
22

3-
The followingscreenshots outline in more detailhow tocreate a new Connection
4-
for JetBrains Gateway to aCoder workspace.
3+
The followingwalkthrough detailshow toconnect JetBrains Gateway to
4+
Coder.
55

66
##Creating a new JetBrains Gateway Connection
77

8-
After installing Gateway on your local system, you may connect to a Coder
9-
workspace as follows
10-
8+
1.[Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
9+
1.[Configure the`coder` CLI](../ides.md#ssh-configuration)
1110
1. Open Gateway, make sure "SSH" is selected under "Remote Development"
12-
2. Click "New Connection"
13-
14-
![Gateway Home](../images/gateway/gateway-home.png)
15-
16-
3. In the resulting dialog, click the gear icon to the right of "Connection:"
17-
18-
![Gateway New Connection](../images/gateway/gateway-new-connection.png)
19-
20-
4. Hit the "+" button to add a new SSH connection
21-
22-
![Gateway Add Connection](../images/gateway/gateway-add-ssh-configuration.png)
23-
24-
1. For the Host, enter`coder.<workspace name>`
25-
2. For the Port, enter`22` (this is ignored by Coder)
26-
3. For the Username, enter`coder`
27-
4. For the Authentication Type, select "OpenSSH config and authentication
28-
agent"
29-
5. Make sure the checkbox for "Parse config file~/.ssh/config" is checked.
30-
6. Click "Test Connection" to ensure you setting are ok.
31-
7. Click "OK"
32-
33-
![Gateway SSH
34-
Configuration](../images/gateway/gateway-create-ssh-configuration.png)
35-
36-
5. Select the connection you just added.
37-
38-
![Gateway Welcome](../images/gateway/gateway-welcome.png)
39-
40-
6. Click "Check Connection and Continue"
41-
42-
![Gateway Continue](../images/gateway/gateway-continue.png)
43-
44-
7. Select the JetBrains IDE for your project and the project directory
45-
1. Use an SSH terminal to your workspace to create a directory or check out
46-
code if you haven't already.
47-
48-
>Note the JetBrains IDE is installed in the directory `~/.
49-
>cache/JetBrains/RemoteDev/dist`
50-
51-
![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png)
52-
53-
8. Click "Download and Start IDE" to connect.
54-
55-
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)
56-
57-
11+
1. Click "New Connection"
12+
![Gateway Home](../images/gateway/gateway-home.png)
13+
1. In the resulting dialog, click the gear icon to the right of "Connection:"
14+
![Gateway New Connection](../images/gateway/gateway-new-connection.png)
15+
1. Hit the "+" button to add a new SSH connection
16+
![Gateway Add Connection](../images/gateway/gateway-add-ssh-configuration.png)
17+
18+
1. For the Host, enter`coder.<workspace name>`
19+
1. For the Port, enter`22` (this is ignored by Coder)
20+
1. For the Username, enter`coder`
21+
1. For the Authentication Type, select "OpenSSH config and authentication
22+
agent"
23+
1. Make sure the checkbox for "Parse config file~/.ssh/config" is checked.
24+
1. Click "Test Connection" to validate these settings.
25+
1. Click "OK"
26+
![Gateway SSH Configuration](../images/gateway/gateway-create-ssh-configuration.png)
27+
1. Select the connection you just added
28+
![Gateway Welcome](../images/gateway/gateway-welcome.png)
29+
1. Click "Check Connection and Continue"
30+
![Gateway Continue](../images/gateway/gateway-continue.png)
31+
1. Select the JetBrains IDE for your project and the project directory.
32+
SSH into your server to create a directory or check out code if you haven't already.
33+
![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png)
34+
>Note the JetBrains IDE is remotely installed into`~/. cache/JetBrains/RemoteDev/dist`
35+
1. Click "Download and Start IDE" to connect.
36+
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)

‎docs/manifest.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@
8383
"path":"./ides/configuring-web-ides.md"
8484
},
8585
{
86-
"title":"ConfiguringJetbrains Gateway",
87-
"description":"Learn how to configureJetbrains Gateway for your workspaces",
86+
"title":"ConfiguringJetBrains Gateway",
87+
"description":"Learn how to configureJetBrains Gateway for your workspaces",
8888
"path":"./ides/configuring-gateway.md"
8989
}
9090
]

‎docs/templates.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,7 @@ inherited by all child processes of the agent, including SSH sessions.
9898
####startup_script
9999

100100
Use the Coder agent's`startup_script` to run additional commands like
101-
installing IDEs and clone dotfile and project repos. In this example, the
102-
project and dotfile repos are specified as Terraform input variables elsewhere
103-
in the`main.tf` Note the`&` after the`code-server` start to execute
104-
`code-server` process in the background so the`startup_script` can continue
105-
with the repo cloning steps.
101+
installing IDEs,[cloning dotfile](./dotfiles.md#templates), and cloning project repos.
106102

107103
```hcl
108104
resource "coder_agent" "coder" {
@@ -113,27 +109,27 @@ resource "coder_agent" "coder" {
113109
#!/bin/bash
114110
115111
# install code-server
116-
curl -fsSL https://code-server.dev/install.sh | sh
112+
curl -fsSL https://code-server.dev/install.sh | sh
113+
114+
# The & prevents the startup_script from blocking so the
115+
# next commands can run.
117116
code-server --auth none --port &
118117
118+
# var.repo and var.dotfiles_uri is specified
119+
# elsewhere in the Terraform code as input
120+
# variables.
121+
119122
# clone repo
120123
ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts
121124
git clone --progress git@github.com:${var.repo}
122125
123126
# use coder CLI to clone and install dotfiles
124127
coder dotfiles -y ${var.dotfiles_uri}
125128
126-
EOT
129+
EOT
127130
}
128131
```
129132

130-
####Logging
131-
132-
The output of the`startup_script` are located in
133-
`/tmp/coder-startup-script.log` within the workspace.
134-
135-
The Coder agent log is located in`/tmp/coder-agent.log` within the workspace.
136-
137133
###Parameters
138134

139135
Templates often contain_parameters_. These are defined by`variable` blocks in

‎docs/workspaces.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,15 @@ The workspace will be stopped and started:
4949
coder update<workspace-name>
5050
```
5151

52+
##Logging
53+
54+
Coder stores MacOS and Linux logs at the following locations:
55+
56+
| Service| Location|
57+
| ----------------| -------------------------------|
58+
|`startup_script`|`/tmp/coder-startup-script.log`|
59+
| Agent|`/tmp/coder-agent.log`|
60+
5261
---
5362

5463
##Up next

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp