Skip to content

Commit 7cf3263

Browse files
docs: document issue with macos coder desktop behind vpn (#18855)
docs for coder/coder-desktop-macos#201 and coder/coder-desktop-windows#147 > If the logged in Coder deployment requires a VPN to connect, Coder Connect can't establish communication through the VPN, > and will time out. [preview](https://coder.com/docs/@201-desktop-mac-vpn/user-guides/desktop) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: Dean Sheather <dean@deansheather.com>
1 parent 4980f18 commit 7cf3263

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

docs/user-guides/desktop/index.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
# Coder Desktop
22

33
Coder Desktop provides seamless access to your remote workspaces without the need to install a CLI or configure manual port forwarding.
4-
Connect to workspace services using simple hostnames like `myworkspace.coder`, launch native applications with one click, and synchronize files between local and remote environments.
4+
Connect to workspace services using simple hostnames like `myworkspace.coder`, launch native applications with one click,
5+
and synchronize files between local and remote environments.
56

6-
> [!NOTE]
7-
> Coder Desktop requires a Coder deployment running [v2.20.0](https://github.com/coder/coder/releases/tag/v2.20.0) or later.
7+
Coder Desktop requires a Coder deployment running [v2.20.0](https://github.com/coder/coder/releases/tag/v2.20.0) or later.
88

99
## Install Coder Desktop
1010

11+
> [!IMPORTANT]
12+
> Coder Desktop can't connect through a corporate VPN.
13+
>
14+
> Due to a [known issue](#coder-desktop-cant-connect-through-another-vpn),
15+
> if your Coder deployment requires that you connect through a corporate VPN, Desktop will timeout when it tries to connect.
16+
1117
<div class="tabs">
1218

1319
You can install Coder Desktop on macOS or Windows.
@@ -113,15 +119,34 @@ Before you can use Coder Desktop, you will need to sign in.
113119

114120
![Coder Desktop on Windows - enable Coder Connect](../../images/user-guides/desktop/coder-desktop-win-enable-coder-connect.png)
115121

116-
This may take a few moments, as Coder Desktop will download the necessary components from the Coder server if they have been updated.
122+
This may take a few moments, because Coder Desktop will download the necessary components from the Coder server if they have been updated.
117123

118124
1. macOS: You may be prompted to enter your password to allow Coder Connect to start.
119125

120126
1. Coder Connect is now running!
121127

122128
## Troubleshooting
123129

124-
Do not install more than one copy of Coder Desktop. To avoid system VPN configuration conflicts, only one copy of `Coder Desktop.app` should exist on your Mac, and it must remain in `/Applications`.
130+
If you encounter an issue with Coder Desktop that is not listed here, file an issue in the GitHub repository for
131+
Coder Desktop for [macOS](https://github.com/coder/coder-desktop-macos/issues) or
132+
[Windows](https://github.com/coder/coder-desktop-windows/issues), in the
133+
[main Coder repository](https://github.com/coder/coder/issues), or consult the
134+
[community on Discord](https://coder.com/chat).
135+
136+
### Known Issues
137+
138+
#### macOS: Do not install more than one copy of Coder Desktop
139+
140+
To avoid system VPN configuration conflicts, only one copy of `Coder Desktop.app` should exist on your Mac, and it must remain in `/Applications`.
141+
142+
#### Coder Desktop can't connect through another VPN
143+
144+
If the logged in Coder deployment requires a corporate VPN to connect, Coder Connect can't establish communication
145+
through the VPN, and will time out.
146+
147+
This is due to known issues with [macOS](https://github.com/coder/coder-desktop-macos/issues/201) and
148+
[Windows](https://github.com/coder/coder-desktop-windows/issues/147) networking.
149+
A resolution is in progress.
125150

126151
## Next Steps
127152

0 commit comments

Comments
 (0)