From 29c9c1d9289c4db2d7bde63c70fc6566ce5eedd1 Mon Sep 17 00:00:00 2001 From: Ammar Bandukwala Date: Thu, 16 Jun 2022 07:30:56 -0500 Subject: [PATCH] docs: small improvements to install (#2400) * Simplify install docs * docs: clarify security policy --- docs/SECURITY.md | 4 ++-- docs/install.md | 20 ++++++-------------- docs/manifest.json | 2 +- install.sh | 10 +++++++--- 4 files changed, 16 insertions(+), 20 deletions(-) diff --git a/docs/SECURITY.md b/docs/SECURITY.md index c2aaf31e61..649e87d772 100644 --- a/docs/SECURITY.md +++ b/docs/SECURITY.md @@ -1,4 +1,4 @@ # Security Policy -Keeping your code secure is central to what we do. If you find a vulnerability, -please send an email to security@coder.com. +If you find a vulnerability, **DO NOT FILE AN ISSUE**. +Instead, send an email to security@coder.com. diff --git a/docs/install.md b/docs/install.md index dff56fde94..292f3a83d0 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,17 +1,8 @@ # Install -This article walks you through the various ways of installing and deploying Coder. - ## install.sh -The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/blob/main/install.sh) for Linux and macOS. The install script -attempts to use the system package manager detection-reference if possible. - -You can preview what occurs during the install process: - -```bash -curl -L https://coder.com/install.sh | sh -s -- --dry-run -``` +The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/blob/main/install.sh) for Linux and macOS. To install, run: @@ -19,10 +10,11 @@ To install, run: curl -L https://coder.com/install.sh | sh ``` -> If you're concerned about the install script's use of `curl | sh` and the -> security implications, please see [this blog -> post](https://sandstorm.io/news/2015-09-24-is-curl-bash-insecure-pgp-verified-install) -> by [sandstorm.io](https://sandstorm.io). +You can preview what occurs during the install process: + +```bash +curl -L https://coder.com/install.sh | sh -s -- --dry-run +``` You can modify the installation process by including flags. Run the help command for reference: diff --git a/docs/manifest.json b/docs/manifest.json index 9c4675196b..e4638d2af8 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -43,7 +43,7 @@ "path": "./CODE_OF_CONDUCT.md" }, { - "title": "Security policy", + "title": "Security", "description": "How to report vulnerabilities in Coder", "path": "./SECURITY.md" } diff --git a/install.sh b/install.sh index e9c8263501..e131ad40e3 100755 --- a/install.sh +++ b/install.sh @@ -112,11 +112,15 @@ $1 package has been installed. To run Coder as a system service: # Set up an external access URL or enable CODER_TUNNEL - sudo vim /etc/coder.d/coder.env + $ sudo vim /etc/coder.d/coder.env # Use systemd to start Coder now and on reboot - sudo systemctl enable --now coder + $ sudo systemctl enable --now coder # View the logs to ensure a successful start - journalctl -u coder.service -b + $ journalctl -u coder.service -b + +Or, just run the server directly: + + $ coder server EOF }