Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.
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 admin/access-control/password-reset.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ cemanager's **reset-admin-password** command.

To reset the password, run the following in the terminal:

```bash
```console
# get any cemanager pod
kubectl get pods | grep cemanager- | awk '{print $1}' | head -n1

Expand Down
4 changes: 2 additions & 2 deletions admin/environment-management/cvms.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ the following parameters:

You can also provide `latest` instead of specific version numbers. For example:

```bash
```console
gcloud beta container clusters create "YOUR_NEW_CLUSTER" \
--node-version "latest" \
--cluster-version "latest" \
Expand Down Expand Up @@ -82,7 +82,7 @@ and updating your `eksctl` config spec.

2. Create your nodegroup (be sure to provide the correct file name):

```bash
```console
eksctl create nodegroup --config-file=coder-node.yaml
```

Expand Down
8 changes: 4 additions & 4 deletions cli/file-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ local machine and Coder environment.

1. To establish a one-way directory sync to a remote environment:

```bash
```console
coder sync [local directory] [<env name>:<remote directory>]
```

Expand All @@ -27,7 +27,7 @@ local machine and Coder environment.
To sync your local directory **~/Projects/cdr/coder-cli** to **coder-cli** in
the home directory of your environment:

```bash
```console
$ coder sync ~/Projects/cdr/coder-cli my-env:coder-cli
2020-05-19 17:57:40 INFO doing initial sync (~/Projects/cdr/coder-cli -> coder-cli)
2020-05-19 17:57:41 SUCCESS finished initial sync (878ms)
Expand All @@ -45,7 +45,7 @@ help ensure your project is in the same state no matter where you make changes.

1. Log into Coder and configure your local SSH client:

```bash
```console
$ coder login https://coder.yourcompany.com
2020-10-20 11:16:29 SUCCESS Logged in.
$ coder config-ssh
Expand All @@ -61,7 +61,7 @@ help ensure your project is in the same state no matter where you make changes.
session. Note that the folder must exist on the remote server before you
begin this step:

```bash
```console
$ cd ~/my-project
$ coder envs ls
Name ImageTag CPUCores MemoryGB DiskGB GPUs Updating Status
Expand Down
4 changes: 2 additions & 2 deletions cli/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Download releases [from Github](https://github.com/cdr/coder-cli/releases):

Once you've installed the CLI, authenticate the client with your Coder account.

```bash
```console
coder login [https://coder.domain.com]
```

Expand All @@ -51,7 +51,7 @@ such as in CI/CD pipelines, the Coder CLI can also be authenticated with the

Generate a static authentication token with the following command:

```bash
```console
coder tokens create my-token
```

Expand Down
4 changes: 2 additions & 2 deletions environments/personalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ instructions in your `~/personalize` script. Whenever Coder rebuilds your
environment, it runs your `~/personalize` script, installs `fish`, and changes
the default shell.

```bash
```console
#!/bin/bash

echo "--Starting personalize"
Expand All @@ -44,7 +44,7 @@ sudo chsh -s /usr/bin/fish $USER

The following is a more extensive example of a `~/personalize` script:

```bash
```console
#!/bin/bash

###########################################################################
Expand Down
4 changes: 2 additions & 2 deletions environments/ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Before using, configuring, and accessing your environment via SSH:
You can access your environments via SSH by configuring your local machine as
follows:

```bash
```console
$ coder config-ssh

An auto-generated ssh config was written to "/Users/yourName/.ssh/config"
Expand Down Expand Up @@ -49,6 +49,6 @@ To do so, use the flag `-e "coder sh"` in your `rsync` transfer invokation. For
example, the following shows how you can transfer your home directory to your
environment:

```bash
```console
rsync -e "coder sh" -a --progress ~/. my-env:~
```
2 changes: 1 addition & 1 deletion environments/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ contextual information about your environment.
To obtain a list of environment variables and their values, launch the
**Terminal** via the Coder Dashboard and run:

```bash
```console
env | grep CODER_
```

Expand Down
4 changes: 2 additions & 2 deletions guides/admin/helm-charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Coder's helm chart.

1. Get a copy of your existing helm chart and save it as `values.yaml`

```bash
```console
helm show values coder/coder > values.yaml
```

Expand All @@ -28,7 +28,7 @@ Coder's helm chart.
replace the placeholder value in the following command with your Coder
version):

```bash
```console
helm upgrade coder coder/coder -n coder --version=<VERSION> -f values.yaml
```

Expand Down
8 changes: 4 additions & 4 deletions guides/customization/custom-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,11 +128,11 @@ Docker registry. To do so, run the following command in the directory where your
Dockerfile is located (be sure to replace the placeholder values with your tag
and repository name so that the image is pushed to the appropriate location):

```bash
```console
docker build -t coderenterprise/react .
```

```bash
```console
docker push coderenterprise/react
```

Expand Down Expand Up @@ -174,7 +174,7 @@ creators.
To do this, go to the **Environments** page of your Coder deployment and click
**Terminal**. Run the following to create the skeleton for your application:

```bash
```console
npx create-react-app coder-app
```

Expand All @@ -189,7 +189,7 @@ development server so that you can preview the changes you make to your project.
You can switch into your app's directory and start the React development server
(which listens on port 3000) using the Coder deployment's Terminal:

```bash
```console
cd coder-app
yarn start
```
Expand Down
8 changes: 4 additions & 4 deletions guides/deployments/nightly-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ automatically prune old nightly releases, so you'll see a maximum of 100
entries. The easiest way to view the
[index](https://helm-nightly.coder.com/index.yaml) is to obtain it using curl:

```bash
```console
$ curl https://helm-nightly.coder.com/index.yaml

apiVersion: v1
Expand Down Expand Up @@ -64,7 +64,7 @@ crucial that you provide the entire version string to us.
For automation purposes, you can use the following one-liner to get the current
nightly version:

```bash
```console
# Requires curl, yq, jq
$ curl -sS https://helm-nightly.coder.com/index.yaml \
| yq r --tojson - \
Expand All @@ -77,15 +77,15 @@ $ curl -sS https://helm-nightly.coder.com/index.yaml \

1. Add the Helm repo (if you haven't already):

```bash
```console
$ helm repo add coder-nightly https://helm-nightly.coder.com
"coder-nightly" has been added to your repositories
```

1. Install a specific version to the coder namespace (be sure to
backup your database before running the following command):

```bash
```console
$ helm upgrade --namespace coder coder coder-nightly/coder \
--version <VERSION> --atomic --install

Expand Down
20 changes: 10 additions & 10 deletions guides/deployments/teardown.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,25 @@ Coder services but retains environments and their associated disk space.

1. Make sure you're running `eksctl` version 0.37.0 or later:

```bash
```console
eksctl version
```

1. List all of the services in your cluster:

```bash
```console
kubectl get svc --all-namespaces
```

1. Delete any services that have an `EXTERNAL-IP` value in your namespace:

```bash
```console
kubectl delete svc <service-name>
```

1. Delete the cluster and its underlying nodes:

```bash
```console
eksctl delete cluster --name <prod>
```

Expand All @@ -42,19 +42,19 @@ Coder services but retains environments and their associated disk space.
1. Make sure that the environment variable for `RESOURCE_GROUP` is set to the
one you want to delete in Azure:

```bash
```console
echo $RESOURCE_GROUP
```

If the variable is incorrect, fix it by setting it to the proper value:

```bash
```console
RESOURCE_GROUP="<MY_RESOURCE_GROUP_NAME>"
```

1. Delete the cluster:

```bash
```console
az group delete --resource-group $RESOURCE_GROUP
```

Expand All @@ -63,22 +63,22 @@ Coder services but retains environments and their associated disk space.
1. Ensure that the environment variables for `PROJECT_ID` and `CLUSTER_NAME` are
set to those for the cluster you want to delete:

```bash
```console
echo $PROJECT_ID
echo $CLUSTER_NAME
```

If these values are incorrect, you can fix this by providing the proper
names:

```bash
```console
PROJECT_ID="<MY_RESOURCE_GROUP_NAME>" \
CLUSTER_NAME="<MY_CLUSTER_NAME>"
```

1. Delete the cluster:

```bash
```console
gcloud beta container --project $PROJECT_ID clusters delete \
$CLUSTER_NAME --zone <zone>
```
8 changes: 4 additions & 4 deletions guides/mobile-development/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ developed remotely on Coder.

1. Start the Android Debug Server on port 5555:

```bash
```console
$ $ANDROID_SDK_PATH/platform-tools/adb tcpip 5555
restarting in TCP mode port: 5555
```
Expand All @@ -46,22 +46,22 @@ developed remotely on Coder.

1. Forward your Android Debug Server to the remote environment:

```bash
```console
# You must have the Coder CLI installed.
$ coder config-ssh
$ ssh -R 5555:127.0.0.1:5555 coder.<NAME_OF_YOUR_ENVIRONMENT>
```

1. Run `adb devices` to view the emulators forwarded from your local machine:

```bash
```console
$ adb devices
List of devices attached
emulator-5556
```

1. Build and run your Android applications remotely:

```bash
```console
./gradlew android:installDebug
```
6 changes: 3 additions & 3 deletions guides/ssl-certificates/cloudflare.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You must have:

## Step 1: Add cert-manager to Your Kubernetes Cluster

```bash
```console
# Kubernetes 1.16+
$ kubectl apply --validate=false -f \
https://github.com/jetstack/cert-manager/releases/download/v1.0.1/cert-manager.yaml
Expand All @@ -41,7 +41,7 @@ https://github.com/jetstack/cert-manager/releases/download/v1.0.1/cert-manager-l
Once you've started the installation process, you can verify that all the pods
are running:

```bash
```console
$ kubectl get pods -n cert-manager

NAME READY STATUS RESTARTS AGE
Expand Down Expand Up @@ -144,7 +144,7 @@ Issuers](https://docs.cert-manager.io/en/release-0.8/tasks/issuers/index.html).
Read the comments and fill out the blanks. Once you're done, you can go ahead
and apply that to your cluster using:

```bash
```console
$ kubectl apply -f issuer.yaml

secret/cloudflare-api-key-secret created
Expand Down
6 changes: 3 additions & 3 deletions images/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Using the text editor of your choice, create a file named `configure` and add
the instructions that you want included. For example, the following file shows
how you can clone a repo at build time:

```bash
```console
#!/bin/bash
if [ ! -d "/home/coder/workspace/project" ]
then
Expand Down Expand Up @@ -69,13 +69,13 @@ Dockerfile is located (be sure to replace the cdr/config placeholder value with
your tag and repository name so that the image is pushed to the appropriate
location):

```bash
```console
docker build cdr/config .
```

Once you've built the image, push the image to the Docker registry:

```bash
```console
docker push cdr/config
```

Expand Down
Loading