Skip to content

docs: add faqs from sharkymark #11168

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 10 commits into from
Dec 13, 2023
Merged

docs: add faqs from sharkymark #11168

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
34d566e
added sharkymark FAQs page
stirby Dec 12, 2023
987dda4
make fmt
stirby Dec 12, 2023
dbe0939
fixed typos for link
stirby Dec 12, 2023
936bdd2
changed FAQs icon to (i)
stirby Dec 12, 2023
e8bdf14
satisfied review
stirby Dec 13, 2023
7adb6a7
make fmt
stirby Dec 13, 2023
1c0fe88
added docs links for coder_app, CODER_ACCESS_URL
stirby Dec 13, 2023
be1c35f
removed mentions of mark
stirby Dec 13, 2023
e491f20
fixed some minor code formatting issues
stirby Dec 13, 2023
f8214da
fixed numbered bullets rendering, make fmt
stirby Dec 13, 2023
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
Next Next commit
make fmt
  • Loading branch information
@stirby
stirby committed Dec 13, 2023
commit 7adb6a7575cc907da5998fc78a864c673c1ca31d
45 changes: 23 additions & 22 deletions docs/faqs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,29 +36,27 @@ coder licenses add -f <path/filename>
The primary developer use case is a local IDE connecting over SSH to a Coder
workspace.

Coder's networking stack has intelligence to attempt a peer-to-peer or [Direct
connection](https://coder.com/docs/v2/latest/networking#direct-connections) between the local IDE and the workspace.

However, this requires some additional protocols like UDP and being able to
reach a STUN server to echo the IP addresses of the local IDE machine and
workspace, for sharing using a Wireguard Coordination Server.

By default, Coder assumes Internet and attempts to reach Google's STUN servers
to perform this IP echo.
Coder's networking stack has intelligence to attempt a peer-to-peer or
[Direct connection](https://coder.com/docs/v2/latest/networking#direct-connections)
between the local IDE and the workspace. However, this requires some additional
protocols like UDP and being able to reach a STUN server to echo the IP
addresses of the local IDE machine and workspace, for sharing using a Wireguard
Coordination Server. By default, Coder assumes Internet and attempts to reach
Google's STUN servers to perform this IP echo.

Operators experimenting with Coder may run into networking issues if UDP (which
STUN requires) or the STUN servers are unavailable, potentially resulting in
lengthy local IDE and SSH connection times as the Coder control plane attempts
to establish these direct connections.

Setting the following flags as shown disables this logic to simplify troubleshooting.

Setting the following flags as shown disables this logic to simplify
troubleshooting.

Flag | Value | Meaning
---- | ----- | -------
[`CODER_BLOCK_DIRECT`](https://coder.com/docs/v2/latest/cli/server#--block-direct-connections) | `true` | Blocks direct connections
[`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
| Flag | Value | Meaning |
| -------------------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------- |
| [`CODER_BLOCK_DIRECT`](https://coder.com/docs/v2/latest/cli/server#--block-direct-connections) | `true` | Blocks direct connections |
| [`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?

Expand Down Expand Up @@ -100,9 +98,11 @@ This example will hide all built-in coder_app icons except the web terminal.
value: "true"
```

2. In the template, set [`coder_app`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app) [`share`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app#share) option to `authenticated` and when a workspace
is built with this template, the pretty globe shows up next to path-based
`code-server`:
2. In the template, set
[`coder_app`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app)
[`share`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app#share)
option to `authenticated` and when a workspace is built with this template,
the pretty globe shows up next to path-based `code-server`:

```hcl
resource "coder_app" "code-server" {
Expand Down Expand Up @@ -146,9 +146,10 @@ example, if a template prompts users to choose options like a
of these values can lead to existing workspaces failing to start. This issue
occurs because the Terraform state will not be in sync with the new template.

However, a lesser-known CLI sub-command, [`coder update`](https://coder.com/docs/v2/latest/cli/update), can resolve this issue. This
command re-prompts users to re-enter the input variables, potentially saving the
workspace from a failed status.
However, a lesser-known CLI sub-command,
[`coder update`](https://coder.com/docs/v2/latest/cli/update), can resolve this
issue. This command re-prompts users to re-enter the input variables,
potentially saving the workspace from a failed status.

```sh
coder update --always-prompt <workspace name>
Expand Down