Skip to content

Commit e5e1ed2

Browse files
authored
chore: minor clarifications to install docs (#3983)
1 parent 067069d commit e5e1ed2

File tree

3 files changed

+25
-24
lines changed

3 files changed

+25
-24
lines changed

docs/install/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
There are a number of different methods to install Coder:
1+
There are a number of different methods to install and run Coder:
22

33
<children>
44
This page is rendered on https://coder.com/docs/coder-oss/install. Refer to the other documents in the `install/` directory for per-platform instructions.

docs/install/kubernetes.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
## Requirements
22

3-
Before proceeding, please ensure that you have both Helm 3.5+ and the
4-
[latest version of Coder](https://github.com/coder/coder/releases) installed.
5-
You will also need to have a Kubernetes cluster running K8s 1.19+.
3+
Before proceeding, please ensure that you have a Kubernetes cluster running K8s 1.19+ and have Helm 3.5+ installed.
4+
5+
You'll also want to install the [latest version of Coder](https://github.com/coder/coder/releases) locally in order
6+
to log in and manage templates.
67

78
## Install Coder with Helm
89

docs/install/packages.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
1-
Coder publishes the following system packages [in GitHub releases](https://github.com/coder/coder/releases):
1+
1. Download and install one of the following system packages from [GitHub releases](https://github.com/coder/coder/releases):
22

3-
- .deb (Debian, Ubuntu)
4-
- .rpm (Fedora, CentOS, RHEL, SUSE)
5-
- .apk (Alpine)
3+
- .deb (Debian, Ubuntu)
4+
- .rpm (Fedora, CentOS, RHEL, SUSE)
5+
- .apk (Alpine)
66

7-
Once installed, you can run Coder as a system service.
7+
1. Run Coder as a system service.
88

9-
```sh
10-
# Set up an access URL or enable CODER_TUNNEL
11-
sudo vim /etc/coder.d/coder.env
9+
```sh
10+
# Set up an access URL or enable CODER_TUNNEL
11+
sudo vim /etc/coder.d/coder.env
1212

13-
# To systemd to start Coder now and on reboot
14-
sudo systemctl enable --now coder
13+
# To systemd to start Coder now and on reboot
14+
sudo systemctl enable --now coder
1515

16-
# View the logs to see Coder's URL and ensure a successful start
17-
journalctl -u coder.service -b
18-
```
16+
# View the logs to see Coder's URL and ensure a successful start
17+
journalctl -u coder.service -b
18+
```
1919

20-
> Set `CODER_ACCESS_URL` to the external URL that users and workspaces will use to
21-
> connect to Coder. This is not required if you are using the tunnel. Learn more
22-
> about Coder's [configuration options](../admin/configure.md).
20+
> Set `CODER_ACCESS_URL` to the external URL that users and workspaces will use to
21+
> connect to Coder. This is not required if you are using the tunnel. Learn more
22+
> about Coder's [configuration options](../admin/configure.md).
2323
24-
Visit the Coder URL in the logs to set up your first account, or use the CLI:
24+
1. Visit the Coder URL in the logs to set up your first account, or use the CLI:
2525

26-
```sh
27-
coder login <access-url>
28-
```
26+
```sh
27+
coder login <access-url>
28+
```
2929

3030
## Restarting Coder
3131

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy