Skip to content

chore: clarify install options in README #1844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 27, 2022
Merged

chore: clarify install options in README #1844

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5328eba
chore: clarify install options in README
bpmct May 27, 2022
af98704
clarify the path is an example, not a requirement
bpmct May 27, 2022
e9812b3
Update README.md
bpmct May 27, 2022
5d3b70a
Update README.md
bpmct May 27, 2022
18d4b9a
Update README.md
bpmct May 27, 2022
eae3fbf
Update README.md
bpmct May 27, 2022
d21dce8
Update README.md
bpmct May 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,18 @@ release](https://github.com/coder/coder/releases) on a system with at least 1
CPU core and 2 GB RAM:

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

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

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

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

- To run a **temporary deployment**, start with dev mode (all data is in-memory and is destroyed on exit):

```bash
coder server --dev
Expand All @@ -82,19 +84,20 @@ You can set up a temporary deployment, a production deployment, or a system serv
coder server
```

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

```bash
# Edit the configuration!
sudo vim /etc/coder.d/coder.env
sudo service coder restart
```

> Use `coder --help` to get a complete list of flags and environment
> variables.
> OSX and Windows: You'll need to write your own
> configuration to run as a system service.

- See the [installation guide](./docs/install.md) for additional ways to run Coder (e.g docker-compose)

See the [installation guide](./docs/install.md) for additional ways to deploy Coder.
Use `coder --help` to get a complete list of flags and environment variables.

## Creating your first template and workspace

Expand Down