synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-12 00:14:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
246a829ea973cda627c7f8f21ece603ef31083ab
coder/docs/user-guides/desktop/index.md
Edward Angert e906ce2b65 docs: separate coder desktop sections into install and use pages (#18068) 
[preview](https://coder.com/docs/@coder-desktop-section/user-guides/desktop)

we should consider the "Connect" naming in future PRs

---------

Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
2025-05-29 17:42:14 +00:00

4.5 KiB
Raw Blame History

Coder Desktop (Beta)

Use Coder Desktop to work on your workspaces as though they're on your LAN, no port-forwarding required.

Note

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

Install Coder Desktop

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.

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.

Windows

  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

    Coder Desktop menu before the user signs in

    Windows

    Coder Desktop menu before the user signs in

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

    Coder Desktop sign in

  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:

    Sign in to your Coder deployment

  5. Copy the session token to the clipboard:

    Copy session token

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

    Paste the session token in to sign in

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

    Copy session token

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

    Coder Desktop on Windows - enable Coder Connect

    This may take a few moments, as 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!

Next Steps