Skip to content

docs: add Coder Desktop early preview documentation #16544

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Mar 4, 2025
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
d3f6c25
init desktop section
EdwardAngert Feb 12, 2025
412d956
add placeholder icon
EdwardAngert Feb 12, 2025
e92191b
edit
EdwardAngert Feb 12, 2025
a29e8cc
install and configure coder desktop mac homebrew
EdwardAngert Feb 19, 2025
3fa35b4
Update docs/manifest.json
EdwardAngert Feb 19, 2025
1da456a
Update docs/user-guides/desktop/index.md
EdwardAngert Feb 20, 2025
fe3aad2
include feedback from review
EdwardAngert Feb 20, 2025
eb8b566
adjust network extension step
EdwardAngert Feb 20, 2025
653ff5a
Update docs/user-guides/desktop/index.md
EdwardAngert Feb 20, 2025
1fd186a
adjust screenshot sizes
EdwardAngert Feb 20, 2025
df06b1d
Update docs/manifest.json
EdwardAngert Feb 26, 2025
5ea3bee
Merge remote-tracking branch 'origin/main' into 16540-desktop-beta
EdwardAngert Feb 27, 2025
0356dac
temp remove windows
EdwardAngert Feb 27, 2025
3f0cb83
test alpha in manifest
EdwardAngert Feb 27, 2025
aff01a9
test eabadge
EdwardAngert Feb 27, 2025
56d916c
earlyaccess?
EdwardAngert Feb 27, 2025
ceaca40
add ping6 step
EdwardAngert Feb 27, 2025
9ddccf2
screenshot and workspace steps
EdwardAngert Feb 27, 2025
70fe6d4
Revert "temp remove windows"
EdwardAngert Feb 27, 2025
028acc4
add windows steps; update login screenshot
EdwardAngert Feb 27, 2025
72a7a77
Update docs/manifest.json
EdwardAngert Feb 27, 2025
69b7fe9
Update docs/manifest.json
EdwardAngert Feb 27, 2025
0e0e4d8
update login screenshot
EdwardAngert Feb 27, 2025
b80f539
docs changes
ethanndickson Mar 3, 2025
a96b9b4
fixup
ethanndickson Mar 3, 2025
7ad6e8b
remove note blocks
ethanndickson Mar 3, 2025
bc0c79f
beta -> alpha
ethanndickson Mar 3, 2025
1433eb1
remove unused react EA badge
ethanndickson Mar 3, 2025
56f0952
add version requirement
ethanndickson Mar 4, 2025
6a39e67
link to future v2.20
ethanndickson Mar 4, 2025
cffa373
Update Coder Desktop doc to reflect "Early Access" status
matifali Mar 4, 2025
3525e55
Add tabs for browser-specific instructions
matifali Mar 4, 2025
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
20 changes: 20 additions & 0 deletions docs/images/icons/computer-code.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/templates/coder-login-web.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,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": ["earlyaccess"]
},
{
"title": "Workspace Management",
"description": "Manage workspaces",
Expand Down
124 changes: 124 additions & 0 deletions docs/user-guides/desktop/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# 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 Coder Desktop:

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

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

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

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

Select **Open System Settings**.

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

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

### Windows

1. Download the latest `CoderDesktop` executable (`.exe`) from the [coder-desktop-windows repository](https://github.com/coder/coder-desktop-windows/).

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

1. Open the `.exe` files, acknowledge the license terms and conditions, and select **Install**.

1. Windows asks if you "want to allow this app from an unknown publisher to make changes to your device?"

Select **Yes**.

1. The Coder Desktop installation creates a system restore point.
Depending on your system, this step might take a while.

1. If .NET is not already installed, the installation might prompt you with the **Windows Desktop Runtime** installation.

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

1. When the Coder Desktop installation completes, select **Close**.

1. Find and open **Coder Desktop** from your Start Menu.

1. Some systems require an additional Windows App Runtime.

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 Windows App SDK.

Reopen Coder Desktop after you install Windows App SDK.

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

You might need to select the **^** in your system tray to show more icons.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe add a comment about how you can pin it by going to (at least on Win 11) Settings > Personalization > Taskbar > Other system tray icons, then enabling Coder Desktop


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

</div>

## Configure

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

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

<Image height="325px" src="../../images/user-guides/desktop/coder-desktop-pre-sign-in.png" alt="Coder Desktop menu before the user signs in" align="center" />

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. macOS: Select the link to your deployment's `/cli-auth` page to generate a [session token](../../admin/users/sessions-tokens.md).

Windows: Select **Generate a token via the Web UI**.

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="350px" 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!

1. Select the Coder icon in the menu bar (macOS) or system tray (Windows) and enable **CoderVPN**.

## Workspaces from Coder Desktop

![Coder Desktop list of workspaces](../../images/user-guides/desktop/coder-desktop-workspaces.png)

1. You can use `ping6` in your terminal to verify the connection to your workspace:

```shell
ping6 -c 5 yourworkspacename.coder
```

1. Select your workspace from the Coder Desktop icon.

Desktop opens the workspace in your browser.

![Screenshot of a workspace](../../images/screenshots/workspace-running-with-topbar.png)

1. Select the IDE you want to use and start working on your code.

## CoderVPN

Placeholder for some information about CoderVPN
6 changes: 6 additions & 0 deletions site/src/components/Badges/Badges.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
AlphaBadge,
Badges,
DisabledBadge,
EaBadge,
EnabledBadge,
EntitledBadge,
HealthyBadge,
Expand Down Expand Up @@ -65,3 +66,8 @@ export const Alpha: Story = {
children: <AlphaBadge />,
},
};
export const EarlyAccess: Story = {
args: {
children: <EaBadge />,
},
};
17 changes: 17 additions & 0 deletions site/src/components/Badges/Badges.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,23 @@ export const PreviewBadge: FC = () => {
);
};

export const EaBadge: FC = () => {
return (
<span
css={[
styles.badge,
(theme) => ({
border: `1px solid ${theme.roles.preview.outline}`,
backgroundColor: theme.roles.preview.background,
color: theme.roles.preview.text,
}),
]}
>
Early Access
</span>
);
};

export const AlphaBadge: FC = () => {
return (
<span
Expand Down