-
Notifications
You must be signed in to change notification settings - Fork 929
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 4 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 |
---|---|---|
|
@@ -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 conversati
8000
on 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,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 resolved
Hide resolved
|
||
|
||
```shell | ||
brew install --cask coder/coder/coder-desktop-preview | ||
EdwardAngert marked this conversation as resolved.
Show resolved
Hide 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: | ||
|
||
 | ||
|
||
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. | ||
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. Do we want to move this to a macOS-specific heading or tab? 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. 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 configuration should 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**: | ||
|
||
 | ||
|
||
1. In the **Sign In** window, enter your Coder deployment's URL and select **Next**: | ||
|
||
 | ||
|
||
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**: | ||
|
||
 | ||
|
||
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 | ||
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. For this alpha release we could include something like: IIRC 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. strange, it looks like a build issue because the parent page is there I wonder if it doesn't know how to treat the "early access" badge in https://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 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. |
||
|
||
## CoderVPN | ||
|
||
Placeholder for some information about CoderVPN |
Uh oh!
There was an error while loading. Please reload this page.