8000 chore(docs): add requirements re ports and stun server to docs by johnstcn · Pull Request #12026 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

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

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 19 commits into from
Feb 12, 2024
Merged

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

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
aff688e
chore(docs): add requirements re ports and stun server to docs
johnstcn Feb 6, 2024
efb639a
Update docs/networking/index.md
johnstcn Feb 6, 2024
4e95495
add section on stun and nats
johnstcn Feb 6, 2024
c187875
fmt
johnstcn Feb 6, 2024
fb8a887
fix typos
johnstcn Feb 6, 2024
9abe9eb
Apply suggestions from code review
johnstcn Feb 7, 2024
05dcbad
add note re: plugins/ssh
johnstcn Feb 7, 2024
90405b4
clarify requirements regarding direct connections
johnstcn Feb 7, 2024
9d9759b
add one example scenario
johnstcn Feb 7, 2024
ad2d953
add more scenarios and diagrams
johnstcn Feb 8, 2024
7d2b50f
move stun docs to separate page
johnstcn Feb 8, 2024
bd81137
make fmt
johnstcn Feb 8, 2024
56929f7
fix typo
johnstcn Feb 8, 2024
39c5867
Merge remote-tracking branch 'origin/main' into cj/networking-ports
johnstcn Feb 8, 2024
e3a6865
adjust wording
johnstcn Feb 8, 2024
4b4d246
Apply suggestions from code review
johnstcn Feb 12, 2024
9726796
update manifest
johnstcn Feb 12, 2024
6ac84d2
adjust graph for example 2
johnstcn Feb 12, 2024
9cad8e7
make fmt
johnstcn Feb 12, 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
Next Next commit
adjust graph for example 2
  • Loading branch information
@johnstcn
johnstcn committed Feb 12, 2024
commit 6ac84d26ba846aad794e9f8a35fd9016fd83d8a8
17 changes: 8 additions & 9 deletions docs/networking/stun.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,24 +107,23 @@ communicate directly with each other through their respective NATs.

```mermaid
flowchart LR
subgraph homenet["Home Network"]
direction LR
subgraph homenet["Network A"]
client["Client workstation\n192.168.1.101:38297"]
homenat["Home Router/NAT\n65.4.3.21:29187"]
homenat["NAT\n65.4.3.21:29187"]
end
subgraph corpnet["Corp Network"]
direction LR
subgraph corpnet["Network B"]
agent["Workspace agent\n10.21.43.241:56812"]
corpnat["Corp Router/NAT\n12.34.56.7:41563"]
corpnat["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
agent -- "[10.21.43.241:56812]" --- corpnat
corpnat -- "[65.4.3.21:29187]" --> internet
homenat -- "[12.34.56.7:41563]" --> internet

```
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now, fixed by changing the arrow directions.


### 3. Direct connections with VPN and NAT hairpinning
Expand Down
0