You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/faqs.md
+21-63Lines changed: 21 additions & 63 deletions
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,7 @@ Frequently asked questions on Coder OSS and Enterprise deployments. These FAQs
4
4
come from our community and enterprise customers, feel free to
5
5
[contribute to this page](https://github.com/coder/coder/edit/main/docs/faqs.md).
6
6
7
-
<detailsstyle="margin-bottom: 28px;">
8
-
<summarystyle="font-size: larger; font-weight: bold;">How do I add an enterprise license?</summary>
7
+
### How do I add an enterprise license?
9
8
10
9
Visit https://coder.com/trial or contact
11
10
[sales@coder.com](mailto:sales@coder.com?subject=License) to get a v2 enterprise
@@ -32,10 +31,8 @@ If the license is in a file:
32
31
coder licenses add -f <path/filename>
33
32
```
34
33
35
-
</details>
36
34
37
-
<detailsstyle="margin-bottom: 28px;">
38
-
<summarystyle="font-size: larger; font-weight: bold;">I'm experiencing networking issues, so want to disable Tailscale, STUN, Direct connections and force use of websockets</summary>
35
+
### I'm experiencing networking issues, so want to disable Tailscale, STUN, Direct connections and force use of websockets
39
36
40
37
The primary developer use case is a local IDE connecting over SSH to a Coder
<summarystyle="font-size: larger; font-weight: bold;">How do I hide some of the default icons in a workspace like VS Code Desktop, Terminal, SSH, Ports?</summary>
70
+
### How do I hide some of the default icons in a workspace like VS Code Desktop, Terminal, SSH, Ports?
78
71
79
72
The visibility of Coder apps is configurable in the template. To change the
80
73
default (shows all), add this block inside the
@@ -93,10 +86,8 @@ of a template and configure as needed:
93
86
94
87
This example will hide all built-in coder_app icons except the web terminal.
95
88
96
-
</details>
97
89
98
-
<detailsstyle="margin-bottom: 28px;">
99
-
<summarystyle="font-size: larger; font-weight: bold;">I want to allow code-server to be accessible by other users in my deployment.</summary>
90
+
### I want to allow code-server to be accessible by other users in my deployment.
100
91
101
92
> It is **not** recommended to share a web IDE, but if required, the following
102
93
> deployment environment variable settings are required.
<summary style="font-size: larger; font-weight: bold;">I installed Coder and created a workspace but the icons do not load.</summary>
121
+
### I installed Coder and created a workspace but the icons do not load.
133
122
134
123
An important concept to understand is that Coder creates workspaces which have
135
124
an agent that must be able to reach the `coder server`.
@@ -153,10 +142,8 @@ coder server --access-url http://localhost:3000 --address 0.0.0.0:3000
153
142
> Even `coder server` which creates a reverse proxy, will let you use
154
143
> http://localhost to access Coder from a browser.
155
144
156
-
</details>
157
145
158
-
<details style="margin-bottom: 28px;">
159
-
<summary style="font-size: larger; font-weight: bold;">I updated a template, and an existing workspace based on that template fails to start.</summary>
146
+
### I updated a template, and an existing workspace based on that template fails to start.
160
147
161
148
When updating a template, be aware of potential issues with input variables. For
162
149
example, if a template prompts users to choose options like a
@@ -176,10 +163,8 @@ potentially saving the workspace from a failed status.
176
163
coder update --always-prompt <workspace name>
177
164
```
178
165
179
-
</details>
180
166
181
-
<details style="margin-bottom: 28px;">
182
-
<summary style="font-size: larger; font-weight: bold;">I'm running coder on a VM with systemd but latest release installed isn't showing up.</summary>
167
+
### I'm running coder on a VM with systemd but latest release installed isn't showing up.
183
168
184
169
Take, for example, a Coder deployment on a VM with a 2 shared vCPU systemd
185
170
service. In this scenario, it's necessary to reload the daemon and then restart
@@ -194,10 +179,8 @@ sudo systemctl daemon-reload
194
179
sudo systemctl restart coder.service
195
180
```
196
181
197
-
</details>
198
182
199
-
<details style="margin-bottom: 28px;">
200
-
<summary style="font-size: larger; font-weight: bold;">I'm using the built-in Postgres database and forgot admin email I set up.</summary>
183
+
### I'm using the built-in Postgres database and forgot admin email I set up.
201
184
202
185
1. Run the `coder server` command below to retrieve the `psql` connection URL
203
186
which includes the database user and password.
@@ -210,10 +193,8 @@ coder server postgres-builtin-url
<summary style="font-size: larger; font-weight: bold;">How to find out Coder's latest Terraform provider version?</summary>
197
+
### How to find out Coder's latest Terraform provider version?
217
198
218
199
[Coder is on the HashiCorp's Terraform registry](https://registry.terraform.io/providers/coder/coder/latest).
219
200
Check this frequently to make sure you are on the latest version.
@@ -222,10 +203,8 @@ Sometimes, the version may change and `resource` configurations will either
222
203
become deprecated or new ones will be added when you get warnings or errors
223
204
creating and pushing templates.
224
205
225
-
</details>
226
206
227
-
<details style="margin-bottom: 28px;">
228
-
<summary style="font-size: larger; font-weight: bold;">How can I set up TLS for my deployment and not create a signed certificate?</summary>
207
+
### How can I set up TLS for my deployment and not create a signed certificate?
229
208
230
209
Caddy is an easy-to-configure reverse proxy that also automatically creates
231
210
certificates from Let's Encrypt.
@@ -250,10 +229,8 @@ coder.example.com {
250
229
}
251
230
```
252
231
253
-
</details>
254
232
255
-
<details style="margin-bottom: 28px;">
256
-
<summary style="font-size: larger; font-weight: bold;">I'm using Caddy as my reverse proxy in front of Coder. How do I set up a wildcard domain for port forwarding?</summary>
233
+
### I'm using Caddy as my reverse proxy in front of Coder. How do I set up a wildcard domain for port forwarding?
257
234
258
235
Caddy requires your DNS provider's credentials to create wildcard certificates.
259
236
This involves building the Caddy binary
@@ -283,10 +260,8 @@ The updated Caddyfile configuration will look like this:
283
260
}
284
261
```
285
262
286
-
</details>
287
263
288
-
<details style="margin-bottom: 28px;">
289
-
<summary style="font-size: larger; font-weight: bold;">Can I use local or remote Terraform Modules in Coder templates?</summary>
264
+
### Can I use local or remote Terraform Modules in Coder templates?
290
265
291
266
One way is to reference a Terraform module from a GitHub repo to avoid
292
267
duplication and then just extend it or pass template-specific
- [IntelliJ IDEA with Icon](https://github.com/sharkymark/v2-templates/tree/main/pod-idea-icon)
390
-
</details>
391
359
392
-
<details style="margin-bottom: 28px;">
393
-
<summary style="font-size: larger; font-weight: bold;">What options do I have for adding VS Code extensions into code-server, VS Code Desktop or Microsoft's Code Server?</summary>
360
+
### What options do I have for adding VS Code extensions into code-server, VS Code Desktop or Microsoft's Code Server?
394
361
395
362
Coder has an open-source project called
396
363
[`code-marketplace`](https://github.com/coder/code-marketplace) which is a
<summary style="font-size: larger; font-weight: bold;">Why am I getting this "remote host doesn't meet VS Code Server's prerequisites" error when opening up VSCode remote in a Linux environment?</summary>
482
+
### Why am I getting this "remote host doesn't meet VS Code Server's prerequisites" error when opening up VSCode remote in a Linux environment?
522
483
523
484

524
485
@@ -529,10 +490,8 @@ image or supported OS for the VS Code Server. For more information on OS
529
490
prerequisites for Linux, please look at the VSCode docs.
0 commit comments