From 51786ea4074199b7cf0eedad78197bde06da782e Mon Sep 17 00:00:00 2001 From: Stephen Kirby Date: Thu, 5 Sep 2024 15:29:55 +0000 Subject: [PATCH 1/2] Update installation guide with detailed steps Add detailed steps for installing Coder using different methods: - Single CLI for Coder server and client - Release channels: mainline and stable Installation methods: - For Linux/macOS: ```sh curl -L https://coder.com/install.sh | sh ``` - For Windows: - Available on [GitHub releases](https://github.com/coder/coder/releases) - Visual C++ Runtime required for PostgreSQL - Alternatively, use `winget`: ```powershell winget install Coder.Coder ``` Post-install steps: - Start Coder server: ```sh coder server ``` - Log in to existing deployment: ```sh coder login https://coder.example.com ``` Next steps: - [Create your first template](../templates/tutorial.md) --- docs/install/README.md | 64 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/docs/install/README.md b/docs/install/README.md index a12311ac14bf0..a60409924b1b2 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -1,5 +1,67 @@ # Installing Coder -TODO: Make this look great +A single CLI (`coder`) is used for both the Coder server and the client. + +We support two release channels: mainline and stable - read the +[Releases](./releases.md) page to learn more about which best suits your team. + +There are several ways to install Coder. For production deployments with 50+ +users, we recommend [installing on Kubernetes](./kubernetes.md). Otherwise, you +can install Coder on your local machine or on a VM: + +
+ +## Linux/macOS + +Our install script is the fastest way to install Coder on Linux/macOS: + +```sh +curl -L https://coder.com/install.sh | sh +``` + +Refer to [GitHub releases](https://github.com/coder/coder/releases) for +alternate installation methods (e.g. standalone binaries, system packages). + +## Windows + +> **Important:** If you plan to use the built-in PostgreSQL database, you will +> need to ensure that the +> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version) +> is installed. + +Use [GitHub releases](https://github.com/coder/coder/releases) to download the +Windows installer (`.msi`) or standalone binary (`.exe`). + +![Windows setup wizard](../images/install/windows-installer.png) + +Alternatively, you can use the +[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget) +package manager to install Coder: + +```powershell +winget install Coder.Coder +``` + +## Other + +
+ +To start the Coder server: + +```sh +coder server +``` + +![Coder install](../images/install/coder-setup.png) + +To log in to an existing Coder deployment: + +```sh +coder login https://coder.example.com +``` + +## Next up + +- [Create your first template](../templates/tutorial.md) From 9ee7f8e2ec55ea5cc44546ea64cb11061f4a6deb Mon Sep 17 00:00:00 2001 From: Stephen Kirby Date: Thu, 5 Sep 2024 15:35:06 +0000 Subject: [PATCH 2/2] Add link to guide on exposing control plane - Added a link to the guide for exposing the control plane to other users. - This helps admins configure their deployments for multi-user access. --- docs/install/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/install/README.md b/docs/install/README.md index a60409924b1b2..23ae9842086a4 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -65,3 +65,4 @@ coder login https://coder.example.com ## Next up - [Create your first template](../templates/tutorial.md) +- [Expose your control plane to other users](../admin/configure.md)