Skip to content

Commit 3019d51

Browse files
matifalimatifali
committed
refactor
1 parent a1a7edd commit 3019d51

File tree

1 file changed

+143
-59
lines changed

1 file changed

+143
-59
lines changed

‎docs/install/index.md

Lines changed: 143 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,171 @@
1-
1. Install Coder
1+
To use Coder you will need to install the Coder server on your infrastructure.
2+
There are a number of different ways to install Coder, depending on your needs.
3+
4+
<children>
5+
This page is rendered on https://coder.com/docs/v2/latest/install. Refer to the other documents in the `install/` directory for per-platform instructions.
6+
</children>
7+
8+
## Install Coder
29

310
<div class="tabs">
411

5-
## Install Script (Linux/macOS)
12+
## Install Script (Linux and macOS)
613

7-
The easiest way to install Coder is to use our
8-
[install script](https://github.com/coder/coder/blob/main/install.sh) for
9-
Linux and macOS.
14+
The easiest way to install Coder on Linux and macOS is to use our
15+
[install script](https://github.com/coder/coder/blob/main/install.sh).
1016

11-
```shell
12-
curl -fsSL https://coder.com/install.sh | sh
13-
```
17+
```shell
18+
curl -fsSL https://coder.com/install.sh | sh
19+
```
1420

15-
You can preview what occurs during the install process:
21+
You can preview what occurs during the install process:
1622

17-
```shell
18-
curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run
19-
```
23+
```shell
24+
curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run
25+
```
2026

21-
You can modify the installation process by including flags. Run the help
22-
command for reference:
27+
You can modify the installation process by including flags. Run the help command
28+
for reference:
2329

24-
```shell
25-
curl -fsSL https://coder.com/install.sh | sh -s -- --help
26-
```
30+
```shell
31+
curl -fsSL https://coder.com/install.sh | sh -s -- --help
32+
```
2733

28-
## Homebrew
34+
## Homebrew (macOS and Linux)
2935

30-
Install Coder from our official
31-
[Homebrew tap](https://github.com/coder/homebrew-coder)
36+
To install Coder on macOS and Linux, you can use the
37+
[Homebrew](https://brew.sh/) package manager.
3238

33-
```shell
34-
brew install coder/coder/coder
35-
```
39+
Install Coder from our official
40+
[Homebrew tap](https://github.com/coder/homebrew-coder)
3641

37-
## Windows
42+
```shell
43+
brew install coder/coder/coder
44+
```
3845

39-
Install using
40-
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
41-
package manager
46+
## Windows
4247

43-
```powershell
44-
winget install Coder.Coder
45-
```
48+
To install Coder on Windows, you can use the
49+
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
50+
package manager
4651

47-
## System Packages
52+
```powershell
53+
winget install Coder.Coder
54+
```
4855

49-
Download and install one of the following system packages from
50-
[GitHub releases](https://github.com/coder/coder/releases/latest) and install
51-
manullay
56+
<!-- TODO: Replace with direct link to windows installer after we have https://github.com/coder/coder.com/issues/382 -->
5257

53-
- .deb (Debian, Ubuntu)
54-
- .rpm (Fedora, CentOS, RHEL, SUSE)
55-
- .apk (Alpine)
56-
- .exe (Windows)
58+
Or you can use the windows installer from our
59+
[GitHub releases](https://github.com/coder/coder/releases/latest)
5760

58-
## Binary
61+
## Linux
5962

60-
1. Download the
61-
[release archive](https://github.com/coder/coder/releases/latest)
62-
appropriate for your operating system
63+
Coder officially maintains packages for the following Linux distributions:
6364

64-
2. Unzip the folder you just downloaded, and move the `coder` executable to a
65-
location that's on your `PATH`
65+
- .deb (Debian, Ubuntu)
66+
- .rpm (Fedora, CentOS, RHEL, SUSE)
67+
- .apk (Alpine)
6668

67-
```shell
68-
# ex. macOS and Linux
69-
mv coder /usr/local/bin
70-
```
69+
<div class="tabs">
7170

72-
> Windows users: see
73-
> [this guide](https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23)
74-
> for adding folders to `PATH`.
71+
## Debian, Ubuntu
72+
73+
Get the latest `.deb` package from our
74+
[GitHub releases](https://github.com/coder/coder/releases/latest) and install
75+
it manually or use the following commands to download and install the latest
76+
`.deb` package.
77+
78+
```shell
79+
# Download the latest .deb package from GitHub releases
80+
URL=$(curl -s https://api.github.com/repos/coder/coder/releases/latest | jq -r '.assets[] | select(.name | endswith("linux_amd64.deb")) | .browser_download_url')
81+
curl -fsSL $URL -o coder.deb
82+
# Install the package
83+
sudo apt install ./coder.deb
84+
```
85+
86+
## Fedora, CentOS, RHEL, SUSE
87+
88+
Get the latest `.rpm` package from our
89+
[GitHub releases](https://github.com/coder/coder/releases/latest) and install
90+
it manually or use the following commands to download and install the latest
91+
`.rpm` package.
92+
93+
```shell
94+
# Download the latest .rpm package from GitHub releases
95+
URL=$(curl -s https://api.github.com/repos/coder/coder/releases/latest | jq -r '.assets[] | select(.name | endswith("linux_amd64.rpm")) | .browser_download_url')
96+
curl -fsSL $URL -o coder.rpm
97+
# Install the package
98+
sudo yum install ./coder.rpm
99+
```
100+
101+
## Alpine
102+
103+
Get the latest `.apk` package from our
104+
[GitHub releases](https://github.com/coder/coder/releases/latest) and install
105+
it manually or use the following commands to download and install the latest
106+
`.apk` package.
107+
108+
```shell
109+
# Download the latest .apk package from GitHub releases
110+
URL=$(curl -s https://api.github.com/repos/coder/coder/releases/latest | jq -r '.assets[] | select(.name | endswith("linux_amd64.apk")) | .browser_download_url')
111+
curl -fsSL $URL -o coder.apk
112+
# Install the package
113+
sudo apk add ./coder.apk
114+
```
75115

76116
</div>
77117

78-
2. After installing, start the Coder server manually via `coder server` or as a
118+
## Manual
119+
120+
Retrieve the latest release from our GitHub releases page and install it
121+
manually.
122+
123+
1. Download the
124+
[release archive](https://github.com/coder/coder/releases/latest)
125+
appropriate for your operating system
126+
127+
2. Unzip the folder you just downloaded, and move the `coder` executable to a
128+
location that's on your `PATH`
129+
130+
```shell
131+
# ex. macOS and Linux
132+
mv coder /usr/local/bin
133+
```
134+
135+
> Windows users: see
136+
> [this guide](https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23)
137+
> for adding folders to `PATH`.
138+
139+
</div>
140+
141+
## Verify installation
142+
143+
Verify that the installation was successful by opening a new terminal and
144+
running:
145+
146+
```console
147+
coder --help
148+
oder --help
149+
coder v2.6.0+b3e3521
150+
151+
USAGE:
152+
coder [global-flags] <subcommand>
153+
154+
Coder v2.6.0+b3e3521 — A tool for provisioning self-hosted development
155+
environments with Terraform.
156+
- Start a Coder server:
157+
158+
$ coder server
159+
160+
- Get started by creating a template from an example:
161+
162+
$ coder templates init
163+
...
164+
```
165+
166+
## Start Coder
167+
168+
1. After installing, start the Coder server manually via `coder server` or as a
79169
system package.
80170

81171
<div class="tabs">
@@ -114,19 +204,13 @@
114204
By default, the Coder server runs on `http://127.0.0.1:3000` and uses a
115205
[public tunnel](../admin/configure.md#tunnel) for workspace connections.
116206

117-
3. Visit the Coder URL in the logs to set up your first account, or use the CLI
207+
2. Visit the Coder URL in the logs to set up your first account, or use the CLI
118208
to create your first user.
119209

120210
```shell
121211
coder login <access url>
122212
```
123213

124-
There are a number of other different methods to install and run Coder:
125-
126-
<children>
127-
This page is rendered on https://coder.com/docs/v2/latest/install. Refer to the other documents in the `install/` directory for per-platform instructions.
128-
</children>
129-
130214
## Next steps
131215

132216
- [Configuring Coder](../admin/configure.md)

0 commit comments

Comments
 (0)