Skip to content

Commit 1ffa9fa

Browse files
chore(local-windows-rdp): Removed Stale Requirements, Add required agent_name variable, Refine examples for clarity
1 parent 41dbc18 commit 1ffa9fa

File tree

1 file changed

+13
-28
lines changed
  • registry/coder/modules/local-windows-rdp

1 file changed

+13
-28
lines changed

registry/coder/modules/local-windows-rdp/README.md

Lines changed: 13 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@ This module enables Remote Desktop Protocol (RDP) on Windows workspaces and adds
1313

1414
```tf
1515
module "rdp_desktop" {
16-
count = data.coder_workspace.me.start_count
17-
source = "registry.coder.com/coder/local-windows-rdp/coder"
18-
version = "1.0.0"
19-
agent_id = coder_agent.main.id
16+
count = data.coder_workspace.me.start_count
17+
source = "registry.coder.com/coder/local-windows-rdp/coder"
18+
version = "1.0.0"
19+
agent_id = coder_agent.main.id
20+
agent_name = coder_agent.main.name
2021
}
2122
```
2223

@@ -39,9 +40,7 @@ module "rdp_desktop" {
3940

4041
## Requirements
4142

42-
- **Coder Desktop**: Must be installed on the client machine ([Download here](https://github.com/coder/coder/releases))
43-
- **Windows Workspace**: The target workspace must be running Windows
44-
- **Coder Agent**: Must be running on the Windows workspace
43+
- **Coder Desktop**: Must be installed on the client machine ([Download here](https://coder.com/docs/user-guides/desktop))
4544

4645
## Examples
4746

@@ -51,31 +50,17 @@ Uses default credentials (Username: `Administrator`, Password: `coderRDP!`):
5150

5251
```tf
5352
module "rdp_desktop" {
54-
count = data.coder_workspace.me.start_count
55-
source = "registry.coder.com/coder/local-windows-rdp/coder"
56-
version = "1.0.0"
57-
agent_id = coder_agent.main.id
53+
count = data.coder_workspace.me.start_count
54+
source = "registry.coder.com/coder/local-windows-rdp/coder"
55+
version = "1.0.0"
56+
agent_id = coder_agent.main.id
57+
agent_name = coder_agent.main.name
5858
}
5959
```
6060

61-
### Custom Credentials
61+
### Custom display name
6262

63-
Set your own username and password:
64-
65-
```tf
66-
module "rdp_desktop" {
67-
count = data.coder_workspace.me.start_count
68-
source = "registry.coder.com/coder/local-windows-rdp/coder"
69-
version = "1.0.0"
70-
agent_id = coder_agent.main.id
71-
username = "MyAdmin"
72-
password = "MySecurePassword123!"
73-
}
74-
```
75-
76-
### Custom Display and Agent
77-
78-
Configure display name and specify a different agent:
63+
Specify a custom display name for the `coder_app` button:
7964

8065
```tf
8166
module "rdp_desktop" {

0 commit comments

Comments
 (0)