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.

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
Changes from 1 commit
Commits
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
add note re: plugins/ssh
  • Loading branch information
johnstcn committed Feb 7, 2024
commit 05dcbad4d382ee8ebda6c9800a618a8e346770aa
14 changes: 9 additions & 5 deletions docs/networking/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,22 @@ In order for clients and workspaces to be able to connect:

- All clients and agents must be able to establish a connection to the Coder
server (`CODER_ACCESS_URL`) over HTTP/HTTPS.
- Any reverse proxy or ingress between the Coder control plane and clients/agents must
support WebSockets.
- Any reverse proxy or ingress between the Coder control plane and
clients/agents must support WebSockets.

In order for clients to be able to establish direct connections:

> **Note:** Direct connections via the web browser are not supported. To improve
> latency for browser-based applications running inside Coder workspaces in regions far from the Coder control plane,
> consider deploying one or more
> latency for browser-based applications running inside Coder workspaces in
> regions far from the Coder control plane, consider deploying one or more
> [workspace proxies](../admin/workspace-proxies.md).

- The client is connecting using the CLI (e.g. `coder ssh` or
`coder port-forward`).
`coder port-forward`). Note that the
[VSCode extension](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote)
and [JetBrains Plugin](https://plugins.jetbrains.com/plugin/19620-coder/), and
[`ssh coder.<workspace>`](../cli/config-ssh.md) all utilize the CLI to
establish a workspace connection.
- The client and workspace agent are both able to connect to
[a specific STUN server](#stun-in-a-natshell).
- All outbound UDP traffic must be allowed for both the client and the agent on
Expand Down
0