Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

docs: reorganize Coder Desktop docs#18871

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Draft
matifali wants to merge1 commit intomain
base:main
Choose a base branch
Loading
fromatif/coder-desktop-docs
Draft
Changes fromall commits
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
200 changes: 108 additions & 92 deletionsdocs/user-guides/desktop/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,153 +1,169 @@
# 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 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.

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

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

> [!IMPORTANT]
> Coder Desktop can't connect through a corporate VPN.
>
> Due to a [known issue](#coder-desktop-cant-connect-through-another-vpn),
> if your Coder deployment requires that you connect through a corporate VPN, Desktop will timeout when it tries to connect.
**Estimated setup time:** 5-10 minutes

<div class="tabs">

You can install Coder Desktop on macOS or Windows.

### macOS
## Quick Start

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

```shell
brew install --cask coder/coder/coder-desktop
```
## How It Works

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

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

1.Theapplication is treated as a system VPN. macOS will prompt you to confirm with:
TheVPN extension routes only Coder traffic—your other internet activity remains unchanged.

**"Coder Desktop" would like to use a new network extension**
## Installation

Select **Open System Settings**.

1. In the **Network Extensions** system settings, enable the Coder Desktop extension.
<div class="tabs">

1. Continue to the [configuration section](#configure).
### macOS

### Windows
<div class="tabs">

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

To manually install Coder Desktop:
```shell
brew install --cask coder/coder/coder-desktop
```

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

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

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

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

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

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

1. Find and open **Coder Desktop** fromyourStart Menu.
✅ **Verify Installation**:Coder Desktop should appear inyourmenu bar

1. Some systems require an additionalWindows App Runtime SDK.
###Windows

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.
<div class="tabs">

Reopen Coder Desktop after you install the runtime.
#### WinGet (Recommended)**

1. Coder Desktop starts minimized in the Windows System Tray.
```shell
winget install Coder.CoderDesktop
```

You might need to select the **^** in your system tray to show more icons.
#### Manual Installation**

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

</div>

## Configure

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

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

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

## macOS

![Coder Desktop menu before the user signs in](../../images/user-guides/desktop/coder-desktop-mac-pre-sign-in.png)

## Windows

![Coder Desktop menu before the user signs in](../../images/user-guides/desktop/coder-desktop-win-pre-sign-in.png)

</div>

1. In the **Sign In** window, enter your Coder deployment's URL and select **Next**:
</div>

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

1. macOS: Select the linkto yourdeployment's `/cli-auth` page to generate a [session token](../../admin/users/sessions-tokens.md).
Once connected, test accessto yourworkspaces:

Windows: Select **Generate a token via the Web UI**.
**SSH Connection**
```shell
ssh your-workspace.coder
```

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

1. Copy the session token to the clipboard:
# Windows
ping -n 3 your-workspace.coder
```

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

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

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

1. macOS: Allow the VPN configuration for Coder Desktop if you are prompted:
### Connection Issues

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

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

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

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

1. macOS: You may be prompted to enter your password to allow Coder Connecttostart.
A resolution is in development. For now, use the [Coder CLI](../cli.md) when connectedtocorporate VPNs.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

🚫[linkspector]reported byreviewdog 🐶
Cannot reach ../cli.md Status: 404 Cannot find: ../cli.md


1. Coder Connect is now running!
**Secure Browser Context**
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.

## Troubleshooting
### Getting Help

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](https://github.com/coder/coder-desktop-macos/issues) or
[Windows](https://github.com/coder/coder-desktop-windows/issues), in the
[main Coder repository](https://github.com/coder/coder/issues), or consult the
[community on Discord](https://coder.com/chat).
If you encounter issues not covered here:

### Known Issues
- **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)
- **Community support**: [Discord](https://coder.com/chat)

#### macOS: Do not install more than one copy of Coder Desktop
## Uninstalling

To avoid system VPN configuration conflicts, only one copy of `Coder Desktop.app` should exist on your Mac, and it must remain in `/Applications`.
<div class="tabs">

#### Coder Desktop can't connect through another VPN
### macOS

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

This is due to known issues with [macOS](https://github.com/coder/coder-desktop-macos/issues/201) and
[Windows](https://github.com/coder/coder-desktop-windows/issues/147) networking.
A resolution is in progress.
### Windows

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

- [Connect to and work on your workspace](./desktop-connect-sync.md)
</div>
Loading
[8]ページ先頭
©2009-2025 Movatter.jp