Skip to content

Add Rustdesk module #266

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

Open
wants to merge 39 commits into
base: main
Choose a base branch
from
Open

Conversation

BenraouaneSoufiane
Copy link

@BenraouaneSoufiane BenraouaneSoufiane commented Jul 30, 2025

Closes #79

Description

This PR add new module, install minimal desktop environment (xfce), virtual display, ,rustdesk package from deb file, init new screen, export DISPLAY environment variable with last created virtual screen, start new xfce session & execute the rustdesk cli, generate new password, change the default password, then log the ID & password to be used within rustdesk client to connect to the host

Type of Change

  • New module
  • Bug fix
  • Feature/enhancement
  • Documentation
  • Other

Module Information

Overview/test video: live demo that launch rustdesk with GUI in a docker container https://youtu.be/_rR-l7nARN4
Screenshots:
image
image
image
image

Path: registry/BenraouaneSoufiane/modules/rustdesk
New version: v1.0.0
Breaking change: [ ] Yes [x] No

Testing & Validation

  • Tests pass (bun test)
  • Code formatted (bun run fmt)
  • Changes tested locally

Related Issues

/claim #79 (remain asset 150$)

@BenraouaneSoufiane
Copy link
Author

@matifali can you release the pending asset (150$)?

@DevelopmentCats
Copy link
Contributor

@matifali can you release the pending asset (150$)?

This is released automatically once the PR is merged and closed

@BenraouaneSoufiane
Copy link
Author

@matifali can you release the pending asset (150$)?

This is released automatically once the PR is merged and closed

No comment! But why I'm being delayed as this PR resolve the issue?

@DevelopmentCats
Copy link
Contributor

@matifali can you release the pending asset (150$)?

This is released automatically once the PR is merged and closed

No comment! But why I'm being delayed as this PR resolve the issue?

There is no intentional delay, as Algora releases the bounty once the PR is approved, and merged.

This is outlined in the Coder Bounty Issue #213

@DevelopmentCats
Copy link
Contributor

@BenraouaneSoufiane Just checking if there is any update on this?

@BenraouaneSoufiane
Copy link
Author

@BenraouaneSoufiane Just checking if there is any update on this?

Fixed, thank you!

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a new RustDesk module that enables remote desktop access within Coder workspaces. The module automates the installation of RustDesk, sets up a virtual display using Xvfb, and provides connection credentials for remote access.

Key changes:

  • Adds a complete RustDesk module with cross-platform package manager support
  • Implements automatic password generation and virtual display configuration
  • Provides Terraform integration with configurable parameters

Reviewed Changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated 5 comments.

File Description
registry/BenraouaneSoufiane/modules/rustdesk/run.sh Main installation and setup script with package manager detection and RustDesk configuration
registry/BenraouaneSoufiane/modules/rustdesk/main.tf Terraform module definition with variables and Coder resource configuration
registry/BenraouaneSoufiane/modules/rustdesk/README.md Module documentation with usage instructions and configuration examples
registry/BenraouaneSoufiane/README.md Author profile information

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

BenraouaneSoufiane and others added 4 commits August 13, 2025 21:25
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@BenraouaneSoufiane
Copy link
Author

@DevelopmentCats thank you for your suggestions, I've committed the suggested fixes

Tell users how to use/customize the module like rustdesk version, virtual screen dimentions & the password
@DevelopmentCats
Copy link
Contributor

DevelopmentCats commented Aug 14, 2025

@BenraouaneSoufiane Can you run bun run fmt on this? @BenraouaneSoufiane

@BenraouaneSoufiane
Copy link
Author

Can you run bun run fmt on this? @BenraouaneSoufiane

Formatted, thank you

@DevelopmentCats
Copy link
Contributor

DevelopmentCats commented Aug 14, 2025

Can you run bun run fmt on this? @BenraouaneSoufiane

Formatted, thank you

@BenraouaneSoufiane Can you remove the package-lock file you accidentally left in the commit?

@BenraouaneSoufiane
Copy link
Author

Can you run bun run fmt on this? @BenraouaneSoufiane

Formatted, thank you

@BenraouaneSoufiane Can you remove the package-lock file you accidentally left in the commit?

Sorry for that, it were deleted now, thanks

@DevelopmentCats
Copy link
Contributor

Run bun fmt:ci
  bun fmt:ci
  shell: /usr/bin/bash -e {0}
$ bun x prettier --check **/*.sh **/*.ts **/*.md *.md && terraform fmt -check -recursive -diff
Checking formatting...
[warn] registry/BenraouaneSoufiane/modules/rustdesk/README.md
[warn] Code style issues found in the above file. Run Prettier with --write to fix.
error: script "fmt:ci" exited with code 1
Error: Process completed with exit code 1.

@BenraouaneSoufiane

@BenraouaneSoufiane
Copy link
Author

Run bun fmt:ci
  bun fmt:ci
  shell: /usr/bin/bash -e {0}
$ bun x prettier --check **/*.sh **/*.ts **/*.md *.md && terraform fmt -check -recursive -diff
Checking formatting...
[warn] registry/BenraouaneSoufiane/modules/rustdesk/README.md
[warn] Code style issues found in the above file. Run Prettier with --write to fix.
error: script "fmt:ci" exited with code 1
Error: Process completed with exit code 1.

@BenraouaneSoufiane

I think it's related with terraform (not found, even it's installed), all things related with prettier are succeed, so I run terraform fmt command manually with the recursive flag of course which format well my main.tf, the same thing with run.sh, I run shfmt -w path/to/run.sh which format the script, you see the differences

@BenraouaneSoufiane
Copy link
Author

BenraouaneSoufiane commented Aug 14, 2025

I was thinking it may an issue with run.sh after using external formatter, I just did a quick review using online shell validator
The same thing with terraform script (main.tf)
It's probably doesn't related with my contribution at all, I don't know what to do even I come to my room

Screenshot_2025-08-14-21-12-11-62_40deb401b9ffe8e1df2f1cc5ba480b12
Screenshot_2025-08-14-21-17-42-09_40deb401b9ffe8e1df2f1cc5ba480b12

cc: @DevelopmentCats

Copy link
Author

@BenraouaneSoufiane BenraouaneSoufiane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DevelopmentCats Everything looks good, but still couldn't figure out what are changes requested by you

@BenraouaneSoufiane
Copy link
Author

@DevelopmentCats I got changes requested but i couldn't see them, can you outline them?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rustdesk module
2 participants