From 0bcc2f0135fd5c4b65c70b3828a48e7df477ab71 Mon Sep 17 00:00:00 2001 From: Ben Date: Fri, 9 Sep 2022 19:21:04 +0000 Subject: [PATCH 1/2] chore: minor clarifications to install docs --- docs/install/index.md | 2 +- docs/install/kubernetes.md | 7 ++++--- docs/install/packages.md | 40 +++++++++++++++++++------------------- 3 files changed, 25 insertions(+), 24 deletions(-) diff --git a/docs/install/index.md b/docs/install/index.md index f301b41bec8f2..973936080a8be 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -1,4 +1,4 @@ -There are a number of different methods to install Coder: +There are a number of different methods to install and run Coder: This page is rendered on https://coder.com/docs/coder-oss/install. Refer to the other documents in the `install/` directory for per-platform instructions. diff --git a/docs/install/kubernetes.md b/docs/install/kubernetes.md index 637f622ec2e9c..12bc8d7cd42a3 100644 --- a/docs/install/kubernetes.md +++ b/docs/install/kubernetes.md @@ -1,8 +1,9 @@ ## Requirements -Before proceeding, please ensure that you have both Helm 3.5+ and the -[latest version of Coder](https://github.com/coder/coder/releases) installed. -You will also need to have a Kubernetes cluster running K8s 1.19+. +Before proceeding, please ensure that you have a Kubernetes cluster running K8s 1.19+ and have Helm 3.5+ installed. + +You'll also want to install the [latest version of Coder](https://github.com/coder/coder/releases) locally in order +to log in and manage templates. ## Install Coder with Helm diff --git a/docs/install/packages.md b/docs/install/packages.md index 972dd9908aef4..aad20c84f13ed 100644 --- a/docs/install/packages.md +++ b/docs/install/packages.md @@ -1,31 +1,31 @@ -Coder publishes the following system packages [in GitHub releases](https://github.com/coder/coder/releases): +1. Download and install one of the following system packages from [GitHub releases](https://github.com/coder/coder/releases): -- .deb (Debian, Ubuntu) -- .rpm (Fedora, CentOS, RHEL, SUSE) -- .apk (Alpine) + - .deb (Debian, Ubuntu) + - .rpm (Fedora, CentOS, RHEL, SUSE) + - .apk (Alpine) -Once installed, you can run Coder as a system service. +1. Once installed, you can run Coder as a system service. -```sh -# Set up an access URL or enable CODER_TUNNEL -sudo vim /etc/coder.d/coder.env + ```sh + # Set up an access URL or enable CODER_TUNNEL + sudo vim /etc/coder.d/coder.env -# To systemd to start Coder now and on reboot -sudo systemctl enable --now coder + # To systemd to start Coder now and on reboot + sudo systemctl enable --now coder -# View the logs to see Coder's URL and ensure a successful start -journalctl -u coder.service -b -``` + # View the logs to see Coder's URL and ensure a successful start + journalctl -u coder.service -b + ``` -> Set `CODER_ACCESS_URL` to the external URL that users and workspaces will use to -> connect to Coder. This is not required if you are using the tunnel. Learn more -> about Coder's [configuration options](../admin/configure.md). + > Set `CODER_ACCESS_URL` to the external URL that users and workspaces will use to + > connect to Coder. This is not required if you are using the tunnel. Learn more + > about Coder's [configuration options](../admin/configure.md). -Visit the Coder URL in the logs to set up your first account, or use the CLI: +1. Visit the Coder URL in the logs to set up your first account, or use the CLI: -```sh -coder login -``` + ```sh + coder login + ``` ## Restarting Coder From e240c0bbeadd0b337478c2cbab796d62b446ff7a Mon Sep 17 00:00:00 2001 From: Ben Date: Fri, 9 Sep 2022 19:22:34 +0000 Subject: [PATCH 2/2] clarify --- docs/install/packages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/packages.md b/docs/install/packages.md index aad20c84f13ed..d8e455411dae4 100644 --- a/docs/install/packages.md +++ b/docs/install/packages.md @@ -4,7 +4,7 @@ - .rpm (Fedora, CentOS, RHEL, SUSE) - .apk (Alpine) -1. Once installed, you can run Coder as a system service. +1. Run Coder as a system service. ```sh # Set up an access URL or enable CODER_TUNNEL