Skip to content

chore: sync README and install.md installation instructions #2442

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 1 commit into from
Jun 19, 2022
Merged

chore: sync README and install.md installation instructions #2442

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 15 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,28 @@ Coder creates remote development machines so your team can develop from anywhere
> **Note**:
> Coder is in an alpha state. [Report issues here](https://github.com/coder/coder/issues/new).

There are a few ways to install Coder: [install script](https://coder.com/docs/coder-oss/latest/install#installsh) (macOS, Linux), [docker-compose](https://coder.com/docs/coder-oss/latest/install#docker-compose), or [manually](https://coder.com/docs/coder-oss/latest/install#manual) via the latest release (macOS, Windows, and Linux).
The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/blob/main/install.sh) for Linux and macOS.

If you use the install script, you can preview what occurs during the install process:
To install, run:

```sh
curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run
```bash
curl -L https://coder.com/install.sh | sh
```

To install, run:
You can preview what occurs during the install process:

```sh
curl -fsSL https://coder.com/install.sh | sh
```bash
curl -L https://coder.com/install.sh | sh -s -- --dry-run
```

You can modify the installation process by including flags. Run the help command for reference:

```bash
curl -L https://coder.com/install.sh | sh -s -- --help
```

> See [install](docs/install.md) for additional methods.

Once installed, you can start a production deployment with a single command:

```sh
Expand Down