Skip to content

Commit d0f71d3

Browse files
authored
docs: reorganize Coder Desktop docs
1 parent de4a270 commit d0f71d3

File tree

1 file changed

+108
-92
lines changed

1 file changed

+108
-92
lines changed

docs/user-guides/desktop/index.md

Lines changed: 108 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,153 +1,169 @@
11
# Coder Desktop
22

3-
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,
5-
and synchronize files between local and remote environments.
3+
Coder Desktop provides seamless access to your remote workspaces through a native application. Connect to workspace services using simple hostnames like `myworkspace.coder`, launch applications with one click, and synchronize files between local and remote environments—all without installing a CLI or configuring manual port forwarding.
64

7-
Coder Desktop requires a Coder deployment running [v2.20.0](https://github.com/coder/coder/releases/tag/v2.20.0) or later.
5+
## What You'll Need
86

9-
## Install Coder Desktop
7+
- A Coder deployment running [v2.20.0](https://github.com/coder/coder/releases/tag/v2.20.0) or later
8+
- Administrator privileges on your local machine (for VPN extension installation)
9+
- Access to your Coder deployment URL
10+
- Valid Coder account credentials
1011

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.
12+
**Estimated setup time:** 5-10 minutes
1613

17-
<div class="tabs">
18-
19-
You can install Coder Desktop on macOS or Windows.
20-
21-
### macOS
14+
## Quick Start
2215

23-
1. Use [Homebrew](https://brew.sh/) to install Coder Desktop:
16+
1. Install: `brew install --cask coder/coder/coder-desktop` (macOS) or `winget install Coder.CoderDesktop` (Windows)
17+
1. Open Coder Desktop and approve any system prompts to complete the installation.
18+
1. Sign in with your deployment URL and session token
19+
1. Enable "Coder Connect" toggle
20+
1. Access workspaces at `workspace-name.coder`
2421

25-
```shell
26-
brew install --cask coder/coder/coder-desktop
27-
```
22+
## How It Works
2823

29-
Alternatively, you can manually install Coder Desktop from the [releases page](https://github.com/coder/coder-desktop-macos/releases).
24+
Coder Desktop creates a secure tunnel to your Coder deployment, allowing you to:
3025

31-
1. Open **Coder Desktop** from the Applications directory.
26+
- **Access workspaces directly**: Connect via `workspace-name.coder` hostnames
27+
- **Use any application**: SSH clients, browsers, IDEs work seamlessly
28+
- **Sync files**: Bidirectional sync between local and remote directories
29+
- **Work offline**: Edit files locally, sync when reconnected
3230

33-
1. The application is treated as a system VPN. macOS will prompt you to confirm with:
31+
The VPN extension routes only Coder traffic—your other internet activity remains unchanged.
3432

35-
**"Coder Desktop" would like to use a new network extension**
33+
## Installation
3634

37-
Select **Open System Settings**.
38-
39-
1. In the **Network Extensions** system settings, enable the Coder Desktop extension.
35+
<div class="tabs">
4036

41-
1. Continue to the [configuration section](#configure).
37+
### macOS
4238

43-
### Windows
39+
<div class="tabs">
4440

45-
If you use [WinGet](https://github.com/microsoft/winget-cli), run `winget install Coder.CoderDesktop`.
41+
#### Homebrew (Recommended)
4642

47-
To manually install Coder Desktop:
43+
```shell
44+
brew install --cask coder/coder/coder-desktop
45+
```
4846

49-
1. Download the latest `CoderDesktop` installer executable (`.exe`) from the [coder-desktop-windows release page](https://github.com/coder/coder-desktop-windows/releases).
47+
#### Manual Installation**
5048

51-
Choose the architecture that fits your Windows system, `x64` or `arm64`.
49+
1. Download the latest release from [coder-desktop-macos releases](https://github.com/coder/coder-desktop-macos/releases)
50+
1. Drag `Coder Desktop.app` to your Applications folder
51+
1. Open from Applications directory
5252

53-
1. Open the `.exe` file, acknowledge the license terms and conditions, and select **Install**.
53+
</div>
5454

55-
1. If a suitable .NET runtime is not already installed, the installation might prompt you with the **.NET Windows Desktop Runtime** installation.
55+
**System Permissions**
5656

57-
In that installation window, select **Install**. Select **Close** when the runtime installation completes.
57+
Coder Desktop requires VPN extension permissions:
5858

59-
1. When the Coder Desktop installation completes, select **Close**.
59+
1. When prompted with **"Coder Desktop" would like to use a new network extension**, select **Open System Settings**
60+
1. In **Network Extensions** settings, enable the Coder Desktop extension
61+
1. You may need to enter your password to authorize the extension
6062

61-
1. Find and open **Coder Desktop** from your Start Menu.
63+
**Verify Installation**: Coder Desktop should appear in your menu bar
6264

63-
1. Some systems require an additional Windows App Runtime SDK.
65+
### Windows
6466

65-
Select **Yes** if you are prompted to install it.
66-
This will open your default browser where you can download and install the latest stable release of the Windows App Runtime SDK.
67+
<div class="tabs">
6768

68-
Reopen Coder Desktop after you install the runtime.
69+
#### WinGet (Recommended)**
6970

70-
1. Coder Desktop starts minimized in the Windows System Tray.
71+
```shell
72+
winget install Coder.CoderDesktop
73+
```
7174

72-
You might need to select the **^** in your system tray to show more icons.
75+
#### Manual Installation**
7376

74-
1. Continue to the [configuration section](#configure).
77+
1. Download the latest `CoderDesktop` installer (`.exe`) from [coder-desktop-windows releases](https://github.com/coder/coder-desktop-windows/releases)
78+
1. Choose the correct architecture (`x64` or `arm64`) for your system
79+
1. Run the installer and accept the license terms
80+
1. If prompted, install the .NET Windows Desktop Runtime
81+
1. Install Windows App Runtime SDK if prompted
7582

7683
</div>
7784

78-
## Configure
79-
80-
Before you can use Coder Desktop, you will need to sign in.
85+
**System Requirements**
8186

82-
1. Open the Desktop menu and select **Sign in**:
87+
- .NET Windows Desktop Runtime (installed automatically if needed)
88+
- Windows App Runtime SDK (may require manual installation)
8389

84-
<div class="tabs">
90+
**Verify Installation**: Coder Desktop should appear in your system tray (you may need to click **^** to show hidden icons)
8591

86-
## macOS
87-
88-
![Coder Desktop menu before the user signs in](../../images/user-guides/desktop/coder-desktop-mac-pre-sign-in.png)
89-
90-
## Windows
91-
92-
![Coder Desktop menu before the user signs in](../../images/user-guides/desktop/coder-desktop-win-pre-sign-in.png)
93-
94-
</div>
95-
96-
1. In the **Sign In** window, enter your Coder deployment's URL and select **Next**:
92+
</div>
9793

98-
![Coder Desktop sign in](../../images/user-guides/desktop/coder-desktop-sign-in.png)
94+
## Testing Your Connection
9995

100-
1. macOS: Select the link to your deployment's `/cli-auth` page to generate a [session token](../../admin/users/sessions-tokens.md).
96+
Once connected, test access to your workspaces:
10197

102-
Windows: Select **Generate a token via the Web UI**.
98+
**SSH Connection**
99+
```shell
100+
ssh your-workspace.coder
101+
```
103102

104-
1. In your web browser, you may be prompted to sign in to Coder with your credentials.
103+
**Ping Test**
104+
```shell
105+
# macOS
106+
ping6 -c 3 your-workspace.coder
105107

106-
1. Copy the session token to the clipboard:
108+
# Windows
109+
ping -n 3 your-workspace.coder
110+
```
107111

108-
![Copy session token](../../images/templates/coder-session-token.png)
112+
**Web Services**
109113

110-
1. Paste the token in the **Session Token** field of the **Sign In** screen, then select **Sign In**:
114+
Open `http://your-workspace.coder:8080` in your browser (replace `8080` with your service's port)
111115

112-
![Paste the session token in to sign in](../../images/user-guides/desktop/coder-desktop-session-token.png)
116+
## Troubleshooting
113117

114-
1. macOS: Allow the VPN configuration for Coder Desktop if you are prompted:
118+
### Connection Issues
115119

116-
![Copy session token](../../images/user-guides/desktop/mac-allow-vpn.png)
120+
**"Can't connect to workspace"**
121+
- Verify Coder Connect is enabled (toggle should be ON)
122+
- Check that your deployment URL is correct
123+
- Ensure your session token hasn't expired
124+
- Try disconnecting and reconnecting Coder Connect
117125

118-
1. Select the Coder icon in the menu bar (macOS) or system tray (Windows), and click the **Coder Connect** toggle to enable the connection.
126+
**"VPN extension not working"**
127+
- Restart Coder Desktop
128+
- Check system permissions for network extensions
129+
- Ensure only one copy of Coder Desktop is installed
119130

120-
![Coder Desktop on Windows - enable Coder Connect](../../images/user-guides/desktop/coder-desktop-win-enable-coder-connect.png)
131+
### Known Limitations
121132

122-
This may take a few moments, because Coder Desktop will download the necessary components from the Coder server if they have been updated.
133+
**VPN Conflicts**
134+
Coder Desktop is unable to connect if the Coder deployment is only accessible via a VPN. This affects:
135+
- [macOS](https://github.com/coder/coder-desktop-macos/issues/201)
136+
- [Windows](https://github.com/coder/coder-desktop-windows/issues/147)
123137

124-
1. macOS: You may be prompted to enter your password to allow Coder Connect to start.
138+
A resolution is in development. For now, use the [Coder CLI](../cli.md) when connected to corporate VPNs.
125139

126-
1. Coder Connect is now running!
140+
**Secure Browser Context**
141+
Some web applications require HTTPS for certain features. While Coder Connect uses encrypted WireGuard tunnels, browsers may show security warnings for HTTP connections to `.coder` hostnames.
127142

128-
## Troubleshooting
143+
### Getting Help
129144

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).
145+
If you encounter issues not covered here:
135146

136-
### Known Issues
147+
- **File an issue**: [macOS](https://github.com/coder/coder-desktop-macos/issues) | [Windows](https://github.com/coder/coder-desktop-windows/issues) | [General](https://github.com/coder/coder/issues)
148+
- **Community support**: [Discord](https://coder.com/chat)
137149

138-
#### macOS: Do not install more than one copy of Coder Desktop
150+
## Uninstalling
139151

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`.
152+
<div class="tabs">
141153

142-
#### Coder Desktop can't connect through another VPN
154+
### macOS
143155

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.
156+
1. **Disable Coder Connect** in the app menu
157+
2. **Quit Coder Desktop** completely
158+
3. **Remove VPN extension** from System Settings > Network Extensions
159+
4. **Delete the app** from Applications folder
160+
5. **Remove configuration** (optional): `rm -rf ~/Library/Application\ Support/Coder\ Desktop`
146161

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.
162+
### Windows
150163

151-
## Next Steps
164+
1. **Disable Coder Connect** in the app menu
165+
2. **Quit Coder Desktop** from system tray
166+
3. **Uninstall** via Settings > Apps or Control Panel
167+
4. **Remove configuration** (optional): Delete `%APPDATA%\Coder Desktop`
152168

153-
- [Connect to and work on your workspace](./desktop-connect-sync.md)
169+
</div>

0 commit comments

Comments
 (0)