docs: make it clear the CLI must be downloaded to use templates (#5373)

This commit is contained in:
sharkymark
2022-12-13 13:31:09 -06:00
committed by GitHub
parent 4fc4c01cea
commit 8df02f42c0
24 changed files with 198 additions and 146 deletions

View File

@ -4,7 +4,7 @@ Coder publishes self-contained .zip and .tar.gz archives in [GitHub releases](ht
1. Unzip the folder you just downloaded, and move the `coder` executable to a location that's on your `PATH`
```sh
```console
# ex. macOS and Linux
mv coder /usr/local/bin
```
@ -13,7 +13,7 @@ Coder publishes self-contained .zip and .tar.gz archives in [GitHub releases](ht
1. Start a Coder server
```sh
```console
# Automatically sets up an external access URL on *.try.coder.app
coder server

View File

@ -22,7 +22,7 @@ CREATE DATABASE coder;
Coder configuration is defined via [environment variables](../admin/configure.md).
The database client requires the connection string provided via the `CODER_PG_CONNECTION_URL` variable.
```sh
```console
export CODER_PG_CONNECTION_URL="postgres://coder:secret42@localhost/coder?sslmode=disable"
```
@ -49,7 +49,7 @@ Once the schema is created, you can list all schemas with `\dn`:
In this case the database client requires the modified connection string:
```sh
```console
export CODER_PG_CONNECTION_URL="postgres://coder:secret42@localhost/coder?sslmode=disable&search_path=myschema"
```
@ -77,7 +77,7 @@ ALTER ROLE coder SET search_path = myschema;
Please make sure that the schema selected in the connection string `...&search_path=myschema` exists
and the role has granted permissions to access it. The schema should be present on this listing:
```sh
```console
psql -U coder -c '\dn'
```

View File

@ -9,7 +9,7 @@ Docker is required. See the [official installation documentation](https://docs.d
For proof-of-concept deployments, you can run a complete Coder instance with
the following command:
```sh
```console
export CODER_DATA=$HOME/.config/coderv2-docker
export DOCKER_GROUP=$(getent group docker | cut -d: -f3)
mkdir -p $CODER_DATA
@ -34,7 +34,7 @@ For production deployments, we recommend using an external PostgreSQL database
(version 13 or higher). Set `ACCESS_URL` to the external URL that users and
workspaces will use to connect to Coder.
```sh
```console
docker run --rm -it \
-e CODER_ACCESS_URL="https://coder.example.com" \
-e CODER_PG_CONNECTION_URL="postgresql://username:password@database/coder" \
@ -64,7 +64,7 @@ an PostgreSQL container and volume.
For proof-of-concept deployments, you can use [Coder's tunnel](../admin/configure.md#tunnel):
```sh
```console
cd coder
docker-compose up
@ -72,7 +72,7 @@ an PostgreSQL container and volume.
For production deployments, we recommend setting an [access URL](../admin/configure.md#access-url):
```sh
```console
cd coder
CODER_ACCESS_URL=https://coder.example.com docker-compose up

View File

@ -34,7 +34,7 @@ to log in and manage templates.
[helpful guides](https://phoenixnap.com/kb/postgresql-kubernetes) on the
internet that explain sensible configurations for this chart. Example:
```sh
```console
# Install PostgreSQL
helm repo add bitnami https://charts.bitnami.com/bitnami
helm install coder-db bitnami/postgresql \
@ -65,7 +65,7 @@ to log in and manage templates.
1. Create a secret with the database URL:
```sh
```console
# Uses Bitnami PostgreSQL example. If you have another database,
# change to the proper URL.
kubectl create secret generic coder-db-url -n coder \
@ -120,7 +120,7 @@ to log in and manage templates.
1. Run the following command to install the chart in your cluster.
```sh
```console
helm install coder coder-v2/coder \
--namespace coder \
--values values.yaml
@ -143,7 +143,7 @@ to log in and manage templates.
To upgrade Coder in the future or change values,
you can run the following command:
```sh
```console
helm repo update
helm upgrade coder coder-v2/coder \
--namespace coder \

View File

@ -105,13 +105,13 @@ Follow our [docker-compose](./docker.md#run-coder-with-docker-compose) documenta
First, make a create an empty plugins directory:
```sh
```console
mkdir $HOME/plugins
```
Next, add a volume mount to docker-compose.yaml:
```sh
```console
vim docker-compose.yaml
```

View File

@ -6,7 +6,7 @@
1. Run Coder as a system service.
```sh
```console
# Optional) Set up an access URL
sudo vim /etc/coder.d/coder.env
@ -23,7 +23,7 @@
1. Visit the Coder URL in the logs to set up your first account, or use the CLI:
```sh
```console
coder login <access-url>
```
@ -31,7 +31,7 @@
After updating Coder or applying configuration changes, restart the server:
```sh
```console
sudo systemctl restart coder
```

View File

@ -14,19 +14,19 @@ rm -rf ~/.cache/coder
Debian, Ubuntu:
```sh
```console
sudo apt remove coder
```
Fedora, CentOS, RHEL, SUSE:
```sh
```console
sudo yum remove coder
```
Alpine:
```sh
```console
sudo apk del coder
```