NotificationsYou must be signed in to change notification settings
Fork1k
Star11.2k

Commitcbbbb44

authored

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

fixescoder/internal#627Adds docs for `coder://` URLs for Windows Remote Desktop (RDP).Note that we might want to hold of merging since the URI handling isunreleased in Coder Desktop for Windows.

1 parent36224f2 commitcbbbb44Copy full SHA for cbbbb44

File tree

1 file changed

+32

-0

lines changed

docs/user-guides/workspace-access
- remote-desktops.md

1 file changed

+32

-0

lines changed

`‎docs/user-guides/workspace-access/remote-desktops.md‎`

Lines changed: 32 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -47,6 +47,38 @@ Or use your favorite RDP client to connect to `localhost:3399`.
`47`	`47`
`48`	`48`	The default username is`Administrator` and password is`coderRDP!`.
`49`	`49`
	`50`	`+###Coder Desktop URI Handling (Beta)`
	`51`	`+`
	`52`	`+[Coder Desktop](../desktop) can use a URI handler to directly launch an RDP session without setting up port-forwarding.`
	`53`	`+The URI format is:`
	`54`	`+`
	`55`	+```text
	`56`	`+coder://<your Coder server name>/v0/open/ws/<workspace name>/agent/<agent name>/rdp?username=<username>&password=<password>`
	`57`	+```
	`58`	`+`
	`59`	`+For example:`
	`60`	`+`
	`61`	+```text
	`62`	`+coder://coder.example.com/v0/open/ws/myworkspace/agent/main/rdp?username=Administrator&password=coderRDP!`
	`63`	+```
	`64`	`+`
	`65`	+To include a Coder Desktop button to the workspace dashboard page, add a`coder_app` resource to the template:
	`66`	`+`
	`67`	+```tf
	`68`	`+locals {`
	`69`	`+ server_name = regex("https?:\\/\\/([^\\/]+)", data.coder_workspace.me.access_url)[0]`
	`70`	`+}`
	`71`	`+`
	`72`	`+resource "coder_app" "rdp-coder-desktop" {`
	`73`	`+ agent_id = resource.coder_agent.main.id`
	`74`	`+ slug = "rdp-desktop"`
	`75`	`+ display_name = "RDP with Coder Desktop"`
	`76`	`+ url = "coder://${local.server_name}/v0/open/ws/${data.coder_workspace.me.name}/agent/main/rdp?username=Administrator&password=coderRDP!"`
	`77`	`+ icon = "/icon/desktop.svg"`
	`78`	`+ external = true`
	`79`	`+}`
	`80`	+```
	`81`	`+`
`50`	`82`	`##RDP Web`
`51`	`83`
`52`	`84`	`Our[WebRDP](https://registry.coder.com/modules/windows-rdp) module in the Coder`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commitcbbbb44

File tree

1 file changed

1 file changed

`‎docs/user-guides/workspace-access/remote-desktops.md‎`

0 commit comments