From 32a04ea054e8f3295508ebb2706c559e36977a15 Mon Sep 17 00:00:00 2001 From: ammario Date: Thu, 16 Jun 2022 02:47:09 +0000 Subject: [PATCH 1/2] Simplify install docs --- docs/install.md | 18 +++++------------- install.sh | 10 +++++++--- 2 files changed, 12 insertions(+), 16 deletions(-) diff --git a/docs/install.md b/docs/install.md index dff56fde9440b..292f3a83d0fa0 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,29 +1,21 @@ # 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. +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. -You can preview what occurs during the install process: +To install, run: ```bash -curl -L https://coder.com/install.sh | sh -s -- --dry-run +curl -L https://coder.com/install.sh | sh ``` -To install, run: +You can preview what occurs during the install process: ```bash -curl -L https://coder.com/install.sh | sh +curl -L https://coder.com/install.sh | sh -s -- --dry-run ``` -> 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 modify the installation process by including flags. Run the help command for reference: ```bash diff --git a/install.sh b/install.sh index db89cf67b8946..f9692270b7d25 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 } From 334066c5147d50589f56153a51e9f790cfbe4ca9 Mon Sep 17 00:00:00 2001 From: ammario Date: Thu, 16 Jun 2022 02:47:18 +0000 Subject: [PATCH 2/2] docs: clarify security policy --- docs/SECURITY.md | 4 ++-- docs/manifest.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/SECURITY.md b/docs/SECURITY.md index c2aaf31e61a52..649e87d772343 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/manifest.json b/docs/manifest.json index 9c4675196b24a..e4638d2af8ecb 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" }