opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: convert faq headers to dropdowns (#11585)

Browse Source 
* changed FAQs from headers to twists

* added dropdowns and mild formatting

* make fmt
This commit is contained in:
Stephen Kirby
2024-01-12 12:49:41 -06:00
committed by GitHub
parent 162c91ec2a
commit bdefd4e2e6
1 changed files with 92 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/faqs.md
+92 -34
View File
@@ -4,7 +4,8 @@ Frequently asked questions on Coder OSS and Enterprise deployments. These FAQs
come from our community and enterprise customers, feel free to
[contribute to this page](https://github.com/coder/coder/edit/main/docs/faqs.md).
## How do I add an enterprise license?
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">How do I add an enterprise license?</summary>
Visit https://coder.com/trial or contact
[sales@coder.com](mailto:sales@coder.com?subject=License) to get a v2 enterprise
@@ -31,7 +32,10 @@ If the license is in a file:
coder licenses add -f <path/filename>
```
## I'm experiencing networking issues, so want to disable Tailscale, STUN, Direct connections and force use of websockets
</details>
<details style="margin-bottom: 28px;">
<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>
The primary developer use case is a local IDE connecting over SSH to a Coder
workspace.
@@ -58,13 +62,19 @@ troubleshooting.
| [`CODER_DERP_SERVER_STUN_ADDRESSES`](https://coder.com/docs/v2/latest/cli/server#--derp-server-stun-addresses) | `"disable"` | Disables STUN |
| [`CODER_DERP_FORCE_WEBSOCKETS`](https://coder.com/docs/v2/latest/cli/server#--derp-force-websockets) | `true` | Forces websockets over Tailscale DERP |
## How do I configure NGINX as the reverse proxy in front of Coder?
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">How do I configure NGINX as the reverse proxy in front of Coder?</summary>
[This doc](https://github.com/coder/coder/tree/main/examples/web-server/nginx#configure-nginx)
in our repo explains in detail how to configure NGINX with Coder so that our
Tailscale Wireguard networking functions properly.
## How do I hide some of the default icons in a workspace like VS Code Desktop, Terminal, SSH, Ports?
</details>
<details style="margin-bottom: 28px;">
<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>
The visibility of Coder apps is configurable in the template. To change the
default (shows all), add this block inside the
@@ -83,7 +93,10 @@ of a template and configure as needed:
This example will hide all built-in coder_app icons except the web terminal.
## I want to allow code-server to be accessible by other users in my deployment.
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">I want to allow code-server to be accessible by other users in my deployment.</summary>
> It is **not** recommended to share a web IDE, but if required, the following
> deployment environment variable settings are required.
@@ -113,7 +126,10 @@ resource "coder_app" "code-server" {
}
```
## I installed Coder and created a workspace but the icons do not load.
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">I installed Coder and created a workspace but the icons do not load.</summary>
An important concept to understand is that Coder creates workspaces which have
an agent that must be able to reach the `coder server`.
@@ -137,7 +153,10 @@ coder server --access-url http://localhost:3000 --address 0.0.0.0:3000
> Even `coder server` which creates a reverse proxy, will let you use
> http://localhost to access Coder from a browser.
## I updated a template, and an existing workspace based on that template fails to start.
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">I updated a template, and an existing workspace based on that template fails to start.</summary>
When updating a template, be aware of potential issues with input variables. For
example, if a template prompts users to choose options like a
@@ -157,7 +176,10 @@ potentially saving the workspace from a failed status.
coder update --always-prompt <workspace name>
```
## I'm running coder on a VM with systemd but latest release installed isn't showing up.
</details>
<details style="margin-bottom: 28px;">
<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>
Take, for example, a Coder deployment on a VM with a 2 shared vCPU systemd
service. In this scenario, it's necessary to reload the daemon and then restart
@@ -172,7 +194,10 @@ sudo systemctl daemon-reload
sudo systemctl restart coder.service
```
## I'm using the built-in Postgres database and forgot admin email I set up.
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">I'm using the built-in Postgres database and forgot admin email I set up.</summary>
1. Run the `coder server` command below to retrieve the `psql` connection URL
which includes the database user and password.
@@ -185,7 +210,10 @@ coder server postgres-builtin-url
psql "postgres://coder@localhost:53737/coder?sslmode=disable&password=I2S...pTk"
```
## How to find out Coder's latest Terraform provider version?
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">How to find out Coder's latest Terraform provider version?</summary>
[Coder is on the HashiCorp's Terraform registry](https://registry.terraform.io/providers/coder/coder/latest).
Check this frequently to make sure you are on the latest version.
@@ -194,7 +222,10 @@ Sometimes, the version may change and `resource` configurations will either
become deprecated or new ones will be added when you get warnings or errors
creating and pushing templates.
## How can I set up TLS for my deployment and not create a signed certificate?
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">How can I set up TLS for my deployment and not create a signed certificate?</summary>
Caddy is an easy-to-configure reverse proxy that also automatically creates
certificates from Let's Encrypt.
@@ -209,17 +240,20 @@ coder.example.com {
reverse_proxy 127.0.0.1:3000
tls {
tls {
issuer acme {
email user@example.com
}
issuer acme {
email user@example.com
}
}
}
}
```
## I'm using Caddy as my reverse proxy in front of Coder. How do I set up a wildcard domain for port forwarding?
</details>
<details style="margin-bottom: 28px;">
<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>
Caddy requires your DNS provider's credentials to create wildcard certificates.
This involves building the Caddy binary
@@ -235,21 +269,24 @@ The updated Caddyfile configuration will look like this:
```text
*.coder.example.com, coder.example.com {
reverse_proxy 127.0.0.1:3000
reverse_proxy 127.0.0.1:3000
tls {
issuer acme {
email user@example.com
dns googleclouddns {
gcp_project my-gcp-project
}
}
}
tls {
issuer acme {
email user@example.com
dns googleclouddns {
gcp_project my-gcp-project
}
}
}
}
```
## Can I use local or remote Terraform Modules in Coder templates?
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">Can I use local or remote Terraform Modules in Coder templates?</summary>
One way is to reference a Terraform module from a GitHub repo to avoid
duplication and then just extend it or pass template-specific
@@ -291,8 +328,10 @@ References:
- [Public Github Issue 6117](https://github.com/coder/coder/issues/6117)
- [Public Github Issue 5677](https://github.com/coder/coder/issues/5677)
- [Coder docs: Templates/Change Management](https://coder.com/docs/v2/latest/templates/change-management)
</details>
## Can I run Coder in an air-gapped or offline mode? (no Internet)?
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">Can I run Coder in an air-gapped or offline mode? (no Internet)?</summary>
Yes, Coder can be deployed in air-gapped or offline mode.
https://coder.com/docs/v2/latest/install/offline
@@ -306,7 +345,10 @@ defaults to Google's STUN servers, so you can either create your STUN server in
your network or disable and force all traffic through the control plane's DERP
proxy.
## Create a randomized computer_name for an Azure VM
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">Create a randomized computer_name for an Azure VM</summary>
Azure VMs have a 15 character limit for the `computer_name` which can lead to
duplicate name errors.
@@ -321,7 +363,10 @@ locals {
}
```
## Do you have example JetBrains Gateway templates?
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">Do you have example JetBrains Gateway templates?</summary>
In August 2023, JetBrains certified the Coder plugin signifying enhanced
stability and reliability.
@@ -342,8 +387,10 @@ open the IDE.
- [IntelliJ IDEA](https://github.com/sharkymark/v2-templates/tree/main/pod-idea)
- [IntelliJ IDEA with Icon](https://github.com/sharkymark/v2-templates/tree/main/pod-idea-icon)
</details>
## What options do I have for adding VS Code extensions into code-server, VS Code Desktop or Microsoft's Code Server?
<details style="margin-bottom: 28px;">
<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>
Coder has an open-source project called
[`code-marketplace`](https://github.com/coder/code-marketplace) which is a
@@ -369,7 +416,10 @@ https://github.com/sharkymark/v2-templates/blob/main/vs-code-server/main.tf
> Note: these are example templates with no SLAs on them and are not guaranteed
> for long-term support.
## I want to run Docker for my workspaces but not install Docker Desktop.
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">I want to run Docker for my workspaces but not install Docker Desktop.</summary>
[Colima](https://github.com/abiosoft/colima) is a Docker Desktop alternative.
@@ -404,7 +454,10 @@ Colima will show the path to the docker socket so I have a
[Coder template](./docker-code-server/main.tf) that prompts the Coder admin to
enter the docker socket as a Terraform variable.
## How to make a `coder_app` optional?
</details>
<details style="margin-bottom: 28px;">
<summary style="font-size: larger; font-weight: bold;">How to make a `coder_app` optional?</summary>
An example use case is the user should decide if they want a browser-based IDE
like code-server when creating the workspace.
@@ -462,7 +515,10 @@ resource "coder_app" "code-server" {
}
```
## 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?
</details>
<details style="margin-bottom: 28px;">
<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>
![VS Code Server prerequisite](https://github.com/coder/coder/assets/10648092/150c5996-18b1-4fae-afd0-be2b386a3239)
@@ -472,3 +528,5 @@ instance, Alpine is not supported at all. If so, you need to find a container
image or supported OS for the VS Code Server. For more information on OS
prerequisites for Linux, please look at the VSCode docs.
https://code.visualstudio.com/docs/remote/linux#_local-linux-prerequisites
</details>