@@ -3,10 +3,8 @@ title: "Local preview"
3
3
description : Set up a Coder deployment locally for testing.
4
4
---
5
5
6
- Docker
7
-
8
- Coder is typically deployed to a remote datacenter but [ Docker] [ docker-url ] can
9
- be used to create a lightweight preview deployment of Coder.
6
+ Coder is typically deployed to a remote data center, but you can use
7
+ [ Docker] [ docker-url ] to create a lightweight preview deployment of Coder.
10
8
11
9
> Coder currently supports local preview only on workstations running macOS or
12
10
> Linux.
@@ -66,16 +64,16 @@ We are working on bringing Dev URL support to local previews in later releases.
66
64
67
65
### SSH
68
66
69
- With kind, SSH is not configured to run by default.
67
+ When using kind for your local preview , SSH is not configured to run by default.
70
68
71
- With Docker Desktop, SSH will work as long as your machine does not have an
72
- existing SSH server running on port 22 .
69
+ When using Docker Desktop for your local preview , SSH works as long as your
70
+ machine does not have an existing SSH server running on port ` 22 ` .
73
71
74
72
### Air-gapped clusters
75
73
76
74
The local preview option does not work in an air-gapped deployment.
77
75
78
- ## Option 1) Kind
76
+ ## Option 1: Kind
79
77
80
78
To install Coder, run:
81
79
@@ -106,31 +104,31 @@ Password: yfu...yu2
106
104
Visit the URL, and log in using the provided credentials. The platform is
107
105
automatically configured for you, so there's no first-time setup to do.
108
106
109
- ## Option 2) Docker Desktop
107
+ ## Option 2: Docker Desktop
110
108
111
109
[ Docker Desktop] ( docker-desktop-url ) includes a standalone Kubernetes server and
112
- client, which can be used to run Coder.
110
+ client that you can use to run Coder.
111
+
112
+ 1 . [ Enable the Kubernetes cluster] ( docker-k8s-docs ) inside Docker.
113
113
114
- 1 . Follow [ Docker's docs] ( docker-k8s-docs ) to enable the Kubernetes cluster
115
- 1 . Ensure Docker has enough resources allocated to meet
114
+ 1 . Ensure that Docker has enough resources allocated to meet
116
115
[ Coder's requirements] ( https://coder.com/docs/coder/v1.20/setup/requirements )
117
- in Docker preferences
116
+ (you can do so by going to Docker preferences).
118
117
119
118
![ Docker Desktop Resources] ( ../../assets/setup/docker-desktop-resources.png )
120
119
121
120
1 . Install [ metrics-server] ( https://github.com/kubernetes-sigs/metrics-server )
122
- for Coder to get valid metrics from your cluster
121
+ so that Coder gets valid metrics from your cluster:
123
122
124
123
``` console
125
124
helm repo add bitnami https://charts.bitnami.com/bitnami
126
125
```
127
126
128
- 1 . Proceed to our [ install docs] ( ../installation ) to install Coder on your
129
- cluster
127
+ 1 . [ Install Coder] ( ../installation ) on to your cluster.
130
128
131
129
If you run into ` OutOfmemory ` errors when installing, try increasing your
132
- resource allocation in Docker. If that fails install Coder with the following
133
- helm values:
130
+ resource allocation in Docker. If increasing the resource allocation doesn't fix
131
+ the error, reinstall Coder using the following Helm values:
134
132
135
133
``` console
136
134
helm upgrade --install coder \
0 commit comments