synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-12 00:14:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
fixes https://github.com/coder/internal/issues/627

Adds docs for `coder://` URLs for Windows Remote Desktop (RDP).

Note that we might want to hold of merging since the URI handling is
unreleased in Coder Desktop for Windows.
This commit is contained in:
Spike Curtis
2025-05-21 09:28:31 +04:00
committed by GitHub
parent 36224f263f
commit cbbbb4492a
1 changed files with 32 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/user-guides/workspace-access/remote-desktops.md
View File

@ -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