chore(docs): add requirements re ports and stun server to docs #12026

johnstcn · 2024-02-06T12:43:38Z

docs/networking/index.md

deansheather · 2024-02-06T15:23:09Z

docs/networking/index.md

+  source ports `udp/3478` and `udp/41641` to all destination ports.
+  > For more detailed information, see
+  > [What firewall ports should I open to use Tailscale? (tailscale.com)](https://tailscale.com/kb/1082/firewall-ports).
+


There should probably be some details about NATs and stuff but I really don't know what to write without getting super technical :/

Honestly I'd prefer to just link to Tailscale's docs on this.

IDK how well Tailscale's docs cut it, this one doesn't really explain much about NAT just about firewalls.

I link to https://tailscale.com/blog/how-nat-traversal-works a bit above in the STUN section.

This is a good blog post but it's not very good documentation since it's 9000 words long. We should probably dumb it down

OK, I added a fairly high-level overview.

I've Slack'd you some diagrams. If we're going to explain it, then those are my suggested examples.

Added and moved to a separate page as this one is getting plenty big already.

Co-authored-by: Dean Sheather <dean@deansheather.com>

docs/networking/index.md

spikecurtis · 2024-02-07T12:02:16Z

docs/networking/index.md

+  source ports `udp/3478` and `udp/41641` to all destination ports.
+  > For more detailed information, see
+  > [What firewall ports should I open to use Tailscale? (tailscale.com)](https://tailscale.com/kb/1082/firewall-ports).
+


I've Slack'd you some diagrams. If we're going to explain it, then those are my suggested examples.

Co-authored-by: Spike Curtis <spike@coder.com>

johnstcn · 2024-02-08T16:25:44Z

docs/networking/stun.md

+  clusternat --- corpnat
+  corpnat --> stun1
+  corpnat --> stun2
+```


flowchart TD subgraph homenet["Home Network"] client["Client workstation\n192.168.1.101"] homenat["Home Router/NAT\n65.4.3.21"] end subgraph internet["Public Internet"] stun1["Public STUN"] vpn1["VPN entry node"] end subgraph corpnet["Corp Network 172.16.1.0/24"] corpnat["Corp Router/NAT\n172.16.1.1\n12.34.56.7"] vpn2["VPN exit node\n172.16.1.2"] stun2["Private STUN"] subgraph cluster["Cluster Network 10.11.12.0/16"] clusternat["Cluster Router/NAT\n10.11.12.1\n172.16.1.254"] agent["Workspace agent\n10.11.12.34"] end end vpn1 === vpn2 vpn2 --> stun2 client === homenat homenat === vpn1 homenat x-.-x stun1 agent --- clusternat clusternat --- corpnat corpnat --> stun1 corpnat --> stun2

Loading

johnstcn · 2024-02-08T16:25:52Z

docs/networking/stun.md

+  homenat -- "[12.34.56.7:41563]" --- internet
+  internet -- "[12.34.56.7:41563]" --- corpnat
+  corpnat -- "[10.21.43.241:56812]" --> agent
+```


flowchart LR subgraph homenet["Home Network"] direction LR client["Client workstation\n192.168.1.101:38297"] homenat["Home Router/NAT\n65.4.3.21:29187"] end subgraph corpnet["Corp Network"] direction LR agent["Workspace agent\n10.21.43.241:56812"] corpnat["Corp Router/NAT\n12.34.56.7:41563"] end subgraph internet["Public Internet"] end client -- "[12.34.56.7:41563]" --- homenat homenat -- "[12.34.56.7:41563]" --- internet internet -- "[12.34.56.7:41563]" --- corpnat corpnat -- "[10.21.43.241:56812]" --> agent

Loading

It's unfortunate Mermaid lays these out differently. Presumably it's due to the arrow directions... does it look weird to keep the use of arrows consistent?

Yeah, I'm honestly considering replacing with some manual drawings just so we can more easily fine-tune it.

For now, fixed by changing the arrow directions.

johnstcn · 2024-02-08T16:25:59Z

docs/networking/stun.md

+  agent --- corpnat
+  corpnat -- "[I see 12.34.56.7:41563]" --> stun1
+  homenat -- "[I see 65.4.3.21:29187]" --> stun1
+```


flowchart LR subgraph homenet["Network A"] client["Client workstation\n192.168.1.101:38297"] homenat["NAT\n??.??.??.??:?????"] end subgraph internet["Public Internet"] stun1["STUN server"] end subgraph corpnet["Network B"] agent["Workspace agent\n10.21.43.241:56812"] corpnat["NAT\n??.??.??.??:?????"] end client --- homenat agent --- corpnat corpnat -- "[I see 12.34.56.7:41563]" --> stun1 homenat -- "[I see 65.4.3.21:29187]" --> stun1

Loading

johnstcn · 2024-02-08T16:26:04Z

docs/networking/stun.md

+    C[Workspace Agent\n192.168.21.147:41563]
+    A <--> C
+    end
+```


flowchart LR subgraph corpnet["Private Network\ne.g. Corp. LAN"] A[Client Workstation\n192.168.21.47:38297] C[Workspace Agent\n192.168.21.147:41563] A <--> C end

Loading

spikecurtis

This is great! Couple small language tweaks and suggestions inline

docs/networking/stun.md

spikecurtis · 2024-02-12T05:59:27Z

docs/networking/stun.md

+  homenat -- "[12.34.56.7:41563]" --- internet
+  internet -- "[12.34.56.7:41563]" --- corpnat
+  corpnat -- "[10.21.43.241:56812]" --> agent
+```


It's unfortunate Mermaid lays these out differently. Presumably it's due to the arrow directions... does it look weird to keep the use of arrows consistent?

Co-authored-by: Spike Curtis <spike@coder.com>

chore(docs): add requirements re ports and stun server to docs

aff688e

johnstcn self-assigned this Feb 6, 2024

johnstcn requested review from spikecurtis and deansheather February 6, 2024 12:43

deansheather reviewed Feb 6, 2024

View reviewed changes

johnstcn and others added 2 commits February 6, 2024 15:41

Update docs/networking/index.md

efb639a

Co-authored-by: Dean Sheather <dean@deansheather.com>

add section on stun and nats

4e95495

johnstcn requested a review from deansheather February 6, 2024 16:59

johnstcn added 2 commits February 6, 2024 17:05

fmt

c187875

fix typos

fb8a887

spikecurtis reviewed Feb 7, 2024

View reviewed changes

johnstcn and others added 8 commits February 7, 2024 13:47

Apply suggestions from code review

9abe9eb

Co-authored-by: Spike Curtis <spike@coder.com>

add note re: plugins/ssh

05dcbad

clarify requirements regarding direct connections

90405b4

add one example scenario

9d9759b

add more scenarios and diagrams

ad2d953

move stun docs to separate page

7d2b50f

make fmt

bd81137

fix typo

56929f7

johnstcn requested a review from spikecurtis February 8, 2024 16:25

johnstcn commented Feb 8, 2024

View reviewed changes

johnstcn added 2 commits February 8, 2024 19:04

Merge remote-tracking branch 'origin/main' into cj/networking-ports

39c5867

adjust wording

e3a6865

spikecurtis approved these changes Feb 12, 2024

View reviewed changes

johnstcn and others added 3 commits February 12, 2024 09:06

Apply suggestions from code review

4b4d246

Co-authored-by: Spike Curtis <spike@coder.com>

update manifest

9726796

adjust graph for example 2

6ac84d2

make fmt

9cad8e7

johnstcn merged commit d1a522a into main Feb 12, 2024

johnstcn deleted the cj/networking-ports branch February 12, 2024 11:42

github-actions bot locked and limited conversation to collaborators Feb 12, 2024

chore(docs): add requirements re ports and stun server to docs #12026

chore(docs): add requirements re ports and stun server to docs #12026

Uh oh!

Conversation

johnstcn commented Feb 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

spikecurtis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

johnstcn commented Feb 6, 2024 •

edited

Loading