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

Commit272962c

Browse files
authored
docs: add upgrade page & update getting started (#3439)
1 parent5d40b1f commit272962c

File tree

6 files changed

+122
-16
lines changed

6 files changed

+122
-16
lines changed

‎docs/install.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ journalctl -u coder.service -b
4646
Before proceeding, please ensure that you have both Docker and the[latest version of
4747
Coder](https://github.com/coder/coder/releases) installed.
4848

49-
>See our[docker-compose](https://github.com/coder/coder/blob/93b78755a6d48191cc53c82654e249f25fc00ce9/docker-compose.yaml) file
49+
>See our[docker-compose](https://github.com/coder/coder/blob/main/docker-compose.yaml) file
5050
>for additional information.
5151
5252
1. Clone the`coder` repository:
@@ -87,8 +87,6 @@ Coder](https://github.com/coder/coder/releases) installed.
8787

8888
3. Follow the on-screen instructions to create your first template and workspace
8989

90-
---
91-
9290
If the user is not in the Docker group, you will see the following error:
9391

9492
```sh
@@ -130,7 +128,7 @@ We publish self-contained .zip and .tar.gz archives in [GitHub releases](https:/
130128
coder server --postgres-url <url> --access-url <url>
131129
```
132130
133-
##Next steps
131+
##Up Next
134132
135-
Once you've installed and started Coder, see the [quickstart](./quickstart.md)
136-
for instructions on creating your first template and workspace.
133+
- Learn how to [configure](./install/configure.md) Coder.
134+
- Learn about [upgrading](./install/upgrade.md) Coder.

‎docs/install/configure.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
#Configure
2+
3+
This article documents the Coder server's primary configuration variables. For a full list
4+
of the options, run`coder server --help` on the host.
5+
6+
Once you've[installed](../install.md) Coder, you can configure the server by setting the following
7+
variables in`/etc/coder.d/coder.env`:
8+
9+
```sh
10+
# String. Specifies the external URL (HTTP/S) to access Coder. Consumes $CODER_ACCESS_URL
11+
CODER_ACCESS_URL=https://coder.example.com
12+
13+
# String. Address to serve the API and dashboard. Consumes $CODER_ADDRESS (default "127.0.0.1:3000")
14+
CODER_ADDRESS=127.0.0.1:3000
15+
16+
# String. The URL of a PostgreSQL database to connect to. If empty, PostgreSQL binaries
17+
# will be downloaded from Maven (https://repo1.maven.org/maven2) and store all
18+
# 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=""
21+
22+
# Boolean. Specifies if TLS will be enabled. Consumes $CODER_TLS_ENABLE.
23+
CODER_TLS_ENABLE=
24+
25+
# Specifies the path to the certificate for TLS. It requires a PEM-encoded file.
26+
# To configure the listener to use a CA certificate, concatenate the primary
27+
# certificate and the CA certificate together. The primary certificate should
28+
# appear first in the combined file. Consumes $CODER_TLS_CERT_FILE.
29+
CODER_TLS_CERT_FILE=
30+
31+
# Specifies the path to the private key for the certificate. It requires a
32+
# PEM-encoded file. Consumes $CODER_TLS_KEY_FILE.
33+
CODER_TLS_KEY_FILE=
34+
```
35+
36+
##Run Coder
37+
38+
Now, run Coder as a system service on the host:
39+
40+
```sh
41+
# Use systemd to start Coder now and on reboot
42+
sudo systemctlenable --now coder
43+
# View the logs to ensure a successful start
44+
journalctl -u coder.service -b
45+
```
46+
47+
##Up Next
48+
49+
-[Get started using Coder](./quickstart.md).
50+
-[Learn how to upgrade Coder](./upgrade.md).

‎docs/install/upgrade.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
#Upgrade
2+
3+
This article walks you through how to upgrade your Coder server.
4+
5+
To upgrade your Coder server, simply reinstall Coder using your original method
6+
of[install](../install.md).
7+
8+
<blockquoteclass="danger">
9+
<p>
10+
Prior to upgrading a production Coder deployment, take a database snapshot since
11+
Coder does not support rollbacks.
12+
</p>
13+
</blockquote>
14+
15+
##Via install.sh
16+
17+
If you installed Coder using the`install.sh` script, simply re-run the below
18+
command on the host:
19+
20+
```console
21+
curl -L https://coder.com/install.sh | sh
22+
```
23+
24+
The script will unpack the new`coder` binary version over the one currently installed.
25+
Next, you can restart Coder with the following command (if running it as a system
26+
service):
27+
28+
```console
29+
systemctl restart coder
30+
```
31+
32+
##Via docker-compose
33+
34+
If you installed using`docker-compose`, run the below command to upgrade the
35+
Coder container:
36+
37+
```console
38+
docker-compose pull coder && docker-compose up coder -d
39+
```

‎docs/manifest.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,16 @@
2929
"title":"Authentication",
3030
"description":"Learn how to set up authentication using GitHub or OpenID Connect.",
3131
"path":"./install/auth.md"
32+
},
33+
{
34+
"title":"Configuration",
35+
"description":"Learn how to configure Coder",
36+
"path":"./install/configure.md"
37+
},
38+
{
39+
"title":"Upgrade",
40+
"description":"Learn how to upgrade Coder.",
41+
"path":"./install/upgrade.md"
3242
}
3343
]
3444
},

‎docs/quickstart/generic.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
1+
#Getting Started
2+
3+
This article will walk you through how to set up your first Coder user, and begin
4+
using the templates to create and access your development workspaces.
5+
16
##Prerequisites
27

3-
Please[install Coder](./install.md) before proceeding with the stepsoutlined in this article.
8+
Please[install Coder](../install.md) before proceeding with the stepsbelow.
49

510
##First time admin user setup
611

7-
1.Run`coder login <your Access URL>` in a new terminal and follow the
12+
1. Run`coder login <your Access URL>` in a new terminal and follow the
813
interactive instructions to create your admin user and password.
914

1015
>If using`coder server --tunnel`, the Access URL appears in the terminal logs.
1116
12-
##Creating your first template and workspace
17+
##Templates
1318

14-
In a new terminal window, run the following tocopy a sample template:
19+
To get started using templates, run the followingcommandtogenerate a sample template:
1520

1621
```bash
1722
coder templates init
@@ -25,7 +30,9 @@ specific usage (e.g., a template to **Develop code-server in Docker**):
2530

2631
1. Answer the CLI prompts; when done, confirm that you want to create your template.
2732

28-
Create a workspace using your template:
33+
##Create a workspace
34+
35+
Now, create a workspace using your template:
2936

3037
```bash
3138
coder create --template="yourTemplate"<workspaceName>
@@ -37,10 +44,8 @@ Connect to your workspace via SSH:
3744
coder ssh<workspaceName>
3845
```
3946

40-
You can also access your workspace using the**access URL** you provided when
41-
deploying Coder (if you're using a temporary deployment and you opted to use
42-
Coder's tunnel, use the access URL you were provided). Log in with the admin
43-
credentials provided to you by Coder.
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.
4449

4550
![Coder Web UI with code-server](../images/code-server.png)
4651

@@ -59,3 +64,7 @@ cd gcp-linux # modify this line as needed to access the template
5964
vim main.tf
6065
coder templates update gcp-linux# updates the template
6166
```
67+
68+
##Up Next
69+
70+
Learn about[templates](../templates.md).

‎docs/templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +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,[cloningdotfile](./dotfiles.md#templates), and cloning project repos.
101+
installing IDEs,[cloningdotfiles](./dotfiles.md#templates), and cloning project repos.
102102

103103
```hcl
104104
resource "coder_agent" "coder" {

0 commit comments

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