|
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. |
| 1 | +#Installing Coder |
3 | 2 |
|
4 | | -<children> |
5 | | - This page is rendered onhttps://coder.com/docs/v2/latest/install. Refer to the other documents in the`install/` directory for per-platform instructions. |
6 | | -</children> |
| 3 | +A single CLI (`coder`) is used for both the Coder server and the client. |
7 | 4 |
|
8 | | -##Install Coder |
| 5 | +There are several ways to install Coder. For production deployments with 50+ |
| 6 | +users, we recommend[installing on Kubernetes](./kubernetes.md). Otherwise, you |
| 7 | +can install Coder on your local machine or on a VM: |
9 | 8 |
|
10 | 9 | <divclass="tabs"> |
11 | 10 |
|
12 | | -##Linux |
| 11 | +##Linux/macOS |
13 | 12 |
|
14 | | -<divclass="tabs"> |
15 | | - |
16 | | -##Install Script |
17 | | - |
18 | | -The easiest way to install Coder on Linux is to use our |
19 | | -[install script](https://github.com/coder/coder/blob/main/install.sh). |
20 | | - |
21 | | -```shell |
22 | | -curl -fsSL https://coder.com/install.sh| sh |
23 | | -``` |
24 | | - |
25 | | -You can preview what occurs during the install process: |
26 | | - |
27 | | -```shell |
28 | | -curl -fsSL https://coder.com/install.sh| sh -s -- --dry-run |
29 | | -``` |
30 | | - |
31 | | -You can modify the installation process by including flags. Run the help command |
32 | | -for reference: |
33 | | - |
34 | | -```shell |
35 | | -curl -fsSL https://coder.com/install.sh| sh -s -- --help |
36 | | -``` |
37 | | - |
38 | | -##Homebrew |
39 | | - |
40 | | -To install Coder on Linux, you can use the[Homebrew](https://brew.sh/) package |
41 | | -manager that uses our official |
42 | | -[Homebrew tap](https://github.com/coder/homebrew-coder). |
43 | | - |
44 | | -```shell |
45 | | -brew install coder/coder/coder |
46 | | -``` |
47 | | - |
48 | | -##System Packages |
49 | | - |
50 | | -Coder officially maintains packages for the following Linux distributions: |
51 | | - |
52 | | -- .deb (Debian, Ubuntu) |
53 | | -- .rpm (Fedora, CentOS, RHEL, SUSE) |
54 | | -- .apk (Alpine) |
55 | | - |
56 | | -<divclass="tabs"> |
57 | | - |
58 | | -##Debian, Ubuntu |
59 | | - |
60 | | -For Debian and Ubuntu, get the latest`.deb` package from our |
61 | | -[GitHub releases](https://github.com/coder/coder/releases/latest) and install it |
62 | | -manually or use the following commands to download and install the latest`.deb` |
63 | | -package. |
64 | | - |
65 | | -```shell |
66 | | -# Install the package |
67 | | -sudo apt install ./coder.deb |
68 | | -``` |
69 | | - |
70 | | -##RPM Linux |
71 | | - |
72 | | -For Fedora, CentOS, RHEL, SUSE, get the latest`.rpm` package from our |
73 | | -[GitHub releases](https://github.com/coder/coder/releases/latest) and install it |
74 | | -manually or use the following commands to download and install the latest`.rpm` |
75 | | -package. |
76 | | - |
77 | | -```shell |
78 | | -# Install the package |
79 | | -sudo yum install ./coder.rpm |
80 | | -``` |
81 | | - |
82 | | -##Alpine |
83 | | - |
84 | | -Get the latest`.apk` package from our |
85 | | -[GitHub releases](https://github.com/coder/coder/releases/latest) and install it |
86 | | -manually or use the following commands to download and install the latest`.apk` |
87 | | -package. |
88 | | - |
89 | | -```shell |
90 | | -# Install the package |
91 | | -sudo apk add ./coder.apk |
92 | | -``` |
93 | | - |
94 | | -</div> |
95 | | - |
96 | | -##Manual |
97 | | - |
98 | | -Get the latest`.tar.gz` package from our |
99 | | -[GitHub releases](https://github.com/coder/coder/releases/latest) and install it |
100 | | -manually. |
101 | | - |
102 | | -1. Download the |
103 | | -[release archive](https://github.com/coder/coder/releases/latest) appropriate |
104 | | - for your operating system |
105 | | - |
106 | | -2. Unzip the folder you just downloaded, and move the`coder` executable to a |
107 | | - location that's on your`PATH` |
108 | | - |
109 | | -```shell |
110 | | -mv coder /usr/local/bin |
111 | | -``` |
| 13 | +Our install script is the fastest way to install Coder on Linux/macOS: |
112 | 14 |
|
113 | | -</div> |
114 | | - |
115 | | -##macOS |
116 | | - |
117 | | -<divclass="tabs"> |
118 | | - |
119 | | -##Homebrew |
120 | | - |
121 | | -To install Coder on macOS, you can use the[Homebrew](https://brew.sh/) package |
122 | | -manager that uses our official |
123 | | -[Homebrew tap](https://github.com/coder/homebrew-coder). |
124 | | - |
125 | | -```shell |
126 | | -brew install coder/coder/coder |
127 | | -``` |
128 | | - |
129 | | -##Install Script |
130 | | - |
131 | | -The easiest way to install Coder on macOS is to use our |
132 | | -[install script](https://github.com/coder/coder/blob/main/install.sh). |
133 | | - |
134 | | -```shell |
135 | | -curl -fsSL https://coder.com/install.sh| sh |
136 | | -``` |
137 | | - |
138 | | -You can preview what occurs during the install process: |
139 | | - |
140 | | -```shell |
141 | | -curl -fsSL https://coder.com/install.sh| sh -s -- --dry-run |
142 | | -``` |
143 | | - |
144 | | -You can modify the installation process by including flags. Run the help command |
145 | | -for reference: |
146 | | - |
147 | | -```shell |
148 | | -curl -fsSL https://coder.com/install.sh| sh -s -- --help |
| 15 | +```sh |
| 16 | +curl -L https://coder.com/install.sh| sh |
149 | 17 | ``` |
150 | 18 |
|
151 | | -</div> |
| 19 | +Refer to[GitHub releases](https://github.com/coder/coder/releases) for |
| 20 | +alternate installation methods (e.g. standalone binaries, system packages). |
152 | 21 |
|
153 | 22 | ##Windows |
154 | 23 |
|
155 | | -<divclass="tabs"> |
| 24 | +Use[GitHub releases](https://github.com/coder/coder/releases) to download the |
| 25 | +Windows installer (`.msi`) or standalone binary (`.exe`). |
156 | 26 |
|
157 | | -##Winget |
| 27 | + |
158 | 28 |
|
159 | | -To install Coder on Windows, you can use the |
| 29 | +Alternatively, you can use the |
160 | 30 | [`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget) |
161 | | -package manager. |
| 31 | +package manager to install Coder: |
162 | 32 |
|
163 | 33 | ```powershell |
164 | 34 | winget install Coder.Coder |
165 | 35 | ``` |
166 | 36 |
|
167 | | -##Installer |
168 | | - |
169 | | -Download the Windows installer from our |
170 | | -[GitHub releases](https://github.com/coder/coder/releases/latest) and install |
171 | | -it. |
| 37 | +##Other |
172 | 38 |
|
173 | | -##Manual |
174 | | - |
175 | | -Get the latest`.zip` package from our GitHub releases page and extract it to a |
176 | | -location that's on your`PATH` or add the extracted binary to your`PATH`. |
177 | | - |
178 | | ->Windows users: see |
179 | | ->[this guide](https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23) |
180 | | ->for adding folders to`PATH`. |
| 39 | +<children></children> |
181 | 40 |
|
182 | 41 | </div> |
183 | 42 |
|
184 | | -</div> |
185 | | - |
186 | | -##Verify installation |
187 | | - |
188 | | -Verify that the installation was successful by opening a new terminal and |
189 | | -running: |
| 43 | +To start the Coder server: |
190 | 44 |
|
191 | | -```console |
192 | | -coder --version |
193 | | -Coder v2.6.0+b3e3521 Thu Dec 21 22:33:13 UTC 2023 |
194 | | -https://github.com/coder/coder/commit/b3e352127478bfd044a1efa77baace096096d1e6 |
195 | | - |
196 | | -Full build of Coder, supports the server subcommand. |
197 | | -... |
| 45 | +```sh |
| 46 | +coder server |
198 | 47 | ``` |
199 | 48 |
|
200 | | -##Start Coder |
201 | | - |
202 | | -1. After installing, start the Coder server manually via`coder server` or as a |
203 | | - system package. |
204 | | - |
205 | | - <divclass="tabs"> |
206 | | - |
207 | | -##Terminal |
208 | | - |
209 | | -```shell |
210 | | -# Automatically sets up an external access URL on *.try.coder.app |
211 | | - coder server |
| 49 | + |
212 | 50 |
|
213 | | -# Requires a PostgreSQL instance (version 13 or higher) and external access URL |
214 | | - coder server --postgres-url<url> --access-url<url> |
215 | | -``` |
| 51 | +To log in to an existing Coder deployment: |
216 | 52 |
|
217 | | -##System Package (Linux) |
218 | | - |
219 | | - Run Coder as a system service. |
220 | | - |
221 | | -```shell |
222 | | -# (Optional) Set up an access URL |
223 | | - sudo vim /etc/coder.d/coder.env |
224 | | - |
225 | | -# To systemd to start Coder now and on reboot |
226 | | - sudo systemctlenable --now coder |
227 | | - |
228 | | -# View the logs to see Coder URL and ensure a successful start |
229 | | - journalctl -u coder.service -b |
230 | | -``` |
231 | | - |
232 | | - </div> |
233 | | - |
234 | | ->Set`CODER_ACCESS_URL` to the external URL that users and workspaces will |
235 | | ->use to connect to Coder. This is not required if you are using the tunnel. |
236 | | ->Learn more about Coder's[configuration options](../admin/configure.md). |
237 | | -
|
238 | | - By default, the Coder server runs on`http://127.0.0.1:3000` and uses a |
239 | | -[public tunnel](../admin/configure.md#tunnel) for workspace connections. |
240 | | - |
241 | | -2. Visit the Coder URL in the logs to set up your first account, or use the CLI |
242 | | - to create your first user. |
243 | | - |
244 | | -```shell |
245 | | - coder login<access url> |
246 | | -``` |
| 53 | +```sh |
| 54 | +coder login https://coder.example.com |
| 55 | +``` |
247 | 56 |
|
248 | | -##Nextsteps |
| 57 | +##Nextup |
249 | 58 |
|
250 | | --[Configuring Coder](../admin/configure.md) |
251 | | --[Templates](../templates/index.md) |
| 59 | +-[Create your first template](../templates/tutorial.md) |