Skip to content

chore(docs): reorganize installation docs #11465

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 12 commits into from
Jan 10, 2024
Merged

chore(docs): reorganize installation docs #11465

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6947667
Update install.sh.md
matifali Jan 7, 2024
fc31597
update installtion docs
matifali Jan 7, 2024
a1a7edd
refactor
matifali Jan 8, 2024
3019d51
refactor
matifali Jan 8, 2024
b8aa0f8
fixup
matifali Jan 8, 2024
2a651a6
fmt
matifali Jan 8, 2024
1ab9639
Reorganize in three primary tabs
matifali Jan 8, 2024
7f6b810
Update uninstall instructions for different operating systems
matifali Jan 8, 2024
e771b12
Update uninstall instructions for Coder installation
matifali Jan 8, 2024
4ea1e90
Merge branch 'main' into update-install-docs
matifali Jan 9, 2024
6884cd5
review suggestions
matifali Jan 9, 2024
4ec945e
concide tab titles
matifali Jan 10, 2024
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
Prev Previous commit
Next Next commit
Reorganize in three primary tabs
  • Loading branch information
@matifali
matifali committed Jan 8, 2024
commit 1ab963970fc6a95967d3026e2063f50f7894855c
104 changes: 78 additions & 26 deletions docs/install/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,13 @@ There are a number of different ways to install Coder, depending on your needs.

<div class="tabs">

## Install Script (Linux and macOS)
## Linux

<div class="tabs">

The easiest way to install Coder on Linux and macOS is to use our
## Install Script

The easiest way to install Coder on Linux is to use our
[install script](https://github.com/coder/coder/blob/main/install.sh).

```shell
Expand All @@ -31,34 +35,16 @@ for reference:
curl -fsSL https://coder.com/install.sh | sh -s -- --help
```

## Homebrew (macOS and Linux)

To install Coder on macOS and Linux, you can use the
[Homebrew](https://brew.sh/) package manager.
## Homebrew

Install Coder from our official
[Homebrew tap](https://github.com/coder/homebrew-coder)
To install Coder on Linux, you can use the [Homebrew](https://brew.sh/) package
manager that uses our official [Homebrew tap](github.com/coder/homebrew-coder).

```shell
brew install coder/coder/coder
```

## Windows

To install Coder on Windows, you can use the
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
package manager

```powershell
winget install Coder.Coder
```

<!-- TODO: Replace with direct link to windows installer after we have https://github.com/coder/coder.com/issues/382 -->

Or you can use the windows installer from our
[GitHub releases](https://github.com/coder/coder/releases/latest)

## Linux
## System Packages

Coder officially maintains packages for the following Linux distributions:

Expand Down Expand Up @@ -108,7 +94,7 @@ sudo apk add ./coder.apk

## Manual

Retrieve the latest release from our GitHub releases page and install it
Get the latest `.tar.gz` package from our GitHub releases page and install it
manually.

1. Download the
Expand All @@ -119,16 +105,82 @@ manually.
location that's on your `PATH`

```shell
# ex. macOS and Linux
mv coder /usr/local/bin
```

</div>

## macOS

<div class="tabs">

## Homebrew

To install Coder on macOS, you can use the [Homebrew](https://brew.sh/) package
manager that uses our official
[Homebrew tap](https://github.com/coder/homebrew-coder).

```shell
brew install coder/coder/coder
```

## Install Script

The easiest way to install Coder on macOS is to use our
[install script](https://github.com/coder/coder/blob/main/install.sh).

```shell
curl -fsSL https://coder.com/install.sh | sh
```

You can preview what occurs during the install process:

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

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

```shell
curl -fsSL https://coder.com/install.sh | sh -s -- --help
```

</div>

## Windows

<div class="tabs">

## Winget

To install Coder on Windows, you can use the
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
package manager.

```powershell
winget install Coder.Coder
```

## Installer

Download the Windows installer from our
[GitHub releases](https://github.com/coder/coder/releases/latest) and install
it.

## Manual

Get the latest `.zip` package from our GitHub releases page and extract it to a
location that's on your `PATH` or add the extracted binary to your `PATH`.

> Windows users: see
> [this guide](https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23)
> for adding folders to `PATH`.

</div>

</div>

## Verify installation

Verify that the installation was successful by opening a new terminal and
Expand Down