Mar 4, 2025 · Feb 12, 2025 · Feb 12, 2025 · Feb 12, 2025 · Feb 19, 2025 · Feb 19, 2025
diff --git a/docs/images/icons/computer-code.svg b/docs/images/icons/computer-code.svg
diff --git a/docs/images/user-guides/desktop/coder-desktop-mac-menu-bar.png b/docs/images/user-guides/desktop/coder-desktop-mac-menu-bar.png
diff --git a/docs/images/user-guides/desktop/coder-desktop-pre-sign-in.png b/docs/images/user-guides/desktop/coder-desktop-pre-sign-in.png
diff --git a/docs/images/user-guides/desktop/coder-desktop-session-token.png b/docs/images/user-guides/desktop/coder-desktop-session-token.png
diff --git a/docs/images/user-guides/desktop/coder-desktop-sign-in.png b/docs/images/user-guides/desktop/coder-desktop-sign-in.png
diff --git a/docs/manifest.json b/docs/manifest.json
 }
 ]
 },
 {
 "title": "Coder Desktop",
 "description": "Use Coder Desktop to access your workspace like it's a local machine",
 "path": "./user-guides/desktop/index.md",
 "icon_path": "./images/icons/computer-code.svg",
 "state": ["beta"]
 },
 {
 "title": "Workspace Management",
 "description": "Manage workspaces",
diff --git a/docs/user-guides/desktop/index.md b/docs/user-guides/desktop/index.md
 # Coder Desktop

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

 ## Install Coder Desktop

 <div class="tabs">

 You can install Coder Desktop on macOS or Windows.

 ### macOS

 1. Use [Homebrew](https://brew.sh/) to install the Coder Desktop from [cask](https://github.com/coder/coder-desktop-macos/tree/main):

   ```shell
   brew install --cask coder/coder/coder-desktop-preview
   ```

 1. Open Coder Desktop from the Applications directory and when macOS asks if you want to open it, select **Open**.

 1. The application can connect as a VPN. macOS will prompt you to confirm with:

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

   Select **OK**.

 1. The Coder icon will appear in the macOS menu bar:

   ![Coder icon and menu](../../images/user-guides/desktop/coder-desktop-mac-menu-bar.png)

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

 ### Windows

 Download from there.

 </div>

 ## Configure

 Before you can use Coder Desktop, you will need to approve the system extension and log in.

 1. Select the Desktop menu bar icon, then **Approve in System Settings**.

 1. Desktop opens your system settings. Enable the Coder Desktop extension.

 1. Open the Desktop menu again and select **Sign in**:

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

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

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

 1. Select the link to your deployment's `/cli-auth` page to generate a [session token](../../admin/users/sessions-tokens.md).

 1. In your web browser, enter your credentials:

   <Image height="412px" src="../../images/templates/coder-login-web.png" alt="Log in to your Coder deployment" align="center" />

 1. Copy the session token to the clipboard:

   <Image height="472px" src="../../images/templates/coder-session-token.png" alt="Copy session token" align="center" />

 1. Paste the token in the **Session Token** box of the **Sign In** screen, then select **Sign In**:

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

 1. Allow the VPN configuration for Coder Desktop if your OS prompts you.

 1. Coder Desktop is now running!

   Select the Coder icon in the menu bar (macOS) or system tray (Windows) to enable [CoderVPN](#codervpn).

 ## Workspaces from Coder Desktop

 Placeholder for what users can do with workspaces from Coder Desktop

 ## CoderVPN

 Placeholder for some information about CoderVPN
Original file line number	Diff line number	Diff line change
Expand Up		@@ -158,6 +158,13 @@
		}
		]
		},
		{
		"title": "Coder Desktop",
		"description": "Use Coder Desktop to access your workspace like it's a local machine",
		"path": "./user-guides/desktop/index.md",
		"icon_path": "./images/icons/computer-code.svg",
		"state": ["beta"]
EdwardAngert marked this conversation as resolved. Show resolvedHide resolved EdwardAngert marked this conversation as resolved. Show resolvedHide resolved Copy link ContributorAuthor EdwardAngertFeb 27, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. leaving this as`beta` for now because we don't have an`earlyaccess` badge Copy link Member matifaliFeb 28, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. FYI@bpmct. @EdwardAngert I would opt for`alpha` over`beta` in this case. We do support that. ethanndickson marked this conversation as resolved. Show resolvedHide resolved
		},
		{
		"title": "Workspace Management",
		"description": "Manage workspaces",
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,82 @@
		# Coder Desktop

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

		## Install Coder Desktop

		<div class="tabs">

		You can install Coder Desktop on macOS or Windows.

		### macOS

		1. Use [Homebrew](https://brew.sh/) to install the Coder Desktop from [cask](https://github.com/coder/coder-desktop-macos/tree/main):
EdwardAngert marked this conversation as resolved. Show resolvedHide resolved

		```shell
		brew install --cask coder/coder/coder-desktop-preview
EdwardAngert marked this conversation as resolved. Show resolvedHide resolved
		```

		1. Open Coder Desktop from the Applications directory and when macOS asks if you want to open it, select Open.

		1. The application can connect as a VPN. macOS will prompt you to confirm with:

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

		Select OK.

		1. The Coder icon will appear in the macOS menu bar:

		![Coder icon and menu](../../images/user-guides/desktop/coder-desktop-mac-menu-bar.png)

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

		### Windows

		Download from there.

		</div>

		## Configure

		Before you can use Coder Desktop, you will need to approve the system extension and log in.
Copy link Member ThomasK33Feb 20, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Do we want to move this to a macOS-specific heading or tab? I'm guessing that the Windows configuration steps will be different. Copy link ContributorAuthor EdwardAngertFeb 20, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. I adjusted the step per@ethanndickson 's suggestion and that moved the configuration step into the mac-specific section I think the rest of the configurationshould be the same, but I haven't been able to try the Windows version yet

		1. Select the Desktop menu bar icon, then Approve in System Settings.

		1. Desktop opens your system settings. Enable the Coder Desktop extension.

		1. Open the Desktop menu again and select Sign in:

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

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

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

		1. Select the link to your deployment's `/cli-auth` page to generate a [session token](../../admin/users/sessions-tokens.md).

		1. In your web browser, enter your credentials:

		<Image height="412px" src="../../images/templates/coder-login-web.png" alt="Log in to your Coder deployment" align="center" />

		1. Copy the session token to the clipboard:

		<Image height="472px" src="../../images/templates/coder-session-token.png" alt="Copy session token" align="center" />

		1. Paste the token in the Session Token box of the Sign In screen, then select Sign In:

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

		1. Allow the VPN configuration for Coder Desktop if your OS prompts you.

		1. Coder Desktop is now running!

		Select the Coder icon in the menu bar (macOS) or system tray (Windows) to enable [CoderVPN](#codervpn).

		## Workspaces from Coder Desktop

		Placeholder for what users can do with workspaces from Coder Desktop
Copy link Member ethanndicksonFeb 27, 2025• edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. For this alpha release we could include something like: 'You can verify a connection was established with your workspace by pinging it using`ping6`, e.g.`ping6 workspace.coder`" I think this is worth mentioning purely because macOS`ping` won't work, and people will likely try to. Eventually we'll show the latency in-client, somehow. IIRC`ping` does work on Windows matifali reacted with thumbs up emoji Copy link ContributorAuthor EdwardAngertFeb 27, 2025• edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. strange, it looks like a build issue because theparent page is there I wonder if it doesn't know how to treat the "early access" badge inhttps://github.com/coder/coder/pull/16544/files#diff-0cbcfff19a4479219e722863d8f59891658d042d3fac32fe9d9a75d650ce0524R171 edit: tested with`3f0cb83` - seems the site doesn't know what to do with an "early access" badge. I'll try to hunt down where that gets handled Copy link ContributorAuthor EdwardAngertFeb 27, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. @jaaydenh I'm trying to mimic your work in#14670 to add an "Early Access" badge that replaces "Alpha" but I'm messing it up in a way that I can't quite figure out. Can you help me diagnose, please?

		## CoderVPN

		Placeholder for some information about CoderVPN