feat(docs): add automated SSH setup and remote dev guide for VM users#3554
Open
FedericoMusa wants to merge 1 commit intoadenhq:mainfrom
Open
feat(docs): add automated SSH setup and remote dev guide for VM users#3554FedericoMusa wants to merge 1 commit intoadenhq:mainfrom
FedericoMusa wants to merge 1 commit intoadenhq:mainfrom
Conversation
Author
|
This PR introduces a remote development utility and updates the documentation to support developers working within Virtual Machines (e.g., VirtualBox). It aims to eliminate UI latency and keyboard mapping issues by providing an automated SSH setup flow, as discussed in the context of the (archived) issue #3415. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Brief description of the changes in this PR.
Type of Change
Related Issues
Fixes #3415 (Re-opening the conversation with a production-ready solution).
Changes Made
Change 1: Created scripts/setup-remote.sh to automate SSH server installation, Firewall (ufw) rules, and service restarts.
Change 2: Added a comprehensive "Remote Development Setup (SSH)" section to ENVIRONMENT_SETUP.md.
Change 3: Included a visual port-forwarding guide and IDE connection instructions for Windows/Mac hosts.
Testing
Describe the tests you ran to verify your changes:
[x] Manual testing performed: Verified the SSH tunnel stability via VS Code Remote-SSH on an Ubuntu 24.04 VM.
[x] Verified that scripts/setup-remote.sh correctly identifies existing configurations to avoid redundancy.
Checklist
Screenshots (if applicable)
Add screenshots to demonstrate UI changes.