8000 chore: separate install docs by bpmct · Pull Request #3859 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

chore: separate install docs #3859

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.

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 13 commits into from
Sep 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You can modify the installation process by including flags. Run the help command
curl -L https://coder.com/install.sh | sh -s -- --help
```

> See [install](docs/install.md) for additional methods.
> See [install](docs/install) for additional methods.

Once installed, you can start a production deployment<sup>1</sup> with a single command:

Expand Down
15 changes: 12 additions & 3 deletions coder.env
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
# Run "coder server --help" for flag information.
# Coder must be reachable from an external URL
# for users and workspaces to connect.

# Option 1) Enable CODER_TUNNEL to generate a
# unique *. try.coder.com access URL
CODER_TUNNEL=false

# Option 2) Set an access URL
# e.g. https://coder.example.com
CODER_ACCESS_URL=

CODER_ADDRESS=
CODER_PG_CONNECTION_URL=
CODER_TLS_CERT_FILE=
CODER_TLS_ENABLE=
CODER_TLS_KEY_FILE=
# Generate a unique *.try.coder.app access URL
CODER_TUNNEL=false

# Run "coder server --help" for flag information.
File renamed without changes.
38 changes: 30 additions & 8 deletions docs/install/configure.md → docs/admin/configure.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,27 @@
# Configure

This article documents the Coder server's primary configuration variables. For a full list
Coder server's primary configuration is done via environment variables. For a full list
of the options, run `coder server --help` on the host.

Once you've [installed](../ 10000 install.md) Coder, you can configure the server by setting the following
variables in `/etc/coder.d/coder.env`:
## Tunnel

For proof-of-concept deployments, you can set `CODER_TUNNEL=true` to run Coder on a unique `*.try.coder.app` URL.
This is a quick way to allow users and workspaces outside your LAN to connect to Coder.

## Access URL

`CODER_ACCESS_URL` is required if you are not using the tunnel. Set this to the external URL
that users and workspaces use to connect to Coder (e.g. https://coder.example.com). This
should not be localhost.

## PostgreSQL Database

Coder uses a PostgreSQL database to store users, workspace metadata, and other deployment information.
Use `CODER_PG_CONNECTION_URL` to set the database that Coder connects to. If unset, PostgreSQL binaries will be
downloaded from Maven (https://repo1.maven.org/maven2) and store all data in the config root.

## System packages

If you've installed Coder via a [system package](../install/packages.md) Coder, you can
configure the server by setting the following variables in `/etc/coder.d/coder.env`:

```sh
# String. Specifies the external URL (HTTP/S) to access Coder.
Expand Down Expand Up @@ -32,17 +49,22 @@ CODER_TLS_CERT_FILE=
CODER_TLS_KEY_FILE=
```

## Run Coder

Now, run Coder as a system service on the host:
To run Coder as a system service on the host:

```sh
# Use systemd to start Coder now and on reboot
sudo systemctl enable --now coder

# View the logs to ensure a successful start
journalctl -u coder.service -b
```

To restart Coder after applying system changes:

```sh
sudo systemctl restart Coder
```

## Up Next

- [Get started using Coder](../quickstart.md).
Expand Down
5 changes: 5 additions & 0 deletions docs/admin/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Get started with Coder administration:

<children>
This page is rendered on https://coder.com/docs/coder-oss/admin. Refer to the other documents in the `admin/` directory.
</children>
2 changes: 1 addition & 1 deletion docs/install/upgrade.md → docs/admin/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This article walks you through how to upgrade your Coder server.
</blockquote>

To upgrade your Coder server, simply reinstall Coder using your original method
of [install](../install.md).
of [install](../install).

## Via install.sh

Expand Down
File renamed without changes.
265 changes: 0 additions & 265 deletions docs/install.md

This file was deleted.

Loading
0