coder/docs/user-guides/desktop/index.md

Coder Desktop

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

Coder Desktop requires a Coder deployment running v2.20.0 or later.

Install Coder Desktop

Important

Coder Desktop can't connect through a corporate VPN.

Due to a known issue, if your Coder deployment requires that you connect through a corporate VPN, Desktop will timeout when it tries to connect.

You can install Coder Desktop on macOS or Windows.

macOS

1. Use Homebrew to install Coder Desktop:

   brew install --cask coder/coder/coder-desktop
   

   Alternatively, you can manually install Coder Desktop from the releases page.

2. Open Coder Desktop from the Applications directory.

3. The application is treated as a system VPN. macOS will prompt you to confirm with:

   "Coder Desktop" would like to use a new network extension

   Select Open System Settings.

4. In the Network Extensions system settings, enable the Coder Desktop extension.

5. Continue to the configuration section.

Windows

If you use WinGet, run winget install Coder.CoderDesktop.

To manually install Coder Desktop:

1. Download the latest CoderDesktop installer executable (.exe) from the coder-desktop-windows release page.

   Choose the architecture that fits your Windows system, x64 or arm64.

2. Open the .exe file, acknowledge the license terms and conditions, and select Install.

3. If a suitable .NET runtime is not already installed, the installation might prompt you with the .NET Windows Desktop Runtime installation.

   In that installation window, select Install. Select Close when the runtime installation completes.

4. When the Coder Desktop installation completes, select Close.

5. Find and open Coder Desktop from your Start Menu.

6. Some systems require an additional Windows App Runtime SDK.

   Select Yes if you are prompted to install it. This will open your default browser where you can download and install the latest stable release of the Windows App Runtime SDK.

   Reopen Coder Desktop after you install the runtime.

7. Coder Desktop starts minimized in the Windows System Tray.

   You might need to select the ^ in your system tray to show more icons.

8. Continue to the configuration section.

Configure

Before you can use Coder Desktop, you will need to sign in.

1. Open the Desktop menu and select Sign in:

   macOS

   

   Windows

   

2. In the Sign In window, enter your Coder deployment's URL and select Next:

   

3. macOS: Select the link to your deployment's /cli-auth page to generate a session token.

   Windows: Select Generate a token via the Web UI.

4. In your web browser, you may be prompted to sign in to Coder with your credentials.

5. Copy the session token to the clipboard:

   

6. Paste the token in the Session Token field of the Sign In screen, then select Sign In:

   

7. macOS: Allow the VPN configuration for Coder Desktop if you are prompted:

   

8. Select the Coder icon in the menu bar (macOS) or system tray (Windows), and click the Coder Connect toggle to enable the connection.

   

   This may take a few moments, because Coder Desktop will download the necessary components from the Coder server if they have been updated.

9. macOS: You may be prompted to enter your password to allow Coder Connect to start.

10. Coder Connect is now running!

Troubleshooting

If you encounter an issue with Coder Desktop that is not listed here, file an issue in the GitHub repository for Coder Desktop for macOS or Windows, in the main Coder repository, or consult the community on Discord.

Known Issues

macOS: 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.

Coder Desktop can't connect through another VPN

If the logged in Coder deployment requires a corporate VPN to connect, Coder Connect can't establish communication through the VPN, and will time out.

This is due to known issues with macOS and Windows networking. A resolution is in progress.

Next Steps

• Connect to and work on your workspace