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

Commit4e6645a

Browse files
authored
docs: outdent generic quickstart (#3467)
1 parent426b30e commit4e6645a

File tree

5 files changed

+83
-92
lines changed

5 files changed

+83
-92
lines changed

‎docs/install/configure.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,28 @@ Once you've [installed](../install.md) Coder, you can configure the server by se
77
variables in`/etc/coder.d/coder.env`:
88

99
```sh
10-
# String. Specifies the external URL (HTTP/S) to access Coder. Consumes $CODER_ACCESS_URL
10+
# String. Specifies the external URL (HTTP/S) to access Coder.
1111
CODER_ACCESS_URL=https://coder.example.com
1212

13-
# String. Address to serve the API and dashboard. Consumes $CODER_ADDRESS (default "127.0.0.1:3000")
13+
# String. Address to serve the API and dashboard.
1414
CODER_ADDRESS=127.0.0.1:3000
1515

1616
# String. The URL of a PostgreSQL database to connect to. If empty, PostgreSQL binaries
1717
# will be downloaded from Maven (https://repo1.maven.org/maven2) and store all
1818
# data in the config root. Access the built-in database with "coder server postgres-builtin-url".
19-
# Consumes $CODER_PG_CONNECTION_URL.
20-
CODER_PG_CONNECTION_URL=""
19+
CODER_PG_CONNECTION_URL=
2120

22-
# Boolean. Specifies if TLS will be enabled. Consumes $CODER_TLS_ENABLE.
21+
# Boolean. Specifies if TLS will be enabled.
2322
CODER_TLS_ENABLE=
2423

25-
# Specifies the path to the certificate for TLS. It requires a PEM-encoded file.
24+
#String.Specifies the path to the certificate for TLS. It requires a PEM-encoded file.
2625
# To configure the listener to use a CA certificate, concatenate the primary
2726
# certificate and the CA certificate together. The primary certificate should
28-
# appear first in the combined file. Consumes $CODER_TLS_CERT_FILE.
27+
# appear first in the combined file.
2928
CODER_TLS_CERT_FILE=
3029

31-
# Specifies the path to the private key for the certificate. It requires a
32-
# PEM-encoded file. Consumes $CODER_TLS_KEY_FILE.
30+
#String.Specifies the path to the private key for the certificate. It requires a
31+
# PEM-encoded file.
3332
CODER_TLS_KEY_FILE=
3433
```
3534

@@ -46,5 +45,5 @@ journalctl -u coder.service -b
4645

4746
##Up Next
4847

49-
-[Get started using Coder](./quickstart.md).
48+
-[Get started using Coder](../quickstart.md).
5049
-[Learn how to upgrade Coder](./upgrade.md).

‎docs/install/upgrade.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
This article walks you through how to upgrade your Coder server.
44

5-
To upgrade your Coder server, simply reinstall Coder using your original method
6-
of[install](../install.md).
7-
85
<blockquoteclass="danger">
96
<p>
107
Prior to upgrading a production Coder deployment, take a database snapshot since
118
Coder does not support rollbacks.
129
</p>
1310
</blockquote>
1411

12+
To upgrade your Coder server, simply reinstall Coder using your original method
13+
of[install](../install.md).
14+
1515
##Via install.sh
1616

17-
If you installed Coder using the`install.sh` script,simplyre-run the below
17+
If you installed Coder using the`install.sh` script, re-run the below
1818
command on the host:
1919

2020
```console
@@ -37,3 +37,7 @@ Coder container:
3737
```console
3838
docker-compose pull coder && docker-compose up coder -d
3939
```
40+
41+
##Up Next
42+
43+
-[Learn how to configure Coder](./configure.md).

‎docs/manifest.json

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
"path":"./install/configure.md"
3737
},
3838
{
39-
"title":"Upgrade",
39+
"title":"Upgrading",
4040
"description":"Learn how to upgrade Coder.",
4141
"path":"./install/upgrade.md"
4242
}
@@ -53,12 +53,6 @@
5353
"description":"Setup Coder with Docker",
5454
"icon_path":"./images/icons/docker.svg",
5555
"path":"./quickstart/docker.md"
56-
},
57-
{
58-
"title":"Generic",
59-
"description":"Setup Coder on anything",
60-
"icon_path":"./images/icons/generic.svg",
61-
"path":"./quickstart/generic.md"
6256
}
6357
]
6458
},

‎docs/quickstart.md

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,68 @@
33
See our[Docker quickstart](./quickstart/docker.md) for the easiest
44
possible way to use Coder.
55

6-
Otherwise, you can check out the[generic quickstart](./quickstart/generic.md).
6+
##Generic Quickstart
7+
8+
Please[install Coder](../install.md) before proceeding with the steps below.
9+
10+
##First time admin user setup
11+
12+
1. Run`coder login <your Access URL>` in a new terminal and follow the
13+
interactive instructions to create your admin user and password.
14+
15+
>If using`coder server --tunnel`, the Access URL appears in the terminal logs.
16+
17+
##Templates
18+
19+
To get started using templates, run the following command to generate a sample template:
20+
21+
```bash
22+
coder templates init
23+
```
24+
25+
Follow the CLI instructions to select an example that you can modify for your
26+
specific usage (e.g., a template to**Develop code-server in Docker**):
27+
28+
1. Navigate into your new templates folder and create your first template using
29+
the provided command (e.g.,`cd ./docker-code-server && coder templates create`)
30+
31+
1. Answer the CLI prompts; when done, confirm that you want to create your template.
32+
33+
##Create a workspace
34+
35+
Now, create a workspace using your template:
36+
37+
```bash
38+
coder create --template="yourTemplate"<workspaceName>
39+
```
40+
41+
Connect to your workspace via SSH:
42+
43+
```bash
44+
coder ssh<workspaceName>
45+
```
46+
47+
To access your workspace in the Coder dashboard, navigate to the[configured access URL](../configure.md),
48+
and log in with the admin credentials provided to you by Coder.
49+
50+
![Coder Web UI with code-server](./images/code-server.png)
51+
52+
You can also create workspaces using the access URL and the Templates UI.
53+
54+
![Templates UI to create a
55+
workspace](./images/create-workspace-from-templates-ui.png)
56+
57+
##Modifying templates
58+
59+
You can edit the Terraform template as follows:
60+
61+
```sh
62+
coder templates init
63+
cd gcp-linux# modify this line as needed to access the template
64+
vim main.tf
65+
coder templates update gcp-linux# updates the template
66+
```
67+
68+
##Up Next
69+
70+
Learn about[templates](../templates.md).

‎docs/quickstart/generic.md

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

0 commit comments

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