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

Commit3c877c9

Browse files
committed
prettier
1 parentd91288a commit3c877c9

File tree

1 file changed

+67
-49
lines changed

1 file changed

+67
-49
lines changed

‎docs/tutorials/quickstart.md

Lines changed: 67 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ August 18, 2024
1111

1212
---
1313

14-
Follow the steps in this guide to install Coder locally or on a VPS, set up a workspace, and connect to it from VS Code.
14+
Follow the steps in this guide to install Coder locally or on a VPS, set up a
15+
workspace, and connect to it from VS Code.
1516

1617
By the end of this guide, you'll have a remote development environment that you
1718
can connect to from any device anywhere, so you can work on the same files in a
@@ -35,15 +36,15 @@ persistent environment from your main device, a tablet, or your phone.
3536
-[Mac instructions](https://docs.docker.com/desktop/install/mac-install/)
3637

3738
1. Set up the Docker daemon in rootless mode for your user to run Docker as a
38-
non-privileged user:
39+
non-privileged user:
3940

4041
```shell
4142
dockerd-rootless-setuptool.sh install
4243
```
4344

44-
Depending on your system's dependencies, you might need to run other
45-
commandsbefore you retry this step.
46-
Read the output of this command for furtherinstructions.
45+
Depending on your system's dependencies, you might need to run other commands
46+
before you retry this step. Read the output of this command for further
47+
instructions.
4748

4849
1. Assign your user to the Docker group:
4950

@@ -58,26 +59,28 @@ non-privileged user:
5859
```
5960

6061
- For standalone binaries, system packages, or other alternate installation
61-
methods, refer to the
62-
[latest release on GitHub](https://github.com/coder/coder/releases/latest).
62+
methods, refer to the
63+
[latest release on GitHub](https://github.com/coder/coder/releases/latest).
6364

6465
##Windows
6566

66-
>**Important:** If you plan to use the built-in PostgreSQL database,
67-
>ensurethat the
67+
>**Important:** If you plan to use the built-in PostgreSQL database, ensure
68+
>that the
6869
>[Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version)
6970
>is installed.
7071
7172
1.[Install Docker](https://docs.docker.com/desktop/install/windows-install/).
7273

7374
1. Download the Coder Windows installer (`.msi`) or standalone binary (`.exe`)
74-
from the[GitHub repository assets](https://github.com/coder/coder/releases/latest).
75+
from the
76+
[GitHub repository assets](https://github.com/coder/coder/releases/latest).
7577

76-
![Windows setup wizard](../images/install/windows-installer.png)_Windows setup wizard_
78+
![Windows setup wizard](../images/install/windows-installer.png)_Windows
79+
setup wizard_
7780

7881
- Alternatively, you can use the
79-
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
80-
package manager to install Coder:
82+
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
83+
package manager to install Coder:
8184

8285
```powershell
8386
winget install Coder.Coder
@@ -96,28 +99,32 @@ from the [GitHub repository assets](https://github.com/coder/coder/releases/late
9699
1. If you're running Coder locally, go to<http://0.0.0.0:3001/setup>.
97100

98101
- If you get a browser warning similar to`Secure Site Not Available`, you
99-
can ignore the warning and continue to the setup page.
102+
can ignore the warning and continue to the setup page.
100103

101104
If your Coder server is on a network or cloud device, locate the message in
102-
your terminal that reads,`View the Web UI: https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app`.
103-
The server begins to stream logs immediately and you might have to scroll up to find it.
105+
your terminal that reads,
106+
`View the Web UI: https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app`. The server
107+
begins to stream logs immediately and you might have to scroll up to find it.
104108

105109
1. On the**Welcome to Coder** page, enter the information to create an admin
106-
user, then select**Create account**.
110+
user, then select**Create account**.
107111

108-
![Welcome to Coder - Create admin user](../images/guides/quickstart/create-admin-user.png)_Welcome to Coder - Create admin user_
112+
![Welcome to Coder - Create admin user](../images/guides/quickstart/create-admin-user.png)_Welcome
113+
to Coder - Create admin user_
109114

110115
1. On the Workspaces page, select**Go to templates** to create a new template.
111116

112117
1. For this guide, use a Docker container. Locate**Docker Containers** and
113-
select**Use template**.
118+
select**Use template**.
114119

115120
1. Give the template a**Name** that you'll recognize both in the Coder UI and
116-
in command-line calls.
121+
in command-line calls.
117122

118-
The rest of the template details are optional, but will be helpful when you have more templates.
123+
The rest of the template details are optional, but will be helpful when you
124+
have more templates.
119125

120-
![Create template](../images/guides/quickstart/create-template.png)_Create template_
126+
![Create template](../images/guides/quickstart/create-template.png)_Create
127+
template_
121128

122129
1. Select**Create template**.
123130

@@ -127,31 +134,37 @@ in command-line calls.
127134

128135
1. Coder starts your new workspace:
129136

130-
![getting-started-workspace is running](../images/guides/quickstart/workspace-running-with-topbar.png)_getting-started-workspace is running_
137+
![getting-started-workspace is running](../images/guides/quickstart/workspace-running-with-topbar.png)_getting-started-workspace
138+
is running_
131139

132-
1. Select**VS Code Desktop** to install the Coder extension and connect to
133-
yourCoder workspace.
140+
1. Select**VS Code Desktop** to install the Coder extension and connect to your
141+
Coder workspace.
134142

135143
<details><summary>Connect via SSH in VSCodium</summary>
136144

137-
VSCodium doesn't use the Microsoft VS Code extension marketplace or application
138-
calls.
139-
Enable SSH connections tothe Coder workspace Docker container and connect to
140-
it from VSCodium with the**Remote - SSH**extension.
145+
VSCodium doesn't use the Microsoft VS Code extension marketplace or
146+
applicationcalls. Enable SSH connections to the Coder workspace Docker
147+
container and connect toit from VSCodium with the**Remote - SSH**
148+
extension.
141149

142150
1. In the workspace, select**Connect via SSH**.
143151

144-
1. Select the`ssh` command below**Connect to the agent** to copy the command.
152+
1. Select the`ssh` command below**Connect to the agent** to copy the
153+
command.
145154

146-
1. Open a terminal window on the Coder server (or SSH to it if it's a device on your network).
155+
1. Open a terminal window on the Coder server (or SSH to it if it's a device
156+
on your network).
147157

148-
1. Run the`ssh` command to connect to the agent. Replace`your-workspace-name` in this example:
158+
1. Run the`ssh` command to connect to the agent. Replace
159+
`your-workspace-name` in this example:
149160

150161
```bash
151162
ssh coder.your-workspace-name.main
152163
```
153164

154-
1. Use the Web UI URL from [Configure Coder with a new workspace](#configure-coder-with-a-new-workspace) to log in and authenticate:
165+
1. Use the Web UI URL from
166+
[Configure Coder with a new workspace](#configure-coder-with-a-new-workspace)
167+
to login and authenticate:
155168

156169
```bash
157170
coder login https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app
@@ -174,7 +187,8 @@ in command-line calls.
174187
Continue? (yes/no) yes
175188
```
176189
177-
1. Install the [Remote - SSH extension](https://open-vsx.org/extension/jeanp413/open-remote-ssh).
190+
1. Install the
191+
[Remote - SSH extension](https://open-vsx.org/extension/jeanp413/open-remote-ssh).
178192
179193
1. Select **Remote-SSH: Connect to host** from the command palette.
180194
@@ -186,18 +200,21 @@ in command-line calls.
186200
187201
## Work on some code
188202
189-
After VS Code loads the remote environment, you can select **Open Folder** to explore directories in the Docker container or work on something new.
203+
After VS Code loads the remote environment, you can select **Open Folder** to
204+
explore directories in the Docker container or work on something new.
190205
191206
To clone an existing repository:
192207
193208
1. Select **Clone Repository** and enter the repository URL.
194209
195-
For example, to clone the Coder repo, enter `https://github.com/coder/coder.git`.
210+
For example, to clone the Coder repo, enter
211+
`https://github.com/coder/coder.git`.
196212
197-
Learn more about how to find the repository URL in the [GitHub documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
213+
Learn more about how to find the repository URL in the
214+
[GitHub documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
198215
199-
1. Choose the folder to which VS Code should clone the repo.
200-
It will be in its own directory within this folder.
216+
1. Choose the folder to which VS Code should clone the repo. It will be in its
217+
own directory within this folder.
201218
202219
Note that you cannot create a new parent directory in this step.
203220
@@ -210,7 +227,8 @@ It will be in its own directory within this folder.
210227
Now that you have your own workspace, use the same template toset one upfor a
211228
teammate.
212229
213-
Go to**Templates** andselect**Create Workspace** andcontinue from Step 7in [Configure Coder with a new workspace](#configure-coder-with-a-new-workspace).
230+
Go to**Templates** andselect**Create Workspace** andcontinue from Step 7in
231+
[Configure Coder with a new workspace](#configure-coder-with-a-new-workspace).
214232
215233
After that, you can try to:
216234
@@ -232,15 +250,15 @@ After that, you can try to:
232250
```
233251
234252
1. Set up the Docker daemonin rootless modefor your user to run Docker as a
235-
non-privileged user:
253+
non-privileged user:
236254
237255
```shell
238256
dockerd-rootless-setuptool.sh install
239257
```
240258
241-
Depending on your system's dependencies, you might need to run other
242-
commandsbefore you retry this step.
243-
Read the output of this command for furtherinstructions.
259+
Depending on your system's dependencies, you might need to run other commands
260+
before you retry this step. Read the output of this command for further
261+
instructions.
244262
245263
1. Assign your user to the Docker group:
246264
@@ -256,11 +274,11 @@ non-privileged user:
256274
```
257275
258276
- Ubuntu users might not see the group membership update. In that case, run
259-
the following command or reboot the machine:
277+
the following command or reboot the machine:
260278
261-
```shell
262-
newgrp docker
263-
```
279+
```shell
280+
newgrp docker
281+
```
264282
265283
### Can't start Coder server: Address alreadyin use
266284
@@ -281,4 +299,4 @@ error: configure http(s): listen tcp 127.0.0.1:3000: bind: address already in us
281299
coder server
282300
```
283301
284-
1.
302+
1.

0 commit comments

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