Skip to content
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

add vcxsrv script #341

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

Conversation

jashlu
Copy link
Collaborator

@jashlu jashlu commented Nov 29, 2023

Hi all, this PR includes the vcxsrv script that will automate the configs requried for VcXsrv. Also included is the updated README with instructions on running this script.

The same changes have been applied to the maint/pre-hnn-core PR.

Open to any suggestions/comments! Thanks

1. Open the Command Prompt application. Can be found by searching `Command Prompt` in the Windows search bar.
2. Paste the following command to install Windows Subsystem for Linux (WSL)
```
wsl --install
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a way to manually specify WSL2?

I think this is installed by default now but we've run into a few folks that had WSL1 and couldn't install docker

Copy link
Collaborator Author

@jashlu jashlu Dec 1, 2023

Choose a reason for hiding this comment

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

Just for clarification, are u saying folks who already had WSL1 before attempting this installation process were having errors installing docker? Like you said, wsl --install should by default install WSL2 so users who are following this tutorial, starting from scratch, should have WSL2 installed.

I could add some additional instructions here on how to upgrade from WSL1 to WSL2 if that helps (and mention that WSL2 is required over WSL1)

Copy link
Contributor

@ntolley ntolley Dec 8, 2023

Choose a reason for hiding this comment

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

Perhaps we could just say something like:

Note: if WSL is already installed on your computer, please ensure it is WSL2 . WSL1 is incompatible with Docker install.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sounds good, i'll add that in

installer/docker/README.md Outdated Show resolved Hide resolved
Co-authored-by: Nicholas Tolley <[email protected]>
Copy link
Collaborator

@hollandjg hollandjg left a comment

Choose a reason for hiding this comment

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

Hey Josh, you've made a very elegant script there – it leverages you access to the place where the data are (the Linux VM) and automates the tricky Windows part!

I think you would be better served just deleting the old instructions which don't work any more. If you leave them in, people might be misled into thinking that they aren't broken. Don't be afraid to just delete stuff which isn't up to date – we have the history in Git after all.

scripts/configure_vcxsrv.sh Outdated Show resolved Hide resolved
scripts/configure_vcxsrv.sh Show resolved Hide resolved
installer/docker/README.md Outdated Show resolved Hide resolved
installer/docker/README.md Outdated Show resolved Hide resolved
installer/docker/README.md Outdated Show resolved Hide resolved
installer/README.md Outdated Show resolved Hide resolved
installer/README.md Outdated Show resolved Hide resolved
installer/docker/README.md Outdated Show resolved Hide resolved
installer/docker/README.md Outdated Show resolved Hide resolved
installer/README.md Outdated Show resolved Hide resolved
@jashlu jashlu requested a review from hollandjg December 6, 2023 20:18
Copy link
Collaborator

@hollandjg hollandjg left a comment

Choose a reason for hiding this comment

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

This looks good to me, but I'm not in a position to approve this – that's something for the lab members to do!

@jashlu
Copy link
Collaborator Author

jashlu commented Dec 7, 2023

This looks good to me, but I'm not in a position to approve this – that's something for the lab members to do!

But your insight/comments are nevertheless valuable! Thanks for taking a look

@hollandjg hollandjg dismissed their stale review February 5, 2024 14:30

Waiting for code owners to check. Looks good to me.

@hollandjg
Copy link
Collaborator

hi @ntolley – is this good to merge or do we need to do more here?

@hollandjg hollandjg requested a review from ntolley February 5, 2024 14:31
@ntolley
Copy link
Contributor

ntolley commented Feb 7, 2024

Apologies @hollandjg testing this script got lost on my to-do list after the holiday break

@dylansdaniels can we sit together to test out this script on your windows machine?

@dylansdaniels
Copy link
Contributor

@ntolley Yes we can definitely do that. I mostly copied/pasted the instructions from this file anyway when I recently tested install on my machine, but i was doing it line by line since i didn't have the file locally. I only deviated from the instructions in that I copied the IP address manually.

@rythorpe
Copy link
Contributor

rythorpe commented Jun 4, 2024

Where are we at on this @dylansdaniels @ntolley? We should get this merged soon to aid in installation for users who still need to use the old GUI.

@ntolley
Copy link
Contributor

ntolley commented Jun 5, 2024

@rythorpe apologies Dylan and I sat down several times to hammer out installation instructions but got distracted with formatting screenshots for the installation webpage.

@dylansdaniels is it possible for you to test this during the hackathon?

@dylansdaniels
Copy link
Contributor

Yeah sure! I can bring both of my laptops for the hackathon so we have one for any windows testing we need

@jasmainak
Copy link
Collaborator

do we have a list of issues we want to tackle? we could create a project board ...

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

Successfully merging this pull request may close these issues.

6 participants