From 5328ebab430344d7a9799fd8d3d38409da3d7de2 Mon Sep 17 00:00:00 2001 From: Ben Date: Fri, 27 May 2022 15:24:14 +0000 Subject: [PATCH 1/7] chore: clarify install options in README --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e2d9cee250b6e..e22a4c359ea4c 100644 --- a/README.md +++ b/README.md @@ -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 + # 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 @@ -82,8 +84,7 @@ 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! @@ -91,10 +92,12 @@ You can set up a temporary deployment, a production deployment, or a system serv 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 From af987047dc01d4a33255f79775715fecf553c3a3 Mon Sep 17 00:00:00 2001 From: Ben Date: Fri, 27 May 2022 15:26:16 +0000 Subject: [PATCH 2/7] clarify the path is an example, not a requirement --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e22a4c359ea4c..2c20913346eeb 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ CPU core and 2 GB RAM: 1. Unzip the folder you just downloaded, and move the `coder` executable to a location that's on your `PATH` ```sh - # MacOS and Linux + # ex. MacOS and Linux mv coder /usr/local/bin ``` From e9812b3e5a681d8e0556de9f2f5169207f652b76 Mon Sep 17 00:00:00 2001 From: Ben Potter Date: Fri, 27 May 2022 12:53:42 -0500 Subject: [PATCH 3/7] Update README.md Co-authored-by: Katie Horne --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c20913346eeb..d4fcec45cab2a 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ CPU core and 2 GB RAM: mv coder /usr/local/bin ``` - 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` + 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` There are a few ways to run Coder: From 5d3b70a8007b1dd5c0ceba78116f01fe6184925b Mon Sep 17 00:00:00 2001 From: Ben Potter Date: Fri, 27 May 2022 12:53:47 -0500 Subject: [PATCH 4/7] Update README.md Co-authored-by: Katie Horne --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d4fcec45cab2a..243bd0fc3b8c7 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ CPU core and 2 GB RAM: 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): +- To run a **temporary deployment**, start with dev mode (all data is in-memory and destroyed on exit): ```bash coder server --dev From 18d4b9a3092df8b43f129c5f17b509015ff707ea Mon Sep 17 00:00:00 2001 From: Ben Potter Date: Fri, 27 May 2022 12:53:52 -0500 Subject: [PATCH 5/7] Update README.md Co-authored-by: Katie Horne --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 243bd0fc3b8c7..f7b025fc98f28 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ There are a few ways to run Coder: sudo service coder restart ``` - > OSX and Windows: You'll need to write your own + > macOS and Windows users: 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) From eae3fbfd42b93fa4c30306dddd4c78c585ff09c3 Mon Sep 17 00:00:00 2001 From: Ben Potter Date: Fri, 27 May 2022 12:53:58 -0500 Subject: [PATCH 6/7] Update README.md Co-authored-by: Katie Horne --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f7b025fc98f28..0d405dfe8d924 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ There are a few ways to run Coder: ``` > macOS and Windows users: You'll need to write your own - > configuration to run as a system service. + > configuration to run Coder as a system service. - See the [installation guide](./docs/install.md) for additional ways to run Coder (e.g docker-compose) From d21dce8bbff3f9e15e23de18cdcd834196b02aab Mon Sep 17 00:00:00 2001 From: Ben Potter Date: Fri, 27 May 2022 12:54:03 -0500 Subject: [PATCH 7/7] Update README.md Co-authored-by: Katie Horne --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d405dfe8d924..19dd91c48792d 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ There are a few ways to run Coder: > macOS and Windows users: You'll need to write your own > configuration to run Coder 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 run Coder (e.g., docker-compose) Use `coder --help` to get a complete list of flags and environment variables.