Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitd9211b6

Browse files
authored
chore(docs): replace FAQ twisties with h3s (#12859)
* replace FAQ twisties with h3s* make fmt
1 parentcb6fea6 commitd9211b6

File tree

1 file changed

+21
-82
lines changed

1 file changed

+21
-82
lines changed

‎docs/faqs.md

Lines changed: 21 additions & 82 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-
<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?
98

109
Visithttps://coder.com/trial or contact
1110
[sales@coder.com](mailto:sales@coder.com?subject=License) to get a v2 enterprise
@@ -32,10 +31,7 @@ If the license is in a file:
3231
coder licenses add -f<path/filename>
3332
```
3433

35-
</details>
36-
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>
34+
###I'm experiencing networking issues, so want to disable Tailscale, STUN, Direct connections and force use of websockets
3935

4036
The primary developer use case is a local IDE connecting over SSH to a Coder
4137
workspace.
@@ -62,19 +58,13 @@ troubleshooting.
6258
|[`CODER_DERP_SERVER_STUN_ADDRESSES`](https://coder.com/docs/v2/latest/cli/server#--derp-server-stun-addresses)|`"disable"`| Disables STUN|
6359
|[`CODER_DERP_FORCE_WEBSOCKETS`](https://coder.com/docs/v2/latest/cli/server#--derp-force-websockets)|`true`| Forces websockets over Tailscale DERP|
6460

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

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

74-
</details>
75-
76-
<detailsstyle="margin-bottom:28px;">
77-
<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>
67+
###How do I hide some of the default icons in a workspace like VS Code Desktop, Terminal, SSH, Ports?
7868

7969
The visibility of Coder apps is configurable in the template. To change the
8070
default (shows all), add this block inside the
@@ -93,10 +83,7 @@ of a template and configure as needed:
9383

9484
This example will hide all built-in coder_app icons except the web terminal.
9585

96-
</details>
97-
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>
86+
###I want to allow code-server to be accessible by other users in my deployment.
10087

10188
>It is**not** recommended to share a web IDE, but if required, the following
10289
>deployment environment variable settings are required.
@@ -126,10 +113,7 @@ resource "coder_app" "code-server" {
126113
}
127114
```
128115

129-
</details>
130-
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>
116+
### I installed Coder and created a workspace but the icons do not load.
133117

134118
An important concept to understand is that Coder creates workspaces which have
135119
an agent that must be able to reach the `coder server`.
@@ -153,10 +137,7 @@ coder server --access-url http://localhost:3000 --address 0.0.0.0:3000
153137
> Even `coder server` which creates a reverse proxy, will let you use
154138
> http://localhost to access Coder from a browser.
155139

156-
</details>
157-
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>
140+
### I updated a template, and an existing workspace based on that template fails to start.
160141

161142
When updating a template, be aware of potential issues with input variables. For
162143
example, if a template prompts users to choose options like a
@@ -176,10 +157,7 @@ potentially saving the workspace from a failed status.
176157
coder update --always-prompt <workspace name>
177158
```
178159

179-
</details>
180-
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>
160+
### I'm running coder on a VM with systemd but latest release installed isn't showing up.
183161

184162
Take, for example, a Coder deployment on a VM with a 2 shared vCPU systemd
185163
service. In this scenario, it's necessary to reload the daemon and then restart
@@ -194,10 +172,7 @@ sudo systemctl daemon-reload
194172
sudo systemctl restart coder.service
195173
```
196174

197-
</details>
198-
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>
175+
### I'm using the built-in Postgres database and forgot admin email I set up.
201176

202177
1. Run the `coder server` command below to retrieve the `psql` connection URL
203178
which includes the database user and password.
@@ -210,10 +185,7 @@ coder server postgres-builtin-url
210185
psql "postgres://coder@localhost:53737/coder?sslmode=disable&password=I2S...pTk"
211186
```
212187

213-
</details>
214-
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>
188+
### How to find out Coder's latest Terraform provider version?
217189

218190
[Coder is on the HashiCorp's Terraform registry](https://registry.terraform.io/providers/coder/coder/latest).
219191
Check this frequently to make sure you are on the latest version.
@@ -222,10 +194,7 @@ Sometimes, the version may change and `resource` configurations will either
222194
become deprecated or new ones will be added when you get warnings or errors
223195
creating and pushing templates.
224196

225-
</details>
226-
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>
197+
### How can I set up TLS for my deployment and not create a signed certificate?
229198

230199
Caddy is an easy-to-configure reverse proxy that also automatically creates
231200
certificates from Let's Encrypt.
@@ -250,10 +219,7 @@ coder.example.com {
250219
}
251220
```
252221

253-
</details>
254-
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>
222+
### I'm using Caddy as my reverse proxy in front of Coder. How do I set up a wildcard domain for port forwarding?
257223

258224
Caddy requires your DNS provider's credentials to create wildcard certificates.
259225
This involves building the Caddy binary
@@ -283,10 +249,7 @@ The updated Caddyfile configuration will look like this:
283249
}
284250
```
285251

286-
</details>
287-
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>
252+
### Can I use local or remote Terraform Modules in Coder templates?
290253

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

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>
295+
### Can I run Coder in an air-gapped or offline mode? (no Internet)?
335296

336297
Yes, Coder can be deployed in air-gapped or offline mode.
337298
https://coder.com/docs/v2/latest/install/offline
@@ -345,10 +306,7 @@ defaults to Google's STUN servers, so you can either create your STUN server in
345306
your network or disable and force all traffic through the control plane's DERP
346307
proxy.
347308

348-
</details>
349-
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>
309+
### Create a randomized computer_name for an Azure VM
352310

353311
Azure VMs have a 15 character limit for the `computer_name` which can lead to
354312
duplicate name errors.
@@ -363,10 +321,7 @@ locals {
363321
}
364322
```
365323

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

371326
In August 2023, JetBrains certified the Coder plugin signifying enhanced
372327
stability and reliability.
@@ -387,10 +342,8 @@ open the IDE.
387342

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

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>
346+
### What options do I have for adding VS Code extensions into code-server, VS Code Desktop or Microsoft's Code Server?
394347

395348
Coder has an open-source project called
396349
[`code-marketplace`](https://github.com/coder/code-marketplace) which is a
@@ -416,10 +369,7 @@ https://github.com/sharkymark/v2-templates/blob/main/vs-code-server/main.tf
416369
> Note: these are example templates with no SLAs on them and are not guaranteed
417370
> for long-term support.
418371

419-
</details>
420-
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>
372+
### I want to run Docker for my workspaces but not install Docker Desktop.
423373

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

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

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

462409
An example use case is the user should decide if they want a browser-based IDE
463410
like code-server when creating the workspace.
@@ -515,10 +462,7 @@ resource "coder_app" "code-server" {
515462
}
516463
```
517464

518-
</details>
519-
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>
465+
### 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?
522466

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

@@ -529,10 +473,7 @@ image or supported OS for the VS Code Server. For more information on OS
529473
prerequisites for Linux, please look at the VSCode docs.
530474
https://code.visualstudio.com/docs/remote/linux#_local-linux-prerequisites
531475

532-
</details>
533-
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>
476+
### How can I resolve disconnects when connected to Coder via JetBrains Gateway?
536477

537478
If your JetBrains IDE is disconnected for a long period of time due to a network
538479
change (for example turning off a VPN), you may find that the IDE will not
@@ -560,5 +501,3 @@ Note that the JetBrains Gateway configuration blocks for each host in your SSH
560501
config file will be overwritten by the JetBrains Gateway client when it
561502
re-authenticates to your Coder deployment so you must add the above config as a
562503
separate block and not add it to any existing ones.
563-
564-
</details>

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp