Skip to content

docs: small improvements to install #2400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 16, 2022
Merged

docs: small improvements to install #2400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32a04ea
Simplify install docs
ammario Jun 16, 2022
334066c
docs: clarify security policy
ammario Jun 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
18 changes: 5 additions & 13 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"path": "./CODE_OF_CONDUCT.md"
},
{
"title": "Security policy",
"title": "Security",
"description": "How to report vulnerabilities in Coder",
"path": "./SECURITY.md"
}
Expand Down
10 changes: 7 additions & 3 deletions install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down