Skip to content

docs: explain coder:// link for RDP #17901

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.

Sign up for GitHub

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 2 commits into from
May 21, 2025
Merged

docs: explain coder:// link for RDP #17901

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd2e6e1
docs: explain coder:// link for RDP
spikecurtis May 19, 2025
dd48cce
Apply suggestions from code review
spikecurtis May 20, 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
32 changes: 32 additions & 0 deletions docs/user-guides/workspace-access/remote-desktops.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,38 @@ Or use your favorite RDP client to connect to `localhost:3399`.

The default username is `Administrator` and password is `coderRDP!`.

### Coder Desktop URI Handling (Beta)

[Coder Desktop](../desktop) can use a URI handler to directly launch an RDP session without setting up port-forwarding.
The URI format is:

```text
coder://<your Coder server name>/v0/open/ws/<workspace name>/agent/<agent name>/rdp?username=<username>&password=<password>
```

For example:

```text
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:

```tf
locals {
server_name = regex("https?:\\/\\/([^\\/]+)", data.coder_workspace.me.access_url)[0]
}

resource "coder_app" "rdp-coder-desktop" {
agent_id = resource.coder_agent.main.id
slug = "rdp-desktop"
display_name = "RDP with Coder Desktop"
url = "coder://${local.server_name}/v0/open/ws/${data.coder_workspace.me.name}/agent/main/rdp?username=Administrator&password=coderRDP!"
icon = "/icon/desktop.svg"
external = true
}
```

## RDP Web

Our [WebRDP](https://registry.coder.com/modules/windows-rdp) module in the Coder
Expand Down
Loading