docs: small improvements to install (#2400)

* Simplify install docs

* docs: clarify security policy
This commit is contained in:
Ammar Bandukwala
2022-06-16 07:30:56 -05:00
committed by GitHub
parent 10dc9e3876
commit 29c9c1d928
4 changed files with 16 additions and 20 deletions
+2 -2
View File
@@ -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.
+6 -14
View File
@@ -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:
+1 -1
View File
@@ -43,7 +43,7 @@
"path": "./CODE_OF_CONDUCT.md"
},
{
"title": "Security policy",
"title": "Security",
"description": "How to report vulnerabilities in Coder",
"path": "./SECURITY.md"
}
+7 -3
View File
@@ -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
}