Skip to content

Commit 8edf82a

Browse files
committed
add wireguard context to some places where we say tailscale
1 parent badebc7 commit 8edf82a

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

docs/admin/networking/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ 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 networking logic.
1515

1616
## Requirements
1717

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

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

135135
```bash
136-
$ coder server --derp-config-url https://controlplane.tailscale.com/derpmap/default
136+
coder server --derp-config-url https://controlplane.tailscale.com/derpmap/default
137137
```
138138

139139
#### Custom Relays

docs/admin/networking/stun.md

Lines changed: 2 additions & 2 deletions
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ environments. However, some changes to your configuration are necessary.
1010
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1111
| 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) |
1212
| 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) |
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) |
1414
| 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). |
1515
| 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) |
1616
| Telemetry | Telemetry is on by default, and [can be disabled](../reference/cli/server.md#--telemetry) | Telemetry [can be disabled](../reference/cli/server.md#--telemetry) |

docs/tutorials/support-bundle.md

Lines changed: 2 additions & 2 deletions
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)