@@ -4,8 +4,8 @@ description: Set up a Coder deployment locally for testing.
4
4
---
5
5
6
6
Coder is typically deployed onto Kubernetes cluster, but if you would like to
7
- set up a lightweight preview deployment, you can do so locally using using [ URL ]
8
- and [ URL ] .
7
+ set up a lightweight preview deployment, you can do so locally using using
8
+ [ Docker ] [ docker-url ] and [ kind ] [ kind-url ] .
9
9
10
10
> Coder currently supports local preview only on workstations running macOS or
11
11
> Linux.
@@ -31,8 +31,9 @@ deployment running entirely inside a Docker container.
31
31
32
32
### CVMs
33
33
34
- The local preview supports [ URL] if you meet the following requirements (if you
35
- choose not to try out CVMs, these requirements do not apply):
34
+ The local preview supports [ CVMs] [ cvm-url ] if you meet the following
35
+ requirements (if you choose not to try out CVMs, these requirements do not
36
+ apply):
36
37
37
38
1 . Your Linux hosts must be running Linux Kernel 5 and above.
38
39
@@ -49,14 +50,15 @@ choose not to try out CVMs, these requirements do not apply):
49
50
linux linux-headers-5.11.4-arch1-1
50
51
```
51
52
52
- 1 . Docker Desktop for Mac ** must** use version [ URL ] . This specific version is
53
- required because of a recent downgrade to Linux Kernel 4.9 due to a
54
- [ bug] ( docker-bug-url ) .
53
+ 1 . Docker Desktop for Mac ** must** use version [ 2.5.0.1 ] [ docker-mac-url ] . This
54
+ specific version is required because of a recent downgrade to Linux Kernel
55
+ 4.9 due to a [ bug] [ docker-bug-url ] .
55
56
56
57
### Dev URLs
57
58
58
- The local preview doesn't support [ dev URL] by default. Instead, you can use
59
- tools like [ URL] to preview webpages from inside a workspace.
59
+ The local preview doesn't support [ dev URLs] ( ../workspaces/devurls ) by default.
60
+ Instead, you can use tools like [ ngrok] [ ngrok-url ] to preview webpages from
61
+ inside a workspace.
60
62
61
63
To enable local dev URLs, follow
62
64
[ the instructions below] ( #enable-local-dev-urls ) after installing Coder.
@@ -99,7 +101,7 @@ automatically configured for you, so there's no first-time setup to do.
99
101
## Enable local dev URLs
100
102
101
103
A wildcard subdomain is required to use dev URLs with Coder. One option is to
102
- use a service such as [ nip.io] ( nip-url ) to route domains local IP.
104
+ use a service such as [ nip.io] [ nip-url ] to route domains local IP.
103
105
104
106
[ Update Coder] ( https://coder.com/docs/coder/latest/setup/updating#update-coder )
105
107
with the following helm values added for either your local (127.0.0.1) or
@@ -112,7 +114,7 @@ devurls:
112
114
host : " *.127.0.0.1.nip.io"
113
115
` ` `
114
116
115
- Alternatively, [dnsmasq]( dnsmasq-url) can be used to create local domains (e.g
117
+ Alternatively, [dnsmasq][ dnsmasq-url] can be used to create local domains (e.g
116
118
` http://dashboard.coder` and `http://*.coder`). This may be useful if you do not
117
119
want to rely on an external service/network, or if your network has DNS
118
120
rebinding protection. Here's how :
@@ -162,9 +164,8 @@ rebinding protection. Here's how:
162
164
nameserver 127.0.0.1
163
165
` ` `
164
166
165
- 1. To use the new domains,
166
- [update Coder](https://coder.com/docs/coder/latest/setup/updating#update-coder)
167
- with these helm values added :
167
+ 1. To use the new domains, [update Coder](../updating#update-coder) with these
168
+ helm values added :
168
169
169
170
` ` ` yaml
170
171
ingress:
@@ -184,7 +185,7 @@ curl -fsSL https://coder.com/try.sh | sh -s -- down
184
185
Because Coder runs inside Docker, you should have nothing left on your machine
185
186
after tear down.
186
187
187
- If you added custom DNS for [local dev URLs](enable-local-dev-urls), you can
188
+ If you added custom DNS for [local dev URLs](# enable-local-dev-urls), you can
188
189
revert these changes by uninstalling dnsmasq and removing the resolver config :
189
190
190
191
` ` ` console
0 commit comments