Skip to content

Commit bde3779

Browse files
bpmctKatie Horne
and
Katie Horne
authored
chore: clarify install options in README (#1844)
* chore: clarify install options in README * clarify the path is an example, not a requirement * Update README.md Co-authored-by: Katie Horne <katie@coder.com> * Update README.md Co-authored-by: Katie Horne <katie@coder.com> * Update README.md Co-authored-by: Katie Horne <katie@coder.com> * Update README.md Co-authored-by: Katie Horne <katie@coder.com> * Update README.md Co-authored-by: Katie Horne <katie@coder.com> Co-authored-by: Katie Horne <katie@coder.com>
1 parent 5000edb commit bde3779

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

+15-12
Original file line numberDiff line numberDiff line change
@@ -61,16 +61,18 @@ release](https://github.com/coder/coder/releases) on a system with at least 1
6161
CPU core and 2 GB RAM:
6262

6363
1. Download the [release asset](https://github.com/coder/coder/releases) appropriate for your operating system
64-
1. Unzip the folder you just downloaded, and move the `coder` executable to a
65-
location that's on your `PATH`
64+
1. Unzip the folder you just downloaded, and move the `coder` executable to a location that's on your `PATH`
6665

67-
> Make sure you have the appropriate credentials for your cloud provider (e.g.,
68-
> access key ID and secret access key for AWS).
66+
```sh
67+
# ex. MacOS and Linux
68+
mv coder /usr/local/bin
69+
```
6970

70-
You can set up a temporary deployment, a production deployment, or a system service:
71+
Windows: see [this guide](https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23) on adding a folder to `PATH`
7172

72-
- To set up a **temporary deployment**, start with dev mode (all data is in-memory and is
73-
destroyed on exit):
73+
There are a few ways to run Coder:
74+
75+
- To run a **temporary deployment**, start with dev mode (all data is in-memory and destroyed on exit):
7476

7577
```bash
7678
coder server --dev
@@ -83,19 +85,20 @@ You can set up a temporary deployment, a production deployment, or a system serv
8385
coder server
8486
```
8587

86-
- To run as a **system service**, install with `.deb` (Debian, Ubuntu) or `.rpm`
87-
(Fedora, CentOS, RHEL, SUSE):
88+
- To run as a **system service**, install with `.deb` (Debian, Ubuntu) or `.rpm` (Fedora, CentOS, RHEL, SUSE):
8889

8990
```bash
9091
# Edit the configuration!
9192
sudo vim /etc/coder.d/coder.env
9293
sudo service coder restart
9394
```
9495

95-
> Use `coder --help` to get a complete list of flags and environment
96-
> variables.
96+
> macOS and Windows users: You'll need to write your own
97+
> configuration to run Coder as a system service.
98+
99+
- See the [installation guide](./docs/install.md) for additional ways to run Coder (e.g., docker-compose)
97100
98-
See the [installation guide](./docs/install.md) for additional ways to deploy Coder.
101+
Use `coder --help` to get a complete list of flags and environment variables.
99102
100103
## Creating your first template and workspace
101104

0 commit comments

Comments
 (0)