docs: add upgrade page & update getting started (#3439)

2026-09-24 15:04:27 +08:00 · 2022-08-10 17:56:21 -05:00
parent 5d40b1f0f4
commit 272962cfae
6 changed files with 122 additions and 16 deletions
@@ -0,0 +1,50 @@
+# Configure
+
+This article documents the Coder server's primary configuration variables. For a full list
+of the options, run `coder server --help` on the host.
+
+Once you've [installed](../install.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. Consumes $CODER_ACCESS_URL
+CODER_ACCESS_URL=https://coder.example.com
+
+# String. Address to serve the API and dashboard. Consumes $CODER_ADDRESS (default "127.0.0.1:3000")
+CODER_ADDRESS=127.0.0.1:3000
+
+# String. The URL of a PostgreSQL database to connect to. If empty, PostgreSQL binaries
+# will be downloaded from Maven (https://repo1.maven.org/maven2) and store all
+# data in the config root. Access the built-in database with "coder server postgres-builtin-url".
+# Consumes $CODER_PG_CONNECTION_URL.
+CODER_PG_CONNECTION_URL=""
+
+# Boolean. Specifies if TLS will be enabled. Consumes $CODER_TLS_ENABLE.
+CODER_TLS_ENABLE=
+
+# Specifies the path to the certificate for TLS. It requires a PEM-encoded file.
+# To configure the listener to use a CA certificate, concatenate the primary
+# certificate and the CA certificate together. The primary certificate should
+# appear first in the combined file. Consumes $CODER_TLS_CERT_FILE.
+CODER_TLS_CERT_FILE=
+
+# Specifies the path to the private key for the certificate. It requires a
+# PEM-encoded file. Consumes $CODER_TLS_KEY_FILE.
+CODER_TLS_KEY_FILE=
+```
+
+## Run Coder
+
+Now, 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
+```
+
+## Up Next
+
+- [Get started using Coder](./quickstart.md).
+- [Learn how to upgrade Coder](./upgrade.md).
@@ -0,0 +1,39 @@
+# Upgrade
+
+This article walks you through how to upgrade your Coder server.
+
+To upgrade your Coder server, simply reinstall Coder using your original method
+of [install](../install.md).
+
+<blockquote class="danger">
+  <p>
+  Prior to upgrading a production Coder deployment, take a database snapshot since
+  Coder does not support rollbacks.
+  </p>
+</blockquote>
+
+## Via install.sh
+
+If you installed Coder using the `install.sh` script, simply re-run the below
+command on the host:
+
+```console
+curl -L https://coder.com/install.sh | sh
+```
+
+The script will unpack the new `coder` binary version over the one currently installed.
+Next, you can restart Coder with the following command (if running it as a system
+service):
+
+```console
+systemctl restart coder
+```
+
+## Via docker-compose
+
+If you installed using `docker-compose`, run the below command to upgrade the
+Coder container:
+
+```console
+docker-compose pull coder && docker-compose up coder -d
+```