Skip to content

chore: minor clarifications to install docs #3983

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
Sep 12, 2022
Merged

chore: minor clarifications to install docs #3983

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
0bcc2f0
chore: minor clarifications to install docs
bpmct Sep 9, 2022
e240c0b
clarify
bpmct Sep 9, 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
2 changes: 1 addition & 1 deletion docs/install/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
There are a number of different methods to install Coder:
There are a number of different methods to install and run Coder:

<children>
This page is rendered on https://coder.com/docs/coder-oss/install. Refer to the other documents in the `install/` directory for per-platform instructions.
Expand Down
7 changes: 4 additions & 3 deletions docs/install/kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
## Requirements

Before proceeding, please ensure that you have both Helm 3.5+ and the
[latest version of Coder](https://github.com/coder/coder/releases) installed.
You will also need to have a Kubernetes cluster running K8s 1.19+.
Before proceeding, please ensure that you have a Kubernetes cluster running K8s 1.19+ and have Helm 3.5+ installed.

You'll also want to install the [latest version of Coder](https://github.com/coder/coder/releases) locally in order
to log in and manage templates.

## Install Coder with Helm

Expand Down
40 changes: 20 additions & 20 deletions docs/install/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
Coder publishes the following system packages [in GitHub releases](https://github.com/coder/coder/releases):
1. Download and install one of the following system packages from [GitHub releases](https://github.com/coder/coder/releases):

- .deb (Debian, Ubuntu)
- .rpm (Fedora, CentOS, RHEL, SUSE)
- .apk (Alpine)
- .deb (Debian, Ubuntu)
- .rpm (Fedora, CentOS, RHEL, SUSE)
- .apk (Alpine)

Once installed, you can run Coder as a system service.
1. Run Coder as a system service.

```sh
# Set up an access URL or enable CODER_TUNNEL
sudo vim /etc/coder.d/coder.env
```sh
# Set up an access URL or enable CODER_TUNNEL
sudo vim /etc/coder.d/coder.env

# To systemd to start Coder now and on reboot
sudo systemctl enable --now coder
# To systemd to start Coder now and on reboot
sudo systemctl enable --now coder

# View the logs to see Coder's URL and ensure a successful start
journalctl -u coder.service -b
```
# View the logs to see Coder's URL and ensure a successful start
journalctl -u coder.service -b
```

> Set `CODER_ACCESS_URL` to the external URL that users and workspaces will use to
> connect to Coder. This is not required if you are using the tunnel. Learn more
> about Coder's [configuration options](../admin/configure.md).
> Set `CODER_ACCESS_URL` to the external URL that users and workspaces will use to
> connect to Coder. This is not required if you are using the tunnel. Learn more
> about Coder's [configuration options](../admin/configure.md).

Visit the Coder URL in the logs to set up your first account, or use the CLI:
1. Visit the Coder URL in the logs to set up your first account, or use the CLI:

```sh
coder login <access-url>
```
```sh
coder login <access-url>
```

## Restarting Coder

Expand Down