Skip to content
This repository was archived by the owner on Nov 14, 2024. It is now read-only.

Commit 6739a30

Browse files
authored
chore: update README.md with installation instructions (#31)
* chore: update README.md with installation instructions Fixes #29. * fixup! chore: update README.md with installation instructions
1 parent 4707ec4 commit 6739a30

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,27 @@ permissions to run Coder.
1919
- Kubernetes Resosurces: checks that the cluster has the required
2020
resource types available to run Coder.
2121

22+
## Installation
23+
24+
You can manually download the latest [release](https://github.com/cdr/coder-doctor/releases):
25+
26+
1. Click a release and download the tar file for your operating system
27+
(ex: coder-doctor-linux-amd64.tar.gz)
28+
1. (Optional, recommended) Download the `checksums.txt` for the desired
29+
release and verify the `sha256` checksum of the file you downloaded.
30+
1. Extract the `coder-doctor` binary.
31+
1. Move the `coder-doctor` binary to somewhere in your `$PATH`.
32+
33+
Alternatively, use the below command, replacing `$VERSION`, `$OSTYPE`
34+
(one of `darwin`, `linux`, `windows`) and `$ARCH` (one of `amd64`, `arm64`)
35+
as required:
36+
37+
```shell-session
38+
$ curl -fSsL "https://github.com/cdr/coder-doctor/releases/latest/download/coder-doctor_${VERSION}_${OSTYPE}_${ARCH}.tar.gz" | tar -xzvf -
39+
README.md
40+
coder-doctor
41+
```
42+
2243
## Usage
2344

2445
To check if your Kubernetes cluster is ready to install Coder, run:

0 commit comments

Comments
 (0)