-
Notifications
You must be signed in to change notification settings - Fork 943
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
Changes from 23 commits
d3f6c25
412d956
e92191b
a29e8cc
3fa35b4
1da456a
fe3aad2
eb8b566
653ff5a
1fd186a
df06b1d
5ea3bee
0356dac
3f0cb83
aff01a9
56d916c
ceaca40
9ddccf2
70fe6d4
028acc4
72a7a77
69b7fe9
0e0e4d8
b80f539
a96b9b4
7ad6e8b
bc0c79f
1433eb1
56f0952
6a39e67
cffa373
3525e55
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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": ["beta"] | ||
EdwardAngert marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. leaving this as There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. FYI @bpmct.
ethanndickson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
}, | ||
{ | ||
"title": "Workspace Management", | ||
"description": "Manage workspaces", | ||
|
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. | ||
deansheather marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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**. | ||
deansheather marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
1. The Coder Desktop installation creates a system restore point. | ||
Depending on your system, this step might take a while. | ||
deansheather marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
1. If .NET is not already installed, the installation might prompt you with the **Windows Desktop Runtime** installation. | ||
deansheather marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. | ||
deansheather marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. | ||
deansheather marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
1. Coder Desktop starts minimized in the Windows System Tray. | ||
|
||
You might need to select the **^** in your system tray to show more icons. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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**: | ||
|
||
 | ||
|
||
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**: | ||
|
||
 | ||
|
||
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 | ||
|
||
 | ||
|
||
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. | ||
|
||
 | ||
|
||
1. Select the IDE you want to use and start working on your code. | ||
|
||
## CoderVPN | ||
|
||
Placeholder for some information about CoderVPN |
Uh oh!
There was an error while loading. Please reload this page.