Skip to content

chore(docs): replace FAQ twisties with h3s #12859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 3, 2024
Merged

chore(docs): replace FAQ twisties with h3s #12859

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cabfafa
replace FAQ twisties with h3s
stirby Apr 3, 2024
b6f023c
make fmt
stirby Apr 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
make fmt
  • Loading branch information
@stirby
stirby committed Apr 3, 2024
commit b6f023c4045922f3076ee4a346dba2bc2c908552
19 changes: 0 additions & 19 deletions docs/faqs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ 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

The primary developer use case is a local IDE connecting over SSH to a Coder
Expand Down Expand Up @@ -59,14 +58,12 @@ 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?

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

The visibility of Coder apps is configurable in the template. To change the
Expand All @@ -86,7 +83,6 @@ 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.

> It is **not** recommended to share a web IDE, but if required, the following
Expand Down Expand Up @@ -117,7 +113,6 @@ resource "coder_app" "code-server" {
}
```


### I installed Coder and created a workspace but the icons do not load.

An important concept to understand is that Coder creates workspaces which have
Expand All @@ -142,7 +137,6 @@ 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.

When updating a template, be aware of potential issues with input variables. For
Expand All @@ -163,7 +157,6 @@ 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.

Take, for example, a Coder deployment on a VM with a 2 shared vCPU systemd
Expand All @@ -179,7 +172,6 @@ sudo systemctl daemon-reload
sudo systemctl restart coder.service
```


### I'm using the built-in Postgres database and forgot admin email I set up.

1. Run the `coder server` command below to retrieve the `psql` connection URL
Expand All @@ -193,7 +185,6 @@ 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?

[Coder is on the HashiCorp's Terraform registry](https://registry.terraform.io/providers/coder/coder/latest).
Expand All @@ -203,7 +194,6 @@ 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?

Caddy is an easy-to-configure reverse proxy that also automatically creates
Expand All @@ -229,7 +219,6 @@ coder.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?

Caddy requires your DNS provider's credentials to create wildcard certificates.
Expand Down Expand Up @@ -260,7 +249,6 @@ The updated Caddyfile configuration will look like this:
}
```


### Can I use local or remote Terraform Modules in Coder templates?

One way is to reference a Terraform module from a GitHub repo to avoid
Expand Down Expand Up @@ -318,7 +306,6 @@ 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

Azure VMs have a 15 character limit for the `computer_name` which can lead to
Expand All @@ -334,7 +321,6 @@ locals {
}
```


### Do you have example JetBrains Gateway templates?

In August 2023, JetBrains certified the Coder plugin signifying enhanced
Expand Down Expand Up @@ -383,7 +369,6 @@ 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.

[Colima](https://github.com/abiosoft/colima) is a Docker Desktop alternative.
Expand Down Expand Up @@ -419,7 +404,6 @@ Colima will show the path to the docker socket so we have a
[community template](https://github.com/sharkymark/v2-templates/tree/main/docker-code-server)
that prompts the Coder admin to enter the docker socket as a Terraform variable.


### How to make a `coder_app` optional?

An example use case is the user should decide if they want a browser-based IDE
Expand Down Expand Up @@ -478,7 +462,6 @@ 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?

![VS Code Server prerequisite](https://github.com/coder/coder/assets/10648092/150c5996-18b1-4fae-afd0-be2b386a3239)
Expand All @@ -490,7 +473,6 @@ 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


### How can I resolve disconnects when connected to Coder via JetBrains Gateway?

If your JetBrains IDE is disconnected for a long period of time due to a network
Expand Down Expand Up @@ -519,4 +501,3 @@ Note that the JetBrains Gateway configuration blocks for each host in your SSH
config file will be overwritten by the JetBrains Gateway client when it
re-authenticates to your Coder deployment so you must add the above config as a
separate block and not add it to any existing ones.