Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit bcb15aa

Browse files
EdwardAngertEdwardAngert
authored
docs: add context for wireguard in places referencing tailscale (#15901)
> We do not use Tailscale (product) but instead import Tailscale OSS libraries which has some nice ways of handling Wireguard. We also use Tailscale's logo in our architecture, but calling it only `Tailscale` seems to throw people off when they're considering Coder and how it works. I've left it wherever it seems to make sense (such as when we talk about [DERP](https://coder.com/docs/admin/networking#relayed-connections)), and sprinkled some `Wireguard` and `websocket/HTTPS` where I could
1 parent 8de3cd6 commit bcb15aa

File tree

4 files changed

+19
-17
lines changed

4 files changed

+19
-17
lines changed

‎docs/admin/networking/index.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ but otherwise, all topologies _just work_ with Coder.
99
When possible, we establish direct connections between users and workspaces.
1010
Direct connections are as fast as connecting to the workspace outside of Coder.
1111
When NAT traversal fails, connections are relayed through the coder server. All
12-
user <-> workspace connections are end-to-end encrypted.
12+
user-workspace connections are end-to-end encrypted.
1313

14-
[Tailscale's open source](https://tailscale.com) backs our networking logic.
14+
[Tailscale's open source](https://tailscale.com) backs our websocket/HTTPS
15+
networking logic.
1516

1617
## Requirements
1718

@@ -128,12 +129,13 @@ but this can be disabled or changed for
128129
By default, your Coder server also runs a built-in DERP relay which can be used
129130
for both public and [offline deployments](../../install/offline.md).
130131

131-
However, Tailscale has graciously allowed us to use
132+
However, our Wireguard integration through Tailscale has graciously allowed us
133+
to use
132134
[their global DERP relays](https://tailscale.com/kb/1118/custom-derp-servers/#what-are-derp-servers).
133135
You can launch `coder server` with Tailscale's DERPs like so:
134136

135137
```bash
136-
$ coder server --derp-config-url https://controlplane.tailscale.com/derpmap/default
138+
coder server --derp-config-url https://controlplane.tailscale.com/derpmap/default
137139
```
138140

139141
#### Custom Relays

‎docs/admin/networking/stun.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ counterpart can be reached. Once communication succeeds in one direction, we can
3333
inspect the source address of the received packet to determine the return
3434
address.
3535

36-
At a high level, STUN works like this:
37-
3836
> The below glosses over a lot of the complexity of traversing NATs. For a more
3937
> in-depth technical explanation, see
4038
> [How NAT traversal works (tailscale.com)](https://tailscale.com/blog/how-nat-traversal-works).
4139
40+
At a high level, STUN works like this:
41+
4242
- **Discovery:** Both the client and agent will send UDP traffic to one or more
4343
configured STUN servers. These STUN servers are generally located on the
4444
public internet, and respond with the public IP address and port from which

‎docs/install/offline.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ environments. However, some changes to your configuration are necessary.
66
> This is a general comparison. Keep reading for a full tutorial running Coder
77
> offline with Kubernetes or Docker.
88
9-
| | Public deployments | Offline deployments |
10-
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11-
| Terraform binary | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com) | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24) |
12-
| Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below |
13-
| STUN | By default, Coder uses Google's public STUN server for direct workspace connections | STUN can be safely [disabled](../reference/ users can still connect via [relayed connections](../admin/networking/index.md#-geo-distribution). Alternatively, you can set a [custom DERP server](../reference/cli/server.md#--derp-server-stun-addresses) |
14-
| DERP | By default, Coder's built-in DERP relay can be used, or [Tailscale's public relays](../admin/networking/index.md#relayed-connections). | By default, Coder's built-in DERP relay can be used, or [custom relays](../admin/networking/index.md#custom-relays). |
15-
| PostgreSQL | If no [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) is specified, Coder will download Postgres from [repo1.maven.org](https://repo1.maven.org) | An external database is required, you must specify a [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) |
16-
| Telemetry | Telemetry is on by default, and [can be disabled](../reference/cli/server.md#--telemetry) | Telemetry [can be disabled](../reference/cli/server.md#--telemetry) |
17-
| Update check | By default, Coder checks for updates from [GitHub releases](https://github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) |
9+
| | Public deployments | Offline deployments |
10+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11+
| Terraform binary | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com) | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24) |
12+
| Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below |
13+
| STUN | By default, Coder uses Google's public STUN server for direct workspace connections | STUN can be safely [disabled](../reference/cli/server.md#--derp-server-stun-addresses) users can still connect via [relayed connections](../admin/networking/index.md#-geo-distribution). Alternatively, you can set a [custom DERP server](../reference/cli/server.md#--derp-server-stun-addresses) |
14+
| DERP | By default, Coder's built-in DERP relay can be used, or [Tailscale's public relays](../admin/networking/index.md#relayed-connections). | By default, Coder's built-in DERP relay can be used, or [custom relays](../admin/networking/index.md#custom-relays). |
15+
| PostgreSQL | If no [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) is specified, Coder will download Postgres from [repo1.maven.org](https://repo1.maven.org) | An external database is required, you must specify a [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) |
16+
| Telemetry | Telemetry is on by default, and [can be disabled](../reference/cli/server.md#--telemetry) | Telemetry [can be disabled](../reference/cli/server.md#--telemetry) |
17+
| Update check | By default, Coder checks for updates from [GitHub releases](https://github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) |
1818

1919
## Offline container images
2020

‎docs/tutorials/support-bundle.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ A brief overview of all files contained in the bundle is provided below:
2929
| Filename | Description |
3030
| --------------------------------- | ---------------------------------------------------------------------------------------------------------- |
3131
| `agent/agent.json` | The agent used to connect to the workspace with environment variables stripped. |
32-
| `agent/agent_magicsock.html` | The contents of the HTTP debug endpoint of the agent's Tailscale connection. |
33-
| `agent/client_magicsock.html` | The contents of the HTTP debug endpoint of the client's Tailscale connection. |
32+
| `agent/agent_magicsock.html` | The contents of the HTTP debug endpoint of the agent's Tailscale Wireguard connection. |
33+
| `agent/client_magicsock.html` | The contents of the HTTP debug endpoint of the client's Tailscale Wireguard connection. |
3434
| `agent/listening_ports.json` | The listening ports detected by the selected agent running in the workspace. |
3535
| `agent/logs.txt` | The logs of the selected agent running in the workspace. |
3636
| `agent/manifest.json` | The manifest of the selected agent with environment variables stripped. |

0 commit comments

Comments
 (0)