Skip to content

Commit cabfafa

Browse files
committed
replace FAQ twisties with h3s
1 parent 426e9f2 commit cabfafa

File tree

1 file changed

+21
-63
lines changed

1 file changed

+21
-63
lines changed

docs/faqs.md

Lines changed: 21 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ Frequently asked questions on Coder OSS and Enterprise deployments. These FAQs
44
come from our community and enterprise customers, feel free to
55
[contribute to this page](https://github.com/coder/coder/edit/main/docs/faqs.md).
66

7-
<details style="margin-bottom: 28px;">
8-
<summary style="font-size: larger; font-weight: bold;">How do I add an enterprise license?</summary>
7+
### How do I add an enterprise license?
98

109
Visit https://coder.com/trial or contact
1110
[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:
3231
coder licenses add -f <path/filename>
3332
```
3433

35-
</details>
3634

37-
<details style="margin-bottom: 28px;">
38-
<summary style="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
3936

4037
The primary developer use case is a local IDE connecting over SSH to a Coder
4138
workspace.
@@ -62,19 +59,15 @@ troubleshooting.
6259
| [`CODER_DERP_SERVER_STUN_ADDRESSES`](https://coder.com/docs/v2/latest/cli/server#--derp-server-stun-addresses) | `"disable"` | Disables STUN |
6360
| [`CODER_DERP_FORCE_WEBSOCKETS`](https://coder.com/docs/v2/latest/cli/server#--derp-force-websockets) | `true` | Forces websockets over Tailscale DERP |
6461

65-
</details>
6662

67-
<details style="margin-bottom: 28px;">
68-
<summary style="font-size: larger; font-weight: bold;">How do I configure NGINX as the reverse proxy in front of Coder?</summary>
63+
### How do I configure NGINX as the reverse proxy in front of Coder?
6964

7065
[This doc](https://github.com/coder/coder/tree/main/examples/web-server/nginx#configure-nginx)
7166
in our repo explains in detail how to configure NGINX with Coder so that our
7267
Tailscale Wireguard networking functions properly.
7368

74-
</details>
7569

76-
<details style="margin-bottom: 28px;">
77-
<summary style="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?
7871

7972
The visibility of Coder apps is configurable in the template. To change the
8073
default (shows all), add this block inside the
@@ -93,10 +86,8 @@ of a template and configure as needed:
9386

9487
This example will hide all built-in coder_app icons except the web terminal.
9588

96-
</details>
9789

98-
<details style="margin-bottom: 28px;">
99-
<summary style="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.
10091

10192
> It is **not** recommended to share a web IDE, but if required, the following
10293
> deployment environment variable settings are required.
@@ -126,10 +117,8 @@ resource "coder_app" "code-server" {
126117
}
127118
```
128119

129-
</details>
130120

131-
<details style="margin-bottom: 28px;">
132-
<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.
133122

134123
An important concept to understand is that Coder creates workspaces which have
135124
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
153142
> Even `coder server` which creates a reverse proxy, will let you use
154143
> http://localhost to access Coder from a browser.
155144

156-
</details>
157145

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.
160147

161148
When updating a template, be aware of potential issues with input variables. For
162149
example, if a template prompts users to choose options like a
@@ -176,10 +163,8 @@ potentially saving the workspace from a failed status.
176163
coder update --always-prompt <workspace name>
177164
```
178165

179-
</details>
180166

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.
183168

184169
Take, for example, a Coder deployment on a VM with a 2 shared vCPU systemd
185170
service. In this scenario, it's necessary to reload the daemon and then restart
@@ -194,10 +179,8 @@ sudo systemctl daemon-reload
194179
sudo systemctl restart coder.service
195180
```
196181

197-
</details>
198182

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.
201184

202185
1. Run the `coder server` command below to retrieve the `psql` connection URL
203186
which includes the database user and password.
@@ -210,10 +193,8 @@ coder server postgres-builtin-url
210193
psql "postgres://coder@localhost:53737/coder?sslmode=disable&password=I2S...pTk"
211194
```
212195

213-
</details>
214196

215-
<details style="margin-bottom: 28px;">
216-
<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?
217198

218199
[Coder is on the HashiCorp's Terraform registry](https://registry.terraform.io/providers/coder/coder/latest).
219200
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
222203
become deprecated or new ones will be added when you get warnings or errors
223204
creating and pushing templates.
224205

225-
</details>
226206

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?
229208

230209
Caddy is an easy-to-configure reverse proxy that also automatically creates
231210
certificates from Let's Encrypt.
@@ -250,10 +229,8 @@ coder.example.com {
250229
}
251230
```
252231

253-
</details>
254232

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?
257234

258235
Caddy requires your DNS provider's credentials to create wildcard certificates.
259236
This involves building the Caddy binary
@@ -283,10 +260,8 @@ The updated Caddyfile configuration will look like this:
283260
}
284261
```
285262

286-
</details>
287263

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?
290265

291266
One way is to reference a Terraform module from a GitHub repo to avoid
292267
duplication and then just extend it or pass template-specific
@@ -328,10 +303,8 @@ References:
328303
- [Public Github Issue 6117](https://github.com/coder/coder/issues/6117)
329304
- [Public Github Issue 5677](https://github.com/coder/coder/issues/5677)
330305
- [Coder docs: Templates/Change Management](https://coder.com/docs/v2/latest/templates/change-management)
331-
</details>
332306

333-
<details style="margin-bottom: 28px;">
334-
<summary style="font-size: larger; font-weight: bold;">Can I run Coder in an air-gapped or offline mode? (no Internet)?</summary>
307+
### Can I run Coder in an air-gapped or offline mode? (no Internet)?
335308

336309
Yes, Coder can be deployed in air-gapped or offline mode.
337310
https://coder.com/docs/v2/latest/install/offline
@@ -345,10 +318,8 @@ defaults to Google's STUN servers, so you can either create your STUN server in
345318
your network or disable and force all traffic through the control plane's DERP
346319
proxy.
347320

348-
</details>
349321

350-
<details style="margin-bottom: 28px;">
351-
<summary style="font-size: larger; font-weight: bold;">Create a randomized computer_name for an Azure VM</summary>
322+
### Create a randomized computer_name for an Azure VM
352323

353324
Azure VMs have a 15 character limit for the `computer_name` which can lead to
354325
duplicate name errors.
@@ -363,10 +334,8 @@ locals {
363334
}
364335
```
365336

366-
</details>
367337

368-
<details style="margin-bottom: 28px;">
369-
<summary style="font-size: larger; font-weight: bold;">Do you have example JetBrains Gateway templates?</summary>
338+
### Do you have example JetBrains Gateway templates?
370339

371340
In August 2023, JetBrains certified the Coder plugin signifying enhanced
372341
stability and reliability.
@@ -387,10 +356,8 @@ open the IDE.
387356

388357
- [IntelliJ IDEA](https://github.com/sharkymark/v2-templates/tree/main/pod-idea)
389358
- [IntelliJ IDEA with Icon](https://github.com/sharkymark/v2-templates/tree/main/pod-idea-icon)
390-
</details>
391359

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?
394361

395362
Coder has an open-source project called
396363
[`code-marketplace`](https://github.com/coder/code-marketplace) which is a
@@ -416,10 +383,8 @@ https://github.com/sharkymark/v2-templates/blob/main/vs-code-server/main.tf
416383
> Note: these are example templates with no SLAs on them and are not guaranteed
417384
> for long-term support.
418385

419-
</details>
420386

421-
<details style="margin-bottom: 28px;">
422-
<summary style="font-size: larger; font-weight: bold;">I want to run Docker for my workspaces but not install Docker Desktop.</summary>
387+
### I want to run Docker for my workspaces but not install Docker Desktop.
423388

424389
[Colima](https://github.com/abiosoft/colima) is a Docker Desktop alternative.
425390

@@ -454,10 +419,8 @@ Colima will show the path to the docker socket so we have a
454419
[community template](https://github.com/sharkymark/v2-templates/tree/main/docker-code-server)
455420
that prompts the Coder admin to enter the docker socket as a Terraform variable.
456421

457-
</details>
458422

459-
<details style="margin-bottom: 28px;">
460-
<summary style="font-size: larger; font-weight: bold;">How to make a `coder_app` optional?</summary>
423+
### How to make a `coder_app` optional?
461424

462425
An example use case is the user should decide if they want a browser-based IDE
463426
like code-server when creating the workspace.
@@ -515,10 +478,8 @@ resource "coder_app" "code-server" {
515478
}
516479
```
517480

518-
</details>
519481

520-
<details style="margin-bottom: 28px;">
521-
<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?
522483

523484
![VS Code Server prerequisite](https://github.com/coder/coder/assets/10648092/150c5996-18b1-4fae-afd0-be2b386a3239)
524485

@@ -529,10 +490,8 @@ image or supported OS for the VS Code Server. For more information on OS
529490
prerequisites for Linux, please look at the VSCode docs.
530491
https://code.visualstudio.com/docs/remote/linux#_local-linux-prerequisites
531492

532-
</details>
533493

534-
<details style="margin-bottom: 28px;">
535-
<summary style="font-size: larger; font-weight: bold;">How can I resolve disconnects when connected to Coder via JetBrains Gateway?</summary>
494+
### How can I resolve disconnects when connected to Coder via JetBrains Gateway?
536495

537496
If your JetBrains IDE is disconnected for a long period of time due to a network
538497
change (for example turning off a VPN), you may find that the IDE will not
@@ -561,4 +520,3 @@ config file will be overwritten by the JetBrains Gateway client when it
561520
re-authenticates to your Coder deployment so you must add the above config as a
562521
separate block and not add it to any existing ones.
563522

564-
</details>

0 commit comments

Comments
 (0)