-
Notifications
You must be signed in to change notification settings - Fork 929
docs: add Coder Desktop to remote desktop docs #18326
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
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
8d91a1d
docs: add Coder Desktop to remote desktop docs
matifali c73085d
Merge branch 'main' into atof/remote-desktop-docs
matifali dcc851e
Merge branch 'main' into atof/remote-desktop-docs
matifali 71a90b8
Apply suggestions from code review
matifali 2df01ec
Update remote-desktops.md
matifali b9fb5d6
Update remote-desktops.md
matifali 170b41a
address PR comments
matifali File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,37 +15,41 @@ Installation instructions vary depending on your workspace's operating system, | |
platform, and build system. | ||
|
||
As a starting point, see the | ||
[desktop-container](https://github.com/bpmct/coder-templates/tree/main/desktop-container) | ||
community template. It builds and provisions a Dockerized workspace with the | ||
[enterprise-desktop](https://github.com/coder/images/tree/main/images/desktop) | ||
image. It can be used to provision a Dockerized workspace with the | ||
following software: | ||
|
||
- Ubuntu 20.04 | ||
- TigerVNC server | ||
- noVNC client | ||
- Ubuntu 24.04 | ||
- XFCE Desktop | ||
- KasmVNC Server and Web Client | ||
|
||
## RDP Desktop | ||
|
||
To use RDP with Coder, you'll need to install an | ||
[RDP client](https://docs.microsoft.com/en-us/windows-server/remote/remote-desktop-services/clients/remote-desktop-clients) | ||
on your local machine, and enable RDP on your workspace. | ||
|
||
Use the following command to forward the RDP port to your local machine: | ||
<div class="tabs"> | ||
|
||
```console | ||
coder port-forward <workspace-name> --tcp 3399:3389 | ||
``` | ||
### 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. It doesn't make sense to have both a "Coder Desktop" and a "RDP with Coder Desktop (beta)" heading. These need to be consolidated into a single section. |
||
|
||
[Install Coder Desktop](https://coder.com/docs/user-guides/desktop#install-coder-desktop) and connect to `<workspace-name>.coder` from your favourite RDP client. | ||
|
||
Then, connect to your workspace via RDP: | ||
### CLI | ||
|
||
Use the following command to forward the RDP port to your local machine: | ||
|
||
```console | ||
mstsc /v localhost:3399 | ||
coder port-forward <workspace-name> --tcp 3399:3389 | ||
``` | ||
|
||
Or use your favorite RDP client to connect to `localhost:3399`. | ||
Then, connect to your workspace via RDP at `localhost:3399`. | ||
 | ||
|
||
The default username is `Administrator` and password is `coderRDP!`. | ||
</div> | ||
|
||
> [!NOTE] | ||
> The default username is `Administrator` and the password is `coderRDP!`. | ||
|
||
### RDP with Coder Desktop (Beta) | ||
|
||
|
@@ -57,7 +61,7 @@ Use your favorite RDP client to connect to `<workspace-name>.coder` instead of ` | |
> [!NOTE] | ||
> Some versions of Windows, including Windows Server 2022, do not communicate correctly over UDP | ||
> when using Coder Connect because they do not respect the maximum transmission unit (MTU) of the link. | ||
> When this happens the RDP client will appear to connect, but displays a blank screen. | ||
> When this happens, the RDP client will appear to connect, but displays a blank screen. | ||
> | ||
> To avoid this error, Coder's [Windows RDP](https://registry.coder.com/modules/windows-rdp) module | ||
> [disables RDP over UDP automatically](https://github.com/coder/registry/blob/b58bfebcf3bcdcde4f06a183f92eb3e01842d270/registry/coder/modules/windows-rdp/powershell-installation-script.tftpl#L22). | ||
|
@@ -83,7 +87,7 @@ For example: | |
coder://coder.example.com/v0/open/ws/myworkspace/agent/main/rdp?username=Administrator&password=coderRDP! | ||
``` | ||
|
||
To include a Coder Desktop button to the workspace dashboard page, add a `coder_app` resource to the template: | ||
To include a Coder Desktop button on the workspace dashboard page, add a `coder_app` resource to the template: | ||
|
||
```tf | ||
locals { | ||
|
@@ -107,7 +111,7 @@ Registry adds a one-click button to open an RDP session in the browser. This | |
requires just a few lines of Terraform in your template, see the documentation | ||
on our registry for setup. | ||
|
||
 | ||
 | ||
|
||
## Amazon DCV Windows | ||
|
||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.