synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: minor clarifications to install docs (#3983)

Browse Source
This commit is contained in:
Ben Potter
2022-09-11 20:50:20 -04:00
committed by GitHub
parent 067069d2e2
commit e5e1ed2f9c
3 changed files with 25 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/install/index.md
View File

@ -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.

7
docs/install/kubernetes.md
View File

@ -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

40
docs/install/packages.md
View File

@ -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