Skip to content

Commit 29c9c1d

Browse files
authored
docs: small improvements to install (#2400)
* Simplify install docs * docs: clarify security policy
1 parent 10dc9e3 commit 29c9c1d

File tree

4 files changed

+15
-19
lines changed

4 files changed

+15
-19
lines changed

docs/SECURITY.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Security Policy
22

3-
Keeping your code secure is central to what we do. If you find a vulnerability,
4-
please send an email to security@coder.com.
3+
If you find a vulnerability, **DO NOT FILE AN ISSUE**.
4+
Instead, send an email to security@coder.com.

docs/install.md

+5-13
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,21 @@
11
# Install
22

3-
This article walks you through the various ways of installing and deploying Coder.
4-
53
## install.sh
64

7-
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
8-
attempts to use the system package manager detection-reference if possible.
5+
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.
96

10-
You can preview what occurs during the install process:
7+
To install, run:
118

129
```bash
13-
curl -L https://coder.com/install.sh | sh -s -- --dry-run
10+
curl -L https://coder.com/install.sh | sh
1411
```
1512

16-
To install, run:
13+
You can preview what occurs during the install process:
1714

1815
```bash
19-
curl -L https://coder.com/install.sh | sh
16+
curl -L https://coder.com/install.sh | sh -s -- --dry-run
2017
```
2118

22-
> If you're concerned about the install script's use of `curl | sh` and the
23-
> security implications, please see [this blog
24-
> post](https://sandstorm.io/news/2015-09-24-is-curl-bash-insecure-pgp-verified-install)
25-
> by [sandstorm.io](https://sandstorm.io).
26-
2719
You can modify the installation process by including flags. Run the help command for reference:
2820

2921
```bash

docs/manifest.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
"path": "./CODE_OF_CONDUCT.md"
4444
},
4545
{
46-
"title": "Security policy",
46+
"title": "Security",
4747
"description": "How to report vulnerabilities in Coder",
4848
"path": "./SECURITY.md"
4949
}

install.sh

+7-3
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,15 @@ $1 package has been installed.
112112
To run Coder as a system service:
113113
114114
# Set up an external access URL or enable CODER_TUNNEL
115-
sudo vim /etc/coder.d/coder.env
115+
$ sudo vim /etc/coder.d/coder.env
116116
# Use systemd to start Coder now and on reboot
117-
sudo systemctl enable --now coder
117+
$ sudo systemctl enable --now coder
118118
# View the logs to ensure a successful start
119-
journalctl -u coder.service -b
119+
$ journalctl -u coder.service -b
120+
121+
Or, just run the server directly:
122+
123+
$ coder server
120124
121125
EOF
122126
}

0 commit comments

Comments
 (0)